merge_ats_client 1.0.1 → 1.0.2
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/README.md +13 -3
- data/docs/AccountToken.md +3 -1
- data/docs/ApplicationsApi.md +0 -82
- data/docs/Attachment.md +2 -0
- data/docs/AttachmentRequest.md +26 -0
- data/docs/AttachmentTypeEnum.md +15 -0
- data/docs/AttachmentsApi.md +80 -0
- data/docs/AvailableActions.md +1 -1
- data/docs/Candidate.md +2 -2
- data/docs/CandidateRequest.md +5 -1
- data/docs/InterviewsApi.md +80 -0
- data/docs/JobsApi.md +3 -1
- data/docs/ModelOperation.md +3 -1
- data/docs/PaginatedSyncStatusList.md +22 -0
- data/docs/RemoteUserRequest.md +30 -0
- data/docs/ScheduledInterviewRequest.md +38 -0
- data/docs/ScorecardRequest.md +30 -0
- data/docs/ScorecardsApi.md +80 -0
- data/docs/SyncStatus.md +1 -1
- data/docs/SyncStatusApi.md +89 -11
- data/docs/SyncStatusStatusEnum.md +15 -0
- data/docs/UsersApi.md +81 -0
- data/lib/merge_ats_client/api/applications_api.rb +0 -82
- data/lib/merge_ats_client/api/attachments_api.rb +76 -0
- data/lib/merge_ats_client/api/interviews_api.rb +76 -0
- data/lib/merge_ats_client/api/jobs_api.rb +7 -0
- data/lib/merge_ats_client/api/scorecards_api.rb +76 -0
- data/lib/merge_ats_client/api/sync_status_api.rb +78 -10
- data/lib/merge_ats_client/api/users_api.rb +79 -0
- data/lib/merge_ats_client/api_client.rb +1 -1
- data/lib/merge_ats_client/models/account_token.rb +18 -4
- data/lib/merge_ats_client/models/activity.rb +1 -1
- data/lib/merge_ats_client/models/application.rb +1 -1
- data/lib/merge_ats_client/models/attachment.rb +13 -2
- data/lib/merge_ats_client/models/attachment_request.rb +279 -0
- data/lib/merge_ats_client/models/attachment_type_enum.rb +39 -0
- data/lib/merge_ats_client/models/candidate.rb +1 -1
- data/lib/merge_ats_client/models/candidate_request.rb +26 -4
- data/lib/merge_ats_client/models/data_passthrough_request.rb +1 -0
- data/lib/merge_ats_client/models/eeoc.rb +1 -1
- data/lib/merge_ats_client/models/end_user_details_request.rb +1 -5
- data/lib/merge_ats_client/models/job.rb +1 -1
- data/lib/merge_ats_client/models/job_interview_stage.rb +1 -1
- data/lib/merge_ats_client/models/model_operation.rb +20 -4
- data/lib/merge_ats_client/models/offer.rb +1 -1
- data/lib/merge_ats_client/models/paginated_sync_status_list.rb +240 -0
- data/lib/merge_ats_client/models/remote_user_request.rb +302 -0
- data/lib/merge_ats_client/models/scheduled_interview.rb +1 -1
- data/lib/merge_ats_client/models/scheduled_interview_request.rb +331 -0
- data/lib/merge_ats_client/models/scorecard.rb +1 -1
- data/lib/merge_ats_client/models/scorecard_request.rb +287 -0
- data/lib/merge_ats_client/models/sync_status.rb +1 -1
- data/lib/merge_ats_client/models/sync_status_status_enum.rb +37 -0
- data/lib/merge_ats_client/version.rb +2 -2
- data/lib/merge_ats_client.rb +7 -3
- data/spec/api/delete_account_api_spec.rb +46 -0
- data/spec/api/generate_key_api_spec.rb +46 -0
- data/spec/api/issues_api_spec.rb +65 -0
- data/spec/models/attachment_request_spec.rb +58 -0
- data/spec/models/attachment_type_enum_spec.rb +28 -0
- data/spec/models/generate_remote_key_request_spec.rb +1 -1
- data/spec/models/issue_spec.rb +70 -0
- data/spec/models/issue_status_enum_spec.rb +28 -0
- data/spec/models/paginated_issue_list_spec.rb +46 -0
- data/spec/models/paginated_sync_status_list_spec.rb +46 -0
- data/spec/models/remote_data_request_spec.rb +40 -0
- data/spec/models/remote_user_request_spec.rb +70 -0
- data/spec/models/scheduled_interview_request_spec.rb +94 -0
- data/spec/models/scorecard_request_spec.rb +70 -0
- data/spec/models/sync_status_status_enum_spec.rb +28 -0
- data/test_ats.rb +13 -13
- data/test_signature.rb +2 -2
- metadata +44 -3
- data/merge_ats_client-1.0.0.gem +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6dbc9859520778d9dfaccfe22ec307d3fbd5f5215dafb79e1d6b198de2571508
|
4
|
+
data.tar.gz: 30532fbbff70e35e0c456f4f2feb4eb7216889e25ee880042bb9f65fc9e59a6f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5f096bf4ee6ce2e524376a5a3fc2e7cf4382401121aa9d8d7bc400f923a254afcc6b342bea8743f51296b7c2e15aa66fca9e2028a8a1461229ade1a40b3f6f8d
|
7
|
+
data.tar.gz: 42754969c76a8553e0dc5a444ab67f2223a924e3bff4866aa0cd60305b53e44e72a7e630ed5010ced74ed3c9534ea073a9ff3a032ea82b10bd327f24d90dcc83
|
data/README.md
CHANGED
@@ -88,8 +88,8 @@ Class | Method | HTTP request | Description
|
|
88
88
|
*MergeATSClient::ActivitiesApi* | [**activities_retrieve**](docs/ActivitiesApi.md#activities_retrieve) | **GET** /activities/{id} |
|
89
89
|
*MergeATSClient::ApplicationsApi* | [**applications_create**](docs/ApplicationsApi.md#applications_create) | **POST** /applications |
|
90
90
|
*MergeATSClient::ApplicationsApi* | [**applications_list**](docs/ApplicationsApi.md#applications_list) | **GET** /applications |
|
91
|
-
*MergeATSClient::ApplicationsApi* | [**applications_partial_update**](docs/ApplicationsApi.md#applications_partial_update) | **PATCH** /applications/{id} |
|
92
91
|
*MergeATSClient::ApplicationsApi* | [**applications_retrieve**](docs/ApplicationsApi.md#applications_retrieve) | **GET** /applications/{id} |
|
92
|
+
*MergeATSClient::AttachmentsApi* | [**attachments_create**](docs/AttachmentsApi.md#attachments_create) | **POST** /attachments |
|
93
93
|
*MergeATSClient::AttachmentsApi* | [**attachments_list**](docs/AttachmentsApi.md#attachments_list) | **GET** /attachments |
|
94
94
|
*MergeATSClient::AttachmentsApi* | [**attachments_retrieve**](docs/AttachmentsApi.md#attachments_retrieve) | **GET** /attachments/{id} |
|
95
95
|
*MergeATSClient::AvailableActionsApi* | [**available_actions_retrieve**](docs/AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions |
|
@@ -101,6 +101,7 @@ Class | Method | HTTP request | Description
|
|
101
101
|
*MergeATSClient::EeocsApi* | [**eeocs_list**](docs/EeocsApi.md#eeocs_list) | **GET** /eeocs |
|
102
102
|
*MergeATSClient::EeocsApi* | [**eeocs_retrieve**](docs/EeocsApi.md#eeocs_retrieve) | **GET** /eeocs/{id} |
|
103
103
|
*MergeATSClient::GenerateKeyApi* | [**generate_key_create**](docs/GenerateKeyApi.md#generate_key_create) | **POST** /generate-key |
|
104
|
+
*MergeATSClient::InterviewsApi* | [**interviews_create**](docs/InterviewsApi.md#interviews_create) | **POST** /interviews |
|
104
105
|
*MergeATSClient::InterviewsApi* | [**interviews_list**](docs/InterviewsApi.md#interviews_list) | **GET** /interviews |
|
105
106
|
*MergeATSClient::InterviewsApi* | [**interviews_retrieve**](docs/InterviewsApi.md#interviews_retrieve) | **GET** /interviews/{id} |
|
106
107
|
*MergeATSClient::JobInterviewStagesApi* | [**job_interview_stages_list**](docs/JobInterviewStagesApi.md#job_interview_stages_list) | **GET** /job-interview-stages |
|
@@ -116,10 +117,13 @@ Class | Method | HTTP request | Description
|
|
116
117
|
*MergeATSClient::RegenerateKeyApi* | [**regenerate_key_create**](docs/RegenerateKeyApi.md#regenerate_key_create) | **POST** /regenerate-key |
|
117
118
|
*MergeATSClient::RejectReasonsApi* | [**reject_reasons_list**](docs/RejectReasonsApi.md#reject_reasons_list) | **GET** /reject-reasons |
|
118
119
|
*MergeATSClient::RejectReasonsApi* | [**reject_reasons_retrieve**](docs/RejectReasonsApi.md#reject_reasons_retrieve) | **GET** /reject-reasons/{id} |
|
120
|
+
*MergeATSClient::ScorecardsApi* | [**scorecards_create**](docs/ScorecardsApi.md#scorecards_create) | **POST** /scorecards |
|
119
121
|
*MergeATSClient::ScorecardsApi* | [**scorecards_list**](docs/ScorecardsApi.md#scorecards_list) | **GET** /scorecards |
|
120
122
|
*MergeATSClient::ScorecardsApi* | [**scorecards_retrieve**](docs/ScorecardsApi.md#scorecards_retrieve) | **GET** /scorecards/{id} |
|
121
|
-
*MergeATSClient::SyncStatusApi* | [**
|
123
|
+
*MergeATSClient::SyncStatusApi* | [**sync_status_list**](docs/SyncStatusApi.md#sync_status_list) | **GET** /sync-status |
|
124
|
+
*MergeATSClient::SyncStatusApi* | [**sync_status_resync_create**](docs/SyncStatusApi.md#sync_status_resync_create) | **POST** /sync-status/resync |
|
122
125
|
*MergeATSClient::TagsApi* | [**tags_list**](docs/TagsApi.md#tags_list) | **GET** /tags |
|
126
|
+
*MergeATSClient::UsersApi* | [**users_create**](docs/UsersApi.md#users_create) | **POST** /users |
|
123
127
|
*MergeATSClient::UsersApi* | [**users_list**](docs/UsersApi.md#users_list) | **GET** /users |
|
124
128
|
*MergeATSClient::UsersApi* | [**users_retrieve**](docs/UsersApi.md#users_retrieve) | **GET** /users/{id} |
|
125
129
|
|
@@ -134,6 +138,8 @@ Class | Method | HTTP request | Description
|
|
134
138
|
- [MergeATSClient::Application](docs/Application.md)
|
135
139
|
- [MergeATSClient::ApplicationRequest](docs/ApplicationRequest.md)
|
136
140
|
- [MergeATSClient::Attachment](docs/Attachment.md)
|
141
|
+
- [MergeATSClient::AttachmentRequest](docs/AttachmentRequest.md)
|
142
|
+
- [MergeATSClient::AttachmentTypeEnum](docs/AttachmentTypeEnum.md)
|
137
143
|
- [MergeATSClient::AvailableActions](docs/AvailableActions.md)
|
138
144
|
- [MergeATSClient::Candidate](docs/Candidate.md)
|
139
145
|
- [MergeATSClient::CandidateRequest](docs/CandidateRequest.md)
|
@@ -171,8 +177,8 @@ Class | Method | HTTP request | Description
|
|
171
177
|
- [MergeATSClient::PaginatedRemoteUserList](docs/PaginatedRemoteUserList.md)
|
172
178
|
- [MergeATSClient::PaginatedScheduledInterviewList](docs/PaginatedScheduledInterviewList.md)
|
173
179
|
- [MergeATSClient::PaginatedScorecardList](docs/PaginatedScorecardList.md)
|
180
|
+
- [MergeATSClient::PaginatedSyncStatusList](docs/PaginatedSyncStatusList.md)
|
174
181
|
- [MergeATSClient::PaginatedTagList](docs/PaginatedTagList.md)
|
175
|
-
- [MergeATSClient::PatchedApplicationRequest](docs/PatchedApplicationRequest.md)
|
176
182
|
- [MergeATSClient::PhoneNumber](docs/PhoneNumber.md)
|
177
183
|
- [MergeATSClient::PhoneNumberRequest](docs/PhoneNumberRequest.md)
|
178
184
|
- [MergeATSClient::PhoneNumberTypeEnum](docs/PhoneNumberTypeEnum.md)
|
@@ -184,10 +190,14 @@ Class | Method | HTTP request | Description
|
|
184
190
|
- [MergeATSClient::RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
|
185
191
|
- [MergeATSClient::RemoteResponse](docs/RemoteResponse.md)
|
186
192
|
- [MergeATSClient::RemoteUser](docs/RemoteUser.md)
|
193
|
+
- [MergeATSClient::RemoteUserRequest](docs/RemoteUserRequest.md)
|
187
194
|
- [MergeATSClient::ScheduledInterview](docs/ScheduledInterview.md)
|
195
|
+
- [MergeATSClient::ScheduledInterviewRequest](docs/ScheduledInterviewRequest.md)
|
188
196
|
- [MergeATSClient::ScheduledInterviewStatusEnum](docs/ScheduledInterviewStatusEnum.md)
|
189
197
|
- [MergeATSClient::Scorecard](docs/Scorecard.md)
|
198
|
+
- [MergeATSClient::ScorecardRequest](docs/ScorecardRequest.md)
|
190
199
|
- [MergeATSClient::SyncStatus](docs/SyncStatus.md)
|
200
|
+
- [MergeATSClient::SyncStatusStatusEnum](docs/SyncStatusStatusEnum.md)
|
191
201
|
- [MergeATSClient::Tag](docs/Tag.md)
|
192
202
|
- [MergeATSClient::Url](docs/Url.md)
|
193
203
|
- [MergeATSClient::UrlRequest](docs/UrlRequest.md)
|
data/docs/AccountToken.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **account_token** | **String** | | |
|
8
|
+
| **integration** | [**AccountIntegration**](AccountIntegration.md) | | |
|
8
9
|
|
9
10
|
## Example
|
10
11
|
|
@@ -12,7 +13,8 @@
|
|
12
13
|
require 'merge_ats_client'
|
13
14
|
|
14
15
|
instance = MergeATSClient::AccountToken.new(
|
15
|
-
account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB
|
16
|
+
account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB,
|
17
|
+
integration: null
|
16
18
|
)
|
17
19
|
```
|
18
20
|
|
data/docs/ApplicationsApi.md
CHANGED
@@ -6,7 +6,6 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**applications_create**](ApplicationsApi.md#applications_create) | **POST** /applications | |
|
8
8
|
| [**applications_list**](ApplicationsApi.md#applications_list) | **GET** /applications | |
|
9
|
-
| [**applications_partial_update**](ApplicationsApi.md#applications_partial_update) | **PATCH** /applications/{id} | |
|
10
9
|
| [**applications_retrieve**](ApplicationsApi.md#applications_retrieve) | **GET** /applications/{id} | |
|
11
10
|
|
12
11
|
|
@@ -190,87 +189,6 @@ end
|
|
190
189
|
- **Accept**: application/json
|
191
190
|
|
192
191
|
|
193
|
-
## applications_partial_update
|
194
|
-
|
195
|
-
> <Application> applications_partial_update(x_account_token, id, remote_user_id, opts)
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
Updates an `Application` object with the given `id`.
|
200
|
-
|
201
|
-
### Examples
|
202
|
-
|
203
|
-
```ruby
|
204
|
-
require 'time'
|
205
|
-
require 'merge_ats_client'
|
206
|
-
# setup authorization
|
207
|
-
MergeATSClient.configure do |config|
|
208
|
-
# Configure API key authorization: tokenAuth
|
209
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
210
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
211
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
212
|
-
end
|
213
|
-
|
214
|
-
api_instance = MergeATSClient::ApplicationsApi.new
|
215
|
-
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
216
|
-
id = TODO # String |
|
217
|
-
remote_user_id = 'remote_user_id_example' # String | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.
|
218
|
-
opts = {
|
219
|
-
run_async: true, # Boolean | Whether or not third-party updates should be run asynchronously.
|
220
|
-
patched_application_request: MergeATSClient::PatchedApplicationRequest.new # PatchedApplicationRequest |
|
221
|
-
}
|
222
|
-
|
223
|
-
begin
|
224
|
-
|
225
|
-
result = api_instance.applications_partial_update(x_account_token, id, remote_user_id, opts)
|
226
|
-
p result
|
227
|
-
rescue MergeATSClient::ApiError => e
|
228
|
-
puts "Error when calling ApplicationsApi->applications_partial_update: #{e}"
|
229
|
-
end
|
230
|
-
```
|
231
|
-
|
232
|
-
#### Using the applications_partial_update_with_http_info variant
|
233
|
-
|
234
|
-
This returns an Array which contains the response data, status code and headers.
|
235
|
-
|
236
|
-
> <Array(<Application>, Integer, Hash)> applications_partial_update_with_http_info(x_account_token, id, remote_user_id, opts)
|
237
|
-
|
238
|
-
```ruby
|
239
|
-
begin
|
240
|
-
|
241
|
-
data, status_code, headers = api_instance.applications_partial_update_with_http_info(x_account_token, id, remote_user_id, opts)
|
242
|
-
p status_code # => 2xx
|
243
|
-
p headers # => { ... }
|
244
|
-
p data # => <Application>
|
245
|
-
rescue MergeATSClient::ApiError => e
|
246
|
-
puts "Error when calling ApplicationsApi->applications_partial_update_with_http_info: #{e}"
|
247
|
-
end
|
248
|
-
```
|
249
|
-
|
250
|
-
### Parameters
|
251
|
-
|
252
|
-
| Name | Type | Description | Notes |
|
253
|
-
| ---- | ---- | ----------- | ----- |
|
254
|
-
| **x_account_token** | **String** | Token identifying the end user. | |
|
255
|
-
| **id** | [**String**](.md) | | |
|
256
|
-
| **remote_user_id** | **String** | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | |
|
257
|
-
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
258
|
-
| **patched_application_request** | [**PatchedApplicationRequest**](PatchedApplicationRequest.md) | | [optional] |
|
259
|
-
|
260
|
-
### Return type
|
261
|
-
|
262
|
-
[**Application**](Application.md)
|
263
|
-
|
264
|
-
### Authorization
|
265
|
-
|
266
|
-
[tokenAuth](../README.md#tokenAuth)
|
267
|
-
|
268
|
-
### HTTP request headers
|
269
|
-
|
270
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
271
|
-
- **Accept**: application/json
|
272
|
-
|
273
|
-
|
274
192
|
## applications_retrieve
|
275
193
|
|
276
194
|
> <Application> applications_retrieve(x_account_token, id, opts)
|
data/docs/Attachment.md
CHANGED
@@ -9,6 +9,7 @@
|
|
9
9
|
| **file_name** | **String** | The attachment's name. | [optional] |
|
10
10
|
| **file_url** | **String** | The attachment's url. | [optional] |
|
11
11
|
| **candidate** | **String** | | [optional] |
|
12
|
+
| **attachment_type** | [**AttachmentTypeEnum**](AttachmentTypeEnum.md) | The attachment's type. | [optional] |
|
12
13
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
13
14
|
|
14
15
|
## Example
|
@@ -22,6 +23,7 @@ instance = MergeATSClient::Attachment.new(
|
|
22
23
|
file_name: Candidate Resume,
|
23
24
|
file_url: http://alturl.com/p749b,
|
24
25
|
candidate: 2872ba14-4084-492b-be96-e5eee6fc33ef,
|
26
|
+
attachment_type: RESUME,
|
25
27
|
remote_data: [{"path":"/attachments","data":["Varies by platform"]}]
|
26
28
|
)
|
27
29
|
```
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# MergeATSClient::AttachmentRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
8
|
+
| **file_name** | **String** | The attachment's name. | [optional] |
|
9
|
+
| **file_url** | **String** | The attachment's url. | [optional] |
|
10
|
+
| **candidate** | **String** | | [optional] |
|
11
|
+
| **attachment_type** | [**AttachmentTypeEnum**](AttachmentTypeEnum.md) | The attachment's type. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'merge_ats_client'
|
17
|
+
|
18
|
+
instance = MergeATSClient::AttachmentRequest.new(
|
19
|
+
remote_id: 11167,
|
20
|
+
file_name: Candidate Resume,
|
21
|
+
file_url: http://alturl.com/p749b,
|
22
|
+
candidate: 2872ba14-4084-492b-be96-e5eee6fc33ef,
|
23
|
+
attachment_type: RESUME
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeATSClient::AttachmentTypeEnum
|
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::AttachmentTypeEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/AttachmentsApi.md
CHANGED
@@ -4,10 +4,90 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**attachments_create**](AttachmentsApi.md#attachments_create) | **POST** /attachments | |
|
7
8
|
| [**attachments_list**](AttachmentsApi.md#attachments_list) | **GET** /attachments | |
|
8
9
|
| [**attachments_retrieve**](AttachmentsApi.md#attachments_retrieve) | **GET** /attachments/{id} | |
|
9
10
|
|
10
11
|
|
12
|
+
## attachments_create
|
13
|
+
|
14
|
+
> <Attachment> attachments_create(x_account_token, remote_user_id, opts)
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
Creates an `Attachment` object with the given values.
|
19
|
+
|
20
|
+
### Examples
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'time'
|
24
|
+
require 'merge_ats_client'
|
25
|
+
# setup authorization
|
26
|
+
MergeATSClient.configure do |config|
|
27
|
+
# Configure API key authorization: tokenAuth
|
28
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
29
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = MergeATSClient::AttachmentsApi.new
|
34
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
35
|
+
remote_user_id = 'remote_user_id_example' # String | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.
|
36
|
+
opts = {
|
37
|
+
run_async: true, # Boolean | Whether or not third-party updates should be run asynchronously.
|
38
|
+
attachment_request: MergeATSClient::AttachmentRequest.new # AttachmentRequest |
|
39
|
+
}
|
40
|
+
|
41
|
+
begin
|
42
|
+
|
43
|
+
result = api_instance.attachments_create(x_account_token, remote_user_id, opts)
|
44
|
+
p result
|
45
|
+
rescue MergeATSClient::ApiError => e
|
46
|
+
puts "Error when calling AttachmentsApi->attachments_create: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
#### Using the attachments_create_with_http_info variant
|
51
|
+
|
52
|
+
This returns an Array which contains the response data, status code and headers.
|
53
|
+
|
54
|
+
> <Array(<Attachment>, Integer, Hash)> attachments_create_with_http_info(x_account_token, remote_user_id, opts)
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
begin
|
58
|
+
|
59
|
+
data, status_code, headers = api_instance.attachments_create_with_http_info(x_account_token, remote_user_id, opts)
|
60
|
+
p status_code # => 2xx
|
61
|
+
p headers # => { ... }
|
62
|
+
p data # => <Attachment>
|
63
|
+
rescue MergeATSClient::ApiError => e
|
64
|
+
puts "Error when calling AttachmentsApi->attachments_create_with_http_info: #{e}"
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
### Parameters
|
69
|
+
|
70
|
+
| Name | Type | Description | Notes |
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
72
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
73
|
+
| **remote_user_id** | **String** | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | |
|
74
|
+
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
75
|
+
| **attachment_request** | [**AttachmentRequest**](AttachmentRequest.md) | | [optional] |
|
76
|
+
|
77
|
+
### Return type
|
78
|
+
|
79
|
+
[**Attachment**](Attachment.md)
|
80
|
+
|
81
|
+
### Authorization
|
82
|
+
|
83
|
+
[tokenAuth](../README.md#tokenAuth)
|
84
|
+
|
85
|
+
### HTTP request headers
|
86
|
+
|
87
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
88
|
+
- **Accept**: application/json
|
89
|
+
|
90
|
+
|
11
91
|
## attachments_list
|
12
92
|
|
13
93
|
> <PaginatedAttachmentList> attachments_list(x_account_token, opts)
|
data/docs/AvailableActions.md
CHANGED
@@ -16,7 +16,7 @@ require 'merge_ats_client'
|
|
16
16
|
instance = MergeATSClient::AvailableActions.new(
|
17
17
|
integration: null,
|
18
18
|
passthrough_available: true,
|
19
|
-
available_model_operations: [{"model_name":"Candidate","available_operations":["FETCH","CREATE"]}]
|
19
|
+
available_model_operations: [{"model_name":"Candidate","available_operations":["FETCH","CREATE"],"required_post_parameters":["remote_user_id"],"supported_fields":["first_name","last_name","company","title"]}]
|
20
20
|
)
|
21
21
|
```
|
22
22
|
|
data/docs/Candidate.md
CHANGED
@@ -20,8 +20,8 @@
|
|
20
20
|
| **email_addresses** | [**Array<EmailAddress>**](EmailAddress.md) | | [optional] |
|
21
21
|
| **urls** | [**Array<Url>**](Url.md) | | [optional] |
|
22
22
|
| **tags** | **Array<String>** | | [optional] |
|
23
|
-
| **applications** | **Array<String>** | | [optional]
|
24
|
-
| **attachments** | **Array<String>** | | [optional]
|
23
|
+
| **applications** | **Array<String>** | | [optional] |
|
24
|
+
| **attachments** | **Array<String>** | | [optional] |
|
25
25
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
26
26
|
|
27
27
|
## Example
|
data/docs/CandidateRequest.md
CHANGED
@@ -19,6 +19,8 @@
|
|
19
19
|
| **email_addresses** | [**Array<EmailAddressRequest>**](EmailAddressRequest.md) | | [optional] |
|
20
20
|
| **urls** | [**Array<UrlRequest>**](UrlRequest.md) | | [optional] |
|
21
21
|
| **tags** | **Array<String>** | | [optional] |
|
22
|
+
| **applications** | **Array<String>** | | [optional] |
|
23
|
+
| **attachments** | **Array<String>** | | [optional] |
|
22
24
|
|
23
25
|
## Example
|
24
26
|
|
@@ -40,7 +42,9 @@ instance = MergeATSClient::CandidateRequest.new(
|
|
40
42
|
phone_numbers: [{"value":"+1234567890","phone_number_type":"MOBILE"}],
|
41
43
|
email_addresses: [{"value":"hello@merge.dev","email_address_type":"PERSONAL"}],
|
42
44
|
urls: [{"value":"http://alturl.com/p749b","url_type":"BLOG"}],
|
43
|
-
tags: ["High-Priority"]
|
45
|
+
tags: ["High-Priority"],
|
46
|
+
applications: ["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],
|
47
|
+
attachments: ["bea08964-32b4-4a20-8bb4-2612ba09de1d"]
|
44
48
|
)
|
45
49
|
```
|
46
50
|
|
data/docs/InterviewsApi.md
CHANGED
@@ -4,10 +4,90 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**interviews_create**](InterviewsApi.md#interviews_create) | **POST** /interviews | |
|
7
8
|
| [**interviews_list**](InterviewsApi.md#interviews_list) | **GET** /interviews | |
|
8
9
|
| [**interviews_retrieve**](InterviewsApi.md#interviews_retrieve) | **GET** /interviews/{id} | |
|
9
10
|
|
10
11
|
|
12
|
+
## interviews_create
|
13
|
+
|
14
|
+
> <ScheduledInterview> interviews_create(x_account_token, remote_user_id, opts)
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
Creates a `ScheduledInterview` object with the given values.
|
19
|
+
|
20
|
+
### Examples
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'time'
|
24
|
+
require 'merge_ats_client'
|
25
|
+
# setup authorization
|
26
|
+
MergeATSClient.configure do |config|
|
27
|
+
# Configure API key authorization: tokenAuth
|
28
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
29
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = MergeATSClient::InterviewsApi.new
|
34
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
35
|
+
remote_user_id = 'remote_user_id_example' # String | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.
|
36
|
+
opts = {
|
37
|
+
run_async: true, # Boolean | Whether or not third-party updates should be run asynchronously.
|
38
|
+
scheduled_interview_request: MergeATSClient::ScheduledInterviewRequest.new # ScheduledInterviewRequest |
|
39
|
+
}
|
40
|
+
|
41
|
+
begin
|
42
|
+
|
43
|
+
result = api_instance.interviews_create(x_account_token, remote_user_id, opts)
|
44
|
+
p result
|
45
|
+
rescue MergeATSClient::ApiError => e
|
46
|
+
puts "Error when calling InterviewsApi->interviews_create: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
#### Using the interviews_create_with_http_info variant
|
51
|
+
|
52
|
+
This returns an Array which contains the response data, status code and headers.
|
53
|
+
|
54
|
+
> <Array(<ScheduledInterview>, Integer, Hash)> interviews_create_with_http_info(x_account_token, remote_user_id, opts)
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
begin
|
58
|
+
|
59
|
+
data, status_code, headers = api_instance.interviews_create_with_http_info(x_account_token, remote_user_id, opts)
|
60
|
+
p status_code # => 2xx
|
61
|
+
p headers # => { ... }
|
62
|
+
p data # => <ScheduledInterview>
|
63
|
+
rescue MergeATSClient::ApiError => e
|
64
|
+
puts "Error when calling InterviewsApi->interviews_create_with_http_info: #{e}"
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
### Parameters
|
69
|
+
|
70
|
+
| Name | Type | Description | Notes |
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
72
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
73
|
+
| **remote_user_id** | **String** | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. | |
|
74
|
+
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
75
|
+
| **scheduled_interview_request** | [**ScheduledInterviewRequest**](ScheduledInterviewRequest.md) | | [optional] |
|
76
|
+
|
77
|
+
### Return type
|
78
|
+
|
79
|
+
[**ScheduledInterview**](ScheduledInterview.md)
|
80
|
+
|
81
|
+
### Authorization
|
82
|
+
|
83
|
+
[tokenAuth](../README.md#tokenAuth)
|
84
|
+
|
85
|
+
### HTTP request headers
|
86
|
+
|
87
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
88
|
+
- **Accept**: application/json
|
89
|
+
|
90
|
+
|
11
91
|
## interviews_list
|
12
92
|
|
13
93
|
> <PaginatedScheduledInterviewList> interviews_list(x_account_token, opts)
|
data/docs/JobsApi.md
CHANGED
@@ -40,7 +40,8 @@ opts = {
|
|
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.
|
42
42
|
page_size: 56, # Integer | Number of results to return per page.
|
43
|
-
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
43
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
44
|
+
status: 'OPEN' # String | If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING')
|
44
45
|
}
|
45
46
|
|
46
47
|
begin
|
@@ -84,6 +85,7 @@ end
|
|
84
85
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
85
86
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
86
87
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
88
|
+
| **status** | **String** | If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING') | [optional] |
|
87
89
|
|
88
90
|
### Return type
|
89
91
|
|
data/docs/ModelOperation.md
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
| **model_name** | **String** | | |
|
8
8
|
| **available_operations** | **Array<String>** | | |
|
9
9
|
| **required_post_parameters** | **Array<String>** | | |
|
10
|
+
| **supported_fields** | **Array<String>** | | |
|
10
11
|
|
11
12
|
## Example
|
12
13
|
|
@@ -16,7 +17,8 @@ require 'merge_ats_client'
|
|
16
17
|
instance = MergeATSClient::ModelOperation.new(
|
17
18
|
model_name: Candidate,
|
18
19
|
available_operations: ["FETCH","CREATE"],
|
19
|
-
required_post_parameters: ["remote_user_id"]
|
20
|
+
required_post_parameters: ["remote_user_id"],
|
21
|
+
supported_fields: ["first_name","last_name","company","title"]
|
20
22
|
)
|
21
23
|
```
|
22
24
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeATSClient::PaginatedSyncStatusList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **_next** | **String** | | [optional] |
|
8
|
+
| **previous** | **String** | | [optional] |
|
9
|
+
| **results** | [**Array<SyncStatus>**](SyncStatus.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_ats_client'
|
15
|
+
|
16
|
+
instance = MergeATSClient::PaginatedSyncStatusList.new(
|
17
|
+
_next: null,
|
18
|
+
previous: null,
|
19
|
+
results: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# MergeATSClient::RemoteUserRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
8
|
+
| **first_name** | **String** | The user's first name. | [optional] |
|
9
|
+
| **last_name** | **String** | The user's last name. | [optional] |
|
10
|
+
| **email** | **String** | The user's email. | [optional] |
|
11
|
+
| **disabled** | **Boolean** | Whether the user's account had been disabled. | [optional] |
|
12
|
+
| **remote_created_at** | **Time** | When the third party's user was created. | [optional] |
|
13
|
+
| **access_role** | [**AccessRoleEnum**](AccessRoleEnum.md) | The user's role. | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'merge_ats_client'
|
19
|
+
|
20
|
+
instance = MergeATSClient::RemoteUserRequest.new(
|
21
|
+
remote_id: 344321,
|
22
|
+
first_name: Shensi,
|
23
|
+
last_name: Ding,
|
24
|
+
email: hello@merge.dev,
|
25
|
+
disabled: null,
|
26
|
+
remote_created_at: null,
|
27
|
+
access_role: SUPER_ADMIN
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# MergeATSClient::ScheduledInterviewRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
8
|
+
| **application** | **String** | The application being interviewed. | [optional] |
|
9
|
+
| **job_interview_stage** | **String** | The stage of the interview. | [optional] |
|
10
|
+
| **organizer** | **String** | The user organizing the interview. | [optional] |
|
11
|
+
| **interviewers** | **Array<String>** | | [optional] |
|
12
|
+
| **location** | **String** | The interview's location. | [optional] |
|
13
|
+
| **start_at** | **Time** | When the interview was started. | [optional] |
|
14
|
+
| **end_at** | **Time** | When the interview was ended. | [optional] |
|
15
|
+
| **remote_created_at** | **Time** | When the third party's interview was created. | [optional] |
|
16
|
+
| **remote_updated_at** | **Time** | When the third party's interview was updated. | [optional] |
|
17
|
+
| **status** | [**ScheduledInterviewStatusEnum**](ScheduledInterviewStatusEnum.md) | The interview's status. | [optional] |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'merge_ats_client'
|
23
|
+
|
24
|
+
instance = MergeATSClient::ScheduledInterviewRequest.new(
|
25
|
+
remote_id: 3,
|
26
|
+
application: 92e8a369-fffe-430d-b93a-f7e8a16563f1,
|
27
|
+
job_interview_stage: 2f7adb59-3fe6-4b5b-aef6-563f72bd13dc,
|
28
|
+
organizer: 52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633,
|
29
|
+
interviewers: ["f9813dd5-e70b-484c-91d8-00acd6065b07","89a86fcf-d540-4e6b-ac3d-ce07c4ec9b3c"],
|
30
|
+
location: Embarcadero Center 2,
|
31
|
+
start_at: null,
|
32
|
+
end_at: null,
|
33
|
+
remote_created_at: null,
|
34
|
+
remote_updated_at: null,
|
35
|
+
status: SCHEDULED
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# MergeATSClient::ScorecardRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
8
|
+
| **application** | **String** | The application being scored. | [optional] |
|
9
|
+
| **interview** | **String** | The interview being scored. | [optional] |
|
10
|
+
| **interviewer** | **String** | The interviewer doing the scoring. | [optional] |
|
11
|
+
| **remote_created_at** | **Time** | When the third party's scorecard was created. | [optional] |
|
12
|
+
| **submitted_at** | **Time** | When the scorecard was submitted. | [optional] |
|
13
|
+
| **overall_recommendation** | [**OverallRecommendationEnum**](OverallRecommendationEnum.md) | The inteviewer's recommendation. | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'merge_ats_client'
|
19
|
+
|
20
|
+
instance = MergeATSClient::ScorecardRequest.new(
|
21
|
+
remote_id: 22234,
|
22
|
+
application: 2872ba14-4084-492b-be96-e5eee6fc33ef,
|
23
|
+
interview: 52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633,
|
24
|
+
interviewer: bbb519a3-246e-4b95-b6b3-dba16107ba6b,
|
25
|
+
remote_created_at: null,
|
26
|
+
submitted_at: null,
|
27
|
+
overall_recommendation: STRONG_YES
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|