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/Issue.md
CHANGED
@@ -5,12 +5,13 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
|
-
| **status** | [**IssueStatusEnum**](IssueStatusEnum.md) | | [optional] |
|
8
|
+
| **status** | [**IssueStatusEnum**](IssueStatusEnum.md) | Status of the issue. Options: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED | [optional] |
|
9
9
|
| **error_description** | **String** | | |
|
10
10
|
| **end_user** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
11
11
|
| **first_incident_time** | **Time** | | [optional] |
|
12
12
|
| **last_incident_time** | **Time** | | [optional] |
|
13
13
|
| **is_muted** | **Boolean** | | [optional][readonly] |
|
14
|
+
| **error_details** | **Array<String>** | | [optional][readonly] |
|
14
15
|
|
15
16
|
## Example
|
16
17
|
|
@@ -18,13 +19,14 @@
|
|
18
19
|
require 'merge_ats_client'
|
19
20
|
|
20
21
|
instance = MergeATSClient::Issue.new(
|
21
|
-
id:
|
22
|
-
status:
|
23
|
-
error_description:
|
24
|
-
end_user:
|
25
|
-
first_incident_time:
|
26
|
-
last_incident_time:
|
27
|
-
is_muted:
|
22
|
+
id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
|
23
|
+
status: ONGOING,
|
24
|
+
error_description: string,
|
25
|
+
end_user: b82302de-852e-4e60-b050-edf9da3b7c02,
|
26
|
+
first_incident_time: 2022-12-05T16:19:15.161Z,
|
27
|
+
last_incident_time: 2022-12-05T16:19:15.161Z,
|
28
|
+
is_muted: true,
|
29
|
+
error_details: ["Missing employee permissions.","Missing time off permissions."]
|
28
30
|
)
|
29
31
|
```
|
30
32
|
|
data/docs/IssuesApi.md
CHANGED
@@ -39,11 +39,11 @@ opts = {
|
|
39
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
40
|
include_muted: 'include_muted_example', # String | If True, will include muted issues
|
41
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
|
43
|
-
last_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose
|
42
|
+
last_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose last 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 last incident time was before this datetime.
|
44
44
|
page_size: 56, # Integer | Number of results to return per page.
|
45
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 |
|
46
|
+
status: 'ONGOING' # String | Status of the issue. Options: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED
|
47
47
|
}
|
48
48
|
|
49
49
|
begin
|
@@ -85,11 +85,11 @@ end
|
|
85
85
|
| **first_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
|
86
86
|
| **include_muted** | **String** | If True, will include muted issues | [optional] |
|
87
87
|
| **integration_name** | **String** | | [optional] |
|
88
|
-
| **last_incident_time_after** | **Time** | If provided, will only return issues whose
|
89
|
-
| **last_incident_time_before** | **Time** | If provided, will only return issues whose
|
88
|
+
| **last_incident_time_after** | **Time** | If provided, will only return issues whose last incident time was after this datetime. | [optional] |
|
89
|
+
| **last_incident_time_before** | **Time** | If provided, will only return issues whose last incident time was before this datetime. | [optional] |
|
90
90
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
91
91
|
| **start_date** | **String** | If included, will only include issues whose most recent action occurred after this time | [optional] |
|
92
|
-
| **status** | **String** | | [optional] |
|
92
|
+
| **status** | **String** | Status of the issue. Options: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED | [optional] |
|
93
93
|
|
94
94
|
### Return type
|
95
95
|
|
data/docs/Job.md
CHANGED
@@ -9,7 +9,7 @@
|
|
9
9
|
| **name** | **String** | The job's name. | [optional] |
|
10
10
|
| **description** | **String** | The job's description. | [optional] |
|
11
11
|
| **code** | **String** | The job's code. Typically an additional identifier used to reference the particular job that is displayed on the ATS. | [optional] |
|
12
|
-
| **status** | [**JobStatusEnum**](JobStatusEnum.md) | The job's status. | [optional] |
|
12
|
+
| **status** | [**JobStatusEnum**](JobStatusEnum.md) | The job's status. * `OPEN` - OPEN * `CLOSED` - CLOSED * `DRAFT` - DRAFT * `ARCHIVED` - ARCHIVED * `PENDING` - PENDING | [optional] |
|
13
13
|
| **job_posting_urls** | [**Array<Url>**](Url.md) | | [optional] |
|
14
14
|
| **remote_created_at** | **Time** | When the third party's job was created. | [optional] |
|
15
15
|
| **remote_updated_at** | **Time** | When the third party's job was updated. | [optional] |
|
@@ -18,8 +18,10 @@
|
|
18
18
|
| **offices** | **Array<String>** | IDs of `Office` objects for this `Job`. | [optional] |
|
19
19
|
| **hiring_managers** | **Array<String>** | IDs of `RemoteUser` objects that serve as hiring managers for this `Job`. | [optional] |
|
20
20
|
| **recruiters** | **Array<String>** | IDs of `RemoteUser` objects that serve as recruiters for this `Job`. | [optional] |
|
21
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
22
21
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
22
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
23
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
24
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
23
25
|
|
24
26
|
## Example
|
25
27
|
|
@@ -41,8 +43,10 @@ instance = MergeATSClient::Job.new(
|
|
41
43
|
offices: ["9871b4a9-f5d2-4f3b-a66b-dfedbed42c46"],
|
42
44
|
hiring_managers: ["787ed912-33ec-444e-a215-8d71cc42fc12"],
|
43
45
|
recruiters: ["787ed912-33ec-444e-a215-8d71cc42fc12"],
|
44
|
-
|
45
|
-
|
46
|
+
remote_was_deleted: null,
|
47
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
48
|
+
modified_at: 2021-10-16T00:00Z,
|
49
|
+
remote_data: [{"path":"/positions","data":["Varies by platform"]}]
|
46
50
|
)
|
47
51
|
```
|
48
52
|
|
data/docs/JobInterviewStage.md
CHANGED
@@ -6,10 +6,13 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
-
| **name** | **String** |
|
9
|
+
| **name** | **String** | Standard stage names are offered by ATS systems but can be modified by users. | [optional] |
|
10
10
|
| **job** | **String** | This field is populated only if the stage is specific to a particular job. If the stage is generic, this field will not be populated. | [optional] |
|
11
|
-
| **
|
11
|
+
| **stage_order** | **Integer** | The stage’s order, with the lowest values ordered first. If the third-party does not return details on the order of stages, this field will not be populated. | [optional] |
|
12
12
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
13
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
14
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
15
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
13
16
|
|
14
17
|
## Example
|
15
18
|
|
@@ -21,8 +24,11 @@ instance = MergeATSClient::JobInterviewStage.new(
|
|
21
24
|
remote_id: 876556788,
|
22
25
|
name: Phone Screen,
|
23
26
|
job: ba7d9648-5316-4a80-8d73-4e636cef5a90,
|
24
|
-
|
25
|
-
remote_was_deleted: null
|
27
|
+
stage_order: 2,
|
28
|
+
remote_was_deleted: null,
|
29
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
30
|
+
modified_at: 2021-10-16T00:00Z,
|
31
|
+
remote_data: [{"path":"/interview-stages","data":["Varies by platform"]}]
|
26
32
|
)
|
27
33
|
```
|
28
34
|
|
@@ -39,8 +39,8 @@ opts = {
|
|
39
39
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
40
40
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
41
|
job_id: 'job_id_example', # String | If provided, will only return interview stages for this job.
|
42
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
43
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
42
|
+
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.
|
43
|
+
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.
|
44
44
|
page_size: 56, # Integer | Number of results to return per page.
|
45
45
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
46
46
|
}
|
@@ -84,8 +84,8 @@ end
|
|
84
84
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
85
85
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
86
86
|
| **job_id** | **String** | If provided, will only return interview stages for this job. | [optional] |
|
87
|
-
| **modified_after** | **Time** | If provided,
|
88
|
-
| **modified_before** | **Time** | If provided,
|
87
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
88
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
89
89
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
90
90
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
91
91
|
|
data/docs/JobsApi.md
CHANGED
@@ -39,12 +39,14 @@ opts = {
|
|
39
39
|
expand: 'departments', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
40
40
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
41
41
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
42
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
43
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
42
|
+
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.
|
43
|
+
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.
|
44
|
+
offices: 'offices_example', # String | If provided, will only return jobs for this office; multiple offices can be separated by commas.
|
44
45
|
page_size: 56, # Integer | Number of results to return per page.
|
45
|
-
remote_fields: 'status', # String |
|
46
|
+
remote_fields: 'status', # String | Deprecated. Use show_enum_origins.
|
46
47
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
47
|
-
|
48
|
+
show_enum_origins: 'status', # String | Which fields should be returned in non-normalized form.
|
49
|
+
status: 'ARCHIVED' # String | If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING') * `OPEN` - OPEN * `CLOSED` - CLOSED * `DRAFT` - DRAFT * `ARCHIVED` - ARCHIVED * `PENDING` - PENDING
|
48
50
|
}
|
49
51
|
|
50
52
|
begin
|
@@ -86,12 +88,14 @@ end
|
|
86
88
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
87
89
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
88
90
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
89
|
-
| **modified_after** | **Time** | If provided,
|
90
|
-
| **modified_before** | **Time** | If provided,
|
91
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
92
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
93
|
+
| **offices** | **String** | If provided, will only return jobs for this office; multiple offices can be separated by commas. | [optional] |
|
91
94
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
92
|
-
| **remote_fields** | **String** |
|
95
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
93
96
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
94
|
-
| **
|
97
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
98
|
+
| **status** | **String** | If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING') * `OPEN` - OPEN * `CLOSED` - CLOSED * `DRAFT` - DRAFT * `ARCHIVED` - ARCHIVED * `PENDING` - PENDING | [optional] |
|
95
99
|
|
96
100
|
### Return type
|
97
101
|
|
@@ -134,7 +138,8 @@ id = TODO # String |
|
|
134
138
|
opts = {
|
135
139
|
expand: 'departments', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
136
140
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
137
|
-
remote_fields: 'status' # String |
|
141
|
+
remote_fields: 'status', # String | Deprecated. Use show_enum_origins.
|
142
|
+
show_enum_origins: 'status' # String | Which fields should be returned in non-normalized form.
|
138
143
|
}
|
139
144
|
|
140
145
|
begin
|
@@ -172,7 +177,8 @@ end
|
|
172
177
|
| **id** | [**String**](.md) | | |
|
173
178
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
174
179
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
175
|
-
| **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] |
|
176
182
|
|
177
183
|
### Return type
|
178
184
|
|
data/docs/LinkToken.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **link_token** | **String** | | |
|
8
|
-
| **integration_name** | **String** | |
|
8
|
+
| **integration_name** | **String** | | [optional] |
|
9
9
|
| **magic_link_url** | **String** | | [optional] |
|
10
10
|
|
11
11
|
## Example
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# MergeATSClient::LinkedAccountCondition
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **condition_schema_id** | **String** | The ID indicating which condition schema to use for a specific condition. | |
|
8
|
+
| **common_model** | **String** | The common model for a specific condition. | [optional][readonly] |
|
9
|
+
| **native_name** | **String** | User-facing *native condition* name. e.g. \"Skip Manager\". | |
|
10
|
+
| **operator** | **String** | The operator for a specific condition. | |
|
11
|
+
| **value** | [**AnyType**](.md) | The value for a condition. | [optional][readonly] |
|
12
|
+
| **field_name** | **String** | The name of the field on the common model that this condition corresponds to, if they conceptually match. e.g. \"location_type\". | |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'merge_ats_client'
|
18
|
+
|
19
|
+
instance = MergeATSClient::LinkedAccountCondition.new(
|
20
|
+
condition_schema_id: null,
|
21
|
+
common_model: null,
|
22
|
+
native_name: null,
|
23
|
+
operator: null,
|
24
|
+
value: null,
|
25
|
+
field_name: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeATSClient::LinkedAccountConditionRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **condition_schema_id** | **String** | The ID indicating which condition schema to use for a specific condition. | |
|
8
|
+
| **operator** | **String** | The operator for a specific condition. | |
|
9
|
+
| **value** | [**AnyType**](.md) | The value for a specific condition. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_ats_client'
|
15
|
+
|
16
|
+
instance = MergeATSClient::LinkedAccountConditionRequest.new(
|
17
|
+
condition_schema_id: null,
|
18
|
+
operator: null,
|
19
|
+
value: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeATSClient::LinkedAccountSelectiveSyncConfiguration
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **linked_account_conditions** | [**Array<LinkedAccountCondition>**](LinkedAccountCondition.md) | The conditions belonging to a selective sync. | [optional][readonly] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_ats_client'
|
13
|
+
|
14
|
+
instance = MergeATSClient::LinkedAccountSelectiveSyncConfiguration.new(
|
15
|
+
linked_account_conditions: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeATSClient::LinkedAccountSelectiveSyncConfigurationListRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **sync_configurations** | [**Array<LinkedAccountSelectiveSyncConfigurationRequest>**](LinkedAccountSelectiveSyncConfigurationRequest.md) | The selective syncs associated with a linked account. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_ats_client'
|
13
|
+
|
14
|
+
instance = MergeATSClient::LinkedAccountSelectiveSyncConfigurationListRequest.new(
|
15
|
+
sync_configurations: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeATSClient::LinkedAccountSelectiveSyncConfigurationRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **linked_account_conditions** | [**Array<LinkedAccountConditionRequest>**](LinkedAccountConditionRequest.md) | The conditions belonging to a selective sync. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_ats_client'
|
13
|
+
|
14
|
+
instance = MergeATSClient::LinkedAccountSelectiveSyncConfigurationRequest.new(
|
15
|
+
linked_account_conditions: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/LinkedAccountsApi.md
CHANGED
@@ -30,7 +30,7 @@ end
|
|
30
30
|
|
31
31
|
api_instance = MergeATSClient::LinkedAccountsApi.new
|
32
32
|
opts = {
|
33
|
-
category: 'accounting', # String |
|
33
|
+
category: 'accounting', # String | Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage') * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage
|
34
34
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
35
35
|
end_user_email_address: 'end_user_email_address_example', # String | If provided, will only return linked accounts associated with the given email address.
|
36
36
|
end_user_organization_name: 'end_user_organization_name_example', # String | If provided, will only return linked accounts associated with the given organization name.
|
@@ -76,7 +76,7 @@ end
|
|
76
76
|
|
77
77
|
| Name | Type | Description | Notes |
|
78
78
|
| ---- | ---- | ----------- | ----- |
|
79
|
-
| **category** | **String** | | [optional] |
|
79
|
+
| **category** | **String** | Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage') * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage | [optional] |
|
80
80
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
81
81
|
| **end_user_email_address** | **String** | If provided, will only return linked accounts associated with the given email address. | [optional] |
|
82
82
|
| **end_user_organization_name** | **String** | If provided, will only return linked accounts associated with the given organization name. | [optional] |
|
data/docs/MetaResponse.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **request_schema** | [**Hash<String, AnyType>**](AnyType.md) | | |
|
8
|
+
| **remote_field_classes** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
8
9
|
| **status** | [**LinkedAccountStatus**](LinkedAccountStatus.md) | | [optional] |
|
9
10
|
| **has_conditional_params** | **Boolean** | | |
|
10
11
|
| **has_required_linked_account_params** | **Boolean** | | |
|
@@ -16,6 +17,7 @@ require 'merge_ats_client'
|
|
16
17
|
|
17
18
|
instance = MergeATSClient::MetaResponse.new(
|
18
19
|
request_schema: null,
|
20
|
+
remote_field_classes: null,
|
19
21
|
status: null,
|
20
22
|
has_conditional_params: null,
|
21
23
|
has_required_linked_account_params: null
|
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **name** | **String** | The name of the form field | |
|
8
8
|
| **data** | **String** | The data for the form field. | |
|
9
|
-
| **encoding** | [**EncodingEnum**](EncodingEnum.md) | The encoding of the value of `data`. Defaults to `RAW` if not defined. | [optional] |
|
9
|
+
| **encoding** | [**EncodingEnum**](EncodingEnum.md) | The encoding of the value of `data`. Defaults to `RAW` if not defined. * `RAW` - RAW * `BASE64` - BASE64 * `GZIP_BASE64` - GZIP_BASE64 | [optional] |
|
10
10
|
| **file_name** | **String** | The file name of the form field, if the field is for a file. | [optional] |
|
11
11
|
| **content_type** | **String** | The MIME type of the file, if the field is for a file. | [optional] |
|
12
12
|
|
data/docs/Offer.md
CHANGED
@@ -6,15 +6,17 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
-
| **application** | **String** |
|
10
|
-
| **creator** | **String** |
|
9
|
+
| **application** | **String** | The application who is receiving the offer. | [optional] |
|
10
|
+
| **creator** | **String** | The user who created the offer. | [optional] |
|
11
11
|
| **remote_created_at** | **Time** | When the third party's offer was created. | [optional] |
|
12
12
|
| **closed_at** | **Time** | When the offer was closed. | [optional] |
|
13
13
|
| **sent_at** | **Time** | When the offer was sent. | [optional] |
|
14
14
|
| **start_date** | **Time** | The employment start date on the offer. | [optional] |
|
15
|
-
| **status** | [**OfferStatusEnum**](OfferStatusEnum.md) | The offer's status. | [optional] |
|
16
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
15
|
+
| **status** | [**OfferStatusEnum**](OfferStatusEnum.md) | The offer's status. * `DRAFT` - DRAFT * `APPROVAL-SENT` - APPROVAL-SENT * `APPROVED` - APPROVED * `SENT` - SENT * `SENT-MANUALLY` - SENT-MANUALLY * `OPENED` - OPENED * `DENIED` - DENIED * `SIGNED` - SIGNED * `DEPRECATED` - DEPRECATED | [optional] |
|
17
16
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
17
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
18
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
19
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
18
20
|
|
19
21
|
## Example
|
20
22
|
|
@@ -31,8 +33,10 @@ instance = MergeATSClient::Offer.new(
|
|
31
33
|
sent_at: 2021-10-15T00:00Z,
|
32
34
|
start_date: 2021-11-15T00:00Z,
|
33
35
|
status: SENT,
|
34
|
-
|
35
|
-
|
36
|
+
remote_was_deleted: null,
|
37
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
38
|
+
modified_at: 2021-10-16T00:00Z,
|
39
|
+
remote_data: [{"path":"/offers","data":["Varies by platform"]}]
|
36
40
|
)
|
37
41
|
```
|
38
42
|
|
data/docs/OffersApi.md
CHANGED
@@ -40,11 +40,12 @@ opts = {
|
|
40
40
|
expand: 'application', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
41
41
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
42
42
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
43
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
44
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
43
|
+
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.
|
44
|
+
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.
|
45
45
|
page_size: 56, # Integer | Number of results to return per page.
|
46
|
-
remote_fields: 'status', # String |
|
47
|
-
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
46
|
+
remote_fields: 'status', # String | Deprecated. Use show_enum_origins.
|
47
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
48
|
+
show_enum_origins: 'status' # String | Which fields should be returned in non-normalized form.
|
48
49
|
}
|
49
50
|
|
50
51
|
begin
|
@@ -87,11 +88,12 @@ end
|
|
87
88
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
88
89
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
89
90
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
90
|
-
| **modified_after** | **Time** | If provided,
|
91
|
-
| **modified_before** | **Time** | If provided,
|
91
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
92
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
92
93
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
93
|
-
| **remote_fields** | **String** |
|
94
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
94
95
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
96
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
95
97
|
|
96
98
|
### Return type
|
97
99
|
|
@@ -134,7 +136,8 @@ id = TODO # String |
|
|
134
136
|
opts = {
|
135
137
|
expand: 'application', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
136
138
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
137
|
-
remote_fields: 'status' # String |
|
139
|
+
remote_fields: 'status', # String | Deprecated. Use show_enum_origins.
|
140
|
+
show_enum_origins: 'status' # String | Which fields should be returned in non-normalized form.
|
138
141
|
}
|
139
142
|
|
140
143
|
begin
|
@@ -172,7 +175,8 @@ end
|
|
172
175
|
| **id** | [**String**](.md) | | |
|
173
176
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
174
177
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
175
|
-
| **remote_fields** | **String** |
|
178
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
179
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
176
180
|
|
177
181
|
### Return type
|
178
182
|
|
data/docs/Office.md
CHANGED
@@ -8,8 +8,10 @@
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
9
|
| **name** | **String** | The office's name. | [optional] |
|
10
10
|
| **location** | **String** | The office's location. | [optional] |
|
11
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
12
11
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
12
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
13
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
14
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
13
15
|
|
14
16
|
## Example
|
15
17
|
|
@@ -21,8 +23,10 @@ instance = MergeATSClient::Office.new(
|
|
21
23
|
remote_id: 876556788,
|
22
24
|
name: SF Office,
|
23
25
|
location: Embarcadero Center 2,
|
24
|
-
|
25
|
-
|
26
|
+
remote_was_deleted: null,
|
27
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
28
|
+
modified_at: 2021-10-16T00:00Z,
|
29
|
+
remote_data: [{"path":"/locations","data":["Varies by platform"]}]
|
26
30
|
)
|
27
31
|
```
|
28
32
|
|
data/docs/OfficesApi.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
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeATSClient::OperatorSchema
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **operator** | **String** | The operator for which an operator schema is defined. | [optional][readonly] |
|
8
|
+
| **is_unique** | **Boolean** | Whether the operator can be repeated multiple times. | [optional][readonly] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_ats_client'
|
14
|
+
|
15
|
+
instance = MergeATSClient::OperatorSchema.new(
|
16
|
+
operator: null,
|
17
|
+
is_unique: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeATSClient::PaginatedConditionSchemaList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **_next** | **String** | | [optional] |
|
8
|
+
| **previous** | **String** | | [optional] |
|
9
|
+
| **results** | [**Array<ConditionSchema>**](ConditionSchema.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_ats_client'
|
15
|
+
|
16
|
+
instance = MergeATSClient::PaginatedConditionSchemaList.new(
|
17
|
+
_next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
|
18
|
+
previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
|
19
|
+
results: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/PhoneNumber.md
CHANGED
@@ -5,7 +5,8 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **value** | **String** | The phone number. | [optional] |
|
8
|
-
| **phone_number_type** | [**PhoneNumberTypeEnum**](PhoneNumberTypeEnum.md) | The type of phone number. | [optional] |
|
8
|
+
| **phone_number_type** | [**PhoneNumberTypeEnum**](PhoneNumberTypeEnum.md) | The type of phone number. * `HOME` - HOME * `WORK` - WORK * `MOBILE` - MOBILE * `SKYPE` - SKYPE * `OTHER` - OTHER | [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::PhoneNumber.new(
|
16
17
|
value: +3198675309,
|
17
|
-
phone_number_type: HOME
|
18
|
+
phone_number_type: HOME,
|
19
|
+
modified_at: 2021-10-16T00:00Z
|
18
20
|
)
|
19
21
|
```
|
20
22
|
|
data/docs/PhoneNumberRequest.md
CHANGED
@@ -5,7 +5,9 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **value** | **String** | The phone number. | [optional] |
|
8
|
-
| **phone_number_type** | [**PhoneNumberTypeEnum**](PhoneNumberTypeEnum.md) | The type of phone number. | [optional] |
|
8
|
+
| **phone_number_type** | [**PhoneNumberTypeEnum**](PhoneNumberTypeEnum.md) | The type of phone number. * `HOME` - HOME * `WORK` - WORK * `MOBILE` - MOBILE * `SKYPE` - SKYPE * `OTHER` - OTHER | [optional] |
|
9
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
10
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
9
11
|
|
10
12
|
## Example
|
11
13
|
|
@@ -14,7 +16,9 @@ require 'merge_ats_client'
|
|
14
16
|
|
15
17
|
instance = MergeATSClient::PhoneNumberRequest.new(
|
16
18
|
value: +3198675309,
|
17
|
-
phone_number_type: HOME
|
19
|
+
phone_number_type: HOME,
|
20
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
21
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
18
22
|
)
|
19
23
|
```
|
20
24
|
|