merge_ats_client 2.0.1 → 3.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE.md +16 -0
- data/README.md +186 -167
- data/docs/AccountIntegration.md +6 -2
- data/docs/ActivitiesApi.md +164 -8
- data/docs/Activity.md +12 -6
- data/docs/ActivityEndpointRequest.md +20 -0
- data/docs/ActivityRequest.md +32 -0
- data/docs/ActivityResponse.md +24 -0
- data/docs/Application.md +12 -10
- data/docs/ApplicationRequest.md +5 -9
- data/docs/ApplicationsApi.md +4 -4
- data/docs/Attachment.md +8 -4
- data/docs/AttachmentRequest.md +1 -3
- data/docs/AttachmentsApi.md +13 -9
- data/docs/Candidate.md +8 -6
- data/docs/CandidateRequest.md +1 -9
- data/docs/CandidatesApi.md +16 -13
- data/docs/CommonModelScopesBodyRequest.md +22 -0
- data/docs/ConditionSchema.md +30 -0
- data/docs/ConditionTypeEnum.md +15 -0
- data/docs/DataPassthroughRequest.md +1 -1
- data/docs/Department.md +7 -3
- data/docs/DepartmentsApi.md +4 -4
- data/docs/EEOC.md +12 -8
- data/docs/EeocsApi.md +13 -9
- data/docs/EmailAddress.md +4 -2
- data/docs/EmailAddressRequest.md +6 -2
- data/docs/EnabledActionsEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +5 -3
- data/docs/ForceResyncApi.md +1 -1
- data/docs/InterviewsApi.md +165 -9
- data/docs/Issue.md +10 -8
- data/docs/IssuesApi.md +6 -6
- data/docs/Job.md +8 -4
- data/docs/JobInterviewStage.md +10 -4
- data/docs/JobInterviewStagesApi.md +4 -4
- data/docs/JobsApi.md +16 -10
- data/docs/LinkToken.md +1 -1
- data/docs/LinkedAccountCondition.md +28 -0
- data/docs/LinkedAccountConditionRequest.md +22 -0
- data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/MetaResponse.md +2 -0
- data/docs/MultipartFormFieldRequest.md +1 -1
- data/docs/Offer.md +10 -6
- data/docs/OffersApi.md +13 -9
- data/docs/Office.md +7 -3
- data/docs/OfficesApi.md +4 -4
- data/docs/OperatorSchema.md +20 -0
- data/docs/PaginatedConditionSchemaList.md +22 -0
- data/docs/PhoneNumber.md +4 -2
- data/docs/PhoneNumberRequest.md +6 -2
- data/docs/RejectReason.md +7 -3
- data/docs/RejectReasonsApi.md +4 -4
- data/docs/RemoteUser.md +8 -4
- data/docs/ScheduledInterview.md +11 -7
- data/docs/ScheduledInterviewEndpointRequest.md +20 -0
- data/docs/ScheduledInterviewRequest.md +36 -0
- data/docs/ScheduledInterviewResponse.md +24 -0
- data/docs/Scorecard.md +11 -7
- data/docs/ScorecardsApi.md +13 -9
- data/docs/SelectiveSyncApi.md +233 -0
- data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
- data/docs/SyncStatus.md +3 -1
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tag.md +7 -3
- data/docs/TagsApi.md +4 -4
- data/docs/Url.md +4 -2
- data/docs/UrlRequest.md +6 -2
- data/docs/UsersApi.md +13 -9
- data/lib/merge_ats_client/api/activities_api.rb +160 -8
- data/lib/merge_ats_client/api/applications_api.rb +4 -4
- data/lib/merge_ats_client/api/attachments_api.rb +22 -8
- data/lib/merge_ats_client/api/candidates_api.rb +15 -11
- data/lib/merge_ats_client/api/departments_api.rb +4 -4
- data/lib/merge_ats_client/api/eeocs_api.rb +22 -8
- data/lib/merge_ats_client/api/force_resync_api.rb +2 -2
- data/lib/merge_ats_client/api/interviews_api.rb +160 -8
- data/lib/merge_ats_client/api/issues_api.rb +6 -6
- data/lib/merge_ats_client/api/job_interview_stages_api.rb +4 -4
- data/lib/merge_ats_client/api/jobs_api.rb +27 -10
- data/lib/merge_ats_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_ats_client/api/offers_api.rb +22 -8
- data/lib/merge_ats_client/api/offices_api.rb +4 -4
- data/lib/merge_ats_client/api/reject_reasons_api.rb +4 -4
- data/lib/merge_ats_client/api/scorecards_api.rb +22 -8
- data/lib/merge_ats_client/api/selective_sync_api.rb +225 -0
- data/lib/merge_ats_client/api/sync_status_api.rb +2 -2
- data/lib/merge_ats_client/api/tags_api.rb +4 -4
- data/lib/merge_ats_client/api/users_api.rb +22 -8
- data/lib/merge_ats_client/models/access_role_enum.rb +1 -1
- data/lib/merge_ats_client/models/account_details_and_actions_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/account_integration.rb +30 -8
- data/lib/merge_ats_client/models/activity.rb +50 -16
- data/lib/merge_ats_client/models/activity_endpoint_request.rb +237 -0
- data/lib/merge_ats_client/models/activity_request.rb +300 -0
- data/lib/merge_ats_client/models/activity_response.rb +266 -0
- data/lib/merge_ats_client/models/activity_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/application.rb +40 -26
- data/lib/merge_ats_client/models/application_request.rb +7 -26
- data/lib/merge_ats_client/models/attachment.rb +38 -16
- data/lib/merge_ats_client/models/attachment_request.rb +3 -14
- data/lib/merge_ats_client/models/attachment_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/candidate.rb +36 -27
- data/lib/merge_ats_client/models/candidate_request.rb +3 -49
- data/lib/merge_ats_client/models/categories_enum.rb +4 -2
- data/lib/merge_ats_client/models/category_enum.rb +4 -2
- data/lib/merge_ats_client/models/common_model_scopes_body_request.rb +274 -0
- data/lib/merge_ats_client/models/condition_schema.rb +298 -0
- data/lib/merge_ats_client/models/condition_type_enum.rb +50 -0
- data/lib/merge_ats_client/models/data_passthrough_request.rb +1 -0
- data/lib/merge_ats_client/models/department.rb +36 -14
- data/lib/merge_ats_client/models/disability_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/eeoc.rb +42 -19
- data/lib/merge_ats_client/models/email_address.rb +16 -6
- data/lib/merge_ats_client/models/email_address_request.rb +30 -6
- data/lib/merge_ats_client/models/email_address_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/enabled_actions_enum.rb +45 -0
- data/lib/merge_ats_client/models/encoding_enum.rb +1 -1
- data/lib/merge_ats_client/models/end_user_details_request.rb +20 -7
- data/lib/merge_ats_client/models/gender_enum.rb +1 -1
- data/lib/merge_ats_client/models/issue.rb +16 -4
- data/lib/merge_ats_client/models/job.rb +38 -16
- data/lib/merge_ats_client/models/job_interview_stage.rb +72 -15
- data/lib/merge_ats_client/models/job_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/link_token.rb +0 -5
- data/lib/merge_ats_client/models/linked_account_condition.rb +282 -0
- data/lib/merge_ats_client/models/linked_account_condition_request.rb +269 -0
- data/lib/merge_ats_client/models/linked_account_selective_sync_configuration.rb +221 -0
- data/lib/merge_ats_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
- data/lib/merge_ats_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
- data/lib/merge_ats_client/models/meta_response.rb +12 -1
- data/lib/merge_ats_client/models/method_enum.rb +1 -1
- data/lib/merge_ats_client/models/multipart_form_field_request.rb +1 -1
- data/lib/merge_ats_client/models/offer.rb +40 -16
- data/lib/merge_ats_client/models/offer_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/office.rb +37 -15
- data/lib/merge_ats_client/models/operator_schema.rb +229 -0
- data/lib/merge_ats_client/models/overall_recommendation_enum.rb +1 -1
- data/lib/merge_ats_client/models/paginated_condition_schema_list.rb +240 -0
- data/lib/merge_ats_client/models/phone_number.rb +16 -6
- data/lib/merge_ats_client/models/phone_number_request.rb +30 -6
- 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 +1 -1
- data/lib/merge_ats_client/models/reject_reason.rb +37 -15
- data/lib/merge_ats_client/models/remote_user.rb +38 -16
- data/lib/merge_ats_client/models/request_format_enum.rb +1 -1
- data/lib/merge_ats_client/models/response_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/scheduled_interview.rb +41 -16
- data/lib/merge_ats_client/models/scheduled_interview_endpoint_request.rb +237 -0
- data/lib/merge_ats_client/models/scheduled_interview_request.rb +323 -0
- data/lib/merge_ats_client/models/scheduled_interview_response.rb +266 -0
- data/lib/merge_ats_client/models/scheduled_interview_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/scorecard.rb +41 -16
- data/lib/merge_ats_client/models/selective_sync_configurations_usage_enum.rb +45 -0
- data/lib/merge_ats_client/models/sync_status.rb +13 -4
- data/lib/merge_ats_client/models/sync_status_status_enum.rb +3 -2
- data/lib/merge_ats_client/models/tag.rb +36 -14
- data/lib/merge_ats_client/models/url.rb +17 -7
- data/lib/merge_ats_client/models/url_request.rb +31 -7
- data/lib/merge_ats_client/models/url_type_enum.rb +1 -1
- 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/version.rb +1 -1
- data/lib/merge_ats_client.rb +19 -1
- data/spec/api/activities_api_spec.rb +31 -4
- data/spec/api/applications_api_spec.rb +2 -2
- data/spec/api/attachments_api_spec.rb +6 -4
- data/spec/api/candidates_api_spec.rb +5 -3
- data/spec/api/departments_api_spec.rb +2 -2
- data/spec/api/eeocs_api_spec.rb +6 -4
- data/spec/api/force_resync_api_spec.rb +1 -1
- data/spec/api/interviews_api_spec.rb +31 -4
- data/spec/api/issues_api_spec.rb +3 -3
- data/spec/api/job_interview_stages_api_spec.rb +2 -2
- data/spec/api/jobs_api_spec.rb +8 -5
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/offers_api_spec.rb +6 -4
- data/spec/api/offices_api_spec.rb +2 -2
- data/spec/api/reject_reasons_api_spec.rb +2 -2
- data/spec/api/scorecards_api_spec.rb +6 -4
- data/spec/api/selective_sync_api_spec.rb +72 -0
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/api/tags_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +6 -4
- data/spec/models/account_integration_spec.rb +12 -0
- data/spec/models/{ignore_common_model_spec.rb → activity_endpoint_request_spec.rb} +8 -8
- data/spec/models/activity_request_spec.rb +76 -0
- data/spec/models/activity_response_spec.rb +52 -0
- data/spec/models/activity_spec.rb +19 -1
- data/spec/models/application_request_spec.rb +0 -12
- data/spec/models/application_spec.rb +9 -3
- data/spec/models/attachment_request_spec.rb +0 -6
- data/spec/models/attachment_spec.rb +14 -2
- data/spec/models/candidate_request_spec.rb +0 -24
- data/spec/models/candidate_spec.rb +9 -3
- data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
- data/spec/models/condition_schema_spec.rb +70 -0
- data/spec/models/condition_type_enum_spec.rb +28 -0
- data/spec/models/department_spec.rb +14 -2
- data/spec/models/eeoc_spec.rb +14 -2
- data/spec/models/email_address_request_spec.rb +12 -0
- data/spec/models/email_address_spec.rb +6 -0
- data/spec/models/enabled_actions_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/issue_spec.rb +6 -0
- data/spec/models/job_interview_stage_spec.rb +19 -1
- data/spec/models/job_spec.rb +14 -2
- data/spec/models/linked_account_condition_request_spec.rb +46 -0
- data/spec/models/linked_account_condition_spec.rb +64 -0
- data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
- data/spec/models/meta_response_spec.rb +6 -0
- data/spec/models/offer_spec.rb +14 -2
- data/spec/models/office_spec.rb +14 -2
- data/spec/models/{remote_data_request_spec.rb → operator_schema_spec.rb} +8 -8
- data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
- data/spec/models/phone_number_request_spec.rb +12 -0
- data/spec/models/phone_number_spec.rb +6 -0
- data/spec/models/reject_reason_spec.rb +14 -2
- data/spec/models/remote_user_spec.rb +14 -2
- data/spec/models/scheduled_interview_endpoint_request_spec.rb +40 -0
- data/spec/models/scheduled_interview_request_spec.rb +88 -0
- data/spec/models/scheduled_interview_response_spec.rb +52 -0
- data/spec/models/scheduled_interview_spec.rb +14 -2
- data/spec/models/scorecard_spec.rb +14 -2
- data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
- data/spec/models/sync_status_spec.rb +6 -0
- data/spec/models/tag_spec.rb +14 -2
- data/spec/models/url_request_spec.rb +12 -0
- data/spec/models/url_spec.rb +6 -0
- metadata +182 -109
data/docs/RejectReason.md
CHANGED
@@ -7,8 +7,10 @@
|
|
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 rejection reason’s name. | [optional] |
|
10
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
11
10
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
11
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
12
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
13
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
12
14
|
|
13
15
|
## Example
|
14
16
|
|
@@ -19,8 +21,10 @@ instance = MergeATSClient::RejectReason.new(
|
|
19
21
|
id: 8be99a4a-f8d4-4339-bf1e-30eac970e217,
|
20
22
|
remote_id: 876556788,
|
21
23
|
name: Not passionate enough about APIs.,
|
22
|
-
|
23
|
-
|
24
|
+
remote_was_deleted: null,
|
25
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
26
|
+
modified_at: 2021-10-16T00:00Z,
|
27
|
+
remote_data: [{"path":"/rejection-reasons","data":["Varies by platform"]}]
|
24
28
|
)
|
25
29
|
```
|
26
30
|
|
data/docs/RejectReasonsApi.md
CHANGED
@@ -37,8 +37,8 @@ opts = {
|
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
38
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
39
39
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
40
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
41
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
40
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
41
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
42
42
|
page_size: 56, # Integer | Number of results to return per page.
|
43
43
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
44
44
|
}
|
@@ -80,8 +80,8 @@ end
|
|
80
80
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
81
81
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
82
82
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
83
|
-
| **modified_after** | **Time** | If provided,
|
84
|
-
| **modified_before** | **Time** | If provided,
|
83
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
84
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
85
85
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
86
86
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
87
87
|
|
data/docs/RemoteUser.md
CHANGED
@@ -11,9 +11,11 @@
|
|
11
11
|
| **email** | **String** | The user's email. | [optional] |
|
12
12
|
| **disabled** | **Boolean** | Whether the user's account had been disabled. | [optional] |
|
13
13
|
| **remote_created_at** | **Time** | When the third party's user was created. | [optional] |
|
14
|
-
| **access_role** | [**AccessRoleEnum**](AccessRoleEnum.md) | The user's role. | [optional] |
|
15
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
14
|
+
| **access_role** | [**AccessRoleEnum**](AccessRoleEnum.md) | The user's role. * `SUPER_ADMIN` - SUPER_ADMIN * `ADMIN` - ADMIN * `TEAM_MEMBER` - TEAM_MEMBER * `LIMITED_TEAM_MEMBER` - LIMITED_TEAM_MEMBER * `INTERVIEWER` - INTERVIEWER | [optional] |
|
16
15
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
16
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
17
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
18
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
17
19
|
|
18
20
|
## Example
|
19
21
|
|
@@ -29,8 +31,10 @@ instance = MergeATSClient::RemoteUser.new(
|
|
29
31
|
disabled: null,
|
30
32
|
remote_created_at: 2020-11-10T00:00Z,
|
31
33
|
access_role: SUPER_ADMIN,
|
32
|
-
|
33
|
-
|
34
|
+
remote_was_deleted: null,
|
35
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
36
|
+
modified_at: 2021-10-16T00:00Z,
|
37
|
+
remote_data: [{"path":"/users","data":["Varies by platform"]}]
|
34
38
|
)
|
35
39
|
```
|
36
40
|
|
data/docs/ScheduledInterview.md
CHANGED
@@ -6,18 +6,20 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
-
| **application** | **String** |
|
10
|
-
| **job_interview_stage** | **String** |
|
11
|
-
| **organizer** | **String** |
|
9
|
+
| **application** | **String** | The application being interviewed. | [optional] |
|
10
|
+
| **job_interview_stage** | **String** | The stage of the interview. | [optional] |
|
11
|
+
| **organizer** | **String** | The user organizing the interview. | [optional] |
|
12
12
|
| **interviewers** | **Array<String>** | Array of `RemoteUser` IDs. | [optional] |
|
13
13
|
| **location** | **String** | The interview's location. | [optional] |
|
14
14
|
| **start_at** | **Time** | When the interview was started. | [optional] |
|
15
15
|
| **end_at** | **Time** | When the interview was ended. | [optional] |
|
16
16
|
| **remote_created_at** | **Time** | When the third party's interview was created. | [optional] |
|
17
17
|
| **remote_updated_at** | **Time** | When the third party's interview was updated. | [optional] |
|
18
|
-
| **status** | [**ScheduledInterviewStatusEnum**](ScheduledInterviewStatusEnum.md) | The interview's status. | [optional] |
|
19
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
18
|
+
| **status** | [**ScheduledInterviewStatusEnum**](ScheduledInterviewStatusEnum.md) | The interview's status. * `SCHEDULED` - SCHEDULED * `AWAITING_FEEDBACK` - AWAITING_FEEDBACK * `COMPLETE` - COMPLETE | [optional] |
|
20
19
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
20
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
21
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
22
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
21
23
|
|
22
24
|
## Example
|
23
25
|
|
@@ -37,8 +39,10 @@ instance = MergeATSClient::ScheduledInterview.new(
|
|
37
39
|
remote_created_at: 2021-10-15T00:00Z,
|
38
40
|
remote_updated_at: 2021-10-15T00:00Z,
|
39
41
|
status: SCHEDULED,
|
40
|
-
|
41
|
-
|
42
|
+
remote_was_deleted: null,
|
43
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
44
|
+
modified_at: 2021-10-16T00:00Z,
|
45
|
+
remote_data: [{"path":"/interviews","data":["Varies by platform"]}]
|
42
46
|
)
|
43
47
|
```
|
44
48
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeATSClient::ScheduledInterviewEndpointRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**ScheduledInterviewRequest**](ScheduledInterviewRequest.md) | | |
|
8
|
+
| **remote_user_id** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_ats_client'
|
14
|
+
|
15
|
+
instance = MergeATSClient::ScheduledInterviewEndpointRequest.new(
|
16
|
+
model: null,
|
17
|
+
remote_user_id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# MergeATSClient::ScheduledInterviewRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **application** | **String** | The application being interviewed. | [optional] |
|
8
|
+
| **job_interview_stage** | **String** | The stage of the interview. | [optional] |
|
9
|
+
| **organizer** | **String** | The user organizing the interview. | [optional] |
|
10
|
+
| **interviewers** | **Array<String>** | Array of `RemoteUser` IDs. | [optional] |
|
11
|
+
| **location** | **String** | The interview's location. | [optional] |
|
12
|
+
| **start_at** | **Time** | When the interview was started. | [optional] |
|
13
|
+
| **end_at** | **Time** | When the interview was ended. | [optional] |
|
14
|
+
| **status** | [**ScheduledInterviewStatusEnum**](ScheduledInterviewStatusEnum.md) | The interview's status. * `SCHEDULED` - SCHEDULED * `AWAITING_FEEDBACK` - AWAITING_FEEDBACK * `COMPLETE` - COMPLETE | [optional] |
|
15
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
16
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'merge_ats_client'
|
22
|
+
|
23
|
+
instance = MergeATSClient::ScheduledInterviewRequest.new(
|
24
|
+
application: 92e8a369-fffe-430d-b93a-f7e8a16563f1,
|
25
|
+
job_interview_stage: 2f7adb59-3fe6-4b5b-aef6-563f72bd13dc,
|
26
|
+
organizer: 52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633,
|
27
|
+
interviewers: ["f9813dd5-e70b-484c-91d8-00acd6065b07","89a86fcf-d540-4e6b-ac3d-ce07c4ec9b3c"],
|
28
|
+
location: Embarcadero Center 2,
|
29
|
+
start_at: 2021-10-15T00:00Z,
|
30
|
+
end_at: 2021-10-15T02:00Z,
|
31
|
+
status: SCHEDULED,
|
32
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
33
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeATSClient::ScheduledInterviewResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**ScheduledInterview**](ScheduledInterview.md) | | |
|
8
|
+
| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) | | |
|
9
|
+
| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) | | |
|
10
|
+
| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'merge_ats_client'
|
16
|
+
|
17
|
+
instance = MergeATSClient::ScheduledInterviewResponse.new(
|
18
|
+
model: null,
|
19
|
+
warnings: null,
|
20
|
+
errors: null,
|
21
|
+
logs: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/Scorecard.md
CHANGED
@@ -6,14 +6,16 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
-
| **application** | **String** |
|
10
|
-
| **interview** | **String** |
|
11
|
-
| **interviewer** | **String** |
|
9
|
+
| **application** | **String** | The application being scored. | [optional] |
|
10
|
+
| **interview** | **String** | The interview being scored. | [optional] |
|
11
|
+
| **interviewer** | **String** | The interviewer doing the scoring. | [optional] |
|
12
12
|
| **remote_created_at** | **Time** | When the third party's scorecard was created. | [optional] |
|
13
13
|
| **submitted_at** | **Time** | When the scorecard was submitted. | [optional] |
|
14
|
-
| **overall_recommendation** | [**OverallRecommendationEnum**](OverallRecommendationEnum.md) | The inteviewer's recommendation. | [optional] |
|
15
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
14
|
+
| **overall_recommendation** | [**OverallRecommendationEnum**](OverallRecommendationEnum.md) | The inteviewer's recommendation. * `DEFINITELY_NO` - DEFINITELY_NO * `NO` - NO * `YES` - YES * `STRONG_YES` - STRONG_YES * `NO_DECISION` - NO_DECISION | [optional] |
|
16
15
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
16
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
17
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
18
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
17
19
|
|
18
20
|
## Example
|
19
21
|
|
@@ -29,8 +31,10 @@ instance = MergeATSClient::Scorecard.new(
|
|
29
31
|
remote_created_at: 2021-10-15T00:00Z,
|
30
32
|
submitted_at: 2021-10-15T00:00Z,
|
31
33
|
overall_recommendation: STRONG_YES,
|
32
|
-
|
33
|
-
|
34
|
+
remote_was_deleted: null,
|
35
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
36
|
+
modified_at: 2021-10-16T00:00Z,
|
37
|
+
remote_data: [{"path":"/ratings","data":["Varies by platform"]}]
|
34
38
|
)
|
35
39
|
```
|
36
40
|
|
data/docs/ScorecardsApi.md
CHANGED
@@ -41,11 +41,12 @@ opts = {
|
|
41
41
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
42
42
|
interview_id: 'interview_id_example', # String | If provided, will only return scorecards for this interview.
|
43
43
|
interviewer_id: 'interviewer_id_example', # String | If provided, will only return scorecards for this interviewer.
|
44
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
45
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
44
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
45
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
46
46
|
page_size: 56, # Integer | Number of results to return per page.
|
47
|
-
remote_fields: 'overall_recommendation', # String |
|
48
|
-
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
47
|
+
remote_fields: 'overall_recommendation', # String | Deprecated. Use show_enum_origins.
|
48
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
49
|
+
show_enum_origins: 'overall_recommendation' # String | Which fields should be returned in non-normalized form.
|
49
50
|
}
|
50
51
|
|
51
52
|
begin
|
@@ -89,11 +90,12 @@ end
|
|
89
90
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
90
91
|
| **interview_id** | **String** | If provided, will only return scorecards for this interview. | [optional] |
|
91
92
|
| **interviewer_id** | **String** | If provided, will only return scorecards for this interviewer. | [optional] |
|
92
|
-
| **modified_after** | **Time** | If provided,
|
93
|
-
| **modified_before** | **Time** | If provided,
|
93
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
94
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
94
95
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
95
|
-
| **remote_fields** | **String** |
|
96
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
96
97
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
98
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
97
99
|
|
98
100
|
### Return type
|
99
101
|
|
@@ -136,7 +138,8 @@ id = TODO # String |
|
|
136
138
|
opts = {
|
137
139
|
expand: 'application', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
138
140
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
139
|
-
remote_fields: 'overall_recommendation' # String |
|
141
|
+
remote_fields: 'overall_recommendation', # String | Deprecated. Use show_enum_origins.
|
142
|
+
show_enum_origins: 'overall_recommendation' # String | Which fields should be returned in non-normalized form.
|
140
143
|
}
|
141
144
|
|
142
145
|
begin
|
@@ -174,7 +177,8 @@ end
|
|
174
177
|
| **id** | [**String**](.md) | | |
|
175
178
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
176
179
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
177
|
-
| **remote_fields** | **String** |
|
180
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
181
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
178
182
|
|
179
183
|
### Return type
|
180
184
|
|
@@ -0,0 +1,233 @@
|
|
1
|
+
# MergeATSClient::SelectiveSyncApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**selective_sync_configurations_list**](SelectiveSyncApi.md#selective_sync_configurations_list) | **GET** /selective-sync/configurations | |
|
8
|
+
| [**selective_sync_configurations_update**](SelectiveSyncApi.md#selective_sync_configurations_update) | **PUT** /selective-sync/configurations | |
|
9
|
+
| [**selective_sync_meta_list**](SelectiveSyncApi.md#selective_sync_meta_list) | **GET** /selective-sync/meta | |
|
10
|
+
|
11
|
+
|
12
|
+
## selective_sync_configurations_list
|
13
|
+
|
14
|
+
> <Array<LinkedAccountSelectiveSyncConfiguration>> selective_sync_configurations_list(x_account_token)
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
Get a linked account's selective syncs.
|
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::SelectiveSyncApi.new
|
34
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
35
|
+
|
36
|
+
begin
|
37
|
+
|
38
|
+
result = api_instance.selective_sync_configurations_list(x_account_token)
|
39
|
+
p result
|
40
|
+
rescue MergeATSClient::ApiError => e
|
41
|
+
puts "Error when calling SelectiveSyncApi->selective_sync_configurations_list: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
#### Using the selective_sync_configurations_list_with_http_info variant
|
46
|
+
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
48
|
+
|
49
|
+
> <Array(<Array<LinkedAccountSelectiveSyncConfiguration>>, Integer, Hash)> selective_sync_configurations_list_with_http_info(x_account_token)
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
begin
|
53
|
+
|
54
|
+
data, status_code, headers = api_instance.selective_sync_configurations_list_with_http_info(x_account_token)
|
55
|
+
p status_code # => 2xx
|
56
|
+
p headers # => { ... }
|
57
|
+
p data # => <Array<LinkedAccountSelectiveSyncConfiguration>>
|
58
|
+
rescue MergeATSClient::ApiError => e
|
59
|
+
puts "Error when calling SelectiveSyncApi->selective_sync_configurations_list_with_http_info: #{e}"
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
### Parameters
|
64
|
+
|
65
|
+
| Name | Type | Description | Notes |
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
67
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
[**Array<LinkedAccountSelectiveSyncConfiguration>**](LinkedAccountSelectiveSyncConfiguration.md)
|
72
|
+
|
73
|
+
### Authorization
|
74
|
+
|
75
|
+
[tokenAuth](../README.md#tokenAuth)
|
76
|
+
|
77
|
+
### HTTP request headers
|
78
|
+
|
79
|
+
- **Content-Type**: Not defined
|
80
|
+
- **Accept**: application/json
|
81
|
+
|
82
|
+
|
83
|
+
## selective_sync_configurations_update
|
84
|
+
|
85
|
+
> <Array<LinkedAccountSelectiveSyncConfiguration>> selective_sync_configurations_update(x_account_token, linked_account_selective_sync_configuration_list_request)
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
Replace a linked account's selective syncs.
|
90
|
+
|
91
|
+
### Examples
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
require 'time'
|
95
|
+
require 'merge_ats_client'
|
96
|
+
# setup authorization
|
97
|
+
MergeATSClient.configure do |config|
|
98
|
+
# Configure API key authorization: tokenAuth
|
99
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
100
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
101
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
102
|
+
end
|
103
|
+
|
104
|
+
api_instance = MergeATSClient::SelectiveSyncApi.new
|
105
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
106
|
+
linked_account_selective_sync_configuration_list_request = MergeATSClient::LinkedAccountSelectiveSyncConfigurationListRequest.new({sync_configurations: [MergeATSClient::LinkedAccountSelectiveSyncConfigurationRequest.new({linked_account_conditions: [MergeATSClient::LinkedAccountConditionRequest.new({condition_schema_id: 'condition_schema_id_example', operator: 'operator_example', value: TODO})]})]}) # LinkedAccountSelectiveSyncConfigurationListRequest |
|
107
|
+
|
108
|
+
begin
|
109
|
+
|
110
|
+
result = api_instance.selective_sync_configurations_update(x_account_token, linked_account_selective_sync_configuration_list_request)
|
111
|
+
p result
|
112
|
+
rescue MergeATSClient::ApiError => e
|
113
|
+
puts "Error when calling SelectiveSyncApi->selective_sync_configurations_update: #{e}"
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
#### Using the selective_sync_configurations_update_with_http_info variant
|
118
|
+
|
119
|
+
This returns an Array which contains the response data, status code and headers.
|
120
|
+
|
121
|
+
> <Array(<Array<LinkedAccountSelectiveSyncConfiguration>>, Integer, Hash)> selective_sync_configurations_update_with_http_info(x_account_token, linked_account_selective_sync_configuration_list_request)
|
122
|
+
|
123
|
+
```ruby
|
124
|
+
begin
|
125
|
+
|
126
|
+
data, status_code, headers = api_instance.selective_sync_configurations_update_with_http_info(x_account_token, linked_account_selective_sync_configuration_list_request)
|
127
|
+
p status_code # => 2xx
|
128
|
+
p headers # => { ... }
|
129
|
+
p data # => <Array<LinkedAccountSelectiveSyncConfiguration>>
|
130
|
+
rescue MergeATSClient::ApiError => e
|
131
|
+
puts "Error when calling SelectiveSyncApi->selective_sync_configurations_update_with_http_info: #{e}"
|
132
|
+
end
|
133
|
+
```
|
134
|
+
|
135
|
+
### Parameters
|
136
|
+
|
137
|
+
| Name | Type | Description | Notes |
|
138
|
+
| ---- | ---- | ----------- | ----- |
|
139
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
140
|
+
| **linked_account_selective_sync_configuration_list_request** | [**LinkedAccountSelectiveSyncConfigurationListRequest**](LinkedAccountSelectiveSyncConfigurationListRequest.md) | | |
|
141
|
+
|
142
|
+
### Return type
|
143
|
+
|
144
|
+
[**Array<LinkedAccountSelectiveSyncConfiguration>**](LinkedAccountSelectiveSyncConfiguration.md)
|
145
|
+
|
146
|
+
### Authorization
|
147
|
+
|
148
|
+
[tokenAuth](../README.md#tokenAuth)
|
149
|
+
|
150
|
+
### HTTP request headers
|
151
|
+
|
152
|
+
- **Content-Type**: application/json
|
153
|
+
- **Accept**: application/json
|
154
|
+
|
155
|
+
|
156
|
+
## selective_sync_meta_list
|
157
|
+
|
158
|
+
> <PaginatedConditionSchemaList> selective_sync_meta_list(x_account_token, opts)
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
Get metadata for the conditions available to a linked account.
|
163
|
+
|
164
|
+
### Examples
|
165
|
+
|
166
|
+
```ruby
|
167
|
+
require 'time'
|
168
|
+
require 'merge_ats_client'
|
169
|
+
# setup authorization
|
170
|
+
MergeATSClient.configure do |config|
|
171
|
+
# Configure API key authorization: tokenAuth
|
172
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
173
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
174
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
175
|
+
end
|
176
|
+
|
177
|
+
api_instance = MergeATSClient::SelectiveSyncApi.new
|
178
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
179
|
+
opts = {
|
180
|
+
common_model: 'common_model_example', # String |
|
181
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
182
|
+
page_size: 56 # Integer | Number of results to return per page.
|
183
|
+
}
|
184
|
+
|
185
|
+
begin
|
186
|
+
|
187
|
+
result = api_instance.selective_sync_meta_list(x_account_token, opts)
|
188
|
+
p result
|
189
|
+
rescue MergeATSClient::ApiError => e
|
190
|
+
puts "Error when calling SelectiveSyncApi->selective_sync_meta_list: #{e}"
|
191
|
+
end
|
192
|
+
```
|
193
|
+
|
194
|
+
#### Using the selective_sync_meta_list_with_http_info variant
|
195
|
+
|
196
|
+
This returns an Array which contains the response data, status code and headers.
|
197
|
+
|
198
|
+
> <Array(<PaginatedConditionSchemaList>, Integer, Hash)> selective_sync_meta_list_with_http_info(x_account_token, opts)
|
199
|
+
|
200
|
+
```ruby
|
201
|
+
begin
|
202
|
+
|
203
|
+
data, status_code, headers = api_instance.selective_sync_meta_list_with_http_info(x_account_token, opts)
|
204
|
+
p status_code # => 2xx
|
205
|
+
p headers # => { ... }
|
206
|
+
p data # => <PaginatedConditionSchemaList>
|
207
|
+
rescue MergeATSClient::ApiError => e
|
208
|
+
puts "Error when calling SelectiveSyncApi->selective_sync_meta_list_with_http_info: #{e}"
|
209
|
+
end
|
210
|
+
```
|
211
|
+
|
212
|
+
### Parameters
|
213
|
+
|
214
|
+
| Name | Type | Description | Notes |
|
215
|
+
| ---- | ---- | ----------- | ----- |
|
216
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
217
|
+
| **common_model** | **String** | | [optional] |
|
218
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
219
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
220
|
+
|
221
|
+
### Return type
|
222
|
+
|
223
|
+
[**PaginatedConditionSchemaList**](PaginatedConditionSchemaList.md)
|
224
|
+
|
225
|
+
### Authorization
|
226
|
+
|
227
|
+
[tokenAuth](../README.md#tokenAuth)
|
228
|
+
|
229
|
+
### HTTP request headers
|
230
|
+
|
231
|
+
- **Content-Type**: Not defined
|
232
|
+
- **Accept**: application/json
|
233
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeATSClient::SelectiveSyncConfigurationsUsageEnum
|
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::SelectiveSyncConfigurationsUsageEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/SyncStatus.md
CHANGED
@@ -10,6 +10,7 @@
|
|
10
10
|
| **next_sync_start** | **Time** | | [optional] |
|
11
11
|
| **status** | [**SyncStatusStatusEnum**](SyncStatusStatusEnum.md) | | |
|
12
12
|
| **is_initial_sync** | **Boolean** | | |
|
13
|
+
| **selective_sync_configurations_usage** | [**SelectiveSyncConfigurationsUsageEnum**](SelectiveSyncConfigurationsUsageEnum.md) | | [optional] |
|
13
14
|
|
14
15
|
## Example
|
15
16
|
|
@@ -22,7 +23,8 @@ instance = MergeATSClient::SyncStatus.new(
|
|
22
23
|
last_sync_start: 2021-03-30T19:44:18.695973Z,
|
23
24
|
next_sync_start: 2021-03-30T20:44:18.662942Z,
|
24
25
|
status: SYNCING,
|
25
|
-
is_initial_sync: true
|
26
|
+
is_initial_sync: true,
|
27
|
+
selective_sync_configurations_usage: null
|
26
28
|
)
|
27
29
|
```
|
28
30
|
|
data/docs/SyncStatusApi.md
CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
13
13
|
|
14
14
|
|
15
15
|
|
16
|
-
Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PAUSED`, `SYNCING`
|
16
|
+
Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`
|
17
17
|
|
18
18
|
### Examples
|
19
19
|
|
data/docs/Tag.md
CHANGED
@@ -6,8 +6,10 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
8
8
|
| **name** | **String** | The tag's name. | [optional] |
|
9
|
-
| **remote_data** | **Array<Hash<String, AnyType>>** | | [optional] |
|
10
9
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
10
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
11
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
12
|
+
| **remote_data** | **Array<Hash<String, AnyType>>** | | [optional] |
|
11
13
|
|
12
14
|
## Example
|
13
15
|
|
@@ -17,8 +19,10 @@ require 'merge_ats_client'
|
|
17
19
|
instance = MergeATSClient::Tag.new(
|
18
20
|
remote_id: 4567,
|
19
21
|
name: High-Priority,
|
20
|
-
|
21
|
-
|
22
|
+
remote_was_deleted: null,
|
23
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
24
|
+
modified_at: 2021-10-16T00:00Z,
|
25
|
+
remote_data: [{"path":"/tags","data":["Varies by platform"]}]
|
22
26
|
)
|
23
27
|
```
|
24
28
|
|
data/docs/TagsApi.md
CHANGED
@@ -36,8 +36,8 @@ opts = {
|
|
36
36
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
37
37
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
38
38
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
39
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
40
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
39
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
40
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
41
41
|
page_size: 56, # Integer | Number of results to return per page.
|
42
42
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
43
43
|
}
|
@@ -79,8 +79,8 @@ end
|
|
79
79
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
80
80
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
81
81
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
82
|
-
| **modified_after** | **Time** | If provided,
|
83
|
-
| **modified_before** | **Time** | If provided,
|
82
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
83
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
84
84
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
85
85
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
86
86
|
|
data/docs/Url.md
CHANGED
@@ -5,7 +5,8 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **value** | **String** | The site's url. | [optional] |
|
8
|
-
| **url_type** | [**UrlTypeEnum**](UrlTypeEnum.md) | The type of site. | [optional] |
|
8
|
+
| **url_type** | [**UrlTypeEnum**](UrlTypeEnum.md) | The type of site. * `PERSONAL` - PERSONAL * `COMPANY` - COMPANY * `PORTFOLIO` - PORTFOLIO * `BLOG` - BLOG * `SOCIAL_MEDIA` - SOCIAL_MEDIA * `OTHER` - OTHER * `JOB_POSTING` - JOB_POSTING | [optional] |
|
9
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
9
10
|
|
10
11
|
## Example
|
11
12
|
|
@@ -14,7 +15,8 @@ require 'merge_ats_client'
|
|
14
15
|
|
15
16
|
instance = MergeATSClient::Url.new(
|
16
17
|
value: http://alturl.com/p749b,
|
17
|
-
url_type: PERSONAL
|
18
|
+
url_type: PERSONAL,
|
19
|
+
modified_at: 2021-10-16T00:00Z
|
18
20
|
)
|
19
21
|
```
|
20
22
|
|