merge_ats_client 2.0.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/LICENSE.md +16 -0
- data/README.md +20 -6
- data/docs/AccountDetails.md +3 -1
- data/docs/AccountDetailsAndActions.md +2 -0
- data/docs/ActivitiesApi.md +7 -3
- data/docs/Activity.md +1 -1
- data/docs/ApplicationsApi.md +84 -2
- data/docs/AttachmentsApi.md +7 -3
- data/docs/CandidatesApi.md +2 -2
- data/docs/ConditionSchema.md +30 -0
- data/docs/ConditionTypeEnum.md +15 -0
- data/docs/DataPassthroughRequest.md +3 -1
- data/docs/Department.md +1 -1
- data/docs/DepartmentsApi.md +2 -2
- data/docs/EEOC.md +1 -1
- data/docs/EeocsApi.md +7 -3
- data/docs/EmailAddressRequest.md +5 -1
- data/docs/EndUserDetailsRequest.md +9 -7
- data/docs/InterviewsApi.md +7 -3
- data/docs/Job.md +4 -2
- data/docs/JobInterviewStage.md +2 -2
- data/docs/JobInterviewStagesApi.md +2 -2
- data/docs/JobsApi.md +7 -3
- data/docs/LinkToken.md +3 -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 -0
- data/docs/Offer.md +1 -1
- data/docs/OffersApi.md +7 -3
- data/docs/Office.md +1 -1
- data/docs/OfficesApi.md +2 -2
- data/docs/OperatorSchema.md +20 -0
- data/docs/PaginatedConditionSchemaList.md +22 -0
- data/docs/PhoneNumberRequest.md +5 -1
- data/docs/RejectReason.md +1 -1
- data/docs/RejectReasonsApi.md +2 -2
- data/docs/RemoteResponse.md +5 -1
- data/docs/RemoteUser.md +1 -1
- data/docs/ResponseTypeEnum.md +15 -0
- data/docs/ScheduledInterview.md +1 -1
- data/docs/Scorecard.md +1 -1
- data/docs/ScorecardsApi.md +7 -3
- data/docs/SelectiveSyncApi.md +233 -0
- data/docs/SyncStatus.md +2 -2
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tag.md +1 -1
- data/docs/TagsApi.md +2 -2
- data/docs/UpdateApplicationStageRequest.md +20 -0
- data/docs/UrlRequest.md +5 -1
- data/docs/UsersApi.md +7 -3
- data/lib/merge_ats_client/api/activities_api.rb +16 -2
- data/lib/merge_ats_client/api/applications_api.rb +80 -2
- data/lib/merge_ats_client/api/attachments_api.rb +16 -2
- data/lib/merge_ats_client/api/candidates_api.rb +2 -2
- data/lib/merge_ats_client/api/departments_api.rb +2 -2
- data/lib/merge_ats_client/api/eeocs_api.rb +16 -2
- data/lib/merge_ats_client/api/interviews_api.rb +16 -2
- data/lib/merge_ats_client/api/job_interview_stages_api.rb +2 -2
- data/lib/merge_ats_client/api/jobs_api.rb +16 -2
- data/lib/merge_ats_client/api/linked_accounts_api.rb +3 -0
- data/lib/merge_ats_client/api/offers_api.rb +16 -2
- data/lib/merge_ats_client/api/offices_api.rb +2 -2
- data/lib/merge_ats_client/api/reject_reasons_api.rb +2 -2
- data/lib/merge_ats_client/api/scorecards_api.rb +16 -2
- 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 +2 -2
- data/lib/merge_ats_client/api/users_api.rb +16 -2
- data/lib/merge_ats_client/models/access_role_enum.rb +17 -7
- data/lib/merge_ats_client/models/account_details.rb +15 -4
- data/lib/merge_ats_client/models/account_details_and_actions.rb +12 -1
- data/lib/merge_ats_client/models/account_details_and_actions_status_enum.rb +17 -7
- data/lib/merge_ats_client/models/activity.rb +1 -1
- data/lib/merge_ats_client/models/activity_type_enum.rb +17 -7
- data/lib/merge_ats_client/models/application.rb +1 -1
- data/lib/merge_ats_client/models/application_request.rb +3 -3
- data/lib/merge_ats_client/models/attachment_request.rb +2 -2
- data/lib/merge_ats_client/models/attachment_type_enum.rb +17 -7
- data/lib/merge_ats_client/models/candidate.rb +1 -1
- data/lib/merge_ats_client/models/candidate_request.rb +3 -3
- data/lib/merge_ats_client/models/categories_enum.rb +17 -7
- data/lib/merge_ats_client/models/category_enum.rb +17 -7
- data/lib/merge_ats_client/models/condition_schema.rb +297 -0
- data/lib/merge_ats_client/models/condition_type_enum.rb +50 -0
- data/lib/merge_ats_client/models/data_passthrough_request.rb +15 -6
- data/lib/merge_ats_client/models/department.rb +1 -1
- data/lib/merge_ats_client/models/disability_status_enum.rb +17 -7
- data/lib/merge_ats_client/models/eeoc.rb +1 -1
- data/lib/merge_ats_client/models/email_address_request.rb +29 -5
- data/lib/merge_ats_client/models/email_address_type_enum.rb +17 -7
- data/lib/merge_ats_client/models/encoding_enum.rb +18 -7
- data/lib/merge_ats_client/models/end_user_details_request.rb +28 -11
- data/lib/merge_ats_client/models/gender_enum.rb +17 -7
- data/lib/merge_ats_client/models/issue.rb +1 -1
- data/lib/merge_ats_client/models/issue_status_enum.rb +17 -7
- data/lib/merge_ats_client/models/job.rb +14 -3
- data/lib/merge_ats_client/models/job_interview_stage.rb +3 -2
- data/lib/merge_ats_client/models/job_status_enum.rb +17 -7
- data/lib/merge_ats_client/models/link_token.rb +13 -4
- 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 +1 -1
- data/lib/merge_ats_client/models/method_enum.rb +17 -7
- data/lib/merge_ats_client/models/offer.rb +1 -1
- data/lib/merge_ats_client/models/offer_status_enum.rb +17 -7
- data/lib/merge_ats_client/models/office.rb +1 -1
- data/lib/merge_ats_client/models/operator_schema.rb +229 -0
- data/lib/merge_ats_client/models/overall_recommendation_enum.rb +17 -7
- data/lib/merge_ats_client/models/{remote_data_request.rb → paginated_condition_schema_list.rb} +28 -41
- data/lib/merge_ats_client/models/phone_number_request.rb +29 -5
- data/lib/merge_ats_client/models/phone_number_type_enum.rb +17 -7
- data/lib/merge_ats_client/models/race_enum.rb +17 -7
- data/lib/merge_ats_client/models/reason_enum.rb +17 -7
- data/lib/merge_ats_client/models/reject_reason.rb +1 -1
- data/lib/merge_ats_client/models/remote_response.rb +23 -9
- data/lib/merge_ats_client/models/remote_user.rb +1 -1
- data/lib/merge_ats_client/models/request_format_enum.rb +17 -7
- data/lib/merge_ats_client/models/response_type_enum.rb +45 -0
- data/lib/merge_ats_client/models/scheduled_interview.rb +2 -2
- data/lib/merge_ats_client/models/scheduled_interview_status_enum.rb +17 -7
- data/lib/merge_ats_client/models/scorecard.rb +2 -2
- data/lib/merge_ats_client/models/sync_status.rb +0 -10
- data/lib/merge_ats_client/models/sync_status_status_enum.rb +18 -7
- data/lib/merge_ats_client/models/tag.rb +2 -2
- data/lib/merge_ats_client/models/update_application_stage_request.rb +244 -0
- data/lib/merge_ats_client/models/url.rb +1 -1
- data/lib/merge_ats_client/models/url_request.rb +30 -6
- data/lib/merge_ats_client/models/url_type_enum.rb +18 -7
- data/lib/merge_ats_client/models/veteran_status_enum.rb +17 -7
- data/lib/merge_ats_client/models/visibility_enum.rb +17 -7
- data/lib/merge_ats_client/version.rb +1 -1
- data/lib/merge_ats_client.rb +12 -1
- data/spec/api/activities_api_spec.rb +3 -1
- data/spec/api/applications_api_spec.rb +16 -1
- data/spec/api/attachments_api_spec.rb +3 -1
- data/spec/api/candidates_api_spec.rb +1 -1
- data/spec/api/departments_api_spec.rb +1 -1
- data/spec/api/eeocs_api_spec.rb +3 -1
- data/spec/api/interviews_api_spec.rb +3 -1
- data/spec/api/job_interview_stages_api_spec.rb +1 -1
- data/spec/api/jobs_api_spec.rb +3 -1
- data/spec/api/linked_accounts_api_spec.rb +1 -0
- data/spec/api/offers_api_spec.rb +3 -1
- data/spec/api/offices_api_spec.rb +1 -1
- data/spec/api/reject_reasons_api_spec.rb +1 -1
- data/spec/api/scorecards_api_spec.rb +3 -1
- 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 +1 -1
- data/spec/api/users_api_spec.rb +3 -1
- data/spec/models/account_details_and_actions_spec.rb +6 -0
- data/spec/models/account_details_spec.rb +6 -0
- data/spec/models/condition_schema_spec.rb +70 -0
- data/spec/models/condition_type_enum_spec.rb +28 -0
- data/spec/models/data_passthrough_request_spec.rb +6 -0
- data/spec/models/email_address_request_spec.rb +12 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/job_spec.rb +6 -0
- data/spec/models/link_token_spec.rb +6 -0
- 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/operator_schema_spec.rb +40 -0
- data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
- data/spec/models/phone_number_request_spec.rb +12 -0
- data/spec/models/remote_response_spec.rb +12 -0
- data/spec/models/response_type_enum_spec.rb +28 -0
- data/spec/models/update_application_stage_request_spec.rb +40 -0
- data/spec/models/url_request_spec.rb +12 -0
- metadata +153 -105
data/docs/InterviewsApi.md
CHANGED
|
@@ -37,13 +37,14 @@ opts = {
|
|
|
37
37
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
|
38
38
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
|
39
39
|
expand: 'application', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
40
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
|
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
42
|
job_interview_stage_id: 'job_interview_stage_id_example', # String | If provided, will only return interviews at this stage.
|
|
43
43
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
|
44
44
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
|
45
45
|
organizer_id: 'organizer_id_example', # String | If provided, will only return interviews organized by this user.
|
|
46
46
|
page_size: 56, # Integer | Number of results to return per page.
|
|
47
|
+
remote_fields: 'status', # String | Which fields should be returned in non-normalized form.
|
|
47
48
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
|
48
49
|
}
|
|
49
50
|
|
|
@@ -84,13 +85,14 @@ end
|
|
|
84
85
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
|
85
86
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
|
86
87
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
87
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
|
88
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
|
88
89
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
89
90
|
| **job_interview_stage_id** | **String** | If provided, will only return interviews at this stage. | [optional] |
|
|
90
91
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
|
91
92
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
|
92
93
|
| **organizer_id** | **String** | If provided, will only return interviews organized by this user. | [optional] |
|
|
93
94
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
95
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
|
94
96
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
|
95
97
|
|
|
96
98
|
### Return type
|
|
@@ -133,7 +135,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
|
133
135
|
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
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
138
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
139
|
+
remote_fields: 'status' # String | Which fields should be returned in non-normalized form.
|
|
137
140
|
}
|
|
138
141
|
|
|
139
142
|
begin
|
|
@@ -171,6 +174,7 @@ end
|
|
|
171
174
|
| **id** | [**String**](.md) | | |
|
|
172
175
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
173
176
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
177
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
|
174
178
|
|
|
175
179
|
### Return type
|
|
176
180
|
|
data/docs/Job.md
CHANGED
|
@@ -10,15 +10,16 @@
|
|
|
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
12
|
| **status** | [**JobStatusEnum**](JobStatusEnum.md) | The job's status. | [optional] |
|
|
13
|
+
| **job_posting_urls** | [**Array<Url>**](Url.md) | | [optional] |
|
|
13
14
|
| **remote_created_at** | **Time** | When the third party's job was created. | [optional] |
|
|
14
15
|
| **remote_updated_at** | **Time** | When the third party's job was updated. | [optional] |
|
|
15
16
|
| **confidential** | **Boolean** | Whether the job is confidential. | [optional] |
|
|
16
17
|
| **departments** | **Array<String>** | IDs of `Department` objects for this `Job`. | [optional] |
|
|
17
18
|
| **offices** | **Array<String>** | IDs of `Office` objects for this `Job`. | [optional] |
|
|
18
19
|
| **hiring_managers** | **Array<String>** | IDs of `RemoteUser` objects that serve as hiring managers for this `Job`. | [optional] |
|
|
19
|
-
| **recruiters** | **Array<String>** | IDs of RemoteUser objects that serve as recruiters for this Job
|
|
20
|
+
| **recruiters** | **Array<String>** | IDs of `RemoteUser` objects that serve as recruiters for this `Job`. | [optional] |
|
|
20
21
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
21
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
|
22
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
|
22
23
|
|
|
23
24
|
## Example
|
|
24
25
|
|
|
@@ -32,6 +33,7 @@ instance = MergeATSClient::Job.new(
|
|
|
32
33
|
description: <b>If you're reading this documentation, you might be a good fit for Merge!</b>,
|
|
33
34
|
code: C0025,
|
|
34
35
|
status: OPEN,
|
|
36
|
+
job_posting_urls: [{"value":"https://merge.dev/careers","url_type":"JOB_POSTING"}],
|
|
35
37
|
remote_created_at: 2021-10-15T00:00Z,
|
|
36
38
|
remote_updated_at: 2021-10-16T00:00Z,
|
|
37
39
|
confidential: true,
|
data/docs/JobInterviewStage.md
CHANGED
|
@@ -7,9 +7,9 @@
|
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
|
9
9
|
| **name** | **String** | The stage's name. | [optional] |
|
|
10
|
-
| **job** | **String** |
|
|
10
|
+
| **job** | **String** | 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
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
12
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
|
12
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -36,7 +36,7 @@ opts = {
|
|
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
|
38
38
|
expand: 'job', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
39
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
|
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
42
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
|
@@ -81,7 +81,7 @@ end
|
|
|
81
81
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
|
82
82
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
|
83
83
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
84
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
|
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
87
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
data/docs/JobsApi.md
CHANGED
|
@@ -37,11 +37,12 @@ opts = {
|
|
|
37
37
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
|
38
38
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
|
39
39
|
expand: 'departments', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
40
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
|
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
42
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
|
43
43
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
|
44
44
|
page_size: 56, # Integer | Number of results to return per page.
|
|
45
|
+
remote_fields: 'status', # String | Which fields should be returned in non-normalized form.
|
|
45
46
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
|
46
47
|
status: 'ARCHIVED' # String | If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING')
|
|
47
48
|
}
|
|
@@ -83,11 +84,12 @@ end
|
|
|
83
84
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
|
84
85
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
|
85
86
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
86
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
|
87
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
|
87
88
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
88
89
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
|
89
90
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
|
90
91
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
92
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
|
91
93
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
|
92
94
|
| **status** | **String** | If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING') | [optional] |
|
|
93
95
|
|
|
@@ -131,7 +133,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
|
131
133
|
id = TODO # String |
|
|
132
134
|
opts = {
|
|
133
135
|
expand: 'departments', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
134
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
136
|
+
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 | Which fields should be returned in non-normalized form.
|
|
135
138
|
}
|
|
136
139
|
|
|
137
140
|
begin
|
|
@@ -169,6 +172,7 @@ end
|
|
|
169
172
|
| **id** | [**String**](.md) | | |
|
|
170
173
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
171
174
|
| **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** | Which fields should be returned in non-normalized form. | [optional] |
|
|
172
176
|
|
|
173
177
|
### Return type
|
|
174
178
|
|
data/docs/LinkToken.md
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **link_token** | **String** | | |
|
|
8
8
|
| **integration_name** | **String** | | |
|
|
9
|
+
| **magic_link_url** | **String** | | [optional] |
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
@@ -14,7 +15,8 @@ require 'merge_ats_client'
|
|
|
14
15
|
|
|
15
16
|
instance = MergeATSClient::LinkToken.new(
|
|
16
17
|
link_token: necdP7FtdASl1fQwm62be2_dM4wBG8_GactqoUV0,
|
|
17
|
-
integration_name: Lever
|
|
18
|
+
integration_name: Lever,
|
|
19
|
+
magic_link_url: https://link.merge.dev/asdfjkl12345jsndfgi2i83n
|
|
18
20
|
)
|
|
19
21
|
```
|
|
20
22
|
|
|
@@ -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
|
@@ -38,6 +38,7 @@ opts = {
|
|
|
38
38
|
end_user_origin_ids: 'end_user_origin_ids_example', # String | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
|
|
39
39
|
id: TODO, # String |
|
|
40
40
|
ids: 'ids_example', # String | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
|
|
41
|
+
include_duplicates: true, # Boolean | If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
|
|
41
42
|
integration_name: 'integration_name_example', # String | If provided, will only return linked accounts associated with the given integration name.
|
|
42
43
|
is_test_account: 'is_test_account_example', # String | If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
|
|
43
44
|
page_size: 56, # Integer | Number of results to return per page.
|
|
@@ -83,6 +84,7 @@ end
|
|
|
83
84
|
| **end_user_origin_ids** | **String** | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. | [optional] |
|
|
84
85
|
| **id** | [**String**](.md) | | [optional] |
|
|
85
86
|
| **ids** | **String** | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. | [optional] |
|
|
87
|
+
| **include_duplicates** | **Boolean** | If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account. | [optional] |
|
|
86
88
|
| **integration_name** | **String** | If provided, will only return linked accounts associated with the given integration name. | [optional] |
|
|
87
89
|
| **is_test_account** | **String** | If included, will only include test linked accounts. If not included, will only include non-test linked accounts. | [optional] |
|
|
88
90
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
data/docs/Offer.md
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
| **start_date** | **Time** | The employment start date on the offer. | [optional] |
|
|
15
15
|
| **status** | [**OfferStatusEnum**](OfferStatusEnum.md) | The offer's status. | [optional] |
|
|
16
16
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
17
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
|
17
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
data/docs/OffersApi.md
CHANGED
|
@@ -38,11 +38,12 @@ opts = {
|
|
|
38
38
|
creator_id: 'creator_id_example', # String | If provided, will only return offers created by this user.
|
|
39
39
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
|
40
40
|
expand: 'application', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
41
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
|
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
43
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
|
44
44
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
|
45
45
|
page_size: 56, # Integer | Number of results to return per page.
|
|
46
|
+
remote_fields: 'status', # String | Which fields should be returned in non-normalized form.
|
|
46
47
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
|
47
48
|
}
|
|
48
49
|
|
|
@@ -84,11 +85,12 @@ end
|
|
|
84
85
|
| **creator_id** | **String** | If provided, will only return offers created by this user. | [optional] |
|
|
85
86
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
|
86
87
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
87
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
|
88
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
|
88
89
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
89
90
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
|
90
91
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
|
91
92
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
93
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
|
92
94
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
|
93
95
|
|
|
94
96
|
### Return type
|
|
@@ -131,7 +133,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
|
131
133
|
id = TODO # String |
|
|
132
134
|
opts = {
|
|
133
135
|
expand: 'application', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
134
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
136
|
+
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 | Which fields should be returned in non-normalized form.
|
|
135
138
|
}
|
|
136
139
|
|
|
137
140
|
begin
|
|
@@ -169,6 +172,7 @@ end
|
|
|
169
172
|
| **id** | [**String**](.md) | | |
|
|
170
173
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
171
174
|
| **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** | Which fields should be returned in non-normalized form. | [optional] |
|
|
172
176
|
|
|
173
177
|
### Return type
|
|
174
178
|
|
data/docs/Office.md
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **name** | **String** | The office's name. | [optional] |
|
|
10
10
|
| **location** | **String** | The office's location. | [optional] |
|
|
11
11
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
12
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
|
12
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
data/docs/OfficesApi.md
CHANGED
|
@@ -35,7 +35,7 @@ opts = {
|
|
|
35
35
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
|
38
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
|
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
40
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
|
41
41
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
|
@@ -78,7 +78,7 @@ end
|
|
|
78
78
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
|
79
79
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
|
80
80
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
|
81
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
|
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
83
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
|
84
84
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
|
@@ -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: null,
|
|
18
|
+
previous: null,
|
|
19
|
+
results: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/PhoneNumberRequest.md
CHANGED
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **value** | **String** | The phone number. | [optional] |
|
|
8
8
|
| **phone_number_type** | [**PhoneNumberTypeEnum**](PhoneNumberTypeEnum.md) | The type of phone number. | [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
|
|
data/docs/RejectReason.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
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
10
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
11
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
|
11
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
data/docs/RejectReasonsApi.md
CHANGED
|
@@ -35,7 +35,7 @@ opts = {
|
|
|
35
35
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
|
38
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
|
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
40
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
|
41
41
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
|
@@ -78,7 +78,7 @@ end
|
|
|
78
78
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
|
79
79
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
|
80
80
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
|
81
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
|
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
83
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
|
84
84
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
data/docs/RemoteResponse.md
CHANGED
|
@@ -7,7 +7,9 @@
|
|
|
7
7
|
| **method** | **String** | | |
|
|
8
8
|
| **path** | **String** | | |
|
|
9
9
|
| **status** | **Integer** | | |
|
|
10
|
-
| **response** | [**
|
|
10
|
+
| **response** | [**AnyType**](.md) | | |
|
|
11
|
+
| **response_headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
12
|
+
| **response_type** | [**ResponseTypeEnum**](ResponseTypeEnum.md) | | [optional] |
|
|
11
13
|
| **headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
12
14
|
|
|
13
15
|
## Example
|
|
@@ -20,6 +22,8 @@ instance = MergeATSClient::RemoteResponse.new(
|
|
|
20
22
|
path: /scooters,
|
|
21
23
|
status: 200,
|
|
22
24
|
response: {"scooters":[{"company":"Lime","model":"Gen 2.5"},{"company":"Bird","model":"Bird Zero"}]},
|
|
25
|
+
response_headers: {"X-Page-Token":"value"},
|
|
26
|
+
response_type: JSON,
|
|
23
27
|
headers: {"EXTRA-HEADER":"value","Authorization":"<redacted>"}
|
|
24
28
|
)
|
|
25
29
|
```
|
data/docs/RemoteUser.md
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
| **remote_created_at** | **Time** | When the third party's user was created. | [optional] |
|
|
14
14
|
| **access_role** | [**AccessRoleEnum**](AccessRoleEnum.md) | The user's role. | [optional] |
|
|
15
15
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
16
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
|
16
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# MergeATSClient::ResponseTypeEnum
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'merge_ats_client'
|
|
12
|
+
|
|
13
|
+
instance = MergeATSClient::ResponseTypeEnum.new()
|
|
14
|
+
```
|
|
15
|
+
|
data/docs/ScheduledInterview.md
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
| **remote_updated_at** | **Time** | When the third party's interview was updated. | [optional] |
|
|
18
18
|
| **status** | [**ScheduledInterviewStatusEnum**](ScheduledInterviewStatusEnum.md) | The interview's status. | [optional] |
|
|
19
19
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
20
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
|
20
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
|
21
21
|
|
|
22
22
|
## Example
|
|
23
23
|
|
data/docs/Scorecard.md
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
| **submitted_at** | **Time** | When the scorecard was submitted. | [optional] |
|
|
14
14
|
| **overall_recommendation** | [**OverallRecommendationEnum**](OverallRecommendationEnum.md) | The inteviewer's recommendation. | [optional] |
|
|
15
15
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
16
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
|
16
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
data/docs/ScorecardsApi.md
CHANGED
|
@@ -37,13 +37,14 @@ opts = {
|
|
|
37
37
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
|
38
38
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
|
39
39
|
expand: 'application', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
40
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
|
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
42
|
interview_id: 'interview_id_example', # String | If provided, will only return scorecards for this interview.
|
|
43
43
|
interviewer_id: 'interviewer_id_example', # String | If provided, will only return scorecards for this interviewer.
|
|
44
44
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
|
45
45
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
|
46
46
|
page_size: 56, # Integer | Number of results to return per page.
|
|
47
|
+
remote_fields: 'overall_recommendation', # String | Which fields should be returned in non-normalized form.
|
|
47
48
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
|
48
49
|
}
|
|
49
50
|
|
|
@@ -84,13 +85,14 @@ end
|
|
|
84
85
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
|
85
86
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
|
86
87
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
87
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
|
88
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
|
88
89
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
89
90
|
| **interview_id** | **String** | If provided, will only return scorecards for this interview. | [optional] |
|
|
90
91
|
| **interviewer_id** | **String** | If provided, will only return scorecards for this interviewer. | [optional] |
|
|
91
92
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
|
92
93
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
|
93
94
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
95
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
|
94
96
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
|
95
97
|
|
|
96
98
|
### Return type
|
|
@@ -133,7 +135,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
|
133
135
|
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
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
138
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
139
|
+
remote_fields: 'overall_recommendation' # String | Which fields should be returned in non-normalized form.
|
|
137
140
|
}
|
|
138
141
|
|
|
139
142
|
begin
|
|
@@ -171,6 +174,7 @@ end
|
|
|
171
174
|
| **id** | [**String**](.md) | | |
|
|
172
175
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
173
176
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
177
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
|
174
178
|
|
|
175
179
|
### Return type
|
|
176
180
|
|