merge_ats_client 2.0.0 → 2.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +8 -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/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/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/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/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/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/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/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/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_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/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/overall_recommendation_enum.rb +17 -7
- 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/{remote_data_request.rb → update_application_stage_request.rb} +26 -35
- 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 +2 -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/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/data_passthrough_request_spec.rb +6 -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/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
- metadata +115 -108
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2344d095cbeeea6374687e12b7ce6391d66c540ce55f02194fbe62cddd20d340
|
4
|
+
data.tar.gz: ecceee92235ac642738c1df988e8c66cc772be09010741023ff46779606f2035
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 87b23615ba3e37592531ee58887c6173ec0a72c8d8bf420fa971c81249988ce1238cfe2f8fcaec2b2b05aa4f0a2a64cb1275c351fde0e899cb944cccb4f6fe85
|
7
|
+
data.tar.gz: 479cd9daae95fd255ed4bbd8c1138d39d53f60fd6716ed0cdf7ea66712a7035e480dded2e44bec1493db163230ce520f43b58390d47b5e2087f7b09a49863ce9
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The unified API for building rich integrations with multiple Applicant Tracking
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 1.0
|
10
|
-
- Package version: 2.0.
|
10
|
+
- Package version: 2.0.1
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build merge_ats_client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./merge_ats_client-2.0.
|
27
|
+
gem install ./merge_ats_client-2.0.1.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./merge_ats_client-2.0.
|
30
|
+
(for development, run `gem install --dev ./merge_ats_client-2.0.1.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'merge_ats_client', '~> 2.0.
|
36
|
+
gem 'merge_ats_client', '~> 2.0.1'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -62,7 +62,7 @@ MergeATSClient.configure do |config|
|
|
62
62
|
# Configure API key authorization: tokenAuth
|
63
63
|
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
64
64
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
65
|
-
config.api_key_prefix['tokenAuth'] = 'Bearer'
|
65
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
66
66
|
end
|
67
67
|
|
68
68
|
api_instance = MergeATSClient::AccountDetailsApi.new
|
@@ -87,6 +87,7 @@ Class | Method | HTTP request | Description
|
|
87
87
|
*MergeATSClient::AccountTokenApi* | [**account_token_retrieve**](docs/AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} |
|
88
88
|
*MergeATSClient::ActivitiesApi* | [**activities_list**](docs/ActivitiesApi.md#activities_list) | **GET** /activities |
|
89
89
|
*MergeATSClient::ActivitiesApi* | [**activities_retrieve**](docs/ActivitiesApi.md#activities_retrieve) | **GET** /activities/{id} |
|
90
|
+
*MergeATSClient::ApplicationsApi* | [**applications_change_stage_create**](docs/ApplicationsApi.md#applications_change_stage_create) | **POST** /applications/{id}/change-stage |
|
90
91
|
*MergeATSClient::ApplicationsApi* | [**applications_create**](docs/ApplicationsApi.md#applications_create) | **POST** /applications |
|
91
92
|
*MergeATSClient::ApplicationsApi* | [**applications_list**](docs/ApplicationsApi.md#applications_list) | **GET** /applications |
|
92
93
|
*MergeATSClient::ApplicationsApi* | [**applications_meta_post_retrieve**](docs/ApplicationsApi.md#applications_meta_post_retrieve) | **GET** /applications/meta/post |
|
@@ -219,18 +220,19 @@ Class | Method | HTTP request | Description
|
|
219
220
|
- [MergeATSClient::ReasonEnum](docs/ReasonEnum.md)
|
220
221
|
- [MergeATSClient::RejectReason](docs/RejectReason.md)
|
221
222
|
- [MergeATSClient::RemoteData](docs/RemoteData.md)
|
222
|
-
- [MergeATSClient::RemoteDataRequest](docs/RemoteDataRequest.md)
|
223
223
|
- [MergeATSClient::RemoteKey](docs/RemoteKey.md)
|
224
224
|
- [MergeATSClient::RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
|
225
225
|
- [MergeATSClient::RemoteResponse](docs/RemoteResponse.md)
|
226
226
|
- [MergeATSClient::RemoteUser](docs/RemoteUser.md)
|
227
227
|
- [MergeATSClient::RequestFormatEnum](docs/RequestFormatEnum.md)
|
228
|
+
- [MergeATSClient::ResponseTypeEnum](docs/ResponseTypeEnum.md)
|
228
229
|
- [MergeATSClient::ScheduledInterview](docs/ScheduledInterview.md)
|
229
230
|
- [MergeATSClient::ScheduledInterviewStatusEnum](docs/ScheduledInterviewStatusEnum.md)
|
230
231
|
- [MergeATSClient::Scorecard](docs/Scorecard.md)
|
231
232
|
- [MergeATSClient::SyncStatus](docs/SyncStatus.md)
|
232
233
|
- [MergeATSClient::SyncStatusStatusEnum](docs/SyncStatusStatusEnum.md)
|
233
234
|
- [MergeATSClient::Tag](docs/Tag.md)
|
235
|
+
- [MergeATSClient::UpdateApplicationStageRequest](docs/UpdateApplicationStageRequest.md)
|
234
236
|
- [MergeATSClient::Url](docs/Url.md)
|
235
237
|
- [MergeATSClient::UrlRequest](docs/UrlRequest.md)
|
236
238
|
- [MergeATSClient::UrlTypeEnum](docs/UrlTypeEnum.md)
|
data/docs/AccountDetails.md
CHANGED
@@ -13,6 +13,7 @@
|
|
13
13
|
| **end_user_email_address** | **String** | | [optional][readonly] |
|
14
14
|
| **status** | **String** | | [optional][readonly] |
|
15
15
|
| **webhook_listener_url** | **String** | | [optional][readonly] |
|
16
|
+
| **is_duplicate** | **Boolean** | Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. | [optional][readonly] |
|
16
17
|
|
17
18
|
## Example
|
18
19
|
|
@@ -28,7 +29,8 @@ instance = MergeATSClient::AccountDetails.new(
|
|
28
29
|
end_user_organization_name: Waystar Royco,
|
29
30
|
end_user_email_address: kendall.roy@waystar-royco.com,
|
30
31
|
status: COMPLETE,
|
31
|
-
webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4
|
32
|
+
webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4,
|
33
|
+
is_duplicate: true
|
32
34
|
)
|
33
35
|
```
|
34
36
|
|
@@ -12,6 +12,7 @@
|
|
12
12
|
| **end_user_organization_name** | **String** | | |
|
13
13
|
| **end_user_email_address** | **String** | | |
|
14
14
|
| **webhook_listener_url** | **String** | | |
|
15
|
+
| **is_duplicate** | **Boolean** | Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. | [optional] |
|
15
16
|
| **integration** | [**AccountDetailsAndActionsIntegration**](AccountDetailsAndActionsIntegration.md) | | [optional] |
|
16
17
|
|
17
18
|
## Example
|
@@ -28,6 +29,7 @@ instance = MergeATSClient::AccountDetailsAndActions.new(
|
|
28
29
|
end_user_organization_name: Foo Bar, LLC,
|
29
30
|
end_user_email_address: hradmin@foobar.dev,
|
30
31
|
webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4,
|
32
|
+
is_duplicate: true,
|
31
33
|
integration: null
|
32
34
|
)
|
33
35
|
```
|
data/docs/ActivitiesApi.md
CHANGED
@@ -36,11 +36,12 @@ 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: 'user', # 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
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
42
42
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
43
43
|
page_size: 56, # Integer | Number of results to return per page.
|
44
|
+
remote_fields: 'activity_type', # String | Which fields should be returned in non-normalized form.
|
44
45
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
45
46
|
user_id: 'user_id_example' # String | If provided, will only return activities done by this user.
|
46
47
|
}
|
@@ -81,11 +82,12 @@ end
|
|
81
82
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
82
83
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
83
84
|
| **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
|
85
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
85
86
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
86
87
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
87
88
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
88
89
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
90
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
89
91
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
90
92
|
| **user_id** | **String** | If provided, will only return activities done by this user. | [optional] |
|
91
93
|
|
@@ -129,7 +131,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
129
131
|
id = TODO # String |
|
130
132
|
opts = {
|
131
133
|
expand: 'user', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
132
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
134
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
135
|
+
remote_fields: 'activity_type' # String | Which fields should be returned in non-normalized form.
|
133
136
|
}
|
134
137
|
|
135
138
|
begin
|
@@ -167,6 +170,7 @@ end
|
|
167
170
|
| **id** | [**String**](.md) | | |
|
168
171
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
169
172
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
173
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
170
174
|
|
171
175
|
### Return type
|
172
176
|
|
data/docs/Activity.md
CHANGED
@@ -13,7 +13,7 @@
|
|
13
13
|
| **body** | **String** | The activity's body. | [optional] |
|
14
14
|
| **visibility** | [**VisibilityEnum**](VisibilityEnum.md) | The activity's visibility. | [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/ApplicationsApi.md
CHANGED
@@ -4,12 +4,94 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**applications_change_stage_create**](ApplicationsApi.md#applications_change_stage_create) | **POST** /applications/{id}/change-stage | |
|
7
8
|
| [**applications_create**](ApplicationsApi.md#applications_create) | **POST** /applications | |
|
8
9
|
| [**applications_list**](ApplicationsApi.md#applications_list) | **GET** /applications | |
|
9
10
|
| [**applications_meta_post_retrieve**](ApplicationsApi.md#applications_meta_post_retrieve) | **GET** /applications/meta/post | |
|
10
11
|
| [**applications_retrieve**](ApplicationsApi.md#applications_retrieve) | **GET** /applications/{id} | |
|
11
12
|
|
12
13
|
|
14
|
+
## applications_change_stage_create
|
15
|
+
|
16
|
+
> <ApplicationResponse> applications_change_stage_create(x_account_token, id, opts)
|
17
|
+
|
18
|
+
|
19
|
+
|
20
|
+
Updates the `current_stage` field of an `Application` object
|
21
|
+
|
22
|
+
### Examples
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'time'
|
26
|
+
require 'merge_ats_client'
|
27
|
+
# setup authorization
|
28
|
+
MergeATSClient.configure do |config|
|
29
|
+
# Configure API key authorization: tokenAuth
|
30
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
31
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
33
|
+
end
|
34
|
+
|
35
|
+
api_instance = MergeATSClient::ApplicationsApi.new
|
36
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
37
|
+
id = TODO # String |
|
38
|
+
opts = {
|
39
|
+
is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
|
40
|
+
run_async: true, # Boolean | Whether or not third-party updates should be run asynchronously.
|
41
|
+
update_application_stage_request: MergeATSClient::UpdateApplicationStageRequest.new # UpdateApplicationStageRequest |
|
42
|
+
}
|
43
|
+
|
44
|
+
begin
|
45
|
+
|
46
|
+
result = api_instance.applications_change_stage_create(x_account_token, id, opts)
|
47
|
+
p result
|
48
|
+
rescue MergeATSClient::ApiError => e
|
49
|
+
puts "Error when calling ApplicationsApi->applications_change_stage_create: #{e}"
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
#### Using the applications_change_stage_create_with_http_info variant
|
54
|
+
|
55
|
+
This returns an Array which contains the response data, status code and headers.
|
56
|
+
|
57
|
+
> <Array(<ApplicationResponse>, Integer, Hash)> applications_change_stage_create_with_http_info(x_account_token, id, opts)
|
58
|
+
|
59
|
+
```ruby
|
60
|
+
begin
|
61
|
+
|
62
|
+
data, status_code, headers = api_instance.applications_change_stage_create_with_http_info(x_account_token, id, opts)
|
63
|
+
p status_code # => 2xx
|
64
|
+
p headers # => { ... }
|
65
|
+
p data # => <ApplicationResponse>
|
66
|
+
rescue MergeATSClient::ApiError => e
|
67
|
+
puts "Error when calling ApplicationsApi->applications_change_stage_create_with_http_info: #{e}"
|
68
|
+
end
|
69
|
+
```
|
70
|
+
|
71
|
+
### Parameters
|
72
|
+
|
73
|
+
| Name | Type | Description | Notes |
|
74
|
+
| ---- | ---- | ----------- | ----- |
|
75
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
76
|
+
| **id** | [**String**](.md) | | |
|
77
|
+
| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
|
78
|
+
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
79
|
+
| **update_application_stage_request** | [**UpdateApplicationStageRequest**](UpdateApplicationStageRequest.md) | | [optional] |
|
80
|
+
|
81
|
+
### Return type
|
82
|
+
|
83
|
+
[**ApplicationResponse**](ApplicationResponse.md)
|
84
|
+
|
85
|
+
### Authorization
|
86
|
+
|
87
|
+
[tokenAuth](../README.md#tokenAuth)
|
88
|
+
|
89
|
+
### HTTP request headers
|
90
|
+
|
91
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
92
|
+
- **Accept**: application/json
|
93
|
+
|
94
|
+
|
13
95
|
## applications_create
|
14
96
|
|
15
97
|
> <ApplicationResponse> applications_create(x_account_token, application_endpoint_request, opts)
|
@@ -120,7 +202,7 @@ opts = {
|
|
120
202
|
current_stage_id: 'current_stage_id_example', # String | If provided, will only return applications at this interview stage.
|
121
203
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
122
204
|
expand: 'candidate', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
123
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
205
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
124
206
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
125
207
|
job_id: 'job_id_example', # String | If provided, will only return applications for this job.
|
126
208
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
@@ -170,7 +252,7 @@ end
|
|
170
252
|
| **current_stage_id** | **String** | If provided, will only return applications at this interview stage. | [optional] |
|
171
253
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
172
254
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
173
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
255
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
174
256
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
175
257
|
| **job_id** | **String** | If provided, will only return applications for this job. | [optional] |
|
176
258
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
data/docs/AttachmentsApi.md
CHANGED
@@ -118,11 +118,12 @@ opts = {
|
|
118
118
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
119
119
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
120
120
|
expand: 'candidate', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
121
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
121
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
122
122
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
123
123
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
124
124
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
125
125
|
page_size: 56, # Integer | Number of results to return per page.
|
126
|
+
remote_fields: 'attachment_type', # String | Which fields should be returned in non-normalized form.
|
126
127
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
127
128
|
}
|
128
129
|
|
@@ -163,11 +164,12 @@ end
|
|
163
164
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
164
165
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
165
166
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
166
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
167
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
167
168
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
168
169
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
169
170
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
170
171
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
172
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
171
173
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
172
174
|
|
173
175
|
### Return type
|
@@ -281,7 +283,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
281
283
|
id = TODO # String |
|
282
284
|
opts = {
|
283
285
|
expand: 'candidate', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
284
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
286
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
287
|
+
remote_fields: 'attachment_type' # String | Which fields should be returned in non-normalized form.
|
285
288
|
}
|
286
289
|
|
287
290
|
begin
|
@@ -319,6 +322,7 @@ end
|
|
319
322
|
| **id** | [**String**](.md) | | |
|
320
323
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
321
324
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
325
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
322
326
|
|
323
327
|
### Return type
|
324
328
|
|
data/docs/CandidatesApi.md
CHANGED
@@ -194,7 +194,7 @@ opts = {
|
|
194
194
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
195
195
|
expand: 'applications', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
196
196
|
first_name: 'first_name_example', # String | If provided, will only return candidates with this first name.
|
197
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
197
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
198
198
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
199
199
|
last_name: 'last_name_example', # String | If provided, will only return candidates with this last name.
|
200
200
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
@@ -240,7 +240,7 @@ end
|
|
240
240
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
241
241
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
242
242
|
| **first_name** | **String** | If provided, will only return candidates with this first name. | [optional] |
|
243
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
243
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
244
244
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
245
245
|
| **last_name** | **String** | If provided, will only return candidates with this last name. | [optional] |
|
246
246
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
@@ -11,6 +11,7 @@
|
|
11
11
|
| **multipart_form_data** | [**Array<MultipartFormFieldRequest>**](MultipartFormFieldRequest.md) | Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`. | [optional] |
|
12
12
|
| **headers** | [**Hash<String, AnyType>**](AnyType.md) | The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. | [optional] |
|
13
13
|
| **request_format** | [**RequestFormatEnum**](RequestFormatEnum.md) | | [optional] |
|
14
|
+
| **normalize_response** | **Boolean** | | [optional] |
|
14
15
|
|
15
16
|
## Example
|
16
17
|
|
@@ -24,7 +25,8 @@ instance = MergeATSClient::DataPassthroughRequest.new(
|
|
24
25
|
data: {"company": "Lime", "model": "Gen 2.5"},
|
25
26
|
multipart_form_data: null,
|
26
27
|
headers: {"EXTRA-HEADER":"value"},
|
27
|
-
request_format: JSON
|
28
|
+
request_format: JSON,
|
29
|
+
normalize_response: null
|
28
30
|
)
|
29
31
|
```
|
30
32
|
|
data/docs/Department.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 department'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/DepartmentsApi.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/EEOC.md
CHANGED
@@ -13,7 +13,7 @@
|
|
13
13
|
| **veteran_status** | [**VeteranStatusEnum**](VeteranStatusEnum.md) | The candidate's veteran status. | [optional] |
|
14
14
|
| **disability_status** | [**DisabilityStatusEnum**](DisabilityStatusEnum.md) | The candidate's disability status. | [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/EeocsApi.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: 'candidate', # 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: 'disability_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
|
}
|
47
48
|
|
@@ -82,11 +83,12 @@ end
|
|
82
83
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
83
84
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
84
85
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
85
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
86
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
86
87
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
87
88
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
88
89
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
89
90
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
91
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
90
92
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
91
93
|
|
92
94
|
### Return type
|
@@ -129,7 +131,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
129
131
|
id = TODO # String |
|
130
132
|
opts = {
|
131
133
|
expand: 'candidate', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
132
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
134
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
135
|
+
remote_fields: 'disability_status' # String | Which fields should be returned in non-normalized form.
|
133
136
|
}
|
134
137
|
|
135
138
|
begin
|
@@ -167,6 +170,7 @@ end
|
|
167
170
|
| **id** | [**String**](.md) | | |
|
168
171
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
169
172
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
173
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
170
174
|
|
171
175
|
### Return type
|
172
176
|
|
@@ -4,12 +4,13 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **end_user_email_address** | **String** |
|
8
|
-
| **end_user_organization_name** | **String** |
|
9
|
-
| **end_user_origin_id** | **String** |
|
10
|
-
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) |
|
11
|
-
| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token
|
12
|
-
| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720] for how long this token is valid. Defaults to 30 | [optional][default to 30] |
|
7
|
+
| **end_user_email_address** | **String** | Your end user's email address. | |
|
8
|
+
| **end_user_organization_name** | **String** | Your end user's organization. | |
|
9
|
+
| **end_user_origin_id** | **String** | Unique ID for your end user. | |
|
10
|
+
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | The integration categories to show in Merge Link. | |
|
11
|
+
| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://www.merge.dev/docs/basics/integration-metadata/. | [optional] |
|
12
|
+
| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. | [optional][default to 30] |
|
13
|
+
| **should_create_magic_link_url** | **Boolean** | Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/product/integrations,-fast.-say-hello-to-magic-link/. | [optional][default to false] |
|
13
14
|
|
14
15
|
## Example
|
15
16
|
|
@@ -22,7 +23,8 @@ instance = MergeATSClient::EndUserDetailsRequest.new(
|
|
22
23
|
end_user_origin_id: null,
|
23
24
|
categories: null,
|
24
25
|
integration: null,
|
25
|
-
link_expiry_mins: null
|
26
|
+
link_expiry_mins: null,
|
27
|
+
should_create_magic_link_url: null
|
26
28
|
)
|
27
29
|
```
|
28
30
|
|
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] |
|