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/PassthroughApi.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::PassthroughApi.new
|
data/docs/ReasonEnum.md
ADDED
data/docs/RegenerateKeyApi.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::RegenerateKeyApi.new
|
data/docs/RejectReason.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 rejection reason’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::RejectReason.new(
|
|
18
19
|
id: 8be99a4a-f8d4-4339-bf1e-30eac970e217,
|
19
20
|
remote_id: 876556788,
|
20
21
|
name: Not passionate enough about APIs.,
|
21
|
-
remote_data: [{"path":"/rejection-reasons","data":["Varies by platform"]}]
|
22
|
+
remote_data: [{"path":"/rejection-reasons","data":["Varies by platform"]}],
|
23
|
+
remote_was_deleted: null
|
22
24
|
)
|
23
25
|
```
|
24
26
|
|
data/docs/RejectReasonsApi.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::RejectReasonsApi.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::RejectReasonsApi.new
|
data/docs/RemoteUser.md
CHANGED
@@ -13,6 +13,7 @@
|
|
13
13
|
| **remote_created_at** | **Time** | When the third party's user was created. | [optional] |
|
14
14
|
| **access_role** | [**AccessRoleEnum**](AccessRoleEnum.md) | The user's role. | [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::RemoteUser.new(
|
|
28
29
|
disabled: null,
|
29
30
|
remote_created_at: 2020-11-10T00:00Z,
|
30
31
|
access_role: SUPER_ADMIN,
|
31
|
-
remote_data: [{"path":"/users","data":["Varies by platform"]}]
|
32
|
+
remote_data: [{"path":"/users","data":["Varies by platform"]}],
|
33
|
+
remote_was_deleted: null
|
32
34
|
)
|
33
35
|
```
|
34
36
|
|
data/docs/ScheduledInterview.md
CHANGED
@@ -6,9 +6,9 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
-
| **application** | **String** |
|
10
|
-
| **job_interview_stage** | **String** |
|
11
|
-
| **organizer** | **String** |
|
9
|
+
| **application** | **String** | | [optional] |
|
10
|
+
| **job_interview_stage** | **String** | | [optional] |
|
11
|
+
| **organizer** | **String** | | [optional] |
|
12
12
|
| **interviewers** | **Array<String>** | Array of `RemoteUser` IDs. | [optional] |
|
13
13
|
| **location** | **String** | The interview's location. | [optional] |
|
14
14
|
| **start_at** | **Time** | When the interview was started. | [optional] |
|
@@ -17,6 +17,7 @@
|
|
17
17
|
| **remote_updated_at** | **Time** | When the third party's interview was updated. | [optional] |
|
18
18
|
| **status** | [**ScheduledInterviewStatusEnum**](ScheduledInterviewStatusEnum.md) | The interview's status. | [optional] |
|
19
19
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
20
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
|
20
21
|
|
21
22
|
## Example
|
22
23
|
|
@@ -36,7 +37,8 @@ instance = MergeATSClient::ScheduledInterview.new(
|
|
36
37
|
remote_created_at: 2021-10-15T00:00Z,
|
37
38
|
remote_updated_at: 2021-10-15T00:00Z,
|
38
39
|
status: SCHEDULED,
|
39
|
-
remote_data: [{"path":"/interviews","data":["Varies by platform"]}]
|
40
|
+
remote_data: [{"path":"/interviews","data":["Varies by platform"]}],
|
41
|
+
remote_was_deleted: null
|
40
42
|
)
|
41
43
|
```
|
42
44
|
|
data/docs/Scorecard.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
|
-
| **application** | **String** |
|
10
|
-
| **interview** | **String** |
|
11
|
-
| **interviewer** | **String** |
|
9
|
+
| **application** | **String** | | [optional] |
|
10
|
+
| **interview** | **String** | | [optional] |
|
11
|
+
| **interviewer** | **String** | | [optional] |
|
12
12
|
| **remote_created_at** | **Time** | When the third party's scorecard was created. | [optional] |
|
13
13
|
| **submitted_at** | **Time** | When the scorecard was submitted. | [optional] |
|
14
14
|
| **overall_recommendation** | [**OverallRecommendationEnum**](OverallRecommendationEnum.md) | The inteviewer's recommendation. | [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::Scorecard.new(
|
|
28
29
|
remote_created_at: 2021-10-15T00:00Z,
|
29
30
|
submitted_at: 2021-10-15T00:00Z,
|
30
31
|
overall_recommendation: STRONG_YES,
|
31
|
-
remote_data: [{"path":"/ratings","data":["Varies by platform"]}]
|
32
|
+
remote_data: [{"path":"/ratings","data":["Varies by platform"]}],
|
33
|
+
remote_was_deleted: null
|
32
34
|
)
|
33
35
|
```
|
34
36
|
|
data/docs/ScorecardsApi.md
CHANGED
@@ -4,90 +4,10 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**scorecards_create**](ScorecardsApi.md#scorecards_create) | **POST** /scorecards | |
|
8
7
|
| [**scorecards_list**](ScorecardsApi.md#scorecards_list) | **GET** /scorecards | |
|
9
8
|
| [**scorecards_retrieve**](ScorecardsApi.md#scorecards_retrieve) | **GET** /scorecards/{id} | |
|
10
9
|
|
11
10
|
|
12
|
-
## scorecards_create
|
13
|
-
|
14
|
-
> <Scorecard> scorecards_create(x_account_token, remote_user_id, opts)
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
Creates a `Scorecard` object with the given values.
|
19
|
-
|
20
|
-
### Examples
|
21
|
-
|
22
|
-
```ruby
|
23
|
-
require 'time'
|
24
|
-
require 'merge_ats_client'
|
25
|
-
# setup authorization
|
26
|
-
MergeATSClient.configure do |config|
|
27
|
-
# Configure API key authorization: tokenAuth
|
28
|
-
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
29
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
|
-
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
31
|
-
end
|
32
|
-
|
33
|
-
api_instance = MergeATSClient::ScorecardsApi.new
|
34
|
-
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
35
|
-
remote_user_id = 'remote_user_id_example' # String | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.
|
36
|
-
opts = {
|
37
|
-
run_async: true, # Boolean | Whether or not third-party updates should be run asynchronously.
|
38
|
-
scorecard_request: MergeATSClient::ScorecardRequest.new # ScorecardRequest |
|
39
|
-
}
|
40
|
-
|
41
|
-
begin
|
42
|
-
|
43
|
-
result = api_instance.scorecards_create(x_account_token, remote_user_id, opts)
|
44
|
-
p result
|
45
|
-
rescue MergeATSClient::ApiError => e
|
46
|
-
puts "Error when calling ScorecardsApi->scorecards_create: #{e}"
|
47
|
-
end
|
48
|
-
```
|
49
|
-
|
50
|
-
#### Using the scorecards_create_with_http_info variant
|
51
|
-
|
52
|
-
This returns an Array which contains the response data, status code and headers.
|
53
|
-
|
54
|
-
> <Array(<Scorecard>, Integer, Hash)> scorecards_create_with_http_info(x_account_token, remote_user_id, opts)
|
55
|
-
|
56
|
-
```ruby
|
57
|
-
begin
|
58
|
-
|
59
|
-
data, status_code, headers = api_instance.scorecards_create_with_http_info(x_account_token, remote_user_id, opts)
|
60
|
-
p status_code # => 2xx
|
61
|
-
p headers # => { ... }
|
62
|
-
p data # => <Scorecard>
|
63
|
-
rescue MergeATSClient::ApiError => e
|
64
|
-
puts "Error when calling ScorecardsApi->scorecards_create_with_http_info: #{e}"
|
65
|
-
end
|
66
|
-
```
|
67
|
-
|
68
|
-
### Parameters
|
69
|
-
|
70
|
-
| Name | Type | Description | Notes |
|
71
|
-
| ---- | ---- | ----------- | ----- |
|
72
|
-
| **x_account_token** | **String** | Token identifying the end user. | |
|
73
|
-
| **remote_user_id** | **String** | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | |
|
74
|
-
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
75
|
-
| **scorecard_request** | [**ScorecardRequest**](ScorecardRequest.md) | | [optional] |
|
76
|
-
|
77
|
-
### Return type
|
78
|
-
|
79
|
-
[**Scorecard**](Scorecard.md)
|
80
|
-
|
81
|
-
### Authorization
|
82
|
-
|
83
|
-
[tokenAuth](../README.md#tokenAuth)
|
84
|
-
|
85
|
-
### HTTP request headers
|
86
|
-
|
87
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
88
|
-
- **Accept**: application/json
|
89
|
-
|
90
|
-
|
91
11
|
## scorecards_list
|
92
12
|
|
93
13
|
> <PaginatedScorecardList> scorecards_list(x_account_token, opts)
|
@@ -104,9 +24,9 @@ require 'merge_ats_client'
|
|
104
24
|
# setup authorization
|
105
25
|
MergeATSClient.configure do |config|
|
106
26
|
# Configure API key authorization: tokenAuth
|
107
|
-
config.api_key['
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
108
28
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
109
|
-
# config.api_key_prefix['
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
110
30
|
end
|
111
31
|
|
112
32
|
api_instance = MergeATSClient::ScorecardsApi.new
|
@@ -117,6 +37,7 @@ opts = {
|
|
117
37
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
118
38
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
119
39
|
expand: 'application', # 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.
|
120
41
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
121
42
|
interview_id: 'interview_id_example', # String | If provided, will only return scorecards for this interview.
|
122
43
|
interviewer_id: 'interviewer_id_example', # String | If provided, will only return scorecards for this interviewer.
|
@@ -163,6 +84,7 @@ end
|
|
163
84
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
164
85
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
165
86
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
87
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
166
88
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
167
89
|
| **interview_id** | **String** | If provided, will only return scorecards for this interview. | [optional] |
|
168
90
|
| **interviewer_id** | **String** | If provided, will only return scorecards for this interviewer. | [optional] |
|
@@ -201,9 +123,9 @@ require 'merge_ats_client'
|
|
201
123
|
# setup authorization
|
202
124
|
MergeATSClient.configure do |config|
|
203
125
|
# Configure API key authorization: tokenAuth
|
204
|
-
config.api_key['
|
126
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
205
127
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
206
|
-
# config.api_key_prefix['
|
128
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
207
129
|
end
|
208
130
|
|
209
131
|
api_instance = MergeATSClient::ScorecardsApi.new
|
data/docs/SyncStatusApi.md
CHANGED
@@ -5,7 +5,6 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**sync_status_list**](SyncStatusApi.md#sync_status_list) | **GET** /sync-status | |
|
8
|
-
| [**sync_status_resync_create**](SyncStatusApi.md#sync_status_resync_create) | **POST** /sync-status/resync | |
|
9
8
|
|
10
9
|
|
11
10
|
## sync_status_list
|
@@ -14,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
14
13
|
|
15
14
|
|
16
15
|
|
17
|
-
Get syncing status.
|
16
|
+
Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `SYNCING`
|
18
17
|
|
19
18
|
### Examples
|
20
19
|
|
@@ -32,7 +31,7 @@ end
|
|
32
31
|
api_instance = MergeATSClient::SyncStatusApi.new
|
33
32
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
33
|
opts = {
|
35
|
-
cursor:
|
34
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
36
35
|
page_size: 56 # Integer | Number of results to return per page.
|
37
36
|
}
|
38
37
|
|
@@ -68,7 +67,7 @@ end
|
|
68
67
|
| Name | Type | Description | Notes |
|
69
68
|
| ---- | ---- | ----------- | ----- |
|
70
69
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
71
|
-
| **cursor** | **
|
70
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
72
71
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
73
72
|
|
74
73
|
### Return type
|
@@ -84,74 +83,3 @@ end
|
|
84
83
|
- **Content-Type**: Not defined
|
85
84
|
- **Accept**: application/json
|
86
85
|
|
87
|
-
|
88
|
-
## sync_status_resync_create
|
89
|
-
|
90
|
-
> <SyncStatus> sync_status_resync_create(x_account_token)
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
Force re-sync of all models. This is only available for organizations on Merge's Grow and Expand plans.
|
95
|
-
|
96
|
-
### Examples
|
97
|
-
|
98
|
-
```ruby
|
99
|
-
require 'time'
|
100
|
-
require 'merge_ats_client'
|
101
|
-
# setup authorization
|
102
|
-
MergeATSClient.configure do |config|
|
103
|
-
# Configure API key authorization: tokenAuth
|
104
|
-
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
105
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
106
|
-
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
107
|
-
end
|
108
|
-
|
109
|
-
api_instance = MergeATSClient::SyncStatusApi.new
|
110
|
-
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
111
|
-
|
112
|
-
begin
|
113
|
-
|
114
|
-
result = api_instance.sync_status_resync_create(x_account_token)
|
115
|
-
p result
|
116
|
-
rescue MergeATSClient::ApiError => e
|
117
|
-
puts "Error when calling SyncStatusApi->sync_status_resync_create: #{e}"
|
118
|
-
end
|
119
|
-
```
|
120
|
-
|
121
|
-
#### Using the sync_status_resync_create_with_http_info variant
|
122
|
-
|
123
|
-
This returns an Array which contains the response data, status code and headers.
|
124
|
-
|
125
|
-
> <Array(<SyncStatus>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)
|
126
|
-
|
127
|
-
```ruby
|
128
|
-
begin
|
129
|
-
|
130
|
-
data, status_code, headers = api_instance.sync_status_resync_create_with_http_info(x_account_token)
|
131
|
-
p status_code # => 2xx
|
132
|
-
p headers # => { ... }
|
133
|
-
p data # => <SyncStatus>
|
134
|
-
rescue MergeATSClient::ApiError => e
|
135
|
-
puts "Error when calling SyncStatusApi->sync_status_resync_create_with_http_info: #{e}"
|
136
|
-
end
|
137
|
-
```
|
138
|
-
|
139
|
-
### Parameters
|
140
|
-
|
141
|
-
| Name | Type | Description | Notes |
|
142
|
-
| ---- | ---- | ----------- | ----- |
|
143
|
-
| **x_account_token** | **String** | Token identifying the end user. | |
|
144
|
-
|
145
|
-
### Return type
|
146
|
-
|
147
|
-
[**SyncStatus**](SyncStatus.md)
|
148
|
-
|
149
|
-
### Authorization
|
150
|
-
|
151
|
-
[tokenAuth](../README.md#tokenAuth)
|
152
|
-
|
153
|
-
### HTTP request headers
|
154
|
-
|
155
|
-
- **Content-Type**: Not defined
|
156
|
-
- **Accept**: application/json
|
157
|
-
|
data/docs/Tag.md
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
8
8
|
| **name** | **String** | The tag's name. | [optional] |
|
9
9
|
| **remote_data** | **Array<Hash<String, AnyType>>** | | [optional] |
|
10
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional] |
|
10
11
|
|
11
12
|
## Example
|
12
13
|
|
@@ -16,7 +17,8 @@ require 'merge_ats_client'
|
|
16
17
|
instance = MergeATSClient::Tag.new(
|
17
18
|
remote_id: 4567,
|
18
19
|
name: High-Priority,
|
19
|
-
remote_data: [{"path":"/tags","data":["Varies by platform"]}]
|
20
|
+
remote_data: [{"path":"/tags","data":["Varies by platform"]}],
|
21
|
+
remote_was_deleted: null
|
20
22
|
)
|
21
23
|
```
|
22
24
|
|
data/docs/TagsApi.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::TagsApi.new
|
@@ -34,6 +34,7 @@ opts = {
|
|
34
34
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
35
35
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
36
36
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
37
|
+
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
37
38
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
38
39
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
39
40
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -76,6 +77,7 @@ end
|
|
76
77
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
77
78
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
78
79
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
80
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
79
81
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
80
82
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
81
83
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
data/docs/UsersApi.md
CHANGED
@@ -4,90 +4,10 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**users_create**](UsersApi.md#users_create) | **POST** /users | |
|
8
7
|
| [**users_list**](UsersApi.md#users_list) | **GET** /users | |
|
9
8
|
| [**users_retrieve**](UsersApi.md#users_retrieve) | **GET** /users/{id} | |
|
10
9
|
|
11
10
|
|
12
|
-
## users_create
|
13
|
-
|
14
|
-
> <RemoteUser> users_create(x_account_token, remote_user_id, opts)
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
Creates a `RemoteUser` object with the given values.
|
19
|
-
|
20
|
-
### Examples
|
21
|
-
|
22
|
-
```ruby
|
23
|
-
require 'time'
|
24
|
-
require 'merge_ats_client'
|
25
|
-
# setup authorization
|
26
|
-
MergeATSClient.configure do |config|
|
27
|
-
# Configure API key authorization: tokenAuth
|
28
|
-
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
29
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
|
-
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
31
|
-
end
|
32
|
-
|
33
|
-
api_instance = MergeATSClient::UsersApi.new
|
34
|
-
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
35
|
-
remote_user_id = 'remote_user_id_example' # String | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.
|
36
|
-
opts = {
|
37
|
-
run_async: true, # Boolean | Whether or not third-party updates should be run asynchronously.
|
38
|
-
remote_user_request: MergeATSClient::RemoteUserRequest.new # RemoteUserRequest |
|
39
|
-
}
|
40
|
-
|
41
|
-
begin
|
42
|
-
|
43
|
-
result = api_instance.users_create(x_account_token, remote_user_id, opts)
|
44
|
-
p result
|
45
|
-
rescue MergeATSClient::ApiError => e
|
46
|
-
puts "Error when calling UsersApi->users_create: #{e}"
|
47
|
-
end
|
48
|
-
```
|
49
|
-
|
50
|
-
#### Using the users_create_with_http_info variant
|
51
|
-
|
52
|
-
This returns an Array which contains the response data, status code and headers.
|
53
|
-
|
54
|
-
> <Array(<RemoteUser>, Integer, Hash)> users_create_with_http_info(x_account_token, remote_user_id, opts)
|
55
|
-
|
56
|
-
```ruby
|
57
|
-
begin
|
58
|
-
|
59
|
-
data, status_code, headers = api_instance.users_create_with_http_info(x_account_token, remote_user_id, opts)
|
60
|
-
p status_code # => 2xx
|
61
|
-
p headers # => { ... }
|
62
|
-
p data # => <RemoteUser>
|
63
|
-
rescue MergeATSClient::ApiError => e
|
64
|
-
puts "Error when calling UsersApi->users_create_with_http_info: #{e}"
|
65
|
-
end
|
66
|
-
```
|
67
|
-
|
68
|
-
### Parameters
|
69
|
-
|
70
|
-
| Name | Type | Description | Notes |
|
71
|
-
| ---- | ---- | ----------- | ----- |
|
72
|
-
| **x_account_token** | **String** | Token identifying the end user. | |
|
73
|
-
| **remote_user_id** | **String** | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | |
|
74
|
-
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
75
|
-
| **remote_user_request** | [**RemoteUserRequest**](RemoteUserRequest.md) | | [optional] |
|
76
|
-
|
77
|
-
### Return type
|
78
|
-
|
79
|
-
[**RemoteUser**](RemoteUser.md)
|
80
|
-
|
81
|
-
### Authorization
|
82
|
-
|
83
|
-
[tokenAuth](../README.md#tokenAuth)
|
84
|
-
|
85
|
-
### HTTP request headers
|
86
|
-
|
87
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
88
|
-
- **Accept**: application/json
|
89
|
-
|
90
|
-
|
91
11
|
## users_list
|
92
12
|
|
93
13
|
> <PaginatedRemoteUserList> users_list(x_account_token, opts)
|
@@ -104,9 +24,9 @@ require 'merge_ats_client'
|
|
104
24
|
# setup authorization
|
105
25
|
MergeATSClient.configure do |config|
|
106
26
|
# Configure API key authorization: tokenAuth
|
107
|
-
config.api_key['
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
108
28
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
109
|
-
# config.api_key_prefix['
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
110
30
|
end
|
111
31
|
|
112
32
|
api_instance = MergeATSClient::UsersApi.new
|
@@ -116,6 +36,7 @@ opts = {
|
|
116
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
117
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
118
38
|
email: TODO, # String | If provided, will only return remote users with the given email address
|
39
|
+
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
119
40
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
120
41
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
121
42
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -159,6 +80,7 @@ end
|
|
159
80
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
160
81
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
161
82
|
| **email** | [**String**](.md) | If provided, will only return remote users with the given email address | [optional] |
|
83
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
162
84
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
163
85
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
164
86
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
@@ -195,9 +117,9 @@ require 'merge_ats_client'
|
|
195
117
|
# setup authorization
|
196
118
|
MergeATSClient.configure do |config|
|
197
119
|
# Configure API key authorization: tokenAuth
|
198
|
-
config.api_key['
|
120
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
199
121
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
200
|
-
# config.api_key_prefix['
|
122
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
201
123
|
end
|
202
124
|
|
203
125
|
api_instance = MergeATSClient::UsersApi.new
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeATSClient::ValidationProblemSource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **pointer** | **String** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_ats_client'
|
13
|
+
|
14
|
+
instance = MergeATSClient::ValidationProblemSource.new(
|
15
|
+
pointer: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeATSClient::WarningValidationProblem
|
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::WarningValidationProblem.new(
|
18
|
+
source: null,
|
19
|
+
title: Unrecognized Field,
|
20
|
+
detail: An unrecognized field, age, was passed in with request data.,
|
21
|
+
problem_type: UNRECOGNIZED_FIELD
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeATSClient::WebhookReceiver
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **event** | **String** | | |
|
8
|
+
| **is_active** | **Boolean** | | |
|
9
|
+
| **key** | **String** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_ats_client'
|
15
|
+
|
16
|
+
instance = MergeATSClient::WebhookReceiver.new(
|
17
|
+
event: null,
|
18
|
+
is_active: null,
|
19
|
+
key: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|