merge_ats_client 3.0.2 → 3.0.3
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 +198 -186
- data/docs/Activity.md +2 -2
- data/docs/Application.md +2 -2
- data/docs/AsyncPassthroughApi.md +155 -0
- data/docs/AsyncPassthroughReciept.md +18 -0
- data/docs/Attachment.md +2 -2
- data/docs/Candidate.md +2 -2
- data/docs/CandidatesApi.md +156 -0
- data/docs/DeleteAccountApi.md +9 -9
- data/docs/Department.md +2 -2
- data/docs/EEOC.md +2 -2
- data/docs/EndUserDetailsRequest.md +1 -1
- data/docs/Job.md +2 -2
- data/docs/JobInterviewStage.md +2 -2
- data/docs/Offer.md +2 -2
- data/docs/Office.md +2 -2
- data/docs/PatchedCandidateEndpointRequest.md +20 -0
- data/docs/PatchedCandidateRequest.md +50 -0
- data/docs/RejectReason.md +2 -2
- data/docs/RemoteData.md +1 -1
- data/docs/RemoteUser.md +2 -2
- data/docs/ScheduledInterview.md +2 -2
- data/docs/Scorecard.md +2 -2
- data/docs/Tag.md +2 -2
- data/lib/merge_ats_client/api/async_passthrough_api.rb +160 -0
- data/lib/merge_ats_client/api/candidates_api.rb +150 -0
- data/lib/merge_ats_client/api/delete_account_api.rb +7 -7
- data/lib/merge_ats_client/models/activity.rb +10 -10
- data/lib/merge_ats_client/models/application.rb +10 -10
- data/lib/merge_ats_client/models/async_passthrough_reciept.rb +223 -0
- data/lib/merge_ats_client/models/attachment.rb +10 -10
- data/lib/merge_ats_client/models/candidate.rb +10 -10
- data/lib/merge_ats_client/models/department.rb +10 -10
- data/lib/merge_ats_client/models/eeoc.rb +10 -10
- data/lib/merge_ats_client/models/end_user_details_request.rb +1 -1
- data/lib/merge_ats_client/models/job.rb +10 -10
- data/lib/merge_ats_client/models/job_interview_stage.rb +10 -10
- data/lib/merge_ats_client/models/offer.rb +10 -10
- data/lib/merge_ats_client/models/office.rb +10 -10
- data/lib/merge_ats_client/models/patched_candidate_endpoint_request.rb +237 -0
- data/lib/merge_ats_client/models/patched_candidate_request.rb +418 -0
- data/lib/merge_ats_client/models/reject_reason.rb +10 -10
- data/lib/merge_ats_client/models/remote_data.rb +3 -4
- data/lib/merge_ats_client/models/remote_user.rb +10 -10
- data/lib/merge_ats_client/models/scheduled_interview.rb +10 -10
- data/lib/merge_ats_client/models/scorecard.rb +10 -10
- data/lib/merge_ats_client/models/tag.rb +10 -10
- data/lib/merge_ats_client/version.rb +1 -1
- data/lib/merge_ats_client.rb +4 -0
- data/spec/api/async_passthrough_api_spec.rb +59 -0
- data/spec/api/candidates_api_spec.rb +27 -0
- data/spec/api/delete_account_api_spec.rb +2 -2
- data/spec/models/activity_spec.rb +2 -2
- data/spec/models/application_spec.rb +2 -2
- data/spec/models/async_passthrough_reciept_spec.rb +34 -0
- data/spec/models/attachment_spec.rb +2 -2
- data/spec/models/candidate_spec.rb +2 -2
- data/spec/models/department_spec.rb +2 -2
- data/spec/models/eeoc_spec.rb +2 -2
- data/spec/models/job_interview_stage_spec.rb +2 -2
- data/spec/models/job_spec.rb +2 -2
- data/spec/models/offer_spec.rb +2 -2
- data/spec/models/office_spec.rb +2 -2
- data/spec/models/patched_candidate_endpoint_request_spec.rb +40 -0
- data/spec/models/patched_candidate_request_spec.rb +130 -0
- data/spec/models/reject_reason_spec.rb +2 -2
- data/spec/models/remote_user_spec.rb +2 -2
- data/spec/models/scheduled_interview_spec.rb +2 -2
- data/spec/models/scorecard_spec.rb +2 -2
- data/spec/models/tag_spec.rb +2 -2
- metadata +140 -124
@@ -0,0 +1,155 @@
|
|
1
|
+
# MergeATSClient::AsyncPassthroughApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**async_passthrough_create**](AsyncPassthroughApi.md#async_passthrough_create) | **POST** /async-passthrough | |
|
8
|
+
| [**async_passthrough_retrieve**](AsyncPassthroughApi.md#async_passthrough_retrieve) | **GET** /async-passthrough/{async_passthrough_receipt_id} | |
|
9
|
+
|
10
|
+
|
11
|
+
## async_passthrough_create
|
12
|
+
|
13
|
+
> <AsyncPassthroughReciept> async_passthrough_create(x_account_token, data_passthrough_request)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
Asynchronously pull data from an endpoint not currently supported by Merge.
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'merge_ats_client'
|
24
|
+
# setup authorization
|
25
|
+
MergeATSClient.configure do |config|
|
26
|
+
# Configure API key authorization: tokenAuth
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = MergeATSClient::AsyncPassthroughApi.new
|
33
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
|
+
data_passthrough_request = MergeATSClient::DataPassthroughRequest.new({method: MergeATSClient::MethodEnum::GET, path: '/scooters'}) # DataPassthroughRequest |
|
35
|
+
|
36
|
+
begin
|
37
|
+
|
38
|
+
result = api_instance.async_passthrough_create(x_account_token, data_passthrough_request)
|
39
|
+
p result
|
40
|
+
rescue MergeATSClient::ApiError => e
|
41
|
+
puts "Error when calling AsyncPassthroughApi->async_passthrough_create: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
#### Using the async_passthrough_create_with_http_info variant
|
46
|
+
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
48
|
+
|
49
|
+
> <Array(<AsyncPassthroughReciept>, Integer, Hash)> async_passthrough_create_with_http_info(x_account_token, data_passthrough_request)
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
begin
|
53
|
+
|
54
|
+
data, status_code, headers = api_instance.async_passthrough_create_with_http_info(x_account_token, data_passthrough_request)
|
55
|
+
p status_code # => 2xx
|
56
|
+
p headers # => { ... }
|
57
|
+
p data # => <AsyncPassthroughReciept>
|
58
|
+
rescue MergeATSClient::ApiError => e
|
59
|
+
puts "Error when calling AsyncPassthroughApi->async_passthrough_create_with_http_info: #{e}"
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
### Parameters
|
64
|
+
|
65
|
+
| Name | Type | Description | Notes |
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
67
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
68
|
+
| **data_passthrough_request** | [**DataPassthroughRequest**](DataPassthroughRequest.md) | | |
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
[**AsyncPassthroughReciept**](AsyncPassthroughReciept.md)
|
73
|
+
|
74
|
+
### Authorization
|
75
|
+
|
76
|
+
[tokenAuth](../README.md#tokenAuth)
|
77
|
+
|
78
|
+
### HTTP request headers
|
79
|
+
|
80
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
81
|
+
- **Accept**: application/json
|
82
|
+
|
83
|
+
|
84
|
+
## async_passthrough_retrieve
|
85
|
+
|
86
|
+
> <RemoteResponse> async_passthrough_retrieve(x_account_token, async_passthrough_receipt_id)
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
Retrieves data from earlier async-passthrough POST request
|
91
|
+
|
92
|
+
### Examples
|
93
|
+
|
94
|
+
```ruby
|
95
|
+
require 'time'
|
96
|
+
require 'merge_ats_client'
|
97
|
+
# setup authorization
|
98
|
+
MergeATSClient.configure do |config|
|
99
|
+
# Configure API key authorization: tokenAuth
|
100
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
101
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
102
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = MergeATSClient::AsyncPassthroughApi.new
|
106
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
107
|
+
async_passthrough_receipt_id = TODO # String |
|
108
|
+
|
109
|
+
begin
|
110
|
+
|
111
|
+
result = api_instance.async_passthrough_retrieve(x_account_token, async_passthrough_receipt_id)
|
112
|
+
p result
|
113
|
+
rescue MergeATSClient::ApiError => e
|
114
|
+
puts "Error when calling AsyncPassthroughApi->async_passthrough_retrieve: #{e}"
|
115
|
+
end
|
116
|
+
```
|
117
|
+
|
118
|
+
#### Using the async_passthrough_retrieve_with_http_info variant
|
119
|
+
|
120
|
+
This returns an Array which contains the response data, status code and headers.
|
121
|
+
|
122
|
+
> <Array(<RemoteResponse>, Integer, Hash)> async_passthrough_retrieve_with_http_info(x_account_token, async_passthrough_receipt_id)
|
123
|
+
|
124
|
+
```ruby
|
125
|
+
begin
|
126
|
+
|
127
|
+
data, status_code, headers = api_instance.async_passthrough_retrieve_with_http_info(x_account_token, async_passthrough_receipt_id)
|
128
|
+
p status_code # => 2xx
|
129
|
+
p headers # => { ... }
|
130
|
+
p data # => <RemoteResponse>
|
131
|
+
rescue MergeATSClient::ApiError => e
|
132
|
+
puts "Error when calling AsyncPassthroughApi->async_passthrough_retrieve_with_http_info: #{e}"
|
133
|
+
end
|
134
|
+
```
|
135
|
+
|
136
|
+
### Parameters
|
137
|
+
|
138
|
+
| Name | Type | Description | Notes |
|
139
|
+
| ---- | ---- | ----------- | ----- |
|
140
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
141
|
+
| **async_passthrough_receipt_id** | [**String**](.md) | | |
|
142
|
+
|
143
|
+
### Return type
|
144
|
+
|
145
|
+
[**RemoteResponse**](RemoteResponse.md)
|
146
|
+
|
147
|
+
### Authorization
|
148
|
+
|
149
|
+
[tokenAuth](../README.md#tokenAuth)
|
150
|
+
|
151
|
+
### HTTP request headers
|
152
|
+
|
153
|
+
- **Content-Type**: Not defined
|
154
|
+
- **Accept**: application/json
|
155
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeATSClient::AsyncPassthroughReciept
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **async_passthrough_receipt_id** | **String** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_ats_client'
|
13
|
+
|
14
|
+
instance = MergeATSClient::AsyncPassthroughReciept.new(
|
15
|
+
async_passthrough_receipt_id: fd29020f-2695-445e-922e-dcd5e81903fd
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/Attachment.md
CHANGED
@@ -11,8 +11,8 @@
|
|
11
11
|
| **candidate** | **String** | | [optional] |
|
12
12
|
| **attachment_type** | [**AttachmentTypeEnum**](AttachmentTypeEnum.md) | The attachment's type. * `RESUME` - RESUME * `COVER_LETTER` - COVER_LETTER * `OFFER_LETTER` - OFFER_LETTER * `OTHER` - OTHER | [optional] |
|
13
13
|
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
14
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
15
14
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
15
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
16
16
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
17
17
|
|
18
18
|
## Example
|
@@ -28,8 +28,8 @@ instance = MergeATSClient::Attachment.new(
|
|
28
28
|
candidate: 2872ba14-4084-492b-be96-e5eee6fc33ef,
|
29
29
|
attachment_type: RESUME,
|
30
30
|
remote_was_deleted: null,
|
31
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
32
31
|
modified_at: 2021-10-16T00:00Z,
|
32
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
33
33
|
remote_data: [{"path":"/attachments","data":["Varies by platform"]}]
|
34
34
|
)
|
35
35
|
```
|
data/docs/Candidate.md
CHANGED
@@ -23,8 +23,8 @@
|
|
23
23
|
| **applications** | **Array<String>** | Array of `Application` object IDs. | [optional] |
|
24
24
|
| **attachments** | **Array<String>** | Array of `Attachment` object IDs. | [optional] |
|
25
25
|
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
26
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
27
26
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
27
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
28
28
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
29
29
|
|
30
30
|
## Example
|
@@ -52,8 +52,8 @@ instance = MergeATSClient::Candidate.new(
|
|
52
52
|
applications: ["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],
|
53
53
|
attachments: ["bea08964-32b4-4a20-8bb4-2612ba09de1d"],
|
54
54
|
remote_was_deleted: null,
|
55
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
56
55
|
modified_at: 2021-10-16T00:00Z,
|
56
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
57
57
|
remote_data: [{"path":"/candidates","data":["Varies by platform"]}]
|
58
58
|
)
|
59
59
|
```
|
data/docs/CandidatesApi.md
CHANGED
@@ -7,7 +7,9 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
7
7
|
| [**candidates_create**](CandidatesApi.md#candidates_create) | **POST** /candidates | |
|
8
8
|
| [**candidates_ignore_create**](CandidatesApi.md#candidates_ignore_create) | **POST** /candidates/ignore/{model_id} | |
|
9
9
|
| [**candidates_list**](CandidatesApi.md#candidates_list) | **GET** /candidates | |
|
10
|
+
| [**candidates_meta_patch_retrieve**](CandidatesApi.md#candidates_meta_patch_retrieve) | **GET** /candidates/meta/patch/{id} | |
|
10
11
|
| [**candidates_meta_post_retrieve**](CandidatesApi.md#candidates_meta_post_retrieve) | **GET** /candidates/meta/post | |
|
12
|
+
| [**candidates_partial_update**](CandidatesApi.md#candidates_partial_update) | **PATCH** /candidates/{id} | |
|
11
13
|
| [**candidates_retrieve**](CandidatesApi.md#candidates_retrieve) | **GET** /candidates/{id} | |
|
12
14
|
|
13
15
|
|
@@ -265,6 +267,79 @@ end
|
|
265
267
|
- **Accept**: application/json
|
266
268
|
|
267
269
|
|
270
|
+
## candidates_meta_patch_retrieve
|
271
|
+
|
272
|
+
> <MetaResponse> candidates_meta_patch_retrieve(x_account_token, id)
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
Returns metadata for `Candidate` PATCHs.
|
277
|
+
|
278
|
+
### Examples
|
279
|
+
|
280
|
+
```ruby
|
281
|
+
require 'time'
|
282
|
+
require 'merge_ats_client'
|
283
|
+
# setup authorization
|
284
|
+
MergeATSClient.configure do |config|
|
285
|
+
# Configure API key authorization: tokenAuth
|
286
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
287
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
288
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
289
|
+
end
|
290
|
+
|
291
|
+
api_instance = MergeATSClient::CandidatesApi.new
|
292
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
293
|
+
id = TODO # String |
|
294
|
+
|
295
|
+
begin
|
296
|
+
|
297
|
+
result = api_instance.candidates_meta_patch_retrieve(x_account_token, id)
|
298
|
+
p result
|
299
|
+
rescue MergeATSClient::ApiError => e
|
300
|
+
puts "Error when calling CandidatesApi->candidates_meta_patch_retrieve: #{e}"
|
301
|
+
end
|
302
|
+
```
|
303
|
+
|
304
|
+
#### Using the candidates_meta_patch_retrieve_with_http_info variant
|
305
|
+
|
306
|
+
This returns an Array which contains the response data, status code and headers.
|
307
|
+
|
308
|
+
> <Array(<MetaResponse>, Integer, Hash)> candidates_meta_patch_retrieve_with_http_info(x_account_token, id)
|
309
|
+
|
310
|
+
```ruby
|
311
|
+
begin
|
312
|
+
|
313
|
+
data, status_code, headers = api_instance.candidates_meta_patch_retrieve_with_http_info(x_account_token, id)
|
314
|
+
p status_code # => 2xx
|
315
|
+
p headers # => { ... }
|
316
|
+
p data # => <MetaResponse>
|
317
|
+
rescue MergeATSClient::ApiError => e
|
318
|
+
puts "Error when calling CandidatesApi->candidates_meta_patch_retrieve_with_http_info: #{e}"
|
319
|
+
end
|
320
|
+
```
|
321
|
+
|
322
|
+
### Parameters
|
323
|
+
|
324
|
+
| Name | Type | Description | Notes |
|
325
|
+
| ---- | ---- | ----------- | ----- |
|
326
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
327
|
+
| **id** | [**String**](.md) | | |
|
328
|
+
|
329
|
+
### Return type
|
330
|
+
|
331
|
+
[**MetaResponse**](MetaResponse.md)
|
332
|
+
|
333
|
+
### Authorization
|
334
|
+
|
335
|
+
[tokenAuth](../README.md#tokenAuth)
|
336
|
+
|
337
|
+
### HTTP request headers
|
338
|
+
|
339
|
+
- **Content-Type**: Not defined
|
340
|
+
- **Accept**: application/json
|
341
|
+
|
342
|
+
|
268
343
|
## candidates_meta_post_retrieve
|
269
344
|
|
270
345
|
> <MetaResponse> candidates_meta_post_retrieve(x_account_token)
|
@@ -336,6 +411,87 @@ end
|
|
336
411
|
- **Accept**: application/json
|
337
412
|
|
338
413
|
|
414
|
+
## candidates_partial_update
|
415
|
+
|
416
|
+
> <CandidateResponse> candidates_partial_update(x_account_token, id, patched_candidate_endpoint_request, opts)
|
417
|
+
|
418
|
+
|
419
|
+
|
420
|
+
Updates a `Candidate` object with the given `id`.
|
421
|
+
|
422
|
+
### Examples
|
423
|
+
|
424
|
+
```ruby
|
425
|
+
require 'time'
|
426
|
+
require 'merge_ats_client'
|
427
|
+
# setup authorization
|
428
|
+
MergeATSClient.configure do |config|
|
429
|
+
# Configure API key authorization: tokenAuth
|
430
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
431
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
432
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
433
|
+
end
|
434
|
+
|
435
|
+
api_instance = MergeATSClient::CandidatesApi.new
|
436
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
437
|
+
id = TODO # String |
|
438
|
+
patched_candidate_endpoint_request = MergeATSClient::PatchedCandidateEndpointRequest.new({model: MergeATSClient::PatchedCandidateRequest.new, remote_user_id: 'remote_user_id_example'}) # PatchedCandidateEndpointRequest |
|
439
|
+
opts = {
|
440
|
+
is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
|
441
|
+
run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
|
442
|
+
}
|
443
|
+
|
444
|
+
begin
|
445
|
+
|
446
|
+
result = api_instance.candidates_partial_update(x_account_token, id, patched_candidate_endpoint_request, opts)
|
447
|
+
p result
|
448
|
+
rescue MergeATSClient::ApiError => e
|
449
|
+
puts "Error when calling CandidatesApi->candidates_partial_update: #{e}"
|
450
|
+
end
|
451
|
+
```
|
452
|
+
|
453
|
+
#### Using the candidates_partial_update_with_http_info variant
|
454
|
+
|
455
|
+
This returns an Array which contains the response data, status code and headers.
|
456
|
+
|
457
|
+
> <Array(<CandidateResponse>, Integer, Hash)> candidates_partial_update_with_http_info(x_account_token, id, patched_candidate_endpoint_request, opts)
|
458
|
+
|
459
|
+
```ruby
|
460
|
+
begin
|
461
|
+
|
462
|
+
data, status_code, headers = api_instance.candidates_partial_update_with_http_info(x_account_token, id, patched_candidate_endpoint_request, opts)
|
463
|
+
p status_code # => 2xx
|
464
|
+
p headers # => { ... }
|
465
|
+
p data # => <CandidateResponse>
|
466
|
+
rescue MergeATSClient::ApiError => e
|
467
|
+
puts "Error when calling CandidatesApi->candidates_partial_update_with_http_info: #{e}"
|
468
|
+
end
|
469
|
+
```
|
470
|
+
|
471
|
+
### Parameters
|
472
|
+
|
473
|
+
| Name | Type | Description | Notes |
|
474
|
+
| ---- | ---- | ----------- | ----- |
|
475
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
476
|
+
| **id** | [**String**](.md) | | |
|
477
|
+
| **patched_candidate_endpoint_request** | [**PatchedCandidateEndpointRequest**](PatchedCandidateEndpointRequest.md) | | |
|
478
|
+
| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
|
479
|
+
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
480
|
+
|
481
|
+
### Return type
|
482
|
+
|
483
|
+
[**CandidateResponse**](CandidateResponse.md)
|
484
|
+
|
485
|
+
### Authorization
|
486
|
+
|
487
|
+
[tokenAuth](../README.md#tokenAuth)
|
488
|
+
|
489
|
+
### HTTP request headers
|
490
|
+
|
491
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
492
|
+
- **Accept**: application/json
|
493
|
+
|
494
|
+
|
339
495
|
## candidates_retrieve
|
340
496
|
|
341
497
|
> <Candidate> candidates_retrieve(x_account_token, id, opts)
|
data/docs/DeleteAccountApi.md
CHANGED
@@ -4,12 +4,12 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
7
|
+
| [**delete_account_delete**](DeleteAccountApi.md#delete_account_delete) | **POST** /delete-account | |
|
8
8
|
|
9
9
|
|
10
|
-
##
|
10
|
+
## delete_account_delete
|
11
11
|
|
12
|
-
>
|
12
|
+
> delete_account_delete(x_account_token)
|
13
13
|
|
14
14
|
|
15
15
|
|
@@ -33,27 +33,27 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
33
33
|
|
34
34
|
begin
|
35
35
|
|
36
|
-
api_instance.
|
36
|
+
api_instance.delete_account_delete(x_account_token)
|
37
37
|
rescue MergeATSClient::ApiError => e
|
38
|
-
puts "Error when calling DeleteAccountApi->
|
38
|
+
puts "Error when calling DeleteAccountApi->delete_account_delete: #{e}"
|
39
39
|
end
|
40
40
|
```
|
41
41
|
|
42
|
-
#### Using the
|
42
|
+
#### Using the delete_account_delete_with_http_info variant
|
43
43
|
|
44
44
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
45
45
|
|
46
|
-
> <Array(nil, Integer, Hash)>
|
46
|
+
> <Array(nil, Integer, Hash)> delete_account_delete_with_http_info(x_account_token)
|
47
47
|
|
48
48
|
```ruby
|
49
49
|
begin
|
50
50
|
|
51
|
-
data, status_code, headers = api_instance.
|
51
|
+
data, status_code, headers = api_instance.delete_account_delete_with_http_info(x_account_token)
|
52
52
|
p status_code # => 2xx
|
53
53
|
p headers # => { ... }
|
54
54
|
p data # => nil
|
55
55
|
rescue MergeATSClient::ApiError => e
|
56
|
-
puts "Error when calling DeleteAccountApi->
|
56
|
+
puts "Error when calling DeleteAccountApi->delete_account_delete_with_http_info: #{e}"
|
57
57
|
end
|
58
58
|
```
|
59
59
|
|
data/docs/Department.md
CHANGED
@@ -8,8 +8,8 @@
|
|
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_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
11
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
12
11
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
12
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
13
13
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
14
14
|
|
15
15
|
## Example
|
@@ -22,8 +22,8 @@ instance = MergeATSClient::Department.new(
|
|
22
22
|
remote_id: 23456,
|
23
23
|
name: Engineering,
|
24
24
|
remote_was_deleted: null,
|
25
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
26
25
|
modified_at: 2021-10-16T00:00Z,
|
26
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
27
27
|
remote_data: [{"path":"/departments","data":["Varies by platform"]}]
|
28
28
|
)
|
29
29
|
```
|
data/docs/EEOC.md
CHANGED
@@ -13,8 +13,8 @@
|
|
13
13
|
| **veteran_status** | [**VeteranStatusEnum**](VeteranStatusEnum.md) | The candidate's veteran status. * `I_AM_NOT_A_PROTECTED_VETERAN` - I_AM_NOT_A_PROTECTED_VETERAN * `I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN` - I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN * `I_DONT_WISH_TO_ANSWER` - I_DONT_WISH_TO_ANSWER | [optional] |
|
14
14
|
| **disability_status** | [**DisabilityStatusEnum**](DisabilityStatusEnum.md) | The candidate's disability status. * `YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY` - YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY * `NO_I_DONT_HAVE_A_DISABILITY` - NO_I_DONT_HAVE_A_DISABILITY * `I_DONT_WISH_TO_ANSWER` - I_DONT_WISH_TO_ANSWER | [optional] |
|
15
15
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
16
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
17
16
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
17
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
18
18
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
19
19
|
|
20
20
|
## Example
|
@@ -32,8 +32,8 @@ instance = MergeATSClient::EEOC.new(
|
|
32
32
|
veteran_status: I_AM_NOT_A_PROTECTED_VETERAN,
|
33
33
|
disability_status: I_DONT_WISH_TO_ANSWER,
|
34
34
|
remote_was_deleted: null,
|
35
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
36
35
|
modified_at: 2021-10-16T00:00Z,
|
36
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
37
37
|
remote_data: [{"path":"/eeoc","data":["Varies by platform"]}]
|
38
38
|
)
|
39
39
|
```
|
@@ -10,7 +10,7 @@
|
|
10
10
|
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | The integration categories to show in Merge Link. | |
|
11
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
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/
|
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/integrations-fast-say-hello-to-magic-link. | [optional][default to false] |
|
14
14
|
| **common_models** | [**Array<CommonModelScopesBodyRequest>**](CommonModelScopesBodyRequest.md) | An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. | [optional] |
|
15
15
|
|
16
16
|
## Example
|
data/docs/Job.md
CHANGED
@@ -19,8 +19,8 @@
|
|
19
19
|
| **hiring_managers** | **Array<String>** | IDs of `RemoteUser` objects that serve as hiring managers for this `Job`. | [optional] |
|
20
20
|
| **recruiters** | **Array<String>** | IDs of `RemoteUser` objects that serve as recruiters for this `Job`. | [optional] |
|
21
21
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
22
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
23
22
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
23
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
24
24
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
25
25
|
|
26
26
|
## Example
|
@@ -44,8 +44,8 @@ instance = MergeATSClient::Job.new(
|
|
44
44
|
hiring_managers: ["787ed912-33ec-444e-a215-8d71cc42fc12"],
|
45
45
|
recruiters: ["787ed912-33ec-444e-a215-8d71cc42fc12"],
|
46
46
|
remote_was_deleted: null,
|
47
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
48
47
|
modified_at: 2021-10-16T00:00Z,
|
48
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
49
49
|
remote_data: [{"path":"/positions","data":["Varies by platform"]}]
|
50
50
|
)
|
51
51
|
```
|
data/docs/JobInterviewStage.md
CHANGED
@@ -10,8 +10,8 @@
|
|
10
10
|
| **job** | **String** | This field is populated only if the stage is specific to a particular job. If the stage is generic, this field will not be populated. | [optional] |
|
11
11
|
| **stage_order** | **Integer** | The stage’s order, with the lowest values ordered first. If the third-party does not return details on the order of stages, this field will not be populated. | [optional] |
|
12
12
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
13
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
14
13
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
14
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
15
15
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
16
16
|
|
17
17
|
## Example
|
@@ -26,8 +26,8 @@ instance = MergeATSClient::JobInterviewStage.new(
|
|
26
26
|
job: ba7d9648-5316-4a80-8d73-4e636cef5a90,
|
27
27
|
stage_order: 2,
|
28
28
|
remote_was_deleted: null,
|
29
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
30
29
|
modified_at: 2021-10-16T00:00Z,
|
30
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
31
31
|
remote_data: [{"path":"/interview-stages","data":["Varies by platform"]}]
|
32
32
|
)
|
33
33
|
```
|
data/docs/Offer.md
CHANGED
@@ -14,8 +14,8 @@
|
|
14
14
|
| **start_date** | **Time** | The employment start date on the offer. | [optional] |
|
15
15
|
| **status** | [**OfferStatusEnum**](OfferStatusEnum.md) | The offer's status. * `DRAFT` - DRAFT * `APPROVAL-SENT` - APPROVAL-SENT * `APPROVED` - APPROVED * `SENT` - SENT * `SENT-MANUALLY` - SENT-MANUALLY * `OPENED` - OPENED * `DENIED` - DENIED * `SIGNED` - SIGNED * `DEPRECATED` - DEPRECATED | [optional] |
|
16
16
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
17
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
18
17
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
18
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
19
19
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
20
20
|
|
21
21
|
## Example
|
@@ -34,8 +34,8 @@ instance = MergeATSClient::Offer.new(
|
|
34
34
|
start_date: 2021-11-15T00:00Z,
|
35
35
|
status: SENT,
|
36
36
|
remote_was_deleted: null,
|
37
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
38
37
|
modified_at: 2021-10-16T00:00Z,
|
38
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
39
39
|
remote_data: [{"path":"/offers","data":["Varies by platform"]}]
|
40
40
|
)
|
41
41
|
```
|
data/docs/Office.md
CHANGED
@@ -9,8 +9,8 @@
|
|
9
9
|
| **name** | **String** | The office's name. | [optional] |
|
10
10
|
| **location** | **String** | The office's location. | [optional] |
|
11
11
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
12
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
13
12
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
13
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
14
14
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
15
15
|
|
16
16
|
## Example
|
@@ -24,8 +24,8 @@ instance = MergeATSClient::Office.new(
|
|
24
24
|
name: SF Office,
|
25
25
|
location: Embarcadero Center 2,
|
26
26
|
remote_was_deleted: null,
|
27
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
28
27
|
modified_at: 2021-10-16T00:00Z,
|
28
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
29
29
|
remote_data: [{"path":"/locations","data":["Varies by platform"]}]
|
30
30
|
)
|
31
31
|
```
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeATSClient::PatchedCandidateEndpointRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**PatchedCandidateRequest**](PatchedCandidateRequest.md) | | |
|
8
|
+
| **remote_user_id** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_ats_client'
|
14
|
+
|
15
|
+
instance = MergeATSClient::PatchedCandidateEndpointRequest.new(
|
16
|
+
model: null,
|
17
|
+
remote_user_id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# MergeATSClient::PatchedCandidateRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **first_name** | **String** | The candidate's first name. | [optional] |
|
8
|
+
| **last_name** | **String** | The candidate's last name. | [optional] |
|
9
|
+
| **company** | **String** | The candidate's current company. | [optional] |
|
10
|
+
| **title** | **String** | The candidate's current title. | [optional] |
|
11
|
+
| **last_interaction_at** | **Time** | When the most recent interaction with the candidate occurred. | [optional] |
|
12
|
+
| **is_private** | **Boolean** | Whether or not the candidate is private. | [optional] |
|
13
|
+
| **can_email** | **Boolean** | Whether or not the candidate can be emailed. | [optional] |
|
14
|
+
| **locations** | **Array<String>** | The candidate's locations. | [optional] |
|
15
|
+
| **phone_numbers** | [**Array<PhoneNumberRequest>**](PhoneNumberRequest.md) | | [optional] |
|
16
|
+
| **email_addresses** | [**Array<EmailAddressRequest>**](EmailAddressRequest.md) | | [optional] |
|
17
|
+
| **urls** | [**Array<UrlRequest>**](UrlRequest.md) | | [optional] |
|
18
|
+
| **tags** | **Array<String>** | Array of `Tag` names as strings. | [optional] |
|
19
|
+
| **applications** | **Array<String>** | Array of `Application` object IDs. | [optional] |
|
20
|
+
| **attachments** | **Array<String>** | Array of `Attachment` object IDs. | [optional] |
|
21
|
+
| **remote_template_id** | **String** | | [optional] |
|
22
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
23
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
24
|
+
|
25
|
+
## Example
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'merge_ats_client'
|
29
|
+
|
30
|
+
instance = MergeATSClient::PatchedCandidateRequest.new(
|
31
|
+
first_name: Gil,
|
32
|
+
last_name: Feig,
|
33
|
+
company: Columbia Dining App.,
|
34
|
+
title: Software Engineer,
|
35
|
+
last_interaction_at: 2021-10-17T00:00Z,
|
36
|
+
is_private: true,
|
37
|
+
can_email: true,
|
38
|
+
locations: ["San Francisco","New York","Miami"],
|
39
|
+
phone_numbers: [{"value":"+1234567890","phone_number_type":"MOBILE"}],
|
40
|
+
email_addresses: [{"value":"hello@merge.dev","email_address_type":"PERSONAL"}],
|
41
|
+
urls: [{"value":"http://alturl.com/p749b","url_type":"BLOG"}],
|
42
|
+
tags: ["High-Priority"],
|
43
|
+
applications: ["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],
|
44
|
+
attachments: ["bea08964-32b4-4a20-8bb4-2612ba09de1d"],
|
45
|
+
remote_template_id: 92830948203,
|
46
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
47
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
48
|
+
)
|
49
|
+
```
|
50
|
+
|