diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 9154b47..3cc16e0 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -9,10 +9,12 @@ MergeATSClient/api/applications_api.py MergeATSClient/api/attachments_api.py MergeATSClient/api/available_actions_api.py MergeATSClient/api/candidates_api.py +MergeATSClient/api/delete_account_api.py MergeATSClient/api/departments_api.py MergeATSClient/api/eeocs_api.py MergeATSClient/api/generate_key_api.py MergeATSClient/api/interviews_api.py +MergeATSClient/api/issues_api.py MergeATSClient/api/job_interview_stages_api.py MergeATSClient/api/jobs_api.py MergeATSClient/api/link_token_api.py @@ -53,6 +55,8 @@ MergeATSClient/model/email_address_type_enum.py MergeATSClient/model/end_user_details_request.py MergeATSClient/model/gender_enum.py MergeATSClient/model/generate_remote_key_request.py +MergeATSClient/model/issue.py +MergeATSClient/model/issue_status_enum.py MergeATSClient/model/job.py MergeATSClient/model/job_interview_stage.py MergeATSClient/model/job_status_enum.py @@ -69,6 +73,7 @@ MergeATSClient/model/paginated_attachment_list.py MergeATSClient/model/paginated_candidate_list.py MergeATSClient/model/paginated_department_list.py MergeATSClient/model/paginated_eeoc_list.py +MergeATSClient/model/paginated_issue_list.py MergeATSClient/model/paginated_job_interview_stage_list.py MergeATSClient/model/paginated_job_list.py MergeATSClient/model/paginated_offer_list.py @@ -128,6 +133,7 @@ docs/Candidate.md docs/CandidateRequest.md docs/CandidatesApi.md docs/DataPassthroughRequest.md +docs/DeleteAccountApi.md docs/Department.md docs/DepartmentsApi.md docs/DisabilityStatusEnum.md @@ -141,6 +147,9 @@ docs/GenderEnum.md docs/GenerateKeyApi.md docs/GenerateRemoteKeyRequest.md docs/InterviewsApi.md +docs/Issue.md +docs/IssueStatusEnum.md +docs/IssuesApi.md docs/Job.md docs/JobInterviewStage.md docs/JobInterviewStagesApi.md @@ -162,6 +171,7 @@ docs/PaginatedAttachmentList.md docs/PaginatedCandidateList.md docs/PaginatedDepartmentList.md docs/PaginatedEEOCList.md +docs/PaginatedIssueList.md docs/PaginatedJobInterviewStageList.md docs/PaginatedJobList.md docs/PaginatedOfferList.md diff --git a/MergeATSClient/api/applications_api.py b/MergeATSClient/api/applications_api.py index 1264b31..ba8cd54 100644 --- a/MergeATSClient/api/applications_api.py +++ b/MergeATSClient/api/applications_api.py @@ -42,7 +42,6 @@ def __init__(self, api_client=None): def __applications_create( self, x_account_token, - remote_user_id, **kwargs ): """applications_create # noqa: E501 @@ -51,14 +50,14 @@ def __applications_create( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.applications_create(x_account_token, remote_user_id, async_req=True) + >>> thread = api.applications_create(x_account_token, async_req=True) >>> result = thread.get() Args: x_account_token (str): Token identifying the end user. - remote_user_id (str): The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. Keyword Args: + remote_user_id (str): The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.. [optional] run_async (bool): Whether or not third-party updates should be run asynchronously.. [optional] application_request (ApplicationRequest): [optional] _return_http_data_only (bool): response data without head status @@ -107,8 +106,6 @@ def __applications_create( kwargs['_host_index'] = kwargs.get('_host_index') kwargs['x_account_token'] = \ x_account_token - kwargs['remote_user_id'] = \ - remote_user_id return self.call_with_http_info(**kwargs) self.applications_create = _Endpoint( @@ -131,7 +128,6 @@ def __applications_create( ], 'required': [ 'x_account_token', - 'remote_user_id', ], 'nullable': [ ], diff --git a/MergeATSClient/api/attachments_api.py b/MergeATSClient/api/attachments_api.py index 089a671..332da02 100644 --- a/MergeATSClient/api/attachments_api.py +++ b/MergeATSClient/api/attachments_api.py @@ -42,7 +42,6 @@ def __init__(self, api_client=None): def __attachments_create( self, x_account_token, - remote_user_id, **kwargs ): """attachments_create # noqa: E501 @@ -51,14 +50,14 @@ def __attachments_create( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.attachments_create(x_account_token, remote_user_id, async_req=True) + >>> thread = api.attachments_create(x_account_token, async_req=True) >>> result = thread.get() Args: x_account_token (str): Token identifying the end user. - remote_user_id (str): The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. Keyword Args: + remote_user_id (str): The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.. [optional] run_async (bool): Whether or not third-party updates should be run asynchronously.. [optional] attachment_request (AttachmentRequest): [optional] _return_http_data_only (bool): response data without head status @@ -107,8 +106,6 @@ def __attachments_create( kwargs['_host_index'] = kwargs.get('_host_index') kwargs['x_account_token'] = \ x_account_token - kwargs['remote_user_id'] = \ - remote_user_id return self.call_with_http_info(**kwargs) self.attachments_create = _Endpoint( @@ -131,7 +128,6 @@ def __attachments_create( ], 'required': [ 'x_account_token', - 'remote_user_id', ], 'nullable': [ ], diff --git a/MergeATSClient/api/candidates_api.py b/MergeATSClient/api/candidates_api.py index 89d574d..9e0c7b0 100644 --- a/MergeATSClient/api/candidates_api.py +++ b/MergeATSClient/api/candidates_api.py @@ -42,7 +42,6 @@ def __init__(self, api_client=None): def __candidates_create( self, x_account_token, - remote_user_id, **kwargs ): """candidates_create # noqa: E501 @@ -51,14 +50,14 @@ def __candidates_create( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.candidates_create(x_account_token, remote_user_id, async_req=True) + >>> thread = api.candidates_create(x_account_token, async_req=True) >>> result = thread.get() Args: x_account_token (str): Token identifying the end user. - remote_user_id (str): The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. Keyword Args: + remote_user_id (str): The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.. [optional] run_async (bool): Whether or not third-party updates should be run asynchronously.. [optional] candidate_request (CandidateRequest): [optional] _return_http_data_only (bool): response data without head status @@ -107,8 +106,6 @@ def __candidates_create( kwargs['_host_index'] = kwargs.get('_host_index') kwargs['x_account_token'] = \ x_account_token - kwargs['remote_user_id'] = \ - remote_user_id return self.call_with_http_info(**kwargs) self.candidates_create = _Endpoint( @@ -131,7 +128,6 @@ def __candidates_create( ], 'required': [ 'x_account_token', - 'remote_user_id', ], 'nullable': [ ], diff --git a/MergeATSClient/api/delete_account_api.py b/MergeATSClient/api/delete_account_api.py new file mode 100644 index 0000000..923cc0f --- /dev/null +++ b/MergeATSClient/api/delete_account_api.py @@ -0,0 +1,154 @@ +""" + Merge ATS API + + The unified API for building rich integrations with multiple Applicant Tracking System platforms. # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: hello@merge.dev + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from MergeATSClient.api_client import ApiClient, Endpoint as _Endpoint +from MergeATSClient.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class DeleteAccountApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def __delete_account_create( + self, + x_account_token, + **kwargs + ): + """delete_account_create # noqa: E501 + + Delete a linked account. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_account_create(x_account_token, async_req=True) + >>> result = thread.get() + + Args: + x_account_token (str): Token identifying the end user. + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['x_account_token'] = \ + x_account_token + return self.call_with_http_info(**kwargs) + + self.delete_account_create = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'tokenAuth' + ], + 'endpoint_path': '/delete-account', + 'operation_id': 'delete_account_create', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'x_account_token', + ], + 'required': [ + 'x_account_token', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'x_account_token': + (str,), + }, + 'attribute_map': { + 'x_account_token': 'X-Account-Token', + }, + 'location_map': { + 'x_account_token': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client, + callable=__delete_account_create + ) diff --git a/MergeATSClient/api/interviews_api.py b/MergeATSClient/api/interviews_api.py index 3da15c6..4d4affe 100644 --- a/MergeATSClient/api/interviews_api.py +++ b/MergeATSClient/api/interviews_api.py @@ -42,7 +42,6 @@ def __init__(self, api_client=None): def __interviews_create( self, x_account_token, - remote_user_id, **kwargs ): """interviews_create # noqa: E501 @@ -51,14 +50,14 @@ def __interviews_create( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.interviews_create(x_account_token, remote_user_id, async_req=True) + >>> thread = api.interviews_create(x_account_token, async_req=True) >>> result = thread.get() Args: x_account_token (str): Token identifying the end user. - remote_user_id (str): The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. Keyword Args: + remote_user_id (str): The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.. [optional] run_async (bool): Whether or not third-party updates should be run asynchronously.. [optional] scheduled_interview_request (ScheduledInterviewRequest): [optional] _return_http_data_only (bool): response data without head status @@ -107,8 +106,6 @@ def __interviews_create( kwargs['_host_index'] = kwargs.get('_host_index') kwargs['x_account_token'] = \ x_account_token - kwargs['remote_user_id'] = \ - remote_user_id return self.call_with_http_info(**kwargs) self.interviews_create = _Endpoint( @@ -131,7 +128,6 @@ def __interviews_create( ], 'required': [ 'x_account_token', - 'remote_user_id', ], 'nullable': [ ], diff --git a/MergeATSClient/api/issues_api.py b/MergeATSClient/api/issues_api.py new file mode 100644 index 0000000..39b6de9 --- /dev/null +++ b/MergeATSClient/api/issues_api.py @@ -0,0 +1,325 @@ +""" + Merge ATS API + + The unified API for building rich integrations with multiple Applicant Tracking System platforms. # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: hello@merge.dev + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from MergeATSClient.api_client import ApiClient, Endpoint as _Endpoint +from MergeATSClient.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from MergeATSClient.model.issue import Issue +from MergeATSClient.model.paginated_issue_list import PaginatedIssueList + + +class IssuesApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def __issues_list( + self, + **kwargs + ): + """issues_list # noqa: E501 + + Gets issues. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.issues_list(async_req=True) + >>> result = thread.get() + + + Keyword Args: + account_token (str): account_token. [optional] + cursor (int): The pagination cursor value.. [optional] + end_date (str): If included, will only include issues whose most recent action occurred before this time. [optional] + end_user_organization_name (str): end_user_organization_name. [optional] + include_muted (str): If True, will include muted issues. [optional] + integration_name (str): integration_name. [optional] + page_size (int): Number of results to return per page.. [optional] + start_date (str): If included, will only include issues whose most recent action occurred after this time. [optional] + status (str): status. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + PaginatedIssueList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.call_with_http_info(**kwargs) + + self.issues_list = _Endpoint( + settings={ + 'response_type': (PaginatedIssueList,), + 'auth': [ + 'tokenAuth' + ], + 'endpoint_path': '/issues', + 'operation_id': 'issues_list', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'account_token', + 'cursor', + 'end_date', + 'end_user_organization_name', + 'include_muted', + 'integration_name', + 'page_size', + 'start_date', + 'status', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'status', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('status',): { + + "ONGOING": "ONGOING", + "RESOLVED": "RESOLVED" + }, + }, + 'openapi_types': { + 'account_token': + (str,), + 'cursor': + (int,), + 'end_date': + (str,), + 'end_user_organization_name': + (str,), + 'include_muted': + (str,), + 'integration_name': + (str,), + 'page_size': + (int,), + 'start_date': + (str,), + 'status': + (str,), + }, + 'attribute_map': { + 'account_token': 'account_token', + 'cursor': 'cursor', + 'end_date': 'end_date', + 'end_user_organization_name': 'end_user_organization_name', + 'include_muted': 'include_muted', + 'integration_name': 'integration_name', + 'page_size': 'page_size', + 'start_date': 'start_date', + 'status': 'status', + }, + 'location_map': { + 'account_token': 'query', + 'cursor': 'query', + 'end_date': 'query', + 'end_user_organization_name': 'query', + 'include_muted': 'query', + 'integration_name': 'query', + 'page_size': 'query', + 'start_date': 'query', + 'status': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__issues_list + ) + + def __issues_retrieve( + self, + id, + **kwargs + ): + """issues_retrieve # noqa: E501 + + Get a specific issue. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.issues_retrieve(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + Issue + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.call_with_http_info(**kwargs) + + self.issues_retrieve = _Endpoint( + settings={ + 'response_type': (Issue,), + 'auth': [ + 'tokenAuth' + ], + 'endpoint_path': '/issues/{id}', + 'operation_id': 'issues_retrieve', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client, + callable=__issues_retrieve + ) diff --git a/MergeATSClient/api/scorecards_api.py b/MergeATSClient/api/scorecards_api.py index 799653c..bc44179 100644 --- a/MergeATSClient/api/scorecards_api.py +++ b/MergeATSClient/api/scorecards_api.py @@ -42,7 +42,6 @@ def __init__(self, api_client=None): def __scorecards_create( self, x_account_token, - remote_user_id, **kwargs ): """scorecards_create # noqa: E501 @@ -51,14 +50,14 @@ def __scorecards_create( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.scorecards_create(x_account_token, remote_user_id, async_req=True) + >>> thread = api.scorecards_create(x_account_token, async_req=True) >>> result = thread.get() Args: x_account_token (str): Token identifying the end user. - remote_user_id (str): The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. Keyword Args: + remote_user_id (str): The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.. [optional] run_async (bool): Whether or not third-party updates should be run asynchronously.. [optional] scorecard_request (ScorecardRequest): [optional] _return_http_data_only (bool): response data without head status @@ -107,8 +106,6 @@ def __scorecards_create( kwargs['_host_index'] = kwargs.get('_host_index') kwargs['x_account_token'] = \ x_account_token - kwargs['remote_user_id'] = \ - remote_user_id return self.call_with_http_info(**kwargs) self.scorecards_create = _Endpoint( @@ -131,7 +128,6 @@ def __scorecards_create( ], 'required': [ 'x_account_token', - 'remote_user_id', ], 'nullable': [ ], diff --git a/MergeATSClient/api/users_api.py b/MergeATSClient/api/users_api.py index b32f57d..ebaf168 100644 --- a/MergeATSClient/api/users_api.py +++ b/MergeATSClient/api/users_api.py @@ -42,7 +42,6 @@ def __init__(self, api_client=None): def __users_create( self, x_account_token, - remote_user_id, **kwargs ): """users_create # noqa: E501 @@ -51,14 +50,14 @@ def __users_create( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.users_create(x_account_token, remote_user_id, async_req=True) + >>> thread = api.users_create(x_account_token, async_req=True) >>> result = thread.get() Args: x_account_token (str): Token identifying the end user. - remote_user_id (str): The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. Keyword Args: + remote_user_id (str): The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.. [optional] run_async (bool): Whether or not third-party updates should be run asynchronously.. [optional] remote_user_request (RemoteUserRequest): [optional] _return_http_data_only (bool): response data without head status @@ -107,8 +106,6 @@ def __users_create( kwargs['_host_index'] = kwargs.get('_host_index') kwargs['x_account_token'] = \ x_account_token - kwargs['remote_user_id'] = \ - remote_user_id return self.call_with_http_info(**kwargs) self.users_create = _Endpoint( @@ -131,7 +128,6 @@ def __users_create( ], 'required': [ 'x_account_token', - 'remote_user_id', ], 'nullable': [ ], diff --git a/MergeATSClient/apis/__init__.py b/MergeATSClient/apis/__init__.py index 20d106e..2765c43 100644 --- a/MergeATSClient/apis/__init__.py +++ b/MergeATSClient/apis/__init__.py @@ -20,10 +20,12 @@ from MergeATSClient.api.attachments_api import AttachmentsApi from MergeATSClient.api.available_actions_api import AvailableActionsApi from MergeATSClient.api.candidates_api import CandidatesApi +from MergeATSClient.api.delete_account_api import DeleteAccountApi from MergeATSClient.api.departments_api import DepartmentsApi from MergeATSClient.api.eeocs_api import EeocsApi from MergeATSClient.api.generate_key_api import GenerateKeyApi from MergeATSClient.api.interviews_api import InterviewsApi +from MergeATSClient.api.issues_api import IssuesApi from MergeATSClient.api.job_interview_stages_api import JobInterviewStagesApi from MergeATSClient.api.jobs_api import JobsApi from MergeATSClient.api.link_token_api import LinkTokenApi diff --git a/MergeATSClient/model/candidate.py b/MergeATSClient/model/candidate.py index 0b7abbb..b36d75c 100644 --- a/MergeATSClient/model/candidate.py +++ b/MergeATSClient/model/candidate.py @@ -195,9 +195,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 phone_numbers ([PhoneNumber]): [optional] # noqa: E501 email_addresses ([EmailAddress]): [optional] # noqa: E501 urls ([Url]): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - applications ([str]): [optional] # noqa: E501 - attachments ([str]): [optional] # noqa: E501 + tags ([str]): Array of `Tag` names as strings.. [optional] # noqa: E501 + applications ([str]): Array of `Application` object IDs.. [optional] # noqa: E501 + attachments ([str]): Array of `Attachment` object IDs.. [optional] # noqa: E501 remote_data ([RemoteData], none_type): [optional] # noqa: E501 """ diff --git a/MergeATSClient/model/candidate_request.py b/MergeATSClient/model/candidate_request.py index d05d3b6..fb23698 100644 --- a/MergeATSClient/model/candidate_request.py +++ b/MergeATSClient/model/candidate_request.py @@ -188,9 +188,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 phone_numbers ([PhoneNumberRequest]): [optional] # noqa: E501 email_addresses ([EmailAddressRequest]): [optional] # noqa: E501 urls ([UrlRequest]): [optional] # noqa: E501 - tags ([str]): [optional] # noqa: E501 - applications ([str]): [optional] # noqa: E501 - attachments ([str]): [optional] # noqa: E501 + tags ([str]): Array of `Tag` names as strings.. [optional] # noqa: E501 + applications ([str]): Array of `Application` object IDs.. [optional] # noqa: E501 + attachments ([str]): Array of `Attachment` object IDs.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/MergeATSClient/model/issue.py b/MergeATSClient/model/issue.py new file mode 100644 index 0000000..b9ff0f9 --- /dev/null +++ b/MergeATSClient/model/issue.py @@ -0,0 +1,193 @@ +""" + Merge ATS API + + The unified API for building rich integrations with multiple Applicant Tracking System platforms. # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: hello@merge.dev + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from MergeATSClient.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from MergeATSClient.model.issue_status_enum import IssueStatusEnum + globals()['IssueStatusEnum'] = IssueStatusEnum + + +class Issue(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'error_description': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'status': (IssueStatusEnum,), # noqa: E501 + 'end_user': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'first_incident_time': (datetime, none_type,), # noqa: E501 + 'last_incident_time': (datetime, none_type,), # noqa: E501 + 'is_muted': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'error_description': 'error_description', # noqa: E501 + 'id': 'id', # noqa: E501 + 'status': 'status', # noqa: E501 + 'end_user': 'end_user', # noqa: E501 + 'first_incident_time': 'first_incident_time', # noqa: E501 + 'last_incident_time': 'last_incident_time', # noqa: E501 + 'is_muted': 'is_muted', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, error_description, *args, **kwargs): # noqa: E501 + """Issue - a model defined in OpenAPI + + Args: + error_description (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + status (IssueStatusEnum): [optional] # noqa: E501 + end_user ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] # noqa: E501 + first_incident_time (datetime, none_type): [optional] # noqa: E501 + last_incident_time (datetime, none_type): [optional] # noqa: E501 + is_muted (bool): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.error_description = error_description + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/MergeATSClient/model/issue_status_enum.py b/MergeATSClient/model/issue_status_enum.py new file mode 100644 index 0000000..fbc88c5 --- /dev/null +++ b/MergeATSClient/model/issue_status_enum.py @@ -0,0 +1,184 @@ +""" + Merge ATS API + + The unified API for building rich integrations with multiple Applicant Tracking System platforms. # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: hello@merge.dev + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from MergeATSClient.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + + +class IssueStatusEnum(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'ONGOING': "ONGOING", + 'RESOLVED': "RESOLVED", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """IssueStatusEnum - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["ONGOING", "RESOLVED", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["ONGOING", "RESOLVED", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) diff --git a/MergeATSClient/model/job.py b/MergeATSClient/model/job.py index 65154cc..2424624 100644 --- a/MergeATSClient/model/job.py +++ b/MergeATSClient/model/job.py @@ -168,9 +168,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 remote_created_at (datetime, none_type): When the third party's job was created.. [optional] # noqa: E501 remote_updated_at (datetime, none_type): When the third party's job was updated.. [optional] # noqa: E501 confidential (bool, none_type): Whether the job is confidential.. [optional] # noqa: E501 - departments ([str]): [optional] # noqa: E501 - offices ([str]): [optional] # noqa: E501 - hiring_managers ([str]): [optional] # noqa: E501 + departments ([str]): IDs of `Department` objects for this `Job`.. [optional] # noqa: E501 + offices ([str]): IDs of `Office` objects for this `Job`.. [optional] # noqa: E501 + hiring_managers ([str]): IDs of `RemoteUser` objects that serve as hiring managers for this `Job`.. [optional] # noqa: E501 remote_data ([RemoteData], none_type): [optional] # noqa: E501 """ diff --git a/MergeATSClient/model/paginated_issue_list.py b/MergeATSClient/model/paginated_issue_list.py new file mode 100644 index 0000000..552c42b --- /dev/null +++ b/MergeATSClient/model/paginated_issue_list.py @@ -0,0 +1,178 @@ +""" + Merge ATS API + + The unified API for building rich integrations with multiple Applicant Tracking System platforms. # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: hello@merge.dev + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from MergeATSClient.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from MergeATSClient.model.issue import Issue + globals()['Issue'] = Issue + + +class PaginatedIssueList(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'next': (str, none_type,), # noqa: E501 + 'previous': (str, none_type,), # noqa: E501 + 'results': ([Issue],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'next': 'next', # noqa: E501 + 'previous': 'previous', # noqa: E501 + 'results': 'results', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PaginatedIssueList - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + next (str, none_type): [optional] # noqa: E501 + previous (str, none_type): [optional] # noqa: E501 + results ([Issue]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/MergeATSClient/model/scheduled_interview.py b/MergeATSClient/model/scheduled_interview.py index d31fe47..a0463ea 100644 --- a/MergeATSClient/model/scheduled_interview.py +++ b/MergeATSClient/model/scheduled_interview.py @@ -167,7 +167,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 application (str, none_type): The application being interviewed.. [optional] # noqa: E501 job_interview_stage (str, none_type): The stage of the interview.. [optional] # noqa: E501 organizer (str, none_type): The user organizing the interview.. [optional] # noqa: E501 - interviewers ([str]): [optional] # noqa: E501 + interviewers ([str]): Array of `RemoteUser` IDs.. [optional] # noqa: E501 location (str, none_type): The interview's location.. [optional] # noqa: E501 start_at (datetime, none_type): When the interview was started.. [optional] # noqa: E501 end_at (datetime, none_type): When the interview was ended.. [optional] # noqa: E501 diff --git a/MergeATSClient/model/scheduled_interview_request.py b/MergeATSClient/model/scheduled_interview_request.py index a979e38..f74a344 100644 --- a/MergeATSClient/model/scheduled_interview_request.py +++ b/MergeATSClient/model/scheduled_interview_request.py @@ -155,7 +155,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 application (str, none_type): The application being interviewed.. [optional] # noqa: E501 job_interview_stage (str, none_type): The stage of the interview.. [optional] # noqa: E501 organizer (str, none_type): The user organizing the interview.. [optional] # noqa: E501 - interviewers ([str]): [optional] # noqa: E501 + interviewers ([str]): Array of `RemoteUser` IDs.. [optional] # noqa: E501 location (str, none_type): The interview's location.. [optional] # noqa: E501 start_at (datetime, none_type): When the interview was started.. [optional] # noqa: E501 end_at (datetime, none_type): When the interview was ended.. [optional] # noqa: E501 diff --git a/MergeATSClient/models/__init__.py b/MergeATSClient/models/__init__.py index 3c83a90..c1761e6 100644 --- a/MergeATSClient/models/__init__.py +++ b/MergeATSClient/models/__init__.py @@ -32,6 +32,8 @@ from MergeATSClient.model.end_user_details_request import EndUserDetailsRequest from MergeATSClient.model.gender_enum import GenderEnum from MergeATSClient.model.generate_remote_key_request import GenerateRemoteKeyRequest +from MergeATSClient.model.issue import Issue +from MergeATSClient.model.issue_status_enum import IssueStatusEnum from MergeATSClient.model.job import Job from MergeATSClient.model.job_interview_stage import JobInterviewStage from MergeATSClient.model.job_status_enum import JobStatusEnum @@ -48,6 +50,7 @@ from MergeATSClient.model.paginated_candidate_list import PaginatedCandidateList from MergeATSClient.model.paginated_department_list import PaginatedDepartmentList from MergeATSClient.model.paginated_eeoc_list import PaginatedEEOCList +from MergeATSClient.model.paginated_issue_list import PaginatedIssueList from MergeATSClient.model.paginated_job_interview_stage_list import PaginatedJobInterviewStageList from MergeATSClient.model.paginated_job_list import PaginatedJobList from MergeATSClient.model.paginated_offer_list import PaginatedOfferList diff --git a/README.md b/README.md index c728fbe..2b87d52 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,7 @@ Class | Method | HTTP request | Description *CandidatesApi* | [**candidates_create**](docs/CandidatesApi.md#candidates_create) | **POST** /candidates | *CandidatesApi* | [**candidates_list**](docs/CandidatesApi.md#candidates_list) | **GET** /candidates | *CandidatesApi* | [**candidates_retrieve**](docs/CandidatesApi.md#candidates_retrieve) | **GET** /candidates/{id} | +*DeleteAccountApi* | [**delete_account_create**](docs/DeleteAccountApi.md#delete_account_create) | **POST** /delete-account | *DepartmentsApi* | [**departments_list**](docs/DepartmentsApi.md#departments_list) | **GET** /departments | *DepartmentsApi* | [**departments_retrieve**](docs/DepartmentsApi.md#departments_retrieve) | **GET** /departments/{id} | *EeocsApi* | [**eeocs_list**](docs/EeocsApi.md#eeocs_list) | **GET** /eeocs | @@ -108,6 +109,8 @@ Class | Method | HTTP request | Description *InterviewsApi* | [**interviews_create**](docs/InterviewsApi.md#interviews_create) | **POST** /interviews | *InterviewsApi* | [**interviews_list**](docs/InterviewsApi.md#interviews_list) | **GET** /interviews | *InterviewsApi* | [**interviews_retrieve**](docs/InterviewsApi.md#interviews_retrieve) | **GET** /interviews/{id} | +*IssuesApi* | [**issues_list**](docs/IssuesApi.md#issues_list) | **GET** /issues | +*IssuesApi* | [**issues_retrieve**](docs/IssuesApi.md#issues_retrieve) | **GET** /issues/{id} | *JobInterviewStagesApi* | [**job_interview_stages_list**](docs/JobInterviewStagesApi.md#job_interview_stages_list) | **GET** /job-interview-stages | *JobInterviewStagesApi* | [**job_interview_stages_retrieve**](docs/JobInterviewStagesApi.md#job_interview_stages_retrieve) | **GET** /job-interview-stages/{id} | *JobsApi* | [**jobs_list**](docs/JobsApi.md#jobs_list) | **GET** /jobs | @@ -157,6 +160,8 @@ Class | Method | HTTP request | Description - [EndUserDetailsRequest](docs/EndUserDetailsRequest.md) - [GenderEnum](docs/GenderEnum.md) - [GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md) + - [Issue](docs/Issue.md) + - [IssueStatusEnum](docs/IssueStatusEnum.md) - [Job](docs/Job.md) - [JobInterviewStage](docs/JobInterviewStage.md) - [JobStatusEnum](docs/JobStatusEnum.md) @@ -173,6 +178,7 @@ Class | Method | HTTP request | Description - [PaginatedCandidateList](docs/PaginatedCandidateList.md) - [PaginatedDepartmentList](docs/PaginatedDepartmentList.md) - [PaginatedEEOCList](docs/PaginatedEEOCList.md) + - [PaginatedIssueList](docs/PaginatedIssueList.md) - [PaginatedJobInterviewStageList](docs/PaginatedJobInterviewStageList.md) - [PaginatedJobList](docs/PaginatedJobList.md) - [PaginatedOfferList](docs/PaginatedOfferList.md) diff --git a/docs/ApplicationsApi.md b/docs/ApplicationsApi.md index 14448ac..06afb66 100644 --- a/docs/ApplicationsApi.md +++ b/docs/ApplicationsApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description # **applications_create** -> Application applications_create(x_account_token, remote_user_id) +> Application applications_create(x_account_token) @@ -48,7 +48,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = applications_api.ApplicationsApi(api_client) x_account_token = "X-Account-Token_example" # str | Token identifying the end user. - remote_user_id = "remote_user_id_example" # str | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. + remote_user_id = "remote_user_id_example" # str | The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. (optional) run_async = True # bool | Whether or not third-party updates should be run asynchronously. (optional) application_request = ApplicationRequest( remote_id="98796", @@ -64,7 +64,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set try: - api_response = api_instance.applications_create(x_account_token, remote_user_id) + api_response = api_instance.applications_create(x_account_token) pprint(api_response) except MergeATSClient.ApiException as e: print("Exception when calling ApplicationsApi->applications_create: %s\n" % e) @@ -72,7 +72,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.applications_create(x_account_token, remote_user_id, run_async=run_async, application_request=application_request) + api_response = api_instance.applications_create(x_account_token, remote_user_id=remote_user_id, run_async=run_async, application_request=application_request) pprint(api_response) except MergeATSClient.ApiException as e: print("Exception when calling ApplicationsApi->applications_create: %s\n" % e) @@ -84,7 +84,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **x_account_token** | **str**| Token identifying the end user. | - **remote_user_id** | **str**| The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | + **remote_user_id** | **str**| The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | [optional] **run_async** | **bool**| Whether or not third-party updates should be run asynchronously. | [optional] **application_request** | [**ApplicationRequest**](ApplicationRequest.md)| | [optional] diff --git a/docs/AttachmentsApi.md b/docs/AttachmentsApi.md index 3cb6d91..bf78060 100644 --- a/docs/AttachmentsApi.md +++ b/docs/AttachmentsApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description # **attachments_create** -> Attachment attachments_create(x_account_token, remote_user_id) +> Attachment attachments_create(x_account_token) @@ -48,7 +48,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = attachments_api.AttachmentsApi(api_client) x_account_token = "X-Account-Token_example" # str | Token identifying the end user. - remote_user_id = "remote_user_id_example" # str | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. + remote_user_id = "remote_user_id_example" # str | The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. (optional) run_async = True # bool | Whether or not third-party updates should be run asynchronously. (optional) attachment_request = AttachmentRequest( remote_id="11167", @@ -60,7 +60,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set try: - api_response = api_instance.attachments_create(x_account_token, remote_user_id) + api_response = api_instance.attachments_create(x_account_token) pprint(api_response) except MergeATSClient.ApiException as e: print("Exception when calling AttachmentsApi->attachments_create: %s\n" % e) @@ -68,7 +68,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.attachments_create(x_account_token, remote_user_id, run_async=run_async, attachment_request=attachment_request) + api_response = api_instance.attachments_create(x_account_token, remote_user_id=remote_user_id, run_async=run_async, attachment_request=attachment_request) pprint(api_response) except MergeATSClient.ApiException as e: print("Exception when calling AttachmentsApi->attachments_create: %s\n" % e) @@ -80,7 +80,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **x_account_token** | **str**| Token identifying the end user. | - **remote_user_id** | **str**| The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | + **remote_user_id** | **str**| The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | [optional] **run_async** | **bool**| Whether or not third-party updates should be run asynchronously. | [optional] **attachment_request** | [**AttachmentRequest**](AttachmentRequest.md)| | [optional] diff --git a/docs/Candidate.md b/docs/Candidate.md index 0653c2e..cc1458f 100644 --- a/docs/Candidate.md +++ b/docs/Candidate.md @@ -20,9 +20,9 @@ Name | Type | Description | Notes **phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional] **email_addresses** | [**[EmailAddress]**](EmailAddress.md) | | [optional] **urls** | [**[Url]**](Url.md) | | [optional] -**tags** | **[str]** | | [optional] -**applications** | **[str]** | | [optional] -**attachments** | **[str]** | | [optional] +**tags** | **[str]** | Array of `Tag` names as strings. | [optional] +**applications** | **[str]** | Array of `Application` object IDs. | [optional] +**attachments** | **[str]** | Array of `Attachment` object IDs. | [optional] **remote_data** | [**[RemoteData], none_type**](RemoteData.md) | | [optional] [readonly] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CandidateRequest.md b/docs/CandidateRequest.md index 2c67b7e..0e90e4f 100644 --- a/docs/CandidateRequest.md +++ b/docs/CandidateRequest.md @@ -19,9 +19,9 @@ Name | Type | Description | Notes **phone_numbers** | [**[PhoneNumberRequest]**](PhoneNumberRequest.md) | | [optional] **email_addresses** | [**[EmailAddressRequest]**](EmailAddressRequest.md) | | [optional] **urls** | [**[UrlRequest]**](UrlRequest.md) | | [optional] -**tags** | **[str]** | | [optional] -**applications** | **[str]** | | [optional] -**attachments** | **[str]** | | [optional] +**tags** | **[str]** | Array of `Tag` names as strings. | [optional] +**applications** | **[str]** | Array of `Application` object IDs. | [optional] +**attachments** | **[str]** | Array of `Attachment` object IDs. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CandidatesApi.md b/docs/CandidatesApi.md index 6f49779..372405f 100644 --- a/docs/CandidatesApi.md +++ b/docs/CandidatesApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description # **candidates_create** -> Candidate candidates_create(x_account_token, remote_user_id) +> Candidate candidates_create(x_account_token) @@ -48,7 +48,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = candidates_api.CandidatesApi(api_client) x_account_token = "X-Account-Token_example" # str | Token identifying the end user. - remote_user_id = "remote_user_id_example" # str | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. + remote_user_id = "remote_user_id_example" # str | The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. (optional) run_async = True # bool | Whether or not third-party updates should be run asynchronously. (optional) candidate_request = CandidateRequest( remote_id="21198", @@ -87,7 +87,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set try: - api_response = api_instance.candidates_create(x_account_token, remote_user_id) + api_response = api_instance.candidates_create(x_account_token) pprint(api_response) except MergeATSClient.ApiException as e: print("Exception when calling CandidatesApi->candidates_create: %s\n" % e) @@ -95,7 +95,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.candidates_create(x_account_token, remote_user_id, run_async=run_async, candidate_request=candidate_request) + api_response = api_instance.candidates_create(x_account_token, remote_user_id=remote_user_id, run_async=run_async, candidate_request=candidate_request) pprint(api_response) except MergeATSClient.ApiException as e: print("Exception when calling CandidatesApi->candidates_create: %s\n" % e) @@ -107,7 +107,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **x_account_token** | **str**| Token identifying the end user. | - **remote_user_id** | **str**| The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | + **remote_user_id** | **str**| The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | [optional] **run_async** | **bool**| Whether or not third-party updates should be run asynchronously. | [optional] **candidate_request** | [**CandidateRequest**](CandidateRequest.md)| | [optional] @@ -173,8 +173,11 @@ with MergeATSClient.ApiClient(configuration) as api_client: created_after = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | If provided, will only return objects created after this datetime. (optional) created_before = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | If provided, will only return objects created before this datetime. (optional) cursor = "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" # str | The pagination cursor value. (optional) + email_address = "email_address_example" # str | If provided, will only return candidates with this email_address. (optional) expand = "applications,attachments" # str | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. (optional) + first_name = "first_name_example" # str, none_type | If provided, will only return candidates with this first name. (optional) include_remote_data = True # bool | Whether to include the original data Merge fetched from the third-party to produce these models. (optional) + last_name = "last_name_example" # str, none_type | If provided, will only return candidates with this last name. (optional) modified_after = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | If provided, will only return objects modified after this datetime. (optional) modified_before = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | If provided, will only return objects modified before this datetime. (optional) page_size = 1 # int | Number of results to return per page. (optional) @@ -190,7 +193,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.candidates_list(x_account_token, created_after=created_after, created_before=created_before, cursor=cursor, expand=expand, include_remote_data=include_remote_data, modified_after=modified_after, modified_before=modified_before, page_size=page_size, remote_id=remote_id) + api_response = api_instance.candidates_list(x_account_token, created_after=created_after, created_before=created_before, cursor=cursor, email_address=email_address, expand=expand, first_name=first_name, include_remote_data=include_remote_data, last_name=last_name, modified_after=modified_after, modified_before=modified_before, page_size=page_size, remote_id=remote_id) pprint(api_response) except MergeATSClient.ApiException as e: print("Exception when calling CandidatesApi->candidates_list: %s\n" % e) @@ -205,8 +208,11 @@ Name | Type | Description | Notes **created_after** | **datetime**| If provided, will only return objects created after this datetime. | [optional] **created_before** | **datetime**| If provided, will only return objects created before this datetime. | [optional] **cursor** | **str**| The pagination cursor value. | [optional] + **email_address** | **str**| If provided, will only return candidates with this email_address. | [optional] **expand** | **str**| Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] + **first_name** | **str, none_type**| If provided, will only return candidates with this first name. | [optional] **include_remote_data** | **bool**| Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] + **last_name** | **str, none_type**| If provided, will only return candidates with this last name. | [optional] **modified_after** | **datetime**| If provided, will only return objects modified after this datetime. | [optional] **modified_before** | **datetime**| If provided, will only return objects modified before this datetime. | [optional] **page_size** | **int**| Number of results to return per page. | [optional] diff --git a/docs/DeleteAccountApi.md b/docs/DeleteAccountApi.md new file mode 100644 index 0000000..b038de6 --- /dev/null +++ b/docs/DeleteAccountApi.md @@ -0,0 +1,82 @@ +# MergeATSClient.DeleteAccountApi + +All URIs are relative to *https://api.merge.dev/api/ats/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete_account_create**](DeleteAccountApi.md#delete_account_create) | **POST** /delete-account | + + +# **delete_account_create** +> delete_account_create(x_account_token) + + + +Delete a linked account. + +### Example + +* Api Key Authentication (tokenAuth): +```python +import time +import MergeATSClient +from MergeATSClient.api import delete_account_api +from pprint import pprint +# Defining the host is optional and defaults to https://api.merge.dev/api/ats/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = MergeATSClient.Configuration( + host = "https://api.merge.dev/api/ats/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: tokenAuth +configuration.api_key['tokenAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['tokenAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with MergeATSClient.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = delete_account_api.DeleteAccountApi(api_client) + x_account_token = "X-Account-Token_example" # str | Token identifying the end user. + + # example passing only required values which don't have defaults set + try: + api_instance.delete_account_create(x_account_token) + except MergeATSClient.ApiException as e: + print("Exception when calling DeleteAccountApi->delete_account_create: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **x_account_token** | **str**| Token identifying the end user. | + +### Return type + +void (empty response body) + +### Authorization + +[tokenAuth](../README.md#tokenAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | No response body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/InterviewsApi.md b/docs/InterviewsApi.md index dc52742..503cbed 100644 --- a/docs/InterviewsApi.md +++ b/docs/InterviewsApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description # **interviews_create** -> ScheduledInterview interviews_create(x_account_token, remote_user_id) +> ScheduledInterview interviews_create(x_account_token) @@ -48,7 +48,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = interviews_api.InterviewsApi(api_client) x_account_token = "X-Account-Token_example" # str | Token identifying the end user. - remote_user_id = "remote_user_id_example" # str | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. + remote_user_id = "remote_user_id_example" # str | The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. (optional) run_async = True # bool | Whether or not third-party updates should be run asynchronously. (optional) scheduled_interview_request = ScheduledInterviewRequest( remote_id="3", @@ -66,7 +66,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set try: - api_response = api_instance.interviews_create(x_account_token, remote_user_id) + api_response = api_instance.interviews_create(x_account_token) pprint(api_response) except MergeATSClient.ApiException as e: print("Exception when calling InterviewsApi->interviews_create: %s\n" % e) @@ -74,7 +74,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.interviews_create(x_account_token, remote_user_id, run_async=run_async, scheduled_interview_request=scheduled_interview_request) + api_response = api_instance.interviews_create(x_account_token, remote_user_id=remote_user_id, run_async=run_async, scheduled_interview_request=scheduled_interview_request) pprint(api_response) except MergeATSClient.ApiException as e: print("Exception when calling InterviewsApi->interviews_create: %s\n" % e) @@ -86,7 +86,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **x_account_token** | **str**| Token identifying the end user. | - **remote_user_id** | **str**| The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | + **remote_user_id** | **str**| The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | [optional] **run_async** | **bool**| Whether or not third-party updates should be run asynchronously. | [optional] **scheduled_interview_request** | [**ScheduledInterviewRequest**](ScheduledInterviewRequest.md)| | [optional] diff --git a/docs/Issue.md b/docs/Issue.md new file mode 100644 index 0000000..d533246 --- /dev/null +++ b/docs/Issue.md @@ -0,0 +1,17 @@ +# Issue + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error_description** | **str** | | +**id** | **str** | | [optional] [readonly] +**status** | [**IssueStatusEnum**](IssueStatusEnum.md) | | [optional] +**end_user** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] [readonly] +**first_incident_time** | **datetime, none_type** | | [optional] +**last_incident_time** | **datetime, none_type** | | [optional] +**is_muted** | **bool** | | [optional] [readonly] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IssueStatusEnum.md b/docs/IssueStatusEnum.md new file mode 100644 index 0000000..b2787bd --- /dev/null +++ b/docs/IssueStatusEnum.md @@ -0,0 +1,11 @@ +# IssueStatusEnum + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | must be one of ["ONGOING", "RESOLVED", ] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IssuesApi.md b/docs/IssuesApi.md new file mode 100644 index 0000000..d82d4a4 --- /dev/null +++ b/docs/IssuesApi.md @@ -0,0 +1,177 @@ +# MergeATSClient.IssuesApi + +All URIs are relative to *https://api.merge.dev/api/ats/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**issues_list**](IssuesApi.md#issues_list) | **GET** /issues | +[**issues_retrieve**](IssuesApi.md#issues_retrieve) | **GET** /issues/{id} | + + +# **issues_list** +> PaginatedIssueList issues_list() + + + +Gets issues. + +### Example + +* Api Key Authentication (tokenAuth): +```python +import time +import MergeATSClient +from MergeATSClient.api import issues_api +from MergeATSClient.model.paginated_issue_list import PaginatedIssueList +from pprint import pprint +# Defining the host is optional and defaults to https://api.merge.dev/api/ats/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = MergeATSClient.Configuration( + host = "https://api.merge.dev/api/ats/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: tokenAuth +configuration.api_key['tokenAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['tokenAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with MergeATSClient.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = issues_api.IssuesApi(api_client) + account_token = "account_token_example" # str | account_token (optional) + cursor = 1 # int | The pagination cursor value. (optional) + end_date = "end_date_example" # str | If included, will only include issues whose most recent action occurred before this time (optional) + end_user_organization_name = "end_user_organization_name_example" # str | end_user_organization_name (optional) + include_muted = "include_muted_example" # str | If True, will include muted issues (optional) + integration_name = "integration_name_example" # str | integration_name (optional) + page_size = 1 # int | Number of results to return per page. (optional) + start_date = "start_date_example" # str | If included, will only include issues whose most recent action occurred after this time (optional) + status = "ONGOING" # str | status (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.issues_list(account_token=account_token, cursor=cursor, end_date=end_date, end_user_organization_name=end_user_organization_name, include_muted=include_muted, integration_name=integration_name, page_size=page_size, start_date=start_date, status=status) + pprint(api_response) + except MergeATSClient.ApiException as e: + print("Exception when calling IssuesApi->issues_list: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_token** | **str**| account_token | [optional] + **cursor** | **int**| The pagination cursor value. | [optional] + **end_date** | **str**| If included, will only include issues whose most recent action occurred before this time | [optional] + **end_user_organization_name** | **str**| end_user_organization_name | [optional] + **include_muted** | **str**| If True, will include muted issues | [optional] + **integration_name** | **str**| integration_name | [optional] + **page_size** | **int**| Number of results to return per page. | [optional] + **start_date** | **str**| If included, will only include issues whose most recent action occurred after this time | [optional] + **status** | **str**| status | [optional] + +### Return type + +[**PaginatedIssueList**](PaginatedIssueList.md) + +### Authorization + +[tokenAuth](../README.md#tokenAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **issues_retrieve** +> Issue issues_retrieve(id) + + + +Get a specific issue. + +### Example + +* Api Key Authentication (tokenAuth): +```python +import time +import MergeATSClient +from MergeATSClient.api import issues_api +from MergeATSClient.model.issue import Issue +from pprint import pprint +# Defining the host is optional and defaults to https://api.merge.dev/api/ats/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = MergeATSClient.Configuration( + host = "https://api.merge.dev/api/ats/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: tokenAuth +configuration.api_key['tokenAuth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['tokenAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with MergeATSClient.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = issues_api.IssuesApi(api_client) + id = "id_example" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.issues_retrieve(id) + pprint(api_response) + except MergeATSClient.ApiException as e: + print("Exception when calling IssuesApi->issues_retrieve: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +[**Issue**](Issue.md) + +### Authorization + +[tokenAuth](../README.md#tokenAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/Job.md b/docs/Job.md index 949e2d5..d6b8000 100644 --- a/docs/Job.md +++ b/docs/Job.md @@ -13,9 +13,9 @@ Name | Type | Description | Notes **remote_created_at** | **datetime, none_type** | When the third party's job was created. | [optional] **remote_updated_at** | **datetime, none_type** | When the third party's job was updated. | [optional] **confidential** | **bool, none_type** | Whether the job is confidential. | [optional] -**departments** | **[str]** | | [optional] -**offices** | **[str]** | | [optional] -**hiring_managers** | **[str]** | | [optional] +**departments** | **[str]** | IDs of `Department` objects for this `Job`. | [optional] +**offices** | **[str]** | IDs of `Office` objects for this `Job`. | [optional] +**hiring_managers** | **[str]** | IDs of `RemoteUser` objects that serve as hiring managers for this `Job`. | [optional] **remote_data** | [**[RemoteData], none_type**](RemoteData.md) | | [optional] [readonly] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PaginatedIssueList.md b/docs/PaginatedIssueList.md new file mode 100644 index 0000000..a00734a --- /dev/null +++ b/docs/PaginatedIssueList.md @@ -0,0 +1,13 @@ +# PaginatedIssueList + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next** | **str, none_type** | | [optional] +**previous** | **str, none_type** | | [optional] +**results** | [**[Issue]**](Issue.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScheduledInterview.md b/docs/ScheduledInterview.md index fec0c2c..273c7d1 100644 --- a/docs/ScheduledInterview.md +++ b/docs/ScheduledInterview.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **application** | **str, none_type** | The application being interviewed. | [optional] **job_interview_stage** | **str, none_type** | The stage of the interview. | [optional] **organizer** | **str, none_type** | The user organizing the interview. | [optional] -**interviewers** | **[str]** | | [optional] +**interviewers** | **[str]** | Array of `RemoteUser` IDs. | [optional] **location** | **str, none_type** | The interview's location. | [optional] **start_at** | **datetime, none_type** | When the interview was started. | [optional] **end_at** | **datetime, none_type** | When the interview was ended. | [optional] diff --git a/docs/ScheduledInterviewRequest.md b/docs/ScheduledInterviewRequest.md index 571dc03..f866d67 100644 --- a/docs/ScheduledInterviewRequest.md +++ b/docs/ScheduledInterviewRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **application** | **str, none_type** | The application being interviewed. | [optional] **job_interview_stage** | **str, none_type** | The stage of the interview. | [optional] **organizer** | **str, none_type** | The user organizing the interview. | [optional] -**interviewers** | **[str]** | | [optional] +**interviewers** | **[str]** | Array of `RemoteUser` IDs. | [optional] **location** | **str, none_type** | The interview's location. | [optional] **start_at** | **datetime, none_type** | When the interview was started. | [optional] **end_at** | **datetime, none_type** | When the interview was ended. | [optional] diff --git a/docs/ScorecardsApi.md b/docs/ScorecardsApi.md index 9412ba0..3ac0355 100644 --- a/docs/ScorecardsApi.md +++ b/docs/ScorecardsApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description # **scorecards_create** -> Scorecard scorecards_create(x_account_token, remote_user_id) +> Scorecard scorecards_create(x_account_token) @@ -48,7 +48,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = scorecards_api.ScorecardsApi(api_client) x_account_token = "X-Account-Token_example" # str | Token identifying the end user. - remote_user_id = "remote_user_id_example" # str | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. + remote_user_id = "remote_user_id_example" # str | The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. (optional) run_async = True # bool | Whether or not third-party updates should be run asynchronously. (optional) scorecard_request = ScorecardRequest( remote_id="22234", @@ -62,7 +62,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set try: - api_response = api_instance.scorecards_create(x_account_token, remote_user_id) + api_response = api_instance.scorecards_create(x_account_token) pprint(api_response) except MergeATSClient.ApiException as e: print("Exception when calling ScorecardsApi->scorecards_create: %s\n" % e) @@ -70,7 +70,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.scorecards_create(x_account_token, remote_user_id, run_async=run_async, scorecard_request=scorecard_request) + api_response = api_instance.scorecards_create(x_account_token, remote_user_id=remote_user_id, run_async=run_async, scorecard_request=scorecard_request) pprint(api_response) except MergeATSClient.ApiException as e: print("Exception when calling ScorecardsApi->scorecards_create: %s\n" % e) @@ -82,7 +82,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **x_account_token** | **str**| Token identifying the end user. | - **remote_user_id** | **str**| The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | + **remote_user_id** | **str**| The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | [optional] **run_async** | **bool**| Whether or not third-party updates should be run asynchronously. | [optional] **scorecard_request** | [**ScorecardRequest**](ScorecardRequest.md)| | [optional] diff --git a/docs/UsersApi.md b/docs/UsersApi.md index c01accb..b312e87 100644 --- a/docs/UsersApi.md +++ b/docs/UsersApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description # **users_create** -> RemoteUser users_create(x_account_token, remote_user_id) +> RemoteUser users_create(x_account_token) @@ -48,7 +48,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = users_api.UsersApi(api_client) x_account_token = "X-Account-Token_example" # str | Token identifying the end user. - remote_user_id = "remote_user_id_example" # str | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. + remote_user_id = "remote_user_id_example" # str | The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. (optional) run_async = True # bool | Whether or not third-party updates should be run asynchronously. (optional) remote_user_request = RemoteUserRequest( remote_id="344321", @@ -62,7 +62,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set try: - api_response = api_instance.users_create(x_account_token, remote_user_id) + api_response = api_instance.users_create(x_account_token) pprint(api_response) except MergeATSClient.ApiException as e: print("Exception when calling UsersApi->users_create: %s\n" % e) @@ -70,7 +70,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: # example passing only required values which don't have defaults set # and optional values try: - api_response = api_instance.users_create(x_account_token, remote_user_id, run_async=run_async, remote_user_request=remote_user_request) + api_response = api_instance.users_create(x_account_token, remote_user_id=remote_user_id, run_async=run_async, remote_user_request=remote_user_request) pprint(api_response) except MergeATSClient.ApiException as e: print("Exception when calling UsersApi->users_create: %s\n" % e) @@ -82,7 +82,7 @@ with MergeATSClient.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **x_account_token** | **str**| Token identifying the end user. | - **remote_user_id** | **str**| The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | + **remote_user_id** | **str**| The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | [optional] **run_async** | **bool**| Whether or not third-party updates should be run asynchronously. | [optional] **remote_user_request** | [**RemoteUserRequest**](RemoteUserRequest.md)| | [optional] diff --git a/setup.py b/setup.py index 173a1f6..cdeb07c 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "MergeATSClient" -VERSION = "1.0.2" +VERSION = "1.0.3" # To install the library, run the following # # python setup.py install diff --git a/test/test_delete_account_api.py b/test/test_delete_account_api.py new file mode 100644 index 0000000..97f6202 --- /dev/null +++ b/test/test_delete_account_api.py @@ -0,0 +1,35 @@ +""" + Merge ATS API + + The unified API for building rich integrations with multiple Applicant Tracking System platforms. # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: hello@merge.dev + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import MergeATSClient +from MergeATSClient.api.delete_account_api import DeleteAccountApi # noqa: E501 + + +class TestDeleteAccountApi(unittest.TestCase): + """DeleteAccountApi unit test stubs""" + + def setUp(self): + self.api = DeleteAccountApi() # noqa: E501 + + def tearDown(self): + pass + + def test_delete_account_create(self): + """Test case for delete_account_create + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_issue.py b/test/test_issue.py new file mode 100644 index 0000000..14a56d5 --- /dev/null +++ b/test/test_issue.py @@ -0,0 +1,38 @@ +""" + Merge ATS API + + The unified API for building rich integrations with multiple Applicant Tracking System platforms. # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: hello@merge.dev + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import MergeATSClient +from MergeATSClient.model.issue_status_enum import IssueStatusEnum +globals()['IssueStatusEnum'] = IssueStatusEnum +from MergeATSClient.model.issue import Issue + + +class TestIssue(unittest.TestCase): + """Issue unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testIssue(self): + """Test Issue""" + # FIXME: construct object with mandatory attributes with example values + # model = Issue() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_issue_status_enum.py b/test/test_issue_status_enum.py new file mode 100644 index 0000000..b2d7976 --- /dev/null +++ b/test/test_issue_status_enum.py @@ -0,0 +1,36 @@ +""" + Merge ATS API + + The unified API for building rich integrations with multiple Applicant Tracking System platforms. # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: hello@merge.dev + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import MergeATSClient +from MergeATSClient.model.issue_status_enum import IssueStatusEnum + + +class TestIssueStatusEnum(unittest.TestCase): + """IssueStatusEnum unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testIssueStatusEnum(self): + """Test IssueStatusEnum""" + # FIXME: construct object with mandatory attributes with example values + # model = IssueStatusEnum() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_issues_api.py b/test/test_issues_api.py new file mode 100644 index 0000000..154cd32 --- /dev/null +++ b/test/test_issues_api.py @@ -0,0 +1,35 @@ +""" + Merge ATS API + + The unified API for building rich integrations with multiple Applicant Tracking System platforms. # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: hello@merge.dev + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import MergeATSClient +from MergeATSClient.api.issues_api import IssuesApi # noqa: E501 + + +class TestIssuesApi(unittest.TestCase): + """IssuesApi unit test stubs""" + + def setUp(self): + self.api = IssuesApi() # noqa: E501 + + def tearDown(self): + pass + + def test_issues_list(self): + """Test case for issues_list + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paginated_issue_list.py b/test/test_paginated_issue_list.py new file mode 100644 index 0000000..d6d4de5 --- /dev/null +++ b/test/test_paginated_issue_list.py @@ -0,0 +1,38 @@ +""" + Merge ATS API + + The unified API for building rich integrations with multiple Applicant Tracking System platforms. # noqa: E501 + + The version of the OpenAPI document: 1.0 + Contact: hello@merge.dev + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import MergeATSClient +from MergeATSClient.model.issue import Issue +globals()['Issue'] = Issue +from MergeATSClient.model.paginated_issue_list import PaginatedIssueList + + +class TestPaginatedIssueList(unittest.TestCase): + """PaginatedIssueList unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPaginatedIssueList(self): + """Test PaginatedIssueList""" + # FIXME: construct object with mandatory attributes with example values + # model = PaginatedIssueList() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main()