merge_ats_client 1.0.4 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +37 -17
- data/docs/AccountDetails.md +11 -7
- data/docs/AccountDetailsAndActions.md +4 -0
- data/docs/AccountDetailsAndActionsIntegration.md +1 -1
- data/docs/AccountDetailsApi.md +10 -7
- data/docs/AccountIntegration.md +4 -4
- data/docs/AccountTokenApi.md +2 -2
- data/docs/ActivitiesApi.md +6 -4
- data/docs/Activity.md +4 -2
- data/docs/Application.md +8 -6
- data/docs/ApplicationEndpointRequest.md +20 -0
- data/docs/ApplicationRequest.md +12 -6
- data/docs/ApplicationResponse.md +24 -0
- data/docs/ApplicationsApi.md +98 -18
- data/docs/Attachment.md +3 -1
- data/docs/AttachmentEndpointRequest.md +20 -0
- data/docs/AttachmentRequest.md +5 -1
- data/docs/AttachmentResponse.md +24 -0
- data/docs/AttachmentsApi.md +93 -15
- data/docs/AvailableActionsApi.md +2 -2
- data/docs/Candidate.md +3 -1
- data/docs/CandidateEndpointRequest.md +20 -0
- data/docs/CandidateRequest.md +7 -1
- data/docs/CandidateResponse.md +24 -0
- data/docs/CandidatesApi.md +168 -22
- data/docs/DataPassthroughRequest.md +3 -1
- data/docs/DebugModeLog.md +22 -0
- data/docs/DebugModelLogSummary.md +22 -0
- data/docs/Department.md +3 -1
- data/docs/DepartmentsApi.md +6 -4
- data/docs/EEOC.md +4 -2
- data/docs/EeocsApi.md +6 -4
- data/docs/EncodingEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +5 -3
- data/docs/ErrorValidationProblem.md +24 -0
- data/docs/ForceResyncApi.md +79 -0
- data/docs/GenerateKeyApi.md +2 -2
- data/docs/IgnoreCommonModel.md +20 -0
- data/docs/IgnoreCommonModelRequest.md +20 -0
- data/docs/InterviewsApi.md +6 -84
- data/docs/IssuesApi.md +18 -10
- data/docs/Job.md +5 -1
- data/docs/JobInterviewStage.md +4 -2
- data/docs/JobInterviewStagesApi.md +8 -6
- data/docs/JobsApi.md +8 -5
- data/docs/LinkTokenApi.md +3 -3
- data/docs/LinkedAccountStatus.md +20 -0
- data/docs/LinkedAccountsApi.md +22 -22
- data/docs/MetaResponse.md +24 -0
- data/docs/MultipartFormFieldRequest.md +26 -0
- data/docs/Offer.md +5 -3
- data/docs/OffersApi.md +6 -4
- data/docs/Office.md +3 -1
- data/docs/OfficesApi.md +6 -4
- data/docs/PassthroughApi.md +2 -2
- data/docs/ReasonEnum.md +15 -0
- data/docs/RegenerateKeyApi.md +2 -2
- data/docs/RejectReason.md +3 -1
- data/docs/RejectReasonsApi.md +6 -4
- data/docs/RemoteUser.md +3 -1
- data/docs/ScheduledInterview.md +6 -4
- data/docs/Scorecard.md +6 -4
- data/docs/ScorecardsApi.md +6 -84
- data/docs/SyncStatusApi.md +3 -75
- data/docs/Tag.md +3 -1
- data/docs/TagsApi.md +4 -2
- data/docs/UsersApi.md +6 -84
- data/docs/ValidationProblemSource.md +18 -0
- data/docs/WarningValidationProblem.md +24 -0
- data/docs/WebhookReceiver.md +22 -0
- data/docs/WebhookReceiverRequest.md +22 -0
- data/docs/WebhookReceiversApi.md +153 -0
- data/lib/merge_ats_client/api/account_details_api.rb +10 -3
- data/lib/merge_ats_client/api/activities_api.rb +3 -0
- data/lib/merge_ats_client/api/applications_api.rb +86 -15
- data/lib/merge_ats_client/api/attachments_api.rb +94 -15
- data/lib/merge_ats_client/api/candidates_api.rb +156 -21
- data/lib/merge_ats_client/api/departments_api.rb +3 -0
- data/lib/merge_ats_client/api/eeocs_api.rb +3 -0
- data/lib/merge_ats_client/api/force_resync_api.rb +84 -0
- data/lib/merge_ats_client/api/interviews_api.rb +3 -76
- data/lib/merge_ats_client/api/issues_api.rb +22 -10
- data/lib/merge_ats_client/api/job_interview_stages_api.rb +5 -2
- data/lib/merge_ats_client/api/jobs_api.rb +6 -3
- data/lib/merge_ats_client/api/linked_accounts_api.rb +21 -21
- data/lib/merge_ats_client/api/offers_api.rb +3 -0
- data/lib/merge_ats_client/api/offices_api.rb +3 -0
- data/lib/merge_ats_client/api/reject_reasons_api.rb +3 -0
- data/lib/merge_ats_client/api/scorecards_api.rb +3 -76
- data/lib/merge_ats_client/api/sync_status_api.rb +4 -66
- data/lib/merge_ats_client/api/tags_api.rb +3 -0
- data/lib/merge_ats_client/api/users_api.rb +3 -76
- data/lib/merge_ats_client/api/webhook_receivers_api.rb +154 -0
- data/lib/merge_ats_client/configuration.rb +6 -4
- data/lib/merge_ats_client/models/account_details.rb +22 -4
- data/lib/merge_ats_client/models/account_details_and_actions.rb +24 -1
- data/lib/merge_ats_client/models/account_details_and_actions_integration.rb +4 -2
- data/lib/merge_ats_client/models/account_integration.rb +2 -24
- data/lib/merge_ats_client/models/account_token.rb +1 -1
- data/lib/merge_ats_client/models/activity.rb +16 -7
- data/lib/merge_ats_client/models/application.rb +15 -11
- data/lib/merge_ats_client/models/application_endpoint_request.rb +237 -0
- data/lib/merge_ats_client/models/application_request.rb +56 -12
- data/lib/merge_ats_client/models/application_response.rb +266 -0
- data/lib/merge_ats_client/models/attachment.rb +15 -6
- data/lib/merge_ats_client/models/attachment_endpoint_request.rb +237 -0
- data/lib/merge_ats_client/models/attachment_request.rb +31 -7
- data/lib/merge_ats_client/models/attachment_response.rb +266 -0
- data/lib/merge_ats_client/models/attachment_type_enum.rb +0 -2
- data/lib/merge_ats_client/models/available_actions.rb +1 -1
- data/lib/merge_ats_client/models/candidate.rb +15 -6
- data/lib/merge_ats_client/models/candidate_endpoint_request.rb +237 -0
- data/lib/merge_ats_client/models/candidate_request.rb +56 -7
- data/lib/merge_ats_client/models/candidate_response.rb +266 -0
- data/lib/merge_ats_client/models/categories_enum.rb +2 -0
- data/lib/merge_ats_client/models/category_enum.rb +2 -0
- data/lib/merge_ats_client/models/data_passthrough_request.rb +67 -4
- data/lib/merge_ats_client/models/debug_mode_log.rb +251 -0
- data/lib/merge_ats_client/models/{data_passthrough.rb → debug_model_log_summary.rb} +30 -41
- data/lib/merge_ats_client/models/department.rb +17 -7
- data/lib/merge_ats_client/models/eeoc.rb +16 -7
- data/lib/merge_ats_client/models/email_address.rb +2 -2
- data/lib/merge_ats_client/models/email_address_request.rb +2 -2
- data/lib/merge_ats_client/models/encoding_enum.rb +35 -0
- data/lib/merge_ats_client/models/end_user_details_request.rb +147 -28
- data/lib/merge_ats_client/models/error_validation_problem.rb +260 -0
- data/lib/merge_ats_client/models/generate_remote_key_request.rb +20 -1
- data/lib/merge_ats_client/models/{remote_user_request.rb → ignore_common_model.rb} +30 -85
- data/lib/merge_ats_client/models/ignore_common_model_request.rb +256 -0
- data/lib/merge_ats_client/models/issue.rb +1 -1
- data/lib/merge_ats_client/models/job.rb +28 -6
- data/lib/merge_ats_client/models/job_interview_stage.rb +16 -7
- data/lib/merge_ats_client/models/link_token.rb +1 -1
- data/lib/merge_ats_client/models/linked_account_status.rb +237 -0
- data/lib/merge_ats_client/models/{scorecard_request.rb → meta_response.rb} +45 -70
- data/lib/merge_ats_client/models/model_operation.rb +1 -1
- data/lib/merge_ats_client/models/{scheduled_interview_request.rb → multipart_form_field_request.rb} +115 -106
- data/lib/merge_ats_client/models/offer.rb +16 -8
- data/lib/merge_ats_client/models/office.rb +17 -7
- data/lib/merge_ats_client/models/paginated_activity_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_application_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_attachment_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_candidate_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_department_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_eeoc_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_issue_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_job_interview_stage_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_job_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_offer_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_office_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_reject_reason_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_remote_user_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_scheduled_interview_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_scorecard_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_sync_status_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_tag_list.rb +1 -1
- data/lib/merge_ats_client/models/phone_number.rb +2 -2
- data/lib/merge_ats_client/models/phone_number_request.rb +2 -2
- data/lib/merge_ats_client/models/reason_enum.rb +36 -0
- data/lib/merge_ats_client/models/reject_reason.rb +17 -7
- data/lib/merge_ats_client/models/remote_data.rb +1 -1
- data/lib/merge_ats_client/models/remote_data_request.rb +20 -1
- data/lib/merge_ats_client/models/remote_key.rb +1 -1
- data/lib/merge_ats_client/models/remote_key_for_regeneration_request.rb +20 -1
- data/lib/merge_ats_client/models/remote_response.rb +1 -1
- data/lib/merge_ats_client/models/remote_user.rb +17 -7
- data/lib/merge_ats_client/models/request_format_enum.rb +1 -0
- data/lib/merge_ats_client/models/scheduled_interview.rb +16 -9
- data/lib/merge_ats_client/models/scorecard.rb +16 -9
- data/lib/merge_ats_client/models/sync_status.rb +1 -1
- data/lib/merge_ats_client/models/sync_status_status_enum.rb +1 -2
- data/lib/merge_ats_client/models/tag.rb +17 -7
- data/lib/merge_ats_client/models/url.rb +2 -2
- data/lib/merge_ats_client/models/url_request.rb +2 -2
- data/lib/merge_ats_client/models/{remote_key_for_regeneration.rb → validation_problem_source.rb} +15 -16
- data/lib/merge_ats_client/models/warning_validation_problem.rb +260 -0
- data/lib/merge_ats_client/models/webhook_receiver.rb +246 -0
- data/lib/merge_ats_client/models/{end_user_details.rb → webhook_receiver_request.rb} +60 -69
- data/lib/merge_ats_client/version.rb +1 -1
- data/lib/merge_ats_client.rb +22 -3
- data/spec/api/account_details_api_spec.rb +1 -0
- data/spec/api/account_token_api_spec.rb +1 -1
- data/spec/api/activities_api_spec.rb +4 -1
- data/spec/api/applications_api_spec.rb +31 -1
- data/spec/api/attachments_api_spec.rb +31 -1
- data/spec/api/available_actions_api_spec.rb +1 -1
- data/spec/api/candidates_api_spec.rb +44 -1
- data/spec/api/departments_api_spec.rb +4 -1
- data/spec/api/eeocs_api_spec.rb +4 -1
- data/spec/api/force_resync_api_spec.rb +46 -0
- data/spec/api/interviews_api_spec.rb +4 -1
- data/spec/api/issues_api_spec.rb +9 -5
- data/spec/api/job_interview_stages_api_spec.rb +4 -1
- data/spec/api/jobs_api_spec.rb +6 -1
- data/spec/api/link_token_api_spec.rb +2 -2
- data/spec/api/linked_accounts_api_spec.rb +10 -10
- data/spec/api/offers_api_spec.rb +4 -1
- data/spec/api/offices_api_spec.rb +4 -1
- data/spec/api/passthrough_api_spec.rb +2 -2
- data/spec/api/regenerate_key_api_spec.rb +3 -5
- data/spec/api/reject_reasons_api_spec.rb +4 -1
- data/spec/api/scorecards_api_spec.rb +4 -1
- data/spec/api/sync_status_api_spec.rb +8 -5
- data/spec/api/tags_api_spec.rb +3 -1
- data/spec/api/users_api_spec.rb +5 -1
- data/spec/api/webhook_receivers_api_spec.rb +58 -0
- data/spec/models/access_role_enum_spec.rb +1 -1
- data/spec/models/account_details_and_actions_spec.rb +12 -0
- data/spec/models/account_details_spec.rb +12 -0
- data/spec/models/account_integration_spec.rb +7 -1
- data/spec/models/account_token_spec.rb +7 -1
- data/spec/models/activity_spec.rb +13 -1
- data/spec/models/activity_type_enum_spec.rb +1 -1
- data/spec/models/application_endpoint_request_spec.rb +40 -0
- data/spec/models/application_request_spec.rb +25 -1
- data/spec/models/{end_user_details_spec.rb → application_response_spec.rb} +11 -15
- data/spec/models/application_spec.rb +19 -7
- data/spec/models/attachment_endpoint_request_spec.rb +40 -0
- data/spec/models/attachment_request_spec.rb +12 -0
- data/spec/models/attachment_response_spec.rb +52 -0
- data/spec/models/attachment_spec.rb +25 -1
- data/spec/models/available_actions_spec.rb +1 -1
- data/spec/models/candidate_endpoint_request_spec.rb +40 -0
- data/spec/models/candidate_request_spec.rb +37 -1
- data/spec/models/{data_passthrough_spec.rb → candidate_response_spec.rb} +11 -11
- data/spec/models/candidate_spec.rb +19 -1
- data/spec/models/data_passthrough_request_spec.rb +13 -1
- data/spec/models/debug_mode_log_spec.rb +46 -0
- data/spec/models/debug_model_log_summary_spec.rb +46 -0
- data/spec/models/department_spec.rb +13 -1
- data/spec/models/disability_status_enum_spec.rb +1 -1
- data/spec/models/eeoc_spec.rb +13 -1
- data/spec/models/email_address_request_spec.rb +1 -1
- data/spec/models/email_address_spec.rb +1 -1
- data/spec/models/email_address_type_enum_spec.rb +1 -1
- data/spec/models/encoding_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +13 -5
- data/spec/models/error_validation_problem_spec.rb +52 -0
- data/spec/models/gender_enum_spec.rb +1 -1
- data/spec/models/ignore_common_model_request_spec.rb +40 -0
- data/spec/models/ignore_common_model_spec.rb +40 -0
- data/spec/models/job_interview_stage_spec.rb +13 -1
- data/spec/models/job_spec.rb +31 -1
- data/spec/models/job_status_enum_spec.rb +1 -1
- data/spec/models/link_token_spec.rb +1 -1
- data/spec/models/linked_account_status_spec.rb +40 -0
- data/spec/models/meta_response_spec.rb +52 -0
- data/spec/models/method_enum_spec.rb +1 -1
- data/spec/models/model_operation_spec.rb +13 -1
- data/spec/models/{remote_user_request_spec.rb → multipart_form_field_request_spec.rb} +11 -23
- data/spec/models/offer_spec.rb +13 -1
- data/spec/models/offer_status_enum_spec.rb +1 -1
- data/spec/models/office_spec.rb +13 -1
- data/spec/models/overall_recommendation_enum_spec.rb +1 -1
- data/spec/models/paginated_activity_list_spec.rb +1 -1
- data/spec/models/paginated_application_list_spec.rb +1 -1
- data/spec/models/paginated_attachment_list_spec.rb +1 -1
- data/spec/models/paginated_candidate_list_spec.rb +1 -1
- data/spec/models/paginated_department_list_spec.rb +1 -1
- data/spec/models/paginated_eeoc_list_spec.rb +1 -1
- data/spec/models/paginated_job_interview_stage_list_spec.rb +1 -1
- data/spec/models/paginated_job_list_spec.rb +1 -1
- data/spec/models/paginated_offer_list_spec.rb +1 -1
- data/spec/models/paginated_office_list_spec.rb +1 -1
- data/spec/models/paginated_reject_reason_list_spec.rb +1 -1
- data/spec/models/paginated_remote_user_list_spec.rb +1 -1
- data/spec/models/paginated_scheduled_interview_list_spec.rb +1 -1
- data/spec/models/paginated_scorecard_list_spec.rb +1 -1
- data/spec/models/paginated_tag_list_spec.rb +1 -1
- data/spec/models/phone_number_request_spec.rb +1 -1
- data/spec/models/phone_number_spec.rb +1 -1
- data/spec/models/phone_number_type_enum_spec.rb +1 -1
- data/spec/models/race_enum_spec.rb +1 -1
- data/spec/models/reason_enum_spec.rb +28 -0
- data/spec/models/reject_reason_spec.rb +13 -1
- data/spec/models/remote_data_spec.rb +1 -1
- data/spec/models/remote_key_for_regeneration_request_spec.rb +1 -1
- data/spec/models/remote_key_spec.rb +1 -1
- data/spec/models/remote_response_spec.rb +1 -1
- data/spec/models/remote_user_spec.rb +13 -1
- data/spec/models/scheduled_interview_spec.rb +13 -1
- data/spec/models/scheduled_interview_status_enum_spec.rb +1 -1
- data/spec/models/scorecard_spec.rb +13 -1
- data/spec/models/sync_status_spec.rb +1 -1
- data/spec/models/tag_spec.rb +13 -1
- data/spec/models/url_request_spec.rb +1 -1
- data/spec/models/url_spec.rb +1 -1
- data/spec/models/url_type_enum_spec.rb +1 -1
- data/spec/models/{remote_key_for_regeneration_spec.rb → validation_problem_source_spec.rb} +8 -8
- data/spec/models/veteran_status_enum_spec.rb +1 -1
- data/spec/models/visibility_enum_spec.rb +1 -1
- data/spec/models/warning_validation_problem_spec.rb +52 -0
- data/spec/models/webhook_receiver_request_spec.rb +46 -0
- data/spec/models/webhook_receiver_spec.rb +46 -0
- metadata +179 -123
- data/config.json +0 -2
- data/docs/DataPassthrough.md +0 -24
- data/docs/EndUserDetails.md +0 -24
- data/docs/PatchedApplicationRequest.md +0 -34
- data/docs/RemoteKeyForRegeneration.md +0 -18
- data/docs/RemoteUserRequest.md +0 -30
- data/docs/ScheduledInterviewRequest.md +0 -38
- data/docs/ScorecardRequest.md +0 -30
- data/lib/merge_ats_client/models/patched_application_request.rb +0 -309
- data/merge_ats_client-1.0.3.gem +0 -0
- data/spec/models/patched_application_request_spec.rb +0 -82
- data/spec/models/scheduled_interview_request_spec.rb +0 -94
- data/spec/models/scorecard_request_spec.rb +0 -70
- data/test_ats.rb +0 -22
- data/test_signature.rb +0 -32
data/docs/CandidatesApi.md
CHANGED
@@ -5,13 +5,15 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**candidates_create**](CandidatesApi.md#candidates_create) | **POST** /candidates | |
|
8
|
+
| [**candidates_ignore_create**](CandidatesApi.md#candidates_ignore_create) | **POST** /candidates/ignore/{model_id} | |
|
8
9
|
| [**candidates_list**](CandidatesApi.md#candidates_list) | **GET** /candidates | |
|
10
|
+
| [**candidates_meta_post_retrieve**](CandidatesApi.md#candidates_meta_post_retrieve) | **GET** /candidates/meta/post | |
|
9
11
|
| [**candidates_retrieve**](CandidatesApi.md#candidates_retrieve) | **GET** /candidates/{id} | |
|
10
12
|
|
11
13
|
|
12
14
|
## candidates_create
|
13
15
|
|
14
|
-
> <
|
16
|
+
> <CandidateResponse> candidates_create(x_account_token, candidate_endpoint_request, opts)
|
15
17
|
|
16
18
|
|
17
19
|
|
@@ -25,22 +27,22 @@ require 'merge_ats_client'
|
|
25
27
|
# setup authorization
|
26
28
|
MergeATSClient.configure do |config|
|
27
29
|
# Configure API key authorization: tokenAuth
|
28
|
-
config.api_key['
|
30
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
29
31
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
|
-
# config.api_key_prefix['
|
32
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
31
33
|
end
|
32
34
|
|
33
35
|
api_instance = MergeATSClient::CandidatesApi.new
|
34
36
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
35
|
-
|
37
|
+
candidate_endpoint_request = MergeATSClient::CandidateEndpointRequest.new({model: MergeATSClient::CandidateRequest.new, remote_user_id: 'remote_user_id_example'}) # CandidateEndpointRequest |
|
36
38
|
opts = {
|
37
|
-
|
38
|
-
|
39
|
+
is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
|
40
|
+
run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
|
39
41
|
}
|
40
42
|
|
41
43
|
begin
|
42
44
|
|
43
|
-
result = api_instance.candidates_create(x_account_token,
|
45
|
+
result = api_instance.candidates_create(x_account_token, candidate_endpoint_request, opts)
|
44
46
|
p result
|
45
47
|
rescue MergeATSClient::ApiError => e
|
46
48
|
puts "Error when calling CandidatesApi->candidates_create: #{e}"
|
@@ -51,15 +53,15 @@ end
|
|
51
53
|
|
52
54
|
This returns an Array which contains the response data, status code and headers.
|
53
55
|
|
54
|
-
> <Array(<
|
56
|
+
> <Array(<CandidateResponse>, Integer, Hash)> candidates_create_with_http_info(x_account_token, candidate_endpoint_request, opts)
|
55
57
|
|
56
58
|
```ruby
|
57
59
|
begin
|
58
60
|
|
59
|
-
data, status_code, headers = api_instance.candidates_create_with_http_info(x_account_token,
|
61
|
+
data, status_code, headers = api_instance.candidates_create_with_http_info(x_account_token, candidate_endpoint_request, opts)
|
60
62
|
p status_code # => 2xx
|
61
63
|
p headers # => { ... }
|
62
|
-
p data # => <
|
64
|
+
p data # => <CandidateResponse>
|
63
65
|
rescue MergeATSClient::ApiError => e
|
64
66
|
puts "Error when calling CandidatesApi->candidates_create_with_http_info: #{e}"
|
65
67
|
end
|
@@ -70,13 +72,88 @@ end
|
|
70
72
|
| Name | Type | Description | Notes |
|
71
73
|
| ---- | ---- | ----------- | ----- |
|
72
74
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
73
|
-
| **
|
75
|
+
| **candidate_endpoint_request** | [**CandidateEndpointRequest**](CandidateEndpointRequest.md) | | |
|
76
|
+
| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
|
74
77
|
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
75
|
-
| **candidate_request** | [**CandidateRequest**](CandidateRequest.md) | | [optional] |
|
76
78
|
|
77
79
|
### Return type
|
78
80
|
|
79
|
-
[**
|
81
|
+
[**CandidateResponse**](CandidateResponse.md)
|
82
|
+
|
83
|
+
### Authorization
|
84
|
+
|
85
|
+
[tokenAuth](../README.md#tokenAuth)
|
86
|
+
|
87
|
+
### HTTP request headers
|
88
|
+
|
89
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
90
|
+
- **Accept**: application/json
|
91
|
+
|
92
|
+
|
93
|
+
## candidates_ignore_create
|
94
|
+
|
95
|
+
> <IgnoreCommonModel> candidates_ignore_create(x_account_token, model_id, ignore_common_model_request)
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The \"reason\" and \"message\" fields in the request body will be stored for audit purposes.
|
100
|
+
|
101
|
+
### Examples
|
102
|
+
|
103
|
+
```ruby
|
104
|
+
require 'time'
|
105
|
+
require 'merge_ats_client'
|
106
|
+
# setup authorization
|
107
|
+
MergeATSClient.configure do |config|
|
108
|
+
# Configure API key authorization: tokenAuth
|
109
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
110
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
111
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
112
|
+
end
|
113
|
+
|
114
|
+
api_instance = MergeATSClient::CandidatesApi.new
|
115
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
116
|
+
model_id = TODO # String |
|
117
|
+
ignore_common_model_request = MergeATSClient::IgnoreCommonModelRequest.new({reason: MergeATSClient::ReasonEnum::GENERAL_CUSTOMER_REQUEST}) # IgnoreCommonModelRequest |
|
118
|
+
|
119
|
+
begin
|
120
|
+
|
121
|
+
result = api_instance.candidates_ignore_create(x_account_token, model_id, ignore_common_model_request)
|
122
|
+
p result
|
123
|
+
rescue MergeATSClient::ApiError => e
|
124
|
+
puts "Error when calling CandidatesApi->candidates_ignore_create: #{e}"
|
125
|
+
end
|
126
|
+
```
|
127
|
+
|
128
|
+
#### Using the candidates_ignore_create_with_http_info variant
|
129
|
+
|
130
|
+
This returns an Array which contains the response data, status code and headers.
|
131
|
+
|
132
|
+
> <Array(<IgnoreCommonModel>, Integer, Hash)> candidates_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
|
133
|
+
|
134
|
+
```ruby
|
135
|
+
begin
|
136
|
+
|
137
|
+
data, status_code, headers = api_instance.candidates_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
|
138
|
+
p status_code # => 2xx
|
139
|
+
p headers # => { ... }
|
140
|
+
p data # => <IgnoreCommonModel>
|
141
|
+
rescue MergeATSClient::ApiError => e
|
142
|
+
puts "Error when calling CandidatesApi->candidates_ignore_create_with_http_info: #{e}"
|
143
|
+
end
|
144
|
+
```
|
145
|
+
|
146
|
+
### Parameters
|
147
|
+
|
148
|
+
| Name | Type | Description | Notes |
|
149
|
+
| ---- | ---- | ----------- | ----- |
|
150
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
151
|
+
| **model_id** | [**String**](.md) | | |
|
152
|
+
| **ignore_common_model_request** | [**IgnoreCommonModelRequest**](IgnoreCommonModelRequest.md) | | |
|
153
|
+
|
154
|
+
### Return type
|
155
|
+
|
156
|
+
[**IgnoreCommonModel**](IgnoreCommonModel.md)
|
80
157
|
|
81
158
|
### Authorization
|
82
159
|
|
@@ -104,9 +181,9 @@ require 'merge_ats_client'
|
|
104
181
|
# setup authorization
|
105
182
|
MergeATSClient.configure do |config|
|
106
183
|
# Configure API key authorization: tokenAuth
|
107
|
-
config.api_key['
|
184
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
108
185
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
109
|
-
# config.api_key_prefix['
|
186
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
110
187
|
end
|
111
188
|
|
112
189
|
api_instance = MergeATSClient::CandidatesApi.new
|
@@ -115,16 +192,15 @@ opts = {
|
|
115
192
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
116
193
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
117
194
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
118
|
-
email_address: 'email_address_example', # String | If provided, will only return candidates with this email_address.
|
119
195
|
expand: 'applications', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
120
196
|
first_name: 'first_name_example', # String | If provided, will only return candidates with this first name.
|
197
|
+
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
121
198
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
122
199
|
last_name: 'last_name_example', # String | If provided, will only return candidates with this last name.
|
123
200
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
124
201
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
125
202
|
page_size: 56, # Integer | Number of results to return per page.
|
126
|
-
remote_id: 'remote_id_example'
|
127
|
-
tag: 'tag_example' # String | If provided, will only return candidates with this tag.
|
203
|
+
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
128
204
|
}
|
129
205
|
|
130
206
|
begin
|
@@ -162,16 +238,15 @@ end
|
|
162
238
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
163
239
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
164
240
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
165
|
-
| **email_address** | **String** | If provided, will only return candidates with this email_address. | [optional] |
|
166
241
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
167
242
|
| **first_name** | **String** | If provided, will only return candidates with this first name. | [optional] |
|
243
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
168
244
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
169
245
|
| **last_name** | **String** | If provided, will only return candidates with this last name. | [optional] |
|
170
246
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
171
247
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
172
248
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
173
249
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
174
|
-
| **tag** | **String** | If provided, will only return candidates with this tag. | [optional] |
|
175
250
|
|
176
251
|
### Return type
|
177
252
|
|
@@ -187,6 +262,77 @@ end
|
|
187
262
|
- **Accept**: application/json
|
188
263
|
|
189
264
|
|
265
|
+
## candidates_meta_post_retrieve
|
266
|
+
|
267
|
+
> <MetaResponse> candidates_meta_post_retrieve(x_account_token)
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
Returns metadata for `Candidate` POSTs.
|
272
|
+
|
273
|
+
### Examples
|
274
|
+
|
275
|
+
```ruby
|
276
|
+
require 'time'
|
277
|
+
require 'merge_ats_client'
|
278
|
+
# setup authorization
|
279
|
+
MergeATSClient.configure do |config|
|
280
|
+
# Configure API key authorization: tokenAuth
|
281
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
282
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
283
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
284
|
+
end
|
285
|
+
|
286
|
+
api_instance = MergeATSClient::CandidatesApi.new
|
287
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
288
|
+
|
289
|
+
begin
|
290
|
+
|
291
|
+
result = api_instance.candidates_meta_post_retrieve(x_account_token)
|
292
|
+
p result
|
293
|
+
rescue MergeATSClient::ApiError => e
|
294
|
+
puts "Error when calling CandidatesApi->candidates_meta_post_retrieve: #{e}"
|
295
|
+
end
|
296
|
+
```
|
297
|
+
|
298
|
+
#### Using the candidates_meta_post_retrieve_with_http_info variant
|
299
|
+
|
300
|
+
This returns an Array which contains the response data, status code and headers.
|
301
|
+
|
302
|
+
> <Array(<MetaResponse>, Integer, Hash)> candidates_meta_post_retrieve_with_http_info(x_account_token)
|
303
|
+
|
304
|
+
```ruby
|
305
|
+
begin
|
306
|
+
|
307
|
+
data, status_code, headers = api_instance.candidates_meta_post_retrieve_with_http_info(x_account_token)
|
308
|
+
p status_code # => 2xx
|
309
|
+
p headers # => { ... }
|
310
|
+
p data # => <MetaResponse>
|
311
|
+
rescue MergeATSClient::ApiError => e
|
312
|
+
puts "Error when calling CandidatesApi->candidates_meta_post_retrieve_with_http_info: #{e}"
|
313
|
+
end
|
314
|
+
```
|
315
|
+
|
316
|
+
### Parameters
|
317
|
+
|
318
|
+
| Name | Type | Description | Notes |
|
319
|
+
| ---- | ---- | ----------- | ----- |
|
320
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
321
|
+
|
322
|
+
### Return type
|
323
|
+
|
324
|
+
[**MetaResponse**](MetaResponse.md)
|
325
|
+
|
326
|
+
### Authorization
|
327
|
+
|
328
|
+
[tokenAuth](../README.md#tokenAuth)
|
329
|
+
|
330
|
+
### HTTP request headers
|
331
|
+
|
332
|
+
- **Content-Type**: Not defined
|
333
|
+
- **Accept**: application/json
|
334
|
+
|
335
|
+
|
190
336
|
## candidates_retrieve
|
191
337
|
|
192
338
|
> <Candidate> candidates_retrieve(x_account_token, id, opts)
|
@@ -203,9 +349,9 @@ require 'merge_ats_client'
|
|
203
349
|
# setup authorization
|
204
350
|
MergeATSClient.configure do |config|
|
205
351
|
# Configure API key authorization: tokenAuth
|
206
|
-
config.api_key['
|
352
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
207
353
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
208
|
-
# config.api_key_prefix['
|
354
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
209
355
|
end
|
210
356
|
|
211
357
|
api_instance = MergeATSClient::CandidatesApi.new
|
@@ -8,7 +8,8 @@
|
|
8
8
|
| **path** | **String** | | |
|
9
9
|
| **base_url_override** | **String** | | [optional] |
|
10
10
|
| **data** | **String** | | [optional] |
|
11
|
-
| **
|
11
|
+
| **multipart_form_data** | [**Array<MultipartFormFieldRequest>**](MultipartFormFieldRequest.md) | Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`. | [optional] |
|
12
|
+
| **headers** | [**Hash<String, AnyType>**](AnyType.md) | The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. | [optional] |
|
12
13
|
| **request_format** | [**RequestFormatEnum**](RequestFormatEnum.md) | | [optional] |
|
13
14
|
|
14
15
|
## Example
|
@@ -21,6 +22,7 @@ instance = MergeATSClient::DataPassthroughRequest.new(
|
|
21
22
|
path: /scooters,
|
22
23
|
base_url_override: null,
|
23
24
|
data: {"company": "Lime", "model": "Gen 2.5"},
|
25
|
+
multipart_form_data: null,
|
24
26
|
headers: {"EXTRA-HEADER":"value"},
|
25
27
|
request_format: JSON
|
26
28
|
)
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeATSClient::DebugModeLog
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **log_id** | **String** | | |
|
8
|
+
| **dashboard_view** | **String** | | |
|
9
|
+
| **log_summary** | [**DebugModelLogSummary**](DebugModelLogSummary.md) | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_ats_client'
|
15
|
+
|
16
|
+
instance = MergeATSClient::DebugModeLog.new(
|
17
|
+
log_id: 99433219-8017-4acd-bb3c-ceb23d663832,
|
18
|
+
dashboard_view: https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832,
|
19
|
+
log_summary: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeATSClient::DebugModelLogSummary
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **url** | **String** | | |
|
8
|
+
| **method** | **String** | | |
|
9
|
+
| **status_code** | **Integer** | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_ats_client'
|
15
|
+
|
16
|
+
instance = MergeATSClient::DebugModelLogSummary.new(
|
17
|
+
url: https://harvest.greenhouse.io/v1/candidates/,
|
18
|
+
method: POST,
|
19
|
+
status_code: 200
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Department.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
9
|
| **name** | **String** | The department's name. | [optional] |
|
10
10
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
11
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
|
11
12
|
|
12
13
|
## Example
|
13
14
|
|
@@ -18,7 +19,8 @@ instance = MergeATSClient::Department.new(
|
|
18
19
|
id: 5b3c1341-a20f-4e51-b72c-f3830a16c97b,
|
19
20
|
remote_id: 23456,
|
20
21
|
name: Engineering,
|
21
|
-
remote_data: [{"path":"/departments","data":["Varies by platform"]}]
|
22
|
+
remote_data: [{"path":"/departments","data":["Varies by platform"]}],
|
23
|
+
remote_was_deleted: null
|
22
24
|
)
|
23
25
|
```
|
24
26
|
|
data/docs/DepartmentsApi.md
CHANGED
@@ -24,9 +24,9 @@ require 'merge_ats_client'
|
|
24
24
|
# setup authorization
|
25
25
|
MergeATSClient.configure do |config|
|
26
26
|
# Configure API key authorization: tokenAuth
|
27
|
-
config.api_key['
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
28
28
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
-
# config.api_key_prefix['
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
30
30
|
end
|
31
31
|
|
32
32
|
api_instance = MergeATSClient::DepartmentsApi.new
|
@@ -35,6 +35,7 @@ opts = {
|
|
35
35
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
|
+
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
38
39
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
39
40
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
40
41
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -77,6 +78,7 @@ end
|
|
77
78
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
78
79
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
79
80
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
81
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
80
82
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
81
83
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
82
84
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
@@ -113,9 +115,9 @@ require 'merge_ats_client'
|
|
113
115
|
# setup authorization
|
114
116
|
MergeATSClient.configure do |config|
|
115
117
|
# Configure API key authorization: tokenAuth
|
116
|
-
config.api_key['
|
118
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
117
119
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
118
|
-
# config.api_key_prefix['
|
120
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
119
121
|
end
|
120
122
|
|
121
123
|
api_instance = MergeATSClient::DepartmentsApi.new
|
data/docs/EEOC.md
CHANGED
@@ -6,13 +6,14 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
-
| **candidate** | **String** |
|
9
|
+
| **candidate** | **String** | | [optional] |
|
10
10
|
| **submitted_at** | **Time** | When the information was submitted. | [optional] |
|
11
11
|
| **race** | [**RaceEnum**](RaceEnum.md) | The candidate's race. | [optional] |
|
12
12
|
| **gender** | [**GenderEnum**](GenderEnum.md) | The candidate's gender. | [optional] |
|
13
13
|
| **veteran_status** | [**VeteranStatusEnum**](VeteranStatusEnum.md) | The candidate's veteran status. | [optional] |
|
14
14
|
| **disability_status** | [**DisabilityStatusEnum**](DisabilityStatusEnum.md) | The candidate's disability status. | [optional] |
|
15
15
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
16
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
|
16
17
|
|
17
18
|
## Example
|
18
19
|
|
@@ -28,7 +29,8 @@ instance = MergeATSClient::EEOC.new(
|
|
28
29
|
gender: FEMALE,
|
29
30
|
veteran_status: I_AM_NOT_A_PROTECTED_VETERAN,
|
30
31
|
disability_status: I_DONT_WISH_TO_ANSWER,
|
31
|
-
remote_data: [{"path":"/eeoc","data":["Varies by platform"]}]
|
32
|
+
remote_data: [{"path":"/eeoc","data":["Varies by platform"]}],
|
33
|
+
remote_was_deleted: null
|
32
34
|
)
|
33
35
|
```
|
34
36
|
|
data/docs/EeocsApi.md
CHANGED
@@ -24,9 +24,9 @@ require 'merge_ats_client'
|
|
24
24
|
# setup authorization
|
25
25
|
MergeATSClient.configure do |config|
|
26
26
|
# Configure API key authorization: tokenAuth
|
27
|
-
config.api_key['
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
28
28
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
-
# config.api_key_prefix['
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
30
30
|
end
|
31
31
|
|
32
32
|
api_instance = MergeATSClient::EeocsApi.new
|
@@ -37,6 +37,7 @@ opts = {
|
|
37
37
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
38
38
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
39
39
|
expand: 'candidate', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
40
|
+
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
40
41
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
42
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
42
43
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -81,6 +82,7 @@ end
|
|
81
82
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
82
83
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
83
84
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
85
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
84
86
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
85
87
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
86
88
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
@@ -117,9 +119,9 @@ require 'merge_ats_client'
|
|
117
119
|
# setup authorization
|
118
120
|
MergeATSClient.configure do |config|
|
119
121
|
# Configure API key authorization: tokenAuth
|
120
|
-
config.api_key['
|
122
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
121
123
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
122
|
-
# config.api_key_prefix['
|
124
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
123
125
|
end
|
124
126
|
|
125
127
|
api_instance = MergeATSClient::EeocsApi.new
|
@@ -7,8 +7,9 @@
|
|
7
7
|
| **end_user_email_address** | **String** | | |
|
8
8
|
| **end_user_organization_name** | **String** | | |
|
9
9
|
| **end_user_origin_id** | **String** | | |
|
10
|
-
| **categories** | **Array<
|
11
|
-
| **integration** | **String** |
|
10
|
+
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | | |
|
11
|
+
| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token, for examples of slugs see https://www.merge.dev/docs/basics/integration-metadata | [optional] |
|
12
|
+
| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720] for how long this token is valid. Defaults to 30 | [optional][default to 30] |
|
12
13
|
|
13
14
|
## Example
|
14
15
|
|
@@ -20,7 +21,8 @@ instance = MergeATSClient::EndUserDetailsRequest.new(
|
|
20
21
|
end_user_organization_name: null,
|
21
22
|
end_user_origin_id: null,
|
22
23
|
categories: null,
|
23
|
-
integration: null
|
24
|
+
integration: null,
|
25
|
+
link_expiry_mins: null
|
24
26
|
)
|
25
27
|
```
|
26
28
|
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeATSClient::ErrorValidationProblem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **source** | [**ValidationProblemSource**](ValidationProblemSource.md) | | [optional] |
|
8
|
+
| **title** | **String** | | |
|
9
|
+
| **detail** | **String** | | |
|
10
|
+
| **problem_type** | **String** | | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'merge_ats_client'
|
16
|
+
|
17
|
+
instance = MergeATSClient::ErrorValidationProblem.new(
|
18
|
+
source: null,
|
19
|
+
title: Missing Required Field,
|
20
|
+
detail: custom_fields is a required field on model.,
|
21
|
+
problem_type: MISSING_REQUIRED_FIELD
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,79 @@
|
|
1
|
+
# MergeATSClient::ForceResyncApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**sync_status_resync_create**](ForceResyncApi.md#sync_status_resync_create) | **POST** /sync-status/resync | |
|
8
|
+
|
9
|
+
|
10
|
+
## sync_status_resync_create
|
11
|
+
|
12
|
+
> <Array<SyncStatus>> sync_status_resync_create(x_account_token)
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
Force re-sync of all models. This is only available for organizations on Merge's Grow and Expand plans.
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'merge_ats_client'
|
23
|
+
# setup authorization
|
24
|
+
MergeATSClient.configure do |config|
|
25
|
+
# Configure API key authorization: tokenAuth
|
26
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = MergeATSClient::ForceResyncApi.new
|
32
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
33
|
+
|
34
|
+
begin
|
35
|
+
|
36
|
+
result = api_instance.sync_status_resync_create(x_account_token)
|
37
|
+
p result
|
38
|
+
rescue MergeATSClient::ApiError => e
|
39
|
+
puts "Error when calling ForceResyncApi->sync_status_resync_create: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
#### Using the sync_status_resync_create_with_http_info variant
|
44
|
+
|
45
|
+
This returns an Array which contains the response data, status code and headers.
|
46
|
+
|
47
|
+
> <Array(<Array<SyncStatus>>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)
|
48
|
+
|
49
|
+
```ruby
|
50
|
+
begin
|
51
|
+
|
52
|
+
data, status_code, headers = api_instance.sync_status_resync_create_with_http_info(x_account_token)
|
53
|
+
p status_code # => 2xx
|
54
|
+
p headers # => { ... }
|
55
|
+
p data # => <Array<SyncStatus>>
|
56
|
+
rescue MergeATSClient::ApiError => e
|
57
|
+
puts "Error when calling ForceResyncApi->sync_status_resync_create_with_http_info: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
### Parameters
|
62
|
+
|
63
|
+
| Name | Type | Description | Notes |
|
64
|
+
| ---- | ---- | ----------- | ----- |
|
65
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
[**Array<SyncStatus>**](SyncStatus.md)
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
[tokenAuth](../README.md#tokenAuth)
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: Not defined
|
78
|
+
- **Accept**: application/json
|
79
|
+
|
data/docs/GenerateKeyApi.md
CHANGED
@@ -23,9 +23,9 @@ require 'merge_ats_client'
|
|
23
23
|
# setup authorization
|
24
24
|
MergeATSClient.configure do |config|
|
25
25
|
# Configure API key authorization: tokenAuth
|
26
|
-
config.api_key['
|
26
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
27
27
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
-
# config.api_key_prefix['
|
28
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
29
29
|
end
|
30
30
|
|
31
31
|
api_instance = MergeATSClient::GenerateKeyApi.new
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeATSClient::IgnoreCommonModel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **reason** | [**ReasonEnum**](ReasonEnum.md) | | |
|
8
|
+
| **message** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_ats_client'
|
14
|
+
|
15
|
+
instance = MergeATSClient::IgnoreCommonModel.new(
|
16
|
+
reason: GENERAL_CUSTOMER_REQUEST,
|
17
|
+
message: deletion request by user id 51903790-7dfe-4053-8d63-5a10cc4ffd39
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|