merge_ats_client 3.0.0 → 3.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +25 -6
- 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/AsyncPassthroughApi.md +155 -0
- data/docs/AsyncPassthroughReciept.md +18 -0
- 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 +172 -13
- data/docs/CommonModelScopesBodyRequest.md +22 -0
- data/docs/ConditionSchema.md +1 -1
- data/docs/DataPassthroughRequest.md +1 -1
- data/docs/DeleteAccountApi.md +9 -9
- 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 +1 -1
- data/docs/EnabledActionsEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +4 -2
- 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/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/PaginatedConditionSchemaList.md +2 -2
- data/docs/PatchedCandidateEndpointRequest.md +20 -0
- data/docs/PatchedCandidateRequest.md +50 -0
- data/docs/PhoneNumber.md +4 -2
- data/docs/PhoneNumberRequest.md +1 -1
- data/docs/RejectReason.md +7 -3
- data/docs/RejectReasonsApi.md +4 -4
- data/docs/RemoteData.md +1 -1
- 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 +2 -2
- 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 +1 -1
- 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/async_passthrough_api.rb +160 -0
- data/lib/merge_ats_client/api/attachments_api.rb +22 -8
- data/lib/merge_ats_client/api/candidates_api.rb +165 -11
- data/lib/merge_ats_client/api/delete_account_api.rb +7 -7
- 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 +2 -2
- 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/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/application.rb +40 -26
- data/lib/merge_ats_client/models/application_request.rb +7 -26
- data/lib/merge_ats_client/models/async_passthrough_reciept.rb +223 -0
- 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/candidate.rb +36 -27
- data/lib/merge_ats_client/models/candidate_request.rb +3 -49
- data/lib/merge_ats_client/models/categories_enum.rb +3 -1
- data/lib/merge_ats_client/models/category_enum.rb +3 -1
- data/lib/merge_ats_client/models/common_model_scopes_body_request.rb +274 -0
- data/lib/merge_ats_client/models/condition_schema.rb +1 -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/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 +1 -1
- data/lib/merge_ats_client/models/enabled_actions_enum.rb +45 -0
- data/lib/merge_ats_client/models/end_user_details_request.rb +19 -6
- 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/link_token.rb +0 -5
- data/lib/merge_ats_client/models/meta_response.rb +12 -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/office.rb +37 -15
- data/lib/merge_ats_client/models/patched_candidate_endpoint_request.rb +237 -0
- data/lib/merge_ats_client/models/patched_candidate_request.rb +418 -0
- data/lib/merge_ats_client/models/phone_number.rb +16 -6
- data/lib/merge_ats_client/models/phone_number_request.rb +1 -1
- data/lib/merge_ats_client/models/reject_reason.rb +37 -15
- data/lib/merge_ats_client/models/remote_data.rb +3 -4
- data/lib/merge_ats_client/models/remote_user.rb +38 -16
- 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/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 +2 -1
- data/lib/merge_ats_client/models/tag.rb +36 -14
- data/lib/merge_ats_client/models/url.rb +16 -6
- data/lib/merge_ats_client/models/url_request.rb +1 -1
- data/lib/merge_ats_client/version.rb +1 -1
- data/lib/merge_ats_client.rb +13 -1
- data/spec/api/activities_api_spec.rb +31 -4
- data/spec/api/applications_api_spec.rb +2 -2
- data/spec/api/async_passthrough_api_spec.rb +59 -0
- data/spec/api/attachments_api_spec.rb +6 -4
- data/spec/api/candidates_api_spec.rb +32 -3
- data/spec/api/delete_account_api_spec.rb +2 -2
- 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 +1 -1
- 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/async_passthrough_reciept_spec.rb +34 -0
- 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/department_spec.rb +14 -2
- data/spec/models/eeoc_spec.rb +14 -2
- 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/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 → patched_candidate_endpoint_request_spec.rb} +8 -8
- data/spec/models/patched_candidate_request_spec.rb +130 -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_spec.rb +6 -0
- metadata +167 -119
@@ -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
|
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
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
18
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [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
|
+
modified_at: 2021-10-16T00:00Z,
|
38
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
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
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
13
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [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
|
+
modified_at: 2021-10-16T00:00Z,
|
28
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
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
|
|
@@ -14,8 +14,8 @@
|
|
14
14
|
require 'merge_ats_client'
|
15
15
|
|
16
16
|
instance = MergeATSClient::PaginatedConditionSchemaList.new(
|
17
|
-
_next:
|
18
|
-
previous:
|
17
|
+
_next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
|
18
|
+
previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
|
19
19
|
results: null
|
20
20
|
)
|
21
21
|
```
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeATSClient::PatchedCandidateEndpointRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**PatchedCandidateRequest**](PatchedCandidateRequest.md) | | |
|
8
|
+
| **remote_user_id** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_ats_client'
|
14
|
+
|
15
|
+
instance = MergeATSClient::PatchedCandidateEndpointRequest.new(
|
16
|
+
model: null,
|
17
|
+
remote_user_id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# MergeATSClient::PatchedCandidateRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **first_name** | **String** | The candidate's first name. | [optional] |
|
8
|
+
| **last_name** | **String** | The candidate's last name. | [optional] |
|
9
|
+
| **company** | **String** | The candidate's current company. | [optional] |
|
10
|
+
| **title** | **String** | The candidate's current title. | [optional] |
|
11
|
+
| **last_interaction_at** | **Time** | When the most recent interaction with the candidate occurred. | [optional] |
|
12
|
+
| **is_private** | **Boolean** | Whether or not the candidate is private. | [optional] |
|
13
|
+
| **can_email** | **Boolean** | Whether or not the candidate can be emailed. | [optional] |
|
14
|
+
| **locations** | **Array<String>** | The candidate's locations. | [optional] |
|
15
|
+
| **phone_numbers** | [**Array<PhoneNumberRequest>**](PhoneNumberRequest.md) | | [optional] |
|
16
|
+
| **email_addresses** | [**Array<EmailAddressRequest>**](EmailAddressRequest.md) | | [optional] |
|
17
|
+
| **urls** | [**Array<UrlRequest>**](UrlRequest.md) | | [optional] |
|
18
|
+
| **tags** | **Array<String>** | Array of `Tag` names as strings. | [optional] |
|
19
|
+
| **applications** | **Array<String>** | Array of `Application` object IDs. | [optional] |
|
20
|
+
| **attachments** | **Array<String>** | Array of `Attachment` object IDs. | [optional] |
|
21
|
+
| **remote_template_id** | **String** | | [optional] |
|
22
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
23
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
24
|
+
|
25
|
+
## Example
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'merge_ats_client'
|
29
|
+
|
30
|
+
instance = MergeATSClient::PatchedCandidateRequest.new(
|
31
|
+
first_name: Gil,
|
32
|
+
last_name: Feig,
|
33
|
+
company: Columbia Dining App.,
|
34
|
+
title: Software Engineer,
|
35
|
+
last_interaction_at: 2021-10-17T00:00Z,
|
36
|
+
is_private: true,
|
37
|
+
can_email: true,
|
38
|
+
locations: ["San Francisco","New York","Miami"],
|
39
|
+
phone_numbers: [{"value":"+1234567890","phone_number_type":"MOBILE"}],
|
40
|
+
email_addresses: [{"value":"hello@merge.dev","email_address_type":"PERSONAL"}],
|
41
|
+
urls: [{"value":"http://alturl.com/p749b","url_type":"BLOG"}],
|
42
|
+
tags: ["High-Priority"],
|
43
|
+
applications: ["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],
|
44
|
+
attachments: ["bea08964-32b4-4a20-8bb4-2612ba09de1d"],
|
45
|
+
remote_template_id: 92830948203,
|
46
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
47
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
48
|
+
)
|
49
|
+
```
|
50
|
+
|
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,7 @@
|
|
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
9
|
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
10
10
|
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
11
11
|
|
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
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
12
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [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
|
+
modified_at: 2021-10-16T00:00Z,
|
26
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
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/RemoteData.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **path** | **String** | | |
|
8
|
-
| **data** | [**
|
8
|
+
| **data** | [**AnyType**](.md) | | [optional][readonly] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
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
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
17
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [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
|
+
modified_at: 2021-10-16T00:00Z,
|
36
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
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
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
21
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [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
|
+
modified_at: 2021-10-16T00:00Z,
|
44
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
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
|
+
|