merge_ats_client 1.0.2 → 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 +53 -17
- data/docs/AccountDetails.md +34 -0
- data/docs/AccountDetailsAndActions.md +34 -0
- data/docs/AccountDetailsAndActionsIntegration.md +32 -0
- data/docs/AccountDetailsAndActionsStatusEnum.md +15 -0
- data/docs/AccountDetailsApi.md +79 -0
- data/docs/AccountIntegration.md +4 -4
- data/docs/AccountTokenApi.md +2 -2
- data/docs/ActivitiesApi.md +6 -4
- data/docs/Activity.md +7 -5
- data/docs/Application.md +12 -8
- data/docs/ApplicationEndpointRequest.md +20 -0
- data/docs/ApplicationRequest.md +16 -8
- 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 +11 -7
- data/docs/CandidateEndpointRequest.md +20 -0
- data/docs/CandidateRequest.md +15 -7
- data/docs/CandidateResponse.md +24 -0
- data/docs/CandidatesApi.md +171 -17
- data/docs/CategoriesEnum.md +15 -0
- data/docs/CategoryEnum.md +15 -0
- data/docs/DataPassthroughRequest.md +8 -4
- data/docs/DebugModeLog.md +22 -0
- data/docs/DebugModelLogSummary.md +22 -0
- data/docs/DeleteAccountApi.md +78 -0
- data/docs/Department.md +3 -1
- data/docs/DepartmentsApi.md +6 -4
- data/docs/EEOC.md +5 -3
- data/docs/EeocsApi.md +6 -4
- data/docs/EmailAddress.md +1 -1
- data/docs/EmailAddressRequest.md +1 -1
- 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/Issue.md +30 -0
- data/docs/IssueStatusEnum.md +15 -0
- data/docs/IssuesApi.md +177 -0
- data/docs/Job.md +13 -7
- data/docs/JobInterviewStage.md +4 -2
- data/docs/JobInterviewStagesApi.md +8 -6
- data/docs/JobsApi.md +9 -5
- data/docs/LinkTokenApi.md +3 -3
- data/docs/LinkedAccountStatus.md +20 -0
- data/docs/LinkedAccountsApi.md +103 -0
- data/docs/MetaResponse.md +24 -0
- data/docs/MultipartFormFieldRequest.md +26 -0
- data/docs/Offer.md +9 -7
- data/docs/OffersApi.md +6 -4
- data/docs/Office.md +3 -1
- data/docs/OfficesApi.md +6 -4
- data/docs/PaginatedAccountDetailsAndActionsList.md +22 -0
- data/docs/PaginatedIssueList.md +22 -0
- data/docs/PaginatedSyncStatusList.md +2 -2
- 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 +4 -2
- data/docs/RequestFormatEnum.md +15 -0
- data/docs/ScheduledInterview.md +11 -9
- data/docs/Scorecard.md +8 -6
- 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 +7 -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 +84 -0
- data/lib/merge_ats_client/api/account_token_api.rb +1 -1
- data/lib/merge_ats_client/api/activities_api.rb +4 -1
- data/lib/merge_ats_client/api/applications_api.rb +87 -16
- data/lib/merge_ats_client/api/attachments_api.rb +95 -16
- data/lib/merge_ats_client/api/available_actions_api.rb +1 -1
- data/lib/merge_ats_client/api/candidates_api.rb +163 -16
- data/lib/merge_ats_client/api/delete_account_api.rb +82 -0
- data/lib/merge_ats_client/api/departments_api.rb +4 -1
- data/lib/merge_ats_client/api/eeocs_api.rb +4 -1
- data/lib/merge_ats_client/api/force_resync_api.rb +84 -0
- data/lib/merge_ats_client/api/generate_key_api.rb +1 -1
- data/lib/merge_ats_client/api/interviews_api.rb +4 -77
- data/lib/merge_ats_client/api/issues_api.rb +181 -0
- data/lib/merge_ats_client/api/job_interview_stages_api.rb +6 -3
- data/lib/merge_ats_client/api/jobs_api.rb +10 -4
- data/lib/merge_ats_client/api/link_token_api.rb +1 -1
- data/lib/merge_ats_client/api/linked_accounts_api.rb +117 -0
- data/lib/merge_ats_client/api/offers_api.rb +4 -1
- data/lib/merge_ats_client/api/offices_api.rb +4 -1
- data/lib/merge_ats_client/api/passthrough_api.rb +1 -1
- data/lib/merge_ats_client/api/regenerate_key_api.rb +1 -1
- data/lib/merge_ats_client/api/reject_reasons_api.rb +4 -1
- data/lib/merge_ats_client/api/scorecards_api.rb +4 -77
- data/lib/merge_ats_client/api/sync_status_api.rb +5 -67
- data/lib/merge_ats_client/api/tags_api.rb +4 -1
- data/lib/merge_ats_client/api/users_api.rb +4 -77
- data/lib/merge_ats_client/api/webhook_receivers_api.rb +154 -0
- data/lib/merge_ats_client/api_client.rb +1 -1
- data/lib/merge_ats_client/api_error.rb +1 -1
- data/lib/merge_ats_client/configuration.rb +7 -5
- data/lib/merge_ats_client/models/access_role_enum.rb +1 -1
- data/lib/merge_ats_client/models/{end_user_details.rb → account_details.rb} +68 -66
- data/lib/merge_ats_client/models/{scheduled_interview_request.rb → account_details_and_actions.rb} +85 -100
- data/lib/merge_ats_client/models/account_details_and_actions_integration.rb +310 -0
- data/lib/merge_ats_client/models/account_details_and_actions_status_enum.rb +36 -0
- data/lib/merge_ats_client/models/account_integration.rb +7 -29
- data/lib/merge_ats_client/models/account_token.rb +2 -2
- data/lib/merge_ats_client/models/activity.rb +17 -8
- data/lib/merge_ats_client/models/activity_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/application.rb +29 -12
- data/lib/merge_ats_client/models/application_endpoint_request.rb +237 -0
- data/lib/merge_ats_client/models/application_request.rb +70 -13
- data/lib/merge_ats_client/models/application_response.rb +266 -0
- data/lib/merge_ats_client/models/attachment.rb +16 -7
- 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 +2 -2
- data/lib/merge_ats_client/models/candidate.rb +32 -7
- data/lib/merge_ats_client/models/candidate_endpoint_request.rb +237 -0
- data/lib/merge_ats_client/models/candidate_request.rb +72 -7
- data/lib/merge_ats_client/models/candidate_response.rb +266 -0
- data/lib/merge_ats_client/models/categories_enum.rb +38 -0
- data/lib/merge_ats_client/models/category_enum.rb +38 -0
- data/lib/merge_ats_client/models/data_passthrough_request.rb +81 -10
- 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 +18 -8
- data/lib/merge_ats_client/models/disability_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/eeoc.rb +17 -8
- data/lib/merge_ats_client/models/email_address.rb +3 -3
- data/lib/merge_ats_client/models/email_address_request.rb +3 -3
- data/lib/merge_ats_client/models/email_address_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/encoding_enum.rb +35 -0
- data/lib/merge_ats_client/models/end_user_details_request.rb +148 -29
- data/lib/merge_ats_client/models/error_validation_problem.rb +260 -0
- data/lib/merge_ats_client/models/gender_enum.rb +1 -1
- data/lib/merge_ats_client/models/generate_remote_key_request.rb +21 -2
- 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/{scorecard_request.rb → issue.rb} +56 -62
- data/lib/merge_ats_client/models/issue_status_enum.rb +35 -0
- data/lib/merge_ats_client/models/job.rb +43 -7
- data/lib/merge_ats_client/models/job_interview_stage.rb +17 -8
- data/lib/merge_ats_client/models/job_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/link_token.rb +2 -2
- data/lib/merge_ats_client/models/linked_account_status.rb +237 -0
- data/lib/merge_ats_client/models/meta_response.rb +262 -0
- data/lib/merge_ats_client/models/method_enum.rb +1 -1
- data/lib/merge_ats_client/models/model_operation.rb +2 -2
- data/lib/merge_ats_client/models/{patched_application_request.rb → multipart_form_field_request.rb} +120 -88
- data/lib/merge_ats_client/models/offer.rb +17 -9
- data/lib/merge_ats_client/models/offer_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/office.rb +18 -8
- data/lib/merge_ats_client/models/overall_recommendation_enum.rb +1 -1
- data/lib/merge_ats_client/models/paginated_account_details_and_actions_list.rb +240 -0
- data/lib/merge_ats_client/models/paginated_activity_list.rb +2 -2
- data/lib/merge_ats_client/models/paginated_application_list.rb +2 -2
- data/lib/merge_ats_client/models/paginated_attachment_list.rb +2 -2
- data/lib/merge_ats_client/models/paginated_candidate_list.rb +2 -2
- data/lib/merge_ats_client/models/paginated_department_list.rb +2 -2
- data/lib/merge_ats_client/models/paginated_eeoc_list.rb +2 -2
- data/lib/merge_ats_client/models/paginated_issue_list.rb +240 -0
- data/lib/merge_ats_client/models/paginated_job_interview_stage_list.rb +2 -2
- data/lib/merge_ats_client/models/paginated_job_list.rb +2 -2
- data/lib/merge_ats_client/models/paginated_offer_list.rb +2 -2
- data/lib/merge_ats_client/models/paginated_office_list.rb +2 -2
- data/lib/merge_ats_client/models/paginated_reject_reason_list.rb +2 -2
- data/lib/merge_ats_client/models/paginated_remote_user_list.rb +2 -2
- data/lib/merge_ats_client/models/paginated_scheduled_interview_list.rb +2 -2
- data/lib/merge_ats_client/models/paginated_scorecard_list.rb +2 -2
- data/lib/merge_ats_client/models/paginated_sync_status_list.rb +1 -1
- data/lib/merge_ats_client/models/paginated_tag_list.rb +2 -2
- data/lib/merge_ats_client/models/phone_number.rb +3 -3
- data/lib/merge_ats_client/models/phone_number_request.rb +3 -3
- data/lib/merge_ats_client/models/phone_number_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/race_enum.rb +1 -1
- data/lib/merge_ats_client/models/reason_enum.rb +36 -0
- data/lib/merge_ats_client/models/reject_reason.rb +18 -8
- data/lib/merge_ats_client/models/remote_data.rb +2 -2
- data/lib/merge_ats_client/models/remote_data_request.rb +21 -2
- data/lib/merge_ats_client/models/remote_key.rb +2 -2
- data/lib/merge_ats_client/models/remote_key_for_regeneration_request.rb +21 -2
- data/lib/merge_ats_client/models/remote_response.rb +2 -2
- data/lib/merge_ats_client/models/remote_user.rb +18 -8
- data/lib/merge_ats_client/models/request_format_enum.rb +36 -0
- data/lib/merge_ats_client/models/scheduled_interview.rb +18 -10
- data/lib/merge_ats_client/models/scheduled_interview_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/scorecard.rb +17 -10
- data/lib/merge_ats_client/models/sync_status.rb +2 -2
- data/lib/merge_ats_client/models/sync_status_status_enum.rb +2 -2
- data/lib/merge_ats_client/models/tag.rb +18 -8
- data/lib/merge_ats_client/models/url.rb +8 -8
- data/lib/merge_ats_client/models/url_request.rb +8 -8
- data/lib/merge_ats_client/models/url_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/{remote_key_for_regeneration.rb → validation_problem_source.rb} +15 -16
- data/lib/merge_ats_client/models/veteran_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/visibility_enum.rb +1 -1
- 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/webhook_receiver_request.rb +280 -0
- data/lib/merge_ats_client/version.rb +1 -1
- data/lib/merge_ats_client.rb +38 -4
- data/merge_ats_client.gemspec +1 -1
- data/spec/api/account_details_api_spec.rb +46 -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 +57 -0
- 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/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/access_role_enum_spec.rb +1 -1
- data/spec/models/{scorecard_request_spec.rb → account_details_and_actions_integration_spec.rb} +19 -13
- data/spec/models/{scheduled_interview_request_spec.rb → account_details_and_actions_spec.rb} +15 -27
- data/spec/models/account_details_and_actions_status_enum_spec.rb +28 -0
- data/spec/models/{patched_application_request_spec.rb → account_details_spec.rb} +16 -16
- 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/categories_enum_spec.rb +28 -0
- data/spec/models/category_enum_spec.rb +28 -0
- 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_account_details_and_actions_list_spec.rb +46 -0
- 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/request_format_enum_spec.rb +28 -0
- 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
- data/spec/spec_helper.rb +1 -1
- metadata +220 -113
- 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/test_ats.rb +0 -22
- data/test_signature.rb +0 -32
@@ -7,8 +7,9 @@
|
|
7
7
|
| **end_user_email_address** | **String** | | |
|
8
8
|
| **end_user_organization_name** | **String** | | |
|
9
9
|
| **end_user_origin_id** | **String** | | |
|
10
|
-
| **categories** | **Array<
|
11
|
-
| **integration** | **String** |
|
10
|
+
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | | |
|
11
|
+
| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token, for examples of slugs see https://www.merge.dev/docs/basics/integration-metadata | [optional] |
|
12
|
+
| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720] for how long this token is valid. Defaults to 30 | [optional][default to 30] |
|
12
13
|
|
13
14
|
## Example
|
14
15
|
|
@@ -20,7 +21,8 @@ instance = MergeATSClient::EndUserDetailsRequest.new(
|
|
20
21
|
end_user_organization_name: null,
|
21
22
|
end_user_origin_id: null,
|
22
23
|
categories: null,
|
23
|
-
integration: null
|
24
|
+
integration: null,
|
25
|
+
link_expiry_mins: null
|
24
26
|
)
|
25
27
|
```
|
26
28
|
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeATSClient::ErrorValidationProblem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **source** | [**ValidationProblemSource**](ValidationProblemSource.md) | | [optional] |
|
8
|
+
| **title** | **String** | | |
|
9
|
+
| **detail** | **String** | | |
|
10
|
+
| **problem_type** | **String** | | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'merge_ats_client'
|
16
|
+
|
17
|
+
instance = MergeATSClient::ErrorValidationProblem.new(
|
18
|
+
source: null,
|
19
|
+
title: Missing Required Field,
|
20
|
+
detail: custom_fields is a required field on model.,
|
21
|
+
problem_type: MISSING_REQUIRED_FIELD
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,79 @@
|
|
1
|
+
# MergeATSClient::ForceResyncApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**sync_status_resync_create**](ForceResyncApi.md#sync_status_resync_create) | **POST** /sync-status/resync | |
|
8
|
+
|
9
|
+
|
10
|
+
## sync_status_resync_create
|
11
|
+
|
12
|
+
> <Array<SyncStatus>> sync_status_resync_create(x_account_token)
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
Force re-sync of all models. This is only available for organizations on Merge's Grow and Expand plans.
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'merge_ats_client'
|
23
|
+
# setup authorization
|
24
|
+
MergeATSClient.configure do |config|
|
25
|
+
# Configure API key authorization: tokenAuth
|
26
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = MergeATSClient::ForceResyncApi.new
|
32
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
33
|
+
|
34
|
+
begin
|
35
|
+
|
36
|
+
result = api_instance.sync_status_resync_create(x_account_token)
|
37
|
+
p result
|
38
|
+
rescue MergeATSClient::ApiError => e
|
39
|
+
puts "Error when calling ForceResyncApi->sync_status_resync_create: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
#### Using the sync_status_resync_create_with_http_info variant
|
44
|
+
|
45
|
+
This returns an Array which contains the response data, status code and headers.
|
46
|
+
|
47
|
+
> <Array(<Array<SyncStatus>>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)
|
48
|
+
|
49
|
+
```ruby
|
50
|
+
begin
|
51
|
+
|
52
|
+
data, status_code, headers = api_instance.sync_status_resync_create_with_http_info(x_account_token)
|
53
|
+
p status_code # => 2xx
|
54
|
+
p headers # => { ... }
|
55
|
+
p data # => <Array<SyncStatus>>
|
56
|
+
rescue MergeATSClient::ApiError => e
|
57
|
+
puts "Error when calling ForceResyncApi->sync_status_resync_create_with_http_info: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
### Parameters
|
62
|
+
|
63
|
+
| Name | Type | Description | Notes |
|
64
|
+
| ---- | ---- | ----------- | ----- |
|
65
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
[**Array<SyncStatus>**](SyncStatus.md)
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
[tokenAuth](../README.md#tokenAuth)
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: Not defined
|
78
|
+
- **Accept**: application/json
|
79
|
+
|
data/docs/GenerateKeyApi.md
CHANGED
@@ -23,9 +23,9 @@ require 'merge_ats_client'
|
|
23
23
|
# setup authorization
|
24
24
|
MergeATSClient.configure do |config|
|
25
25
|
# Configure API key authorization: tokenAuth
|
26
|
-
config.api_key['
|
26
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
27
27
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
-
# config.api_key_prefix['
|
28
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
29
29
|
end
|
30
30
|
|
31
31
|
api_instance = MergeATSClient::GenerateKeyApi.new
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeATSClient::IgnoreCommonModel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **reason** | [**ReasonEnum**](ReasonEnum.md) | | |
|
8
|
+
| **message** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_ats_client'
|
14
|
+
|
15
|
+
instance = MergeATSClient::IgnoreCommonModel.new(
|
16
|
+
reason: GENERAL_CUSTOMER_REQUEST,
|
17
|
+
message: deletion request by user id 51903790-7dfe-4053-8d63-5a10cc4ffd39
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -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/Issue.md
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# MergeATSClient::Issue
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional][readonly] |
|
8
|
+
| **status** | [**IssueStatusEnum**](IssueStatusEnum.md) | | [optional] |
|
9
|
+
| **error_description** | **String** | | |
|
10
|
+
| **end_user** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
11
|
+
| **first_incident_time** | **Time** | | [optional] |
|
12
|
+
| **last_incident_time** | **Time** | | [optional] |
|
13
|
+
| **is_muted** | **Boolean** | | [optional][readonly] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'merge_ats_client'
|
19
|
+
|
20
|
+
instance = MergeATSClient::Issue.new(
|
21
|
+
id: null,
|
22
|
+
status: null,
|
23
|
+
error_description: null,
|
24
|
+
end_user: null,
|
25
|
+
first_incident_time: null,
|
26
|
+
last_incident_time: null,
|
27
|
+
is_muted: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeATSClient::IssueStatusEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'merge_ats_client'
|
12
|
+
|
13
|
+
instance = MergeATSClient::IssueStatusEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/IssuesApi.md
ADDED
@@ -0,0 +1,177 @@
|
|
1
|
+
# MergeATSClient::IssuesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**issues_list**](IssuesApi.md#issues_list) | **GET** /issues | |
|
8
|
+
| [**issues_retrieve**](IssuesApi.md#issues_retrieve) | **GET** /issues/{id} | |
|
9
|
+
|
10
|
+
|
11
|
+
## issues_list
|
12
|
+
|
13
|
+
> <PaginatedIssueList> issues_list(opts)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
Gets issues.
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'merge_ats_client'
|
24
|
+
# setup authorization
|
25
|
+
MergeATSClient.configure do |config|
|
26
|
+
# Configure API key authorization: tokenAuth
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = MergeATSClient::IssuesApi.new
|
33
|
+
opts = {
|
34
|
+
account_token: 'account_token_example', # String |
|
35
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
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 |
|
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.
|
40
|
+
include_muted: 'include_muted_example', # String | If True, will include muted issues
|
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.
|
44
|
+
page_size: 56, # Integer | Number of results to return per page.
|
45
|
+
start_date: 'start_date_example', # String | If included, will only include issues whose most recent action occurred after this time
|
46
|
+
status: 'ONGOING' # String |
|
47
|
+
}
|
48
|
+
|
49
|
+
begin
|
50
|
+
|
51
|
+
result = api_instance.issues_list(opts)
|
52
|
+
p result
|
53
|
+
rescue MergeATSClient::ApiError => e
|
54
|
+
puts "Error when calling IssuesApi->issues_list: #{e}"
|
55
|
+
end
|
56
|
+
```
|
57
|
+
|
58
|
+
#### Using the issues_list_with_http_info variant
|
59
|
+
|
60
|
+
This returns an Array which contains the response data, status code and headers.
|
61
|
+
|
62
|
+
> <Array(<PaginatedIssueList>, Integer, Hash)> issues_list_with_http_info(opts)
|
63
|
+
|
64
|
+
```ruby
|
65
|
+
begin
|
66
|
+
|
67
|
+
data, status_code, headers = api_instance.issues_list_with_http_info(opts)
|
68
|
+
p status_code # => 2xx
|
69
|
+
p headers # => { ... }
|
70
|
+
p data # => <PaginatedIssueList>
|
71
|
+
rescue MergeATSClient::ApiError => e
|
72
|
+
puts "Error when calling IssuesApi->issues_list_with_http_info: #{e}"
|
73
|
+
end
|
74
|
+
```
|
75
|
+
|
76
|
+
### Parameters
|
77
|
+
|
78
|
+
| Name | Type | Description | Notes |
|
79
|
+
| ---- | ---- | ----------- | ----- |
|
80
|
+
| **account_token** | **String** | | [optional] |
|
81
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
82
|
+
| **end_date** | **String** | If included, will only include issues whose most recent action occurred before this time | [optional] |
|
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] |
|
86
|
+
| **include_muted** | **String** | If True, will include muted issues | [optional] |
|
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] |
|
90
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
91
|
+
| **start_date** | **String** | If included, will only include issues whose most recent action occurred after this time | [optional] |
|
92
|
+
| **status** | **String** | | [optional] |
|
93
|
+
|
94
|
+
### Return type
|
95
|
+
|
96
|
+
[**PaginatedIssueList**](PaginatedIssueList.md)
|
97
|
+
|
98
|
+
### Authorization
|
99
|
+
|
100
|
+
[tokenAuth](../README.md#tokenAuth)
|
101
|
+
|
102
|
+
### HTTP request headers
|
103
|
+
|
104
|
+
- **Content-Type**: Not defined
|
105
|
+
- **Accept**: application/json
|
106
|
+
|
107
|
+
|
108
|
+
## issues_retrieve
|
109
|
+
|
110
|
+
> <Issue> issues_retrieve(id)
|
111
|
+
|
112
|
+
|
113
|
+
|
114
|
+
Get a specific issue.
|
115
|
+
|
116
|
+
### Examples
|
117
|
+
|
118
|
+
```ruby
|
119
|
+
require 'time'
|
120
|
+
require 'merge_ats_client'
|
121
|
+
# setup authorization
|
122
|
+
MergeATSClient.configure do |config|
|
123
|
+
# Configure API key authorization: tokenAuth
|
124
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
125
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
126
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
127
|
+
end
|
128
|
+
|
129
|
+
api_instance = MergeATSClient::IssuesApi.new
|
130
|
+
id = TODO # String |
|
131
|
+
|
132
|
+
begin
|
133
|
+
|
134
|
+
result = api_instance.issues_retrieve(id)
|
135
|
+
p result
|
136
|
+
rescue MergeATSClient::ApiError => e
|
137
|
+
puts "Error when calling IssuesApi->issues_retrieve: #{e}"
|
138
|
+
end
|
139
|
+
```
|
140
|
+
|
141
|
+
#### Using the issues_retrieve_with_http_info variant
|
142
|
+
|
143
|
+
This returns an Array which contains the response data, status code and headers.
|
144
|
+
|
145
|
+
> <Array(<Issue>, Integer, Hash)> issues_retrieve_with_http_info(id)
|
146
|
+
|
147
|
+
```ruby
|
148
|
+
begin
|
149
|
+
|
150
|
+
data, status_code, headers = api_instance.issues_retrieve_with_http_info(id)
|
151
|
+
p status_code # => 2xx
|
152
|
+
p headers # => { ... }
|
153
|
+
p data # => <Issue>
|
154
|
+
rescue MergeATSClient::ApiError => e
|
155
|
+
puts "Error when calling IssuesApi->issues_retrieve_with_http_info: #{e}"
|
156
|
+
end
|
157
|
+
```
|
158
|
+
|
159
|
+
### Parameters
|
160
|
+
|
161
|
+
| Name | Type | Description | Notes |
|
162
|
+
| ---- | ---- | ----------- | ----- |
|
163
|
+
| **id** | [**String**](.md) | | |
|
164
|
+
|
165
|
+
### Return type
|
166
|
+
|
167
|
+
[**Issue**](Issue.md)
|
168
|
+
|
169
|
+
### Authorization
|
170
|
+
|
171
|
+
[tokenAuth](../README.md#tokenAuth)
|
172
|
+
|
173
|
+
### HTTP request headers
|
174
|
+
|
175
|
+
- **Content-Type**: Not defined
|
176
|
+
- **Accept**: application/json
|
177
|
+
|
data/docs/Job.md
CHANGED
@@ -8,14 +8,17 @@
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
9
|
| **name** | **String** | The job's name. | [optional] |
|
10
10
|
| **description** | **String** | The job's description. | [optional] |
|
11
|
+
| **code** | **String** | The job's code. Typically an additional identifier used to reference the particular job that is displayed on the ATS. | [optional] |
|
11
12
|
| **status** | [**JobStatusEnum**](JobStatusEnum.md) | The job's status. | [optional] |
|
12
13
|
| **remote_created_at** | **Time** | When the third party's job was created. | [optional] |
|
13
14
|
| **remote_updated_at** | **Time** | When the third party's job was updated. | [optional] |
|
14
15
|
| **confidential** | **Boolean** | Whether the job is confidential. | [optional] |
|
15
|
-
| **departments** | **Array<String>** |
|
16
|
-
| **offices** | **Array<String>** |
|
17
|
-
| **hiring_managers** | **Array<String>** |
|
16
|
+
| **departments** | **Array<String>** | IDs of `Department` objects for this `Job`. | [optional] |
|
17
|
+
| **offices** | **Array<String>** | IDs of `Office` objects for this `Job`. | [optional] |
|
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] |
|
18
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] |
|
19
22
|
|
20
23
|
## Example
|
21
24
|
|
@@ -26,15 +29,18 @@ instance = MergeATSClient::Job.new(
|
|
26
29
|
id: 022a2bef-57e5-4def-8ed2-7c41bd9a5ed8,
|
27
30
|
remote_id: 8765432,
|
28
31
|
name: Software Engineer (Merge is actually hiring btw),
|
29
|
-
description: If you're reading this documentation
|
32
|
+
description: <b>If you're reading this documentation, you might be a good fit for Merge!</b>,
|
33
|
+
code: C0025,
|
30
34
|
status: OPEN,
|
31
|
-
remote_created_at:
|
32
|
-
remote_updated_at:
|
35
|
+
remote_created_at: 2021-10-15T00:00Z,
|
36
|
+
remote_updated_at: 2021-10-16T00:00Z,
|
33
37
|
confidential: true,
|
34
38
|
departments: ["5b3c1341-a20f-4e51-b72c-f3830a16c97b","d6e687d6-0c36-48a1-8114-35324b5cb38f"],
|
35
39
|
offices: ["9871b4a9-f5d2-4f3b-a66b-dfedbed42c46"],
|
36
40
|
hiring_managers: ["787ed912-33ec-444e-a215-8d71cc42fc12"],
|
37
|
-
|
41
|
+
recruiters: ["787ed912-33ec-444e-a215-8d71cc42fc12"],
|
42
|
+
remote_data: [{"path":"/positions","data":["Varies by platform"]}],
|
43
|
+
remote_was_deleted: null
|
38
44
|
)
|
39
45
|
```
|
40
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
|
|