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
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeATSClient::IgnoreCommonModelRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **reason** | [**ReasonEnum**](ReasonEnum.md) | | |
|
8
|
+
| **message** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_ats_client'
|
14
|
+
|
15
|
+
instance = MergeATSClient::IgnoreCommonModelRequest.new(
|
16
|
+
reason: GENERAL_CUSTOMER_REQUEST,
|
17
|
+
message: deletion request by user id 51903790-7dfe-4053-8d63-5a10cc4ffd39
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/InterviewsApi.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
|
-
| [**interviews_create**](InterviewsApi.md#interviews_create) | **POST** /interviews | |
|
8
7
|
| [**interviews_list**](InterviewsApi.md#interviews_list) | **GET** /interviews | |
|
9
8
|
| [**interviews_retrieve**](InterviewsApi.md#interviews_retrieve) | **GET** /interviews/{id} | |
|
10
9
|
|
11
10
|
|
12
|
-
## interviews_create
|
13
|
-
|
14
|
-
> <ScheduledInterview> interviews_create(x_account_token, remote_user_id, opts)
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
Creates a `ScheduledInterview` 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::InterviewsApi.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
|
-
scheduled_interview_request: MergeATSClient::ScheduledInterviewRequest.new # ScheduledInterviewRequest |
|
39
|
-
}
|
40
|
-
|
41
|
-
begin
|
42
|
-
|
43
|
-
result = api_instance.interviews_create(x_account_token, remote_user_id, opts)
|
44
|
-
p result
|
45
|
-
rescue MergeATSClient::ApiError => e
|
46
|
-
puts "Error when calling InterviewsApi->interviews_create: #{e}"
|
47
|
-
end
|
48
|
-
```
|
49
|
-
|
50
|
-
#### Using the interviews_create_with_http_info variant
|
51
|
-
|
52
|
-
This returns an Array which contains the response data, status code and headers.
|
53
|
-
|
54
|
-
> <Array(<ScheduledInterview>, Integer, Hash)> interviews_create_with_http_info(x_account_token, remote_user_id, opts)
|
55
|
-
|
56
|
-
```ruby
|
57
|
-
begin
|
58
|
-
|
59
|
-
data, status_code, headers = api_instance.interviews_create_with_http_info(x_account_token, remote_user_id, opts)
|
60
|
-
p status_code # => 2xx
|
61
|
-
p headers # => { ... }
|
62
|
-
p data # => <ScheduledInterview>
|
63
|
-
rescue MergeATSClient::ApiError => e
|
64
|
-
puts "Error when calling InterviewsApi->interviews_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
|
-
| **scheduled_interview_request** | [**ScheduledInterviewRequest**](ScheduledInterviewRequest.md) | | [optional] |
|
76
|
-
|
77
|
-
### Return type
|
78
|
-
|
79
|
-
[**ScheduledInterview**](ScheduledInterview.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
|
## interviews_list
|
92
12
|
|
93
13
|
> <PaginatedScheduledInterviewList> interviews_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::InterviewsApi.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
|
job_interview_stage_id: 'job_interview_stage_id_example', # String | If provided, will only return interviews at this stage.
|
122
43
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
@@ -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
|
| **job_interview_stage_id** | **String** | If provided, will only return interviews at this stage. | [optional] |
|
168
90
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [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::InterviewsApi.new
|
data/docs/IssuesApi.md
CHANGED
@@ -31,15 +31,19 @@ end
|
|
31
31
|
|
32
32
|
api_instance = MergeATSClient::IssuesApi.new
|
33
33
|
opts = {
|
34
|
-
account_token: 'account_token_example', # String |
|
35
|
-
cursor:
|
34
|
+
account_token: 'account_token_example', # String |
|
35
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
36
36
|
end_date: 'end_date_example', # String | If included, will only include issues whose most recent action occurred before this time
|
37
|
-
end_user_organization_name: 'end_user_organization_name_example', # String |
|
37
|
+
end_user_organization_name: 'end_user_organization_name_example', # String |
|
38
|
+
first_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
|
39
|
+
first_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
|
38
40
|
include_muted: 'include_muted_example', # String | If True, will include muted issues
|
39
|
-
integration_name: 'integration_name_example', # String |
|
41
|
+
integration_name: 'integration_name_example', # String |
|
42
|
+
last_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
|
43
|
+
last_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
|
40
44
|
page_size: 56, # Integer | Number of results to return per page.
|
41
45
|
start_date: 'start_date_example', # String | If included, will only include issues whose most recent action occurred after this time
|
42
|
-
status: 'ONGOING' # String |
|
46
|
+
status: 'ONGOING' # String |
|
43
47
|
}
|
44
48
|
|
45
49
|
begin
|
@@ -73,15 +77,19 @@ end
|
|
73
77
|
|
74
78
|
| Name | Type | Description | Notes |
|
75
79
|
| ---- | ---- | ----------- | ----- |
|
76
|
-
| **account_token** | **String** |
|
77
|
-
| **cursor** | **
|
80
|
+
| **account_token** | **String** | | [optional] |
|
81
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
78
82
|
| **end_date** | **String** | If included, will only include issues whose most recent action occurred before this time | [optional] |
|
79
|
-
| **end_user_organization_name** | **String** |
|
83
|
+
| **end_user_organization_name** | **String** | | [optional] |
|
84
|
+
| **first_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
|
85
|
+
| **first_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
|
80
86
|
| **include_muted** | **String** | If True, will include muted issues | [optional] |
|
81
|
-
| **integration_name** | **String** |
|
87
|
+
| **integration_name** | **String** | | [optional] |
|
88
|
+
| **last_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
|
89
|
+
| **last_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
|
82
90
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
83
91
|
| **start_date** | **String** | If included, will only include issues whose most recent action occurred after this time | [optional] |
|
84
|
-
| **status** | **String** |
|
92
|
+
| **status** | **String** | | [optional] |
|
85
93
|
|
86
94
|
### Return type
|
87
95
|
|
data/docs/Job.md
CHANGED
@@ -16,7 +16,9 @@
|
|
16
16
|
| **departments** | **Array<String>** | IDs of `Department` objects for this `Job`. | [optional] |
|
17
17
|
| **offices** | **Array<String>** | IDs of `Office` objects for this `Job`. | [optional] |
|
18
18
|
| **hiring_managers** | **Array<String>** | IDs of `RemoteUser` objects that serve as hiring managers for this `Job`. | [optional] |
|
19
|
+
| **recruiters** | **Array<String>** | IDs of RemoteUser objects that serve as recruiters for this Job. | [optional] |
|
19
20
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
21
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
|
20
22
|
|
21
23
|
## Example
|
22
24
|
|
@@ -36,7 +38,9 @@ instance = MergeATSClient::Job.new(
|
|
36
38
|
departments: ["5b3c1341-a20f-4e51-b72c-f3830a16c97b","d6e687d6-0c36-48a1-8114-35324b5cb38f"],
|
37
39
|
offices: ["9871b4a9-f5d2-4f3b-a66b-dfedbed42c46"],
|
38
40
|
hiring_managers: ["787ed912-33ec-444e-a215-8d71cc42fc12"],
|
39
|
-
|
41
|
+
recruiters: ["787ed912-33ec-444e-a215-8d71cc42fc12"],
|
42
|
+
remote_data: [{"path":"/positions","data":["Varies by platform"]}],
|
43
|
+
remote_was_deleted: null
|
40
44
|
)
|
41
45
|
```
|
42
46
|
|
data/docs/JobInterviewStage.md
CHANGED
@@ -7,8 +7,9 @@
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
9
|
| **name** | **String** | The stage's name. | [optional] |
|
10
|
-
| **job** | **String** |
|
10
|
+
| **job** | **String** | | [optional] |
|
11
11
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
12
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
|
12
13
|
|
13
14
|
## Example
|
14
15
|
|
@@ -20,7 +21,8 @@ instance = MergeATSClient::JobInterviewStage.new(
|
|
20
21
|
remote_id: 876556788,
|
21
22
|
name: Phone Screen,
|
22
23
|
job: ba7d9648-5316-4a80-8d73-4e636cef5a90,
|
23
|
-
remote_data: [{"path":"/interview-stages","data":["Varies by platform"]}]
|
24
|
+
remote_data: [{"path":"/interview-stages","data":["Varies by platform"]}],
|
25
|
+
remote_was_deleted: null
|
24
26
|
)
|
25
27
|
```
|
26
28
|
|
@@ -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::JobInterviewStagesApi.new
|
@@ -35,7 +35,8 @@ 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
|
-
expand: '
|
38
|
+
expand: 'job', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
39
|
+
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
39
40
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
40
41
|
job_id: 'job_id_example', # String | If provided, will only return interview stages for this job.
|
41
42
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
@@ -80,6 +81,7 @@ end
|
|
80
81
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
81
82
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
82
83
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
84
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
83
85
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
84
86
|
| **job_id** | **String** | If provided, will only return interview stages for this job. | [optional] |
|
85
87
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
@@ -117,16 +119,16 @@ require 'merge_ats_client'
|
|
117
119
|
# setup authorization
|
118
120
|
MergeATSClient.configure do |config|
|
119
121
|
# Configure API key authorization: tokenAuth
|
120
|
-
config.api_key['
|
122
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
121
123
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
122
|
-
# config.api_key_prefix['
|
124
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
123
125
|
end
|
124
126
|
|
125
127
|
api_instance = MergeATSClient::JobInterviewStagesApi.new
|
126
128
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
127
129
|
id = TODO # String |
|
128
130
|
opts = {
|
129
|
-
expand: '
|
131
|
+
expand: 'job', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
130
132
|
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
131
133
|
}
|
132
134
|
|
data/docs/JobsApi.md
CHANGED
@@ -24,24 +24,26 @@ 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::JobsApi.new
|
33
33
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
34
|
opts = {
|
35
|
+
code: 'code_example', # String | If provided, will only return jobs with this code.
|
35
36
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
37
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
38
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
39
|
expand: 'departments', # 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.
|
39
41
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
40
42
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
41
43
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
42
44
|
page_size: 56, # Integer | Number of results to return per page.
|
43
45
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
44
|
-
status: '
|
46
|
+
status: 'ARCHIVED' # String | If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING')
|
45
47
|
}
|
46
48
|
|
47
49
|
begin
|
@@ -81,6 +83,7 @@ end
|
|
81
83
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
82
84
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
83
85
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
86
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
84
87
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
85
88
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
86
89
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
@@ -118,9 +121,9 @@ require 'merge_ats_client'
|
|
118
121
|
# setup authorization
|
119
122
|
MergeATSClient.configure do |config|
|
120
123
|
# Configure API key authorization: tokenAuth
|
121
|
-
config.api_key['
|
124
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
122
125
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
123
|
-
# config.api_key_prefix['
|
126
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
124
127
|
end
|
125
128
|
|
126
129
|
api_instance = MergeATSClient::JobsApi.new
|
data/docs/LinkTokenApi.md
CHANGED
@@ -23,13 +23,13 @@ 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::LinkTokenApi.new
|
32
|
-
end_user_details_request = MergeATSClient::EndUserDetailsRequest.new({end_user_email_address: 'end_user_email_address_example', end_user_organization_name: 'end_user_organization_name_example', end_user_origin_id: 'end_user_origin_id_example', categories: [
|
32
|
+
end_user_details_request = MergeATSClient::EndUserDetailsRequest.new({end_user_email_address: 'end_user_email_address_example', end_user_organization_name: 'end_user_organization_name_example', end_user_origin_id: 'end_user_origin_id_example', categories: [MergeATSClient::CategoriesEnum::HRIS]}) # EndUserDetailsRequest |
|
33
33
|
|
34
34
|
begin
|
35
35
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeATSClient::LinkedAccountStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **linked_account_status** | **String** | | |
|
8
|
+
| **can_make_request** | **Boolean** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_ats_client'
|
14
|
+
|
15
|
+
instance = MergeATSClient::LinkedAccountStatus.new(
|
16
|
+
linked_account_status: null,
|
17
|
+
can_make_request: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/LinkedAccountsApi.md
CHANGED
@@ -23,23 +23,23 @@ 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::LinkedAccountsApi.new
|
32
32
|
opts = {
|
33
|
-
category: 'accounting', # String |
|
34
|
-
cursor:
|
35
|
-
end_user_email_address: 'end_user_email_address_example', # String |
|
36
|
-
end_user_organization_name: 'end_user_organization_name_example', # String |
|
37
|
-
end_user_origin_id: 'end_user_origin_id_example', # String |
|
38
|
-
end_user_origin_ids: 'end_user_origin_ids_example', # String | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once
|
39
|
-
id: TODO, # String |
|
40
|
-
ids: 'ids_example', # String | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once
|
41
|
-
integration_name: 'integration_name_example', # String |
|
42
|
-
is_test_account: 'is_test_account_example', # String | If included, will only include test linked accounts. If not included, will only include non-test linked accounts
|
33
|
+
category: 'accounting', # String |
|
34
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
35
|
+
end_user_email_address: 'end_user_email_address_example', # String | If provided, will only return linked accounts associated with the given email address.
|
36
|
+
end_user_organization_name: 'end_user_organization_name_example', # String | If provided, will only return linked accounts associated with the given organization name.
|
37
|
+
end_user_origin_id: 'end_user_origin_id_example', # String | If provided, will only return linked accounts associated with the given origin ID.
|
38
|
+
end_user_origin_ids: 'end_user_origin_ids_example', # String | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
|
39
|
+
id: TODO, # String |
|
40
|
+
ids: 'ids_example', # String | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
|
41
|
+
integration_name: 'integration_name_example', # String | If provided, will only return linked accounts associated with the given integration name.
|
42
|
+
is_test_account: 'is_test_account_example', # String | If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
|
43
43
|
page_size: 56, # Integer | Number of results to return per page.
|
44
44
|
status: 'status_example' # String | Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
|
45
45
|
}
|
@@ -75,16 +75,16 @@ end
|
|
75
75
|
|
76
76
|
| Name | Type | Description | Notes |
|
77
77
|
| ---- | ---- | ----------- | ----- |
|
78
|
-
| **category** | **String** |
|
79
|
-
| **cursor** | **
|
80
|
-
| **end_user_email_address** | **String** |
|
81
|
-
| **end_user_organization_name** | **String** |
|
82
|
-
| **end_user_origin_id** | **String** |
|
83
|
-
| **end_user_origin_ids** | **String** | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once | [optional] |
|
84
|
-
| **id** | [**String**](.md) |
|
85
|
-
| **ids** | **String** | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once | [optional] |
|
86
|
-
| **integration_name** | **String** |
|
87
|
-
| **is_test_account** | **String** | If included, will only include test linked accounts. If not included, will only include non-test linked accounts | [optional] |
|
78
|
+
| **category** | **String** | | [optional] |
|
79
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
80
|
+
| **end_user_email_address** | **String** | If provided, will only return linked accounts associated with the given email address. | [optional] |
|
81
|
+
| **end_user_organization_name** | **String** | If provided, will only return linked accounts associated with the given organization name. | [optional] |
|
82
|
+
| **end_user_origin_id** | **String** | If provided, will only return linked accounts associated with the given origin ID. | [optional] |
|
83
|
+
| **end_user_origin_ids** | **String** | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. | [optional] |
|
84
|
+
| **id** | [**String**](.md) | | [optional] |
|
85
|
+
| **ids** | **String** | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. | [optional] |
|
86
|
+
| **integration_name** | **String** | If provided, will only return linked accounts associated with the given integration name. | [optional] |
|
87
|
+
| **is_test_account** | **String** | If included, will only include test linked accounts. If not included, will only include non-test linked accounts. | [optional] |
|
88
88
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
89
89
|
| **status** | **String** | Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED` | [optional] |
|
90
90
|
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeATSClient::MetaResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **request_schema** | [**Hash<String, AnyType>**](AnyType.md) | | |
|
8
|
+
| **status** | [**LinkedAccountStatus**](LinkedAccountStatus.md) | | [optional] |
|
9
|
+
| **has_conditional_params** | **Boolean** | | |
|
10
|
+
| **has_required_linked_account_params** | **Boolean** | | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'merge_ats_client'
|
16
|
+
|
17
|
+
instance = MergeATSClient::MetaResponse.new(
|
18
|
+
request_schema: null,
|
19
|
+
status: null,
|
20
|
+
has_conditional_params: null,
|
21
|
+
has_required_linked_account_params: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# MergeATSClient::MultipartFormFieldRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | The name of the form field | |
|
8
|
+
| **data** | **String** | The data for the form field. | |
|
9
|
+
| **encoding** | [**EncodingEnum**](EncodingEnum.md) | The encoding of the value of `data`. Defaults to `RAW` if not defined. | [optional] |
|
10
|
+
| **file_name** | **String** | The file name of the form field, if the field is for a file. | [optional] |
|
11
|
+
| **content_type** | **String** | The MIME type of the file, if the field is for a file. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'merge_ats_client'
|
17
|
+
|
18
|
+
instance = MergeATSClient::MultipartFormFieldRequest.new(
|
19
|
+
name: resume,
|
20
|
+
data: SW50ZWdyYXRlIGZhc3QKSW50ZWdyYXRlIG9uY2U=,
|
21
|
+
encoding: BASE64,
|
22
|
+
file_name: resume.pdf,
|
23
|
+
content_type: application/pdf
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/Offer.md
CHANGED
@@ -6,14 +6,15 @@
|
|
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
|
-
| **creator** | **String** |
|
9
|
+
| **application** | **String** | | [optional] |
|
10
|
+
| **creator** | **String** | | [optional] |
|
11
11
|
| **remote_created_at** | **Time** | When the third party's offer was created. | [optional] |
|
12
12
|
| **closed_at** | **Time** | When the offer was closed. | [optional] |
|
13
13
|
| **sent_at** | **Time** | When the offer was sent. | [optional] |
|
14
14
|
| **start_date** | **Time** | The employment start date on the offer. | [optional] |
|
15
15
|
| **status** | [**OfferStatusEnum**](OfferStatusEnum.md) | The offer's status. | [optional] |
|
16
16
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
17
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
|
17
18
|
|
18
19
|
## Example
|
19
20
|
|
@@ -30,7 +31,8 @@ instance = MergeATSClient::Offer.new(
|
|
30
31
|
sent_at: 2021-10-15T00:00Z,
|
31
32
|
start_date: 2021-11-15T00:00Z,
|
32
33
|
status: SENT,
|
33
|
-
remote_data: [{"path":"/offers","data":["Varies by platform"]}]
|
34
|
+
remote_data: [{"path":"/offers","data":["Varies by platform"]}],
|
35
|
+
remote_was_deleted: null
|
34
36
|
)
|
35
37
|
```
|
36
38
|
|
data/docs/OffersApi.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::OffersApi.new
|
@@ -38,6 +38,7 @@ opts = {
|
|
38
38
|
creator_id: 'creator_id_example', # String | If provided, will only return offers created by this user.
|
39
39
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
40
40
|
expand: 'application', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
41
|
+
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
41
42
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
42
43
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
43
44
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -83,6 +84,7 @@ end
|
|
83
84
|
| **creator_id** | **String** | If provided, will only return offers created by this user. | [optional] |
|
84
85
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
85
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] |
|
86
88
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
87
89
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
88
90
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
@@ -119,9 +121,9 @@ require 'merge_ats_client'
|
|
119
121
|
# setup authorization
|
120
122
|
MergeATSClient.configure do |config|
|
121
123
|
# Configure API key authorization: tokenAuth
|
122
|
-
config.api_key['
|
124
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
123
125
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
124
|
-
# config.api_key_prefix['
|
126
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
125
127
|
end
|
126
128
|
|
127
129
|
api_instance = MergeATSClient::OffersApi.new
|
data/docs/Office.md
CHANGED
@@ -9,6 +9,7 @@
|
|
9
9
|
| **name** | **String** | The office's name. | [optional] |
|
10
10
|
| **location** | **String** | The office's location. | [optional] |
|
11
11
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
12
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
|
12
13
|
|
13
14
|
## Example
|
14
15
|
|
@@ -20,7 +21,8 @@ instance = MergeATSClient::Office.new(
|
|
20
21
|
remote_id: 876556788,
|
21
22
|
name: SF Office,
|
22
23
|
location: Embarcadero Center 2,
|
23
|
-
remote_data: [{"path":"/locations","data":["Varies by platform"]}]
|
24
|
+
remote_data: [{"path":"/locations","data":["Varies by platform"]}],
|
25
|
+
remote_was_deleted: null
|
24
26
|
)
|
25
27
|
```
|
26
28
|
|
data/docs/OfficesApi.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::OfficesApi.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::OfficesApi.new
|