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/ApplicationsApi.md
CHANGED
@@ -6,12 +6,13 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**applications_create**](ApplicationsApi.md#applications_create) | **POST** /applications | |
|
8
8
|
| [**applications_list**](ApplicationsApi.md#applications_list) | **GET** /applications | |
|
9
|
+
| [**applications_meta_post_retrieve**](ApplicationsApi.md#applications_meta_post_retrieve) | **GET** /applications/meta/post | |
|
9
10
|
| [**applications_retrieve**](ApplicationsApi.md#applications_retrieve) | **GET** /applications/{id} | |
|
10
11
|
|
11
12
|
|
12
13
|
## applications_create
|
13
14
|
|
14
|
-
> <
|
15
|
+
> <ApplicationResponse> applications_create(x_account_token, application_endpoint_request, opts)
|
15
16
|
|
16
17
|
|
17
18
|
|
@@ -25,22 +26,22 @@ require 'merge_ats_client'
|
|
25
26
|
# setup authorization
|
26
27
|
MergeATSClient.configure do |config|
|
27
28
|
# Configure API key authorization: tokenAuth
|
28
|
-
config.api_key['
|
29
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
29
30
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
|
-
# config.api_key_prefix['
|
31
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
31
32
|
end
|
32
33
|
|
33
34
|
api_instance = MergeATSClient::ApplicationsApi.new
|
34
35
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
35
|
-
|
36
|
+
application_endpoint_request = MergeATSClient::ApplicationEndpointRequest.new({model: MergeATSClient::ApplicationRequest.new, remote_user_id: 'remote_user_id_example'}) # ApplicationEndpointRequest |
|
36
37
|
opts = {
|
37
|
-
|
38
|
-
|
38
|
+
is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
|
39
|
+
run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
|
39
40
|
}
|
40
41
|
|
41
42
|
begin
|
42
43
|
|
43
|
-
result = api_instance.applications_create(x_account_token,
|
44
|
+
result = api_instance.applications_create(x_account_token, application_endpoint_request, opts)
|
44
45
|
p result
|
45
46
|
rescue MergeATSClient::ApiError => e
|
46
47
|
puts "Error when calling ApplicationsApi->applications_create: #{e}"
|
@@ -51,15 +52,15 @@ end
|
|
51
52
|
|
52
53
|
This returns an Array which contains the response data, status code and headers.
|
53
54
|
|
54
|
-
> <Array(<
|
55
|
+
> <Array(<ApplicationResponse>, Integer, Hash)> applications_create_with_http_info(x_account_token, application_endpoint_request, opts)
|
55
56
|
|
56
57
|
```ruby
|
57
58
|
begin
|
58
59
|
|
59
|
-
data, status_code, headers = api_instance.applications_create_with_http_info(x_account_token,
|
60
|
+
data, status_code, headers = api_instance.applications_create_with_http_info(x_account_token, application_endpoint_request, opts)
|
60
61
|
p status_code # => 2xx
|
61
62
|
p headers # => { ... }
|
62
|
-
p data # => <
|
63
|
+
p data # => <ApplicationResponse>
|
63
64
|
rescue MergeATSClient::ApiError => e
|
64
65
|
puts "Error when calling ApplicationsApi->applications_create_with_http_info: #{e}"
|
65
66
|
end
|
@@ -70,13 +71,13 @@ end
|
|
70
71
|
| Name | Type | Description | Notes |
|
71
72
|
| ---- | ---- | ----------- | ----- |
|
72
73
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
73
|
-
| **
|
74
|
+
| **application_endpoint_request** | [**ApplicationEndpointRequest**](ApplicationEndpointRequest.md) | | |
|
75
|
+
| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
|
74
76
|
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
75
|
-
| **application_request** | [**ApplicationRequest**](ApplicationRequest.md) | | [optional] |
|
76
77
|
|
77
78
|
### Return type
|
78
79
|
|
79
|
-
[**
|
80
|
+
[**ApplicationResponse**](ApplicationResponse.md)
|
80
81
|
|
81
82
|
### Authorization
|
82
83
|
|
@@ -104,9 +105,9 @@ require 'merge_ats_client'
|
|
104
105
|
# setup authorization
|
105
106
|
MergeATSClient.configure do |config|
|
106
107
|
# Configure API key authorization: tokenAuth
|
107
|
-
config.api_key['
|
108
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
108
109
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
109
|
-
# config.api_key_prefix['
|
110
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
110
111
|
end
|
111
112
|
|
112
113
|
api_instance = MergeATSClient::ApplicationsApi.new
|
@@ -119,13 +120,15 @@ opts = {
|
|
119
120
|
current_stage_id: 'current_stage_id_example', # String | If provided, will only return applications at this interview stage.
|
120
121
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
121
122
|
expand: 'candidate', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
123
|
+
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
122
124
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
123
125
|
job_id: 'job_id_example', # String | If provided, will only return applications for this job.
|
124
126
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
125
127
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
126
128
|
page_size: 56, # Integer | Number of results to return per page.
|
127
129
|
reject_reason_id: 'reject_reason_id_example', # String | If provided, will only return applications with this reject reason.
|
128
|
-
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
130
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
131
|
+
source: 'source_example' # String | If provided, will only return applications with this source.
|
129
132
|
}
|
130
133
|
|
131
134
|
begin
|
@@ -167,6 +170,7 @@ end
|
|
167
170
|
| **current_stage_id** | **String** | If provided, will only return applications at this interview stage. | [optional] |
|
168
171
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
169
172
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
173
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
170
174
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
171
175
|
| **job_id** | **String** | If provided, will only return applications for this job. | [optional] |
|
172
176
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
@@ -174,6 +178,7 @@ end
|
|
174
178
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
175
179
|
| **reject_reason_id** | **String** | If provided, will only return applications with this reject reason. | [optional] |
|
176
180
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
181
|
+
| **source** | **String** | If provided, will only return applications with this source. | [optional] |
|
177
182
|
|
178
183
|
### Return type
|
179
184
|
|
@@ -189,6 +194,81 @@ end
|
|
189
194
|
- **Accept**: application/json
|
190
195
|
|
191
196
|
|
197
|
+
## applications_meta_post_retrieve
|
198
|
+
|
199
|
+
> <MetaResponse> applications_meta_post_retrieve(x_account_token, opts)
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
Returns metadata for `Application` POSTs.
|
204
|
+
|
205
|
+
### Examples
|
206
|
+
|
207
|
+
```ruby
|
208
|
+
require 'time'
|
209
|
+
require 'merge_ats_client'
|
210
|
+
# setup authorization
|
211
|
+
MergeATSClient.configure do |config|
|
212
|
+
# Configure API key authorization: tokenAuth
|
213
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
214
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
215
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
216
|
+
end
|
217
|
+
|
218
|
+
api_instance = MergeATSClient::ApplicationsApi.new
|
219
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
220
|
+
opts = {
|
221
|
+
application_remote_template_id: 'application_remote_template_id_example' # String | The template ID associated with the nested application in the request.
|
222
|
+
}
|
223
|
+
|
224
|
+
begin
|
225
|
+
|
226
|
+
result = api_instance.applications_meta_post_retrieve(x_account_token, opts)
|
227
|
+
p result
|
228
|
+
rescue MergeATSClient::ApiError => e
|
229
|
+
puts "Error when calling ApplicationsApi->applications_meta_post_retrieve: #{e}"
|
230
|
+
end
|
231
|
+
```
|
232
|
+
|
233
|
+
#### Using the applications_meta_post_retrieve_with_http_info variant
|
234
|
+
|
235
|
+
This returns an Array which contains the response data, status code and headers.
|
236
|
+
|
237
|
+
> <Array(<MetaResponse>, Integer, Hash)> applications_meta_post_retrieve_with_http_info(x_account_token, opts)
|
238
|
+
|
239
|
+
```ruby
|
240
|
+
begin
|
241
|
+
|
242
|
+
data, status_code, headers = api_instance.applications_meta_post_retrieve_with_http_info(x_account_token, opts)
|
243
|
+
p status_code # => 2xx
|
244
|
+
p headers # => { ... }
|
245
|
+
p data # => <MetaResponse>
|
246
|
+
rescue MergeATSClient::ApiError => e
|
247
|
+
puts "Error when calling ApplicationsApi->applications_meta_post_retrieve_with_http_info: #{e}"
|
248
|
+
end
|
249
|
+
```
|
250
|
+
|
251
|
+
### Parameters
|
252
|
+
|
253
|
+
| Name | Type | Description | Notes |
|
254
|
+
| ---- | ---- | ----------- | ----- |
|
255
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
256
|
+
| **application_remote_template_id** | **String** | The template ID associated with the nested application in the request. | [optional] |
|
257
|
+
|
258
|
+
### Return type
|
259
|
+
|
260
|
+
[**MetaResponse**](MetaResponse.md)
|
261
|
+
|
262
|
+
### Authorization
|
263
|
+
|
264
|
+
[tokenAuth](../README.md#tokenAuth)
|
265
|
+
|
266
|
+
### HTTP request headers
|
267
|
+
|
268
|
+
- **Content-Type**: Not defined
|
269
|
+
- **Accept**: application/json
|
270
|
+
|
271
|
+
|
192
272
|
## applications_retrieve
|
193
273
|
|
194
274
|
> <Application> applications_retrieve(x_account_token, id, opts)
|
@@ -205,9 +285,9 @@ require 'merge_ats_client'
|
|
205
285
|
# setup authorization
|
206
286
|
MergeATSClient.configure do |config|
|
207
287
|
# Configure API key authorization: tokenAuth
|
208
|
-
config.api_key['
|
288
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
209
289
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
210
|
-
# config.api_key_prefix['
|
290
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
211
291
|
end
|
212
292
|
|
213
293
|
api_instance = MergeATSClient::ApplicationsApi.new
|
data/docs/Attachment.md
CHANGED
@@ -11,6 +11,7 @@
|
|
11
11
|
| **candidate** | **String** | | [optional] |
|
12
12
|
| **attachment_type** | [**AttachmentTypeEnum**](AttachmentTypeEnum.md) | The attachment's type. | [optional] |
|
13
13
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
14
|
+
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
14
15
|
|
15
16
|
## Example
|
16
17
|
|
@@ -24,7 +25,8 @@ instance = MergeATSClient::Attachment.new(
|
|
24
25
|
file_url: http://alturl.com/p749b,
|
25
26
|
candidate: 2872ba14-4084-492b-be96-e5eee6fc33ef,
|
26
27
|
attachment_type: RESUME,
|
27
|
-
remote_data: [{"path":"/attachments","data":["Varies by platform"]}]
|
28
|
+
remote_data: [{"path":"/attachments","data":["Varies by platform"]}],
|
29
|
+
remote_was_deleted: null
|
28
30
|
)
|
29
31
|
```
|
30
32
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeATSClient::AttachmentEndpointRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**AttachmentRequest**](AttachmentRequest.md) | | |
|
8
|
+
| **remote_user_id** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_ats_client'
|
14
|
+
|
15
|
+
instance = MergeATSClient::AttachmentEndpointRequest.new(
|
16
|
+
model: null,
|
17
|
+
remote_user_id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/AttachmentRequest.md
CHANGED
@@ -9,6 +9,8 @@
|
|
9
9
|
| **file_url** | **String** | The attachment's url. | [optional] |
|
10
10
|
| **candidate** | **String** | | [optional] |
|
11
11
|
| **attachment_type** | [**AttachmentTypeEnum**](AttachmentTypeEnum.md) | The attachment's type. | [optional] |
|
12
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
13
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
12
14
|
|
13
15
|
## Example
|
14
16
|
|
@@ -20,7 +22,9 @@ instance = MergeATSClient::AttachmentRequest.new(
|
|
20
22
|
file_name: Candidate Resume,
|
21
23
|
file_url: http://alturl.com/p749b,
|
22
24
|
candidate: 2872ba14-4084-492b-be96-e5eee6fc33ef,
|
23
|
-
attachment_type: RESUME
|
25
|
+
attachment_type: RESUME,
|
26
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
27
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
24
28
|
)
|
25
29
|
```
|
26
30
|
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeATSClient::AttachmentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**Attachment**](Attachment.md) | | |
|
8
|
+
| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) | | |
|
9
|
+
| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) | | |
|
10
|
+
| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'merge_ats_client'
|
16
|
+
|
17
|
+
instance = MergeATSClient::AttachmentResponse.new(
|
18
|
+
model: null,
|
19
|
+
warnings: null,
|
20
|
+
errors: null,
|
21
|
+
logs: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/AttachmentsApi.md
CHANGED
@@ -6,12 +6,13 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**attachments_create**](AttachmentsApi.md#attachments_create) | **POST** /attachments | |
|
8
8
|
| [**attachments_list**](AttachmentsApi.md#attachments_list) | **GET** /attachments | |
|
9
|
+
| [**attachments_meta_post_retrieve**](AttachmentsApi.md#attachments_meta_post_retrieve) | **GET** /attachments/meta/post | |
|
9
10
|
| [**attachments_retrieve**](AttachmentsApi.md#attachments_retrieve) | **GET** /attachments/{id} | |
|
10
11
|
|
11
12
|
|
12
13
|
## attachments_create
|
13
14
|
|
14
|
-
> <
|
15
|
+
> <AttachmentResponse> attachments_create(x_account_token, attachment_endpoint_request, opts)
|
15
16
|
|
16
17
|
|
17
18
|
|
@@ -32,15 +33,15 @@ end
|
|
32
33
|
|
33
34
|
api_instance = MergeATSClient::AttachmentsApi.new
|
34
35
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
35
|
-
|
36
|
+
attachment_endpoint_request = MergeATSClient::AttachmentEndpointRequest.new({model: MergeATSClient::AttachmentRequest.new, remote_user_id: 'remote_user_id_example'}) # AttachmentEndpointRequest |
|
36
37
|
opts = {
|
37
|
-
|
38
|
-
|
38
|
+
is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
|
39
|
+
run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
|
39
40
|
}
|
40
41
|
|
41
42
|
begin
|
42
43
|
|
43
|
-
result = api_instance.attachments_create(x_account_token,
|
44
|
+
result = api_instance.attachments_create(x_account_token, attachment_endpoint_request, opts)
|
44
45
|
p result
|
45
46
|
rescue MergeATSClient::ApiError => e
|
46
47
|
puts "Error when calling AttachmentsApi->attachments_create: #{e}"
|
@@ -51,15 +52,15 @@ end
|
|
51
52
|
|
52
53
|
This returns an Array which contains the response data, status code and headers.
|
53
54
|
|
54
|
-
> <Array(<
|
55
|
+
> <Array(<AttachmentResponse>, Integer, Hash)> attachments_create_with_http_info(x_account_token, attachment_endpoint_request, opts)
|
55
56
|
|
56
57
|
```ruby
|
57
58
|
begin
|
58
59
|
|
59
|
-
data, status_code, headers = api_instance.attachments_create_with_http_info(x_account_token,
|
60
|
+
data, status_code, headers = api_instance.attachments_create_with_http_info(x_account_token, attachment_endpoint_request, opts)
|
60
61
|
p status_code # => 2xx
|
61
62
|
p headers # => { ... }
|
62
|
-
p data # => <
|
63
|
+
p data # => <AttachmentResponse>
|
63
64
|
rescue MergeATSClient::ApiError => e
|
64
65
|
puts "Error when calling AttachmentsApi->attachments_create_with_http_info: #{e}"
|
65
66
|
end
|
@@ -70,13 +71,13 @@ end
|
|
70
71
|
| Name | Type | Description | Notes |
|
71
72
|
| ---- | ---- | ----------- | ----- |
|
72
73
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
73
|
-
| **
|
74
|
+
| **attachment_endpoint_request** | [**AttachmentEndpointRequest**](AttachmentEndpointRequest.md) | | |
|
75
|
+
| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
|
74
76
|
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
75
|
-
| **attachment_request** | [**AttachmentRequest**](AttachmentRequest.md) | | [optional] |
|
76
77
|
|
77
78
|
### Return type
|
78
79
|
|
79
|
-
[**
|
80
|
+
[**AttachmentResponse**](AttachmentResponse.md)
|
80
81
|
|
81
82
|
### Authorization
|
82
83
|
|
@@ -104,9 +105,9 @@ require 'merge_ats_client'
|
|
104
105
|
# setup authorization
|
105
106
|
MergeATSClient.configure do |config|
|
106
107
|
# Configure API key authorization: tokenAuth
|
107
|
-
config.api_key['
|
108
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
108
109
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
109
|
-
# config.api_key_prefix['
|
110
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
110
111
|
end
|
111
112
|
|
112
113
|
api_instance = MergeATSClient::AttachmentsApi.new
|
@@ -116,6 +117,8 @@ opts = {
|
|
116
117
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
117
118
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
118
119
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
120
|
+
expand: 'candidate', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
121
|
+
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
119
122
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
120
123
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
121
124
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -159,6 +162,8 @@ end
|
|
159
162
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
160
163
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
161
164
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
165
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
166
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
162
167
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
163
168
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
164
169
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
@@ -179,6 +184,77 @@ end
|
|
179
184
|
- **Accept**: application/json
|
180
185
|
|
181
186
|
|
187
|
+
## attachments_meta_post_retrieve
|
188
|
+
|
189
|
+
> <MetaResponse> attachments_meta_post_retrieve(x_account_token)
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
Returns metadata for `Attachment` POSTs.
|
194
|
+
|
195
|
+
### Examples
|
196
|
+
|
197
|
+
```ruby
|
198
|
+
require 'time'
|
199
|
+
require 'merge_ats_client'
|
200
|
+
# setup authorization
|
201
|
+
MergeATSClient.configure do |config|
|
202
|
+
# Configure API key authorization: tokenAuth
|
203
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
204
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
205
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
206
|
+
end
|
207
|
+
|
208
|
+
api_instance = MergeATSClient::AttachmentsApi.new
|
209
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
210
|
+
|
211
|
+
begin
|
212
|
+
|
213
|
+
result = api_instance.attachments_meta_post_retrieve(x_account_token)
|
214
|
+
p result
|
215
|
+
rescue MergeATSClient::ApiError => e
|
216
|
+
puts "Error when calling AttachmentsApi->attachments_meta_post_retrieve: #{e}"
|
217
|
+
end
|
218
|
+
```
|
219
|
+
|
220
|
+
#### Using the attachments_meta_post_retrieve_with_http_info variant
|
221
|
+
|
222
|
+
This returns an Array which contains the response data, status code and headers.
|
223
|
+
|
224
|
+
> <Array(<MetaResponse>, Integer, Hash)> attachments_meta_post_retrieve_with_http_info(x_account_token)
|
225
|
+
|
226
|
+
```ruby
|
227
|
+
begin
|
228
|
+
|
229
|
+
data, status_code, headers = api_instance.attachments_meta_post_retrieve_with_http_info(x_account_token)
|
230
|
+
p status_code # => 2xx
|
231
|
+
p headers # => { ... }
|
232
|
+
p data # => <MetaResponse>
|
233
|
+
rescue MergeATSClient::ApiError => e
|
234
|
+
puts "Error when calling AttachmentsApi->attachments_meta_post_retrieve_with_http_info: #{e}"
|
235
|
+
end
|
236
|
+
```
|
237
|
+
|
238
|
+
### Parameters
|
239
|
+
|
240
|
+
| Name | Type | Description | Notes |
|
241
|
+
| ---- | ---- | ----------- | ----- |
|
242
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
243
|
+
|
244
|
+
### Return type
|
245
|
+
|
246
|
+
[**MetaResponse**](MetaResponse.md)
|
247
|
+
|
248
|
+
### Authorization
|
249
|
+
|
250
|
+
[tokenAuth](../README.md#tokenAuth)
|
251
|
+
|
252
|
+
### HTTP request headers
|
253
|
+
|
254
|
+
- **Content-Type**: Not defined
|
255
|
+
- **Accept**: application/json
|
256
|
+
|
257
|
+
|
182
258
|
## attachments_retrieve
|
183
259
|
|
184
260
|
> <Attachment> attachments_retrieve(x_account_token, id, opts)
|
@@ -195,15 +271,16 @@ require 'merge_ats_client'
|
|
195
271
|
# setup authorization
|
196
272
|
MergeATSClient.configure do |config|
|
197
273
|
# Configure API key authorization: tokenAuth
|
198
|
-
config.api_key['
|
274
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
199
275
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
200
|
-
# config.api_key_prefix['
|
276
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
201
277
|
end
|
202
278
|
|
203
279
|
api_instance = MergeATSClient::AttachmentsApi.new
|
204
280
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
205
281
|
id = TODO # String |
|
206
282
|
opts = {
|
283
|
+
expand: 'candidate', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
207
284
|
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
208
285
|
}
|
209
286
|
|
@@ -240,6 +317,7 @@ end
|
|
240
317
|
| ---- | ---- | ----------- | ----- |
|
241
318
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
242
319
|
| **id** | [**String**](.md) | | |
|
320
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
243
321
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
244
322
|
|
245
323
|
### Return type
|
data/docs/AvailableActionsApi.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::AvailableActionsApi.new
|
data/docs/Candidate.md
CHANGED
@@ -24,6 +24,7 @@
|
|
24
24
|
| **attachments** | **Array<String>** | Array of `Attachment` object IDs. | [optional] |
|
25
25
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
26
26
|
| **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
|
27
|
+
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
27
28
|
|
28
29
|
## Example
|
29
30
|
|
@@ -50,7 +51,8 @@ instance = MergeATSClient::Candidate.new(
|
|
50
51
|
applications: ["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],
|
51
52
|
attachments: ["bea08964-32b4-4a20-8bb4-2612ba09de1d"],
|
52
53
|
remote_data: [{"path":"/candidates","data":["Varies by platform"]}],
|
53
|
-
custom_fields: null
|
54
|
+
custom_fields: null,
|
55
|
+
remote_was_deleted: null
|
54
56
|
)
|
55
57
|
```
|
56
58
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeATSClient::CandidateEndpointRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**CandidateRequest**](CandidateRequest.md) | | |
|
8
|
+
| **remote_user_id** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_ats_client'
|
14
|
+
|
15
|
+
instance = MergeATSClient::CandidateEndpointRequest.new(
|
16
|
+
model: null,
|
17
|
+
remote_user_id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/CandidateRequest.md
CHANGED
@@ -22,6 +22,9 @@
|
|
22
22
|
| **applications** | **Array<String>** | Array of `Application` object IDs. | [optional] |
|
23
23
|
| **attachments** | **Array<String>** | Array of `Attachment` object IDs. | [optional] |
|
24
24
|
| **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
|
25
|
+
| **remote_template_id** | **String** | | [optional] |
|
26
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
27
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
25
28
|
|
26
29
|
## Example
|
27
30
|
|
@@ -46,7 +49,10 @@ instance = MergeATSClient::CandidateRequest.new(
|
|
46
49
|
tags: ["High-Priority"],
|
47
50
|
applications: ["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],
|
48
51
|
attachments: ["bea08964-32b4-4a20-8bb4-2612ba09de1d"],
|
49
|
-
custom_fields: null
|
52
|
+
custom_fields: null,
|
53
|
+
remote_template_id: 92830948203,
|
54
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
55
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
50
56
|
)
|
51
57
|
```
|
52
58
|
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeATSClient::CandidateResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**Candidate**](Candidate.md) | | |
|
8
|
+
| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) | | |
|
9
|
+
| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) | | |
|
10
|
+
| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'merge_ats_client'
|
16
|
+
|
17
|
+
instance = MergeATSClient::CandidateResponse.new(
|
18
|
+
model: null,
|
19
|
+
warnings: null,
|
20
|
+
errors: null,
|
21
|
+
logs: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|