merge_ats_client 3.0.0 → 3.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 +186 -179
- data/docs/AccountIntegration.md +6 -2
- data/docs/ActivitiesApi.md +164 -8
- data/docs/Activity.md +12 -6
- data/docs/ActivityEndpointRequest.md +20 -0
- data/docs/ActivityRequest.md +32 -0
- data/docs/ActivityResponse.md +24 -0
- data/docs/Application.md +12 -10
- data/docs/ApplicationRequest.md +5 -9
- data/docs/ApplicationsApi.md +4 -4
- data/docs/Attachment.md +8 -4
- data/docs/AttachmentRequest.md +1 -3
- data/docs/AttachmentsApi.md +13 -9
- data/docs/Candidate.md +8 -6
- data/docs/CandidateRequest.md +1 -9
- data/docs/CandidatesApi.md +16 -13
- data/docs/CommonModelScopesBodyRequest.md +22 -0
- data/docs/ConditionSchema.md +1 -1
- data/docs/DataPassthroughRequest.md +1 -1
- data/docs/Department.md +7 -3
- data/docs/DepartmentsApi.md +4 -4
- data/docs/EEOC.md +12 -8
- data/docs/EeocsApi.md +13 -9
- data/docs/EmailAddress.md +4 -2
- data/docs/EmailAddressRequest.md +1 -1
- data/docs/EnabledActionsEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +3 -1
- data/docs/ForceResyncApi.md +1 -1
- data/docs/InterviewsApi.md +165 -9
- data/docs/Issue.md +10 -8
- data/docs/IssuesApi.md +6 -6
- data/docs/Job.md +8 -4
- data/docs/JobInterviewStage.md +10 -4
- data/docs/JobInterviewStagesApi.md +4 -4
- data/docs/JobsApi.md +16 -10
- data/docs/LinkToken.md +1 -1
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/MetaResponse.md +2 -0
- data/docs/MultipartFormFieldRequest.md +1 -1
- data/docs/Offer.md +10 -6
- data/docs/OffersApi.md +13 -9
- data/docs/Office.md +7 -3
- data/docs/OfficesApi.md +4 -4
- data/docs/PaginatedConditionSchemaList.md +2 -2
- data/docs/PhoneNumber.md +4 -2
- data/docs/PhoneNumberRequest.md +1 -1
- data/docs/RejectReason.md +7 -3
- data/docs/RejectReasonsApi.md +4 -4
- data/docs/RemoteUser.md +8 -4
- data/docs/ScheduledInterview.md +11 -7
- data/docs/ScheduledInterviewEndpointRequest.md +20 -0
- data/docs/ScheduledInterviewRequest.md +36 -0
- data/docs/ScheduledInterviewResponse.md +24 -0
- data/docs/Scorecard.md +11 -7
- data/docs/ScorecardsApi.md +13 -9
- data/docs/SelectiveSyncApi.md +2 -2
- data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
- data/docs/SyncStatus.md +3 -1
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tag.md +7 -3
- data/docs/TagsApi.md +4 -4
- data/docs/Url.md +4 -2
- data/docs/UrlRequest.md +1 -1
- data/docs/UsersApi.md +13 -9
- data/lib/merge_ats_client/api/activities_api.rb +160 -8
- data/lib/merge_ats_client/api/applications_api.rb +4 -4
- data/lib/merge_ats_client/api/attachments_api.rb +22 -8
- data/lib/merge_ats_client/api/candidates_api.rb +15 -11
- data/lib/merge_ats_client/api/departments_api.rb +4 -4
- data/lib/merge_ats_client/api/eeocs_api.rb +22 -8
- data/lib/merge_ats_client/api/force_resync_api.rb +2 -2
- data/lib/merge_ats_client/api/interviews_api.rb +160 -8
- data/lib/merge_ats_client/api/issues_api.rb +6 -6
- data/lib/merge_ats_client/api/job_interview_stages_api.rb +4 -4
- data/lib/merge_ats_client/api/jobs_api.rb +27 -10
- data/lib/merge_ats_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_ats_client/api/offers_api.rb +22 -8
- data/lib/merge_ats_client/api/offices_api.rb +4 -4
- data/lib/merge_ats_client/api/reject_reasons_api.rb +4 -4
- data/lib/merge_ats_client/api/scorecards_api.rb +22 -8
- data/lib/merge_ats_client/api/selective_sync_api.rb +2 -2
- data/lib/merge_ats_client/api/sync_status_api.rb +2 -2
- data/lib/merge_ats_client/api/tags_api.rb +4 -4
- data/lib/merge_ats_client/api/users_api.rb +22 -8
- data/lib/merge_ats_client/models/account_integration.rb +30 -8
- data/lib/merge_ats_client/models/activity.rb +50 -16
- data/lib/merge_ats_client/models/activity_endpoint_request.rb +237 -0
- data/lib/merge_ats_client/models/activity_request.rb +300 -0
- data/lib/merge_ats_client/models/activity_response.rb +266 -0
- data/lib/merge_ats_client/models/application.rb +40 -26
- data/lib/merge_ats_client/models/application_request.rb +7 -26
- data/lib/merge_ats_client/models/attachment.rb +38 -16
- data/lib/merge_ats_client/models/attachment_request.rb +3 -14
- data/lib/merge_ats_client/models/candidate.rb +36 -27
- data/lib/merge_ats_client/models/candidate_request.rb +3 -49
- data/lib/merge_ats_client/models/categories_enum.rb +3 -1
- data/lib/merge_ats_client/models/category_enum.rb +3 -1
- data/lib/merge_ats_client/models/common_model_scopes_body_request.rb +274 -0
- data/lib/merge_ats_client/models/condition_schema.rb +1 -0
- data/lib/merge_ats_client/models/data_passthrough_request.rb +1 -0
- data/lib/merge_ats_client/models/department.rb +36 -14
- data/lib/merge_ats_client/models/eeoc.rb +42 -19
- data/lib/merge_ats_client/models/email_address.rb +16 -6
- data/lib/merge_ats_client/models/email_address_request.rb +1 -1
- data/lib/merge_ats_client/models/enabled_actions_enum.rb +45 -0
- data/lib/merge_ats_client/models/end_user_details_request.rb +18 -5
- data/lib/merge_ats_client/models/issue.rb +16 -4
- data/lib/merge_ats_client/models/job.rb +38 -16
- data/lib/merge_ats_client/models/job_interview_stage.rb +72 -15
- data/lib/merge_ats_client/models/link_token.rb +0 -5
- data/lib/merge_ats_client/models/meta_response.rb +12 -1
- data/lib/merge_ats_client/models/multipart_form_field_request.rb +1 -1
- data/lib/merge_ats_client/models/offer.rb +40 -16
- data/lib/merge_ats_client/models/office.rb +37 -15
- data/lib/merge_ats_client/models/phone_number.rb +16 -6
- data/lib/merge_ats_client/models/phone_number_request.rb +1 -1
- data/lib/merge_ats_client/models/reject_reason.rb +37 -15
- data/lib/merge_ats_client/models/remote_user.rb +38 -16
- data/lib/merge_ats_client/models/scheduled_interview.rb +41 -16
- data/lib/merge_ats_client/models/scheduled_interview_endpoint_request.rb +237 -0
- data/lib/merge_ats_client/models/scheduled_interview_request.rb +323 -0
- data/lib/merge_ats_client/models/scheduled_interview_response.rb +266 -0
- data/lib/merge_ats_client/models/scorecard.rb +41 -16
- data/lib/merge_ats_client/models/selective_sync_configurations_usage_enum.rb +45 -0
- data/lib/merge_ats_client/models/sync_status.rb +13 -4
- data/lib/merge_ats_client/models/sync_status_status_enum.rb +2 -1
- data/lib/merge_ats_client/models/tag.rb +36 -14
- data/lib/merge_ats_client/models/url.rb +16 -6
- data/lib/merge_ats_client/models/url_request.rb +1 -1
- data/lib/merge_ats_client/version.rb +1 -1
- data/lib/merge_ats_client.rb +9 -1
- data/spec/api/activities_api_spec.rb +31 -4
- data/spec/api/applications_api_spec.rb +2 -2
- data/spec/api/attachments_api_spec.rb +6 -4
- data/spec/api/candidates_api_spec.rb +5 -3
- data/spec/api/departments_api_spec.rb +2 -2
- data/spec/api/eeocs_api_spec.rb +6 -4
- data/spec/api/force_resync_api_spec.rb +1 -1
- data/spec/api/interviews_api_spec.rb +31 -4
- data/spec/api/issues_api_spec.rb +3 -3
- data/spec/api/job_interview_stages_api_spec.rb +2 -2
- data/spec/api/jobs_api_spec.rb +8 -5
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/offers_api_spec.rb +6 -4
- data/spec/api/offices_api_spec.rb +2 -2
- data/spec/api/reject_reasons_api_spec.rb +2 -2
- data/spec/api/scorecards_api_spec.rb +6 -4
- data/spec/api/selective_sync_api_spec.rb +1 -1
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/api/tags_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +6 -4
- data/spec/models/account_integration_spec.rb +12 -0
- data/spec/models/{ignore_common_model_spec.rb → activity_endpoint_request_spec.rb} +8 -8
- data/spec/models/activity_request_spec.rb +76 -0
- data/spec/models/activity_response_spec.rb +52 -0
- data/spec/models/activity_spec.rb +19 -1
- data/spec/models/application_request_spec.rb +0 -12
- data/spec/models/application_spec.rb +9 -3
- data/spec/models/attachment_request_spec.rb +0 -6
- data/spec/models/attachment_spec.rb +14 -2
- data/spec/models/candidate_request_spec.rb +0 -24
- data/spec/models/candidate_spec.rb +9 -3
- data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
- data/spec/models/department_spec.rb +14 -2
- data/spec/models/eeoc_spec.rb +14 -2
- data/spec/models/email_address_spec.rb +6 -0
- data/spec/models/enabled_actions_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/issue_spec.rb +6 -0
- data/spec/models/job_interview_stage_spec.rb +19 -1
- data/spec/models/job_spec.rb +14 -2
- data/spec/models/meta_response_spec.rb +6 -0
- data/spec/models/offer_spec.rb +14 -2
- data/spec/models/office_spec.rb +14 -2
- data/spec/models/phone_number_spec.rb +6 -0
- data/spec/models/reject_reason_spec.rb +14 -2
- data/spec/models/remote_user_spec.rb +14 -2
- data/spec/models/{remote_data_request_spec.rb → scheduled_interview_endpoint_request_spec.rb} +8 -8
- data/spec/models/scheduled_interview_request_spec.rb +88 -0
- data/spec/models/scheduled_interview_response_spec.rb +52 -0
- data/spec/models/scheduled_interview_spec.rb +14 -2
- data/spec/models/scorecard_spec.rb +14 -2
- data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
- data/spec/models/sync_status_spec.rb +6 -0
- data/spec/models/tag_spec.rb +14 -2
- data/spec/models/url_spec.rb +6 -0
- metadata +156 -124
data/docs/CandidatesApi.md
CHANGED
@@ -92,7 +92,7 @@ end
|
|
92
92
|
|
93
93
|
## candidates_ignore_create
|
94
94
|
|
95
|
-
>
|
95
|
+
> candidates_ignore_create(x_account_token, model_id, ignore_common_model_request)
|
96
96
|
|
97
97
|
|
98
98
|
|
@@ -118,8 +118,7 @@ ignore_common_model_request = MergeATSClient::IgnoreCommonModelRequest.new({reas
|
|
118
118
|
|
119
119
|
begin
|
120
120
|
|
121
|
-
|
122
|
-
p result
|
121
|
+
api_instance.candidates_ignore_create(x_account_token, model_id, ignore_common_model_request)
|
123
122
|
rescue MergeATSClient::ApiError => e
|
124
123
|
puts "Error when calling CandidatesApi->candidates_ignore_create: #{e}"
|
125
124
|
end
|
@@ -127,9 +126,9 @@ end
|
|
127
126
|
|
128
127
|
#### Using the candidates_ignore_create_with_http_info variant
|
129
128
|
|
130
|
-
This returns an Array which contains the response data, status code and headers.
|
129
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
131
130
|
|
132
|
-
> <Array(
|
131
|
+
> <Array(nil, Integer, Hash)> candidates_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
|
133
132
|
|
134
133
|
```ruby
|
135
134
|
begin
|
@@ -137,7 +136,7 @@ begin
|
|
137
136
|
data, status_code, headers = api_instance.candidates_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
|
138
137
|
p status_code # => 2xx
|
139
138
|
p headers # => { ... }
|
140
|
-
p data # =>
|
139
|
+
p data # => nil
|
141
140
|
rescue MergeATSClient::ApiError => e
|
142
141
|
puts "Error when calling CandidatesApi->candidates_ignore_create_with_http_info: #{e}"
|
143
142
|
end
|
@@ -153,7 +152,7 @@ end
|
|
153
152
|
|
154
153
|
### Return type
|
155
154
|
|
156
|
-
|
155
|
+
nil (empty response body)
|
157
156
|
|
158
157
|
### Authorization
|
159
158
|
|
@@ -162,7 +161,7 @@ end
|
|
162
161
|
### HTTP request headers
|
163
162
|
|
164
163
|
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
165
|
-
- **Accept**:
|
164
|
+
- **Accept**: Not defined
|
166
165
|
|
167
166
|
|
168
167
|
## candidates_list
|
@@ -192,15 +191,17 @@ opts = {
|
|
192
191
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
193
192
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
194
193
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
194
|
+
email_addresses: 'email_addresses_example', # String | If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas.
|
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
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
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
201
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
200
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
201
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
202
202
|
page_size: 56, # Integer | Number of results to return per page.
|
203
|
-
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
203
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
204
|
+
tags: 'tags_example' # String | If provided, will only return candidates with these tags; multiple tags can be separated by commas.
|
204
205
|
}
|
205
206
|
|
206
207
|
begin
|
@@ -238,15 +239,17 @@ end
|
|
238
239
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
239
240
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
240
241
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
242
|
+
| **email_addresses** | **String** | If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas. | [optional] |
|
241
243
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
242
244
|
| **first_name** | **String** | If provided, will only return candidates with this first name. | [optional] |
|
243
245
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
244
246
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
245
247
|
| **last_name** | **String** | If provided, will only return candidates with this last name. | [optional] |
|
246
|
-
| **modified_after** | **Time** | If provided,
|
247
|
-
| **modified_before** | **Time** | If provided,
|
248
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
249
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
248
250
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
249
251
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
252
|
+
| **tags** | **String** | If provided, will only return candidates with these tags; multiple tags can be separated by commas. | [optional] |
|
250
253
|
|
251
254
|
### Return type
|
252
255
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeATSClient::CommonModelScopesBodyRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model_id** | **String** | | |
|
8
|
+
| **enabled_actions** | [**Array<EnabledActionsEnum>**](EnabledActionsEnum.md) | | |
|
9
|
+
| **disabled_fields** | **Array<String>** | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_ats_client'
|
15
|
+
|
16
|
+
instance = MergeATSClient::CommonModelScopesBodyRequest.new(
|
17
|
+
model_id: hris.Employee,
|
18
|
+
enabled_actions: ["READ","WRITE"],
|
19
|
+
disabled_fields: ["first_name"]
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/ConditionSchema.md
CHANGED
@@ -9,7 +9,7 @@
|
|
9
9
|
| **native_name** | **String** | User-facing *native condition* name. e.g. \"Skip Manager\". | |
|
10
10
|
| **field_name** | **String** | The name of the field on the common model that this condition corresponds to, if they conceptually match. e.g. \"location_type\". | |
|
11
11
|
| **is_unique** | **Boolean** | Whether this condition can only be applied once. If false, the condition can be AND'd together multiple times. | [optional] |
|
12
|
-
| **condition_type** | [**ConditionTypeEnum**](ConditionTypeEnum.md) | | |
|
12
|
+
| **condition_type** | [**ConditionTypeEnum**](ConditionTypeEnum.md) | The type of value(s) that can be set for this condition. * `BOOLEAN` - BOOLEAN * `DATE` - DATE * `DATE_TIME` - DATE_TIME * `INTEGER` - INTEGER * `FLOAT` - FLOAT * `STRING` - STRING * `LIST_OF_STRINGS` - LIST_OF_STRINGS | |
|
13
13
|
| **operators** | [**Array<OperatorSchema>**](OperatorSchema.md) | The schemas for the operators that can be used on a condition. | |
|
14
14
|
|
15
15
|
## Example
|
@@ -11,7 +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** |
|
14
|
+
| **normalize_response** | **Boolean** | Optional. If true, the response will always be an object of the form `{\"type\": T, \"value\": ...}` where `T` will be one of `string, boolean, number, null, array, object`. | [optional] |
|
15
15
|
|
16
16
|
## Example
|
17
17
|
|
data/docs/Department.md
CHANGED
@@ -7,8 +7,10 @@
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
9
|
| **name** | **String** | The department's name. | [optional] |
|
10
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
11
10
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
11
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
12
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
13
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
12
14
|
|
13
15
|
## Example
|
14
16
|
|
@@ -19,8 +21,10 @@ instance = MergeATSClient::Department.new(
|
|
19
21
|
id: 5b3c1341-a20f-4e51-b72c-f3830a16c97b,
|
20
22
|
remote_id: 23456,
|
21
23
|
name: Engineering,
|
22
|
-
|
23
|
-
|
24
|
+
remote_was_deleted: null,
|
25
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
26
|
+
modified_at: 2021-10-16T00:00Z,
|
27
|
+
remote_data: [{"path":"/departments","data":["Varies by platform"]}]
|
24
28
|
)
|
25
29
|
```
|
26
30
|
|
data/docs/DepartmentsApi.md
CHANGED
@@ -37,8 +37,8 @@ opts = {
|
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
38
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
39
39
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
40
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
41
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
40
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
41
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
42
42
|
page_size: 56, # Integer | Number of results to return per page.
|
43
43
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
44
44
|
}
|
@@ -80,8 +80,8 @@ end
|
|
80
80
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
81
81
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
82
82
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
83
|
-
| **modified_after** | **Time** | If provided,
|
84
|
-
| **modified_before** | **Time** | If provided,
|
83
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
84
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
85
85
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
86
86
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
87
87
|
|
data/docs/EEOC.md
CHANGED
@@ -6,14 +6,16 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
-
| **candidate** | **String** |
|
9
|
+
| **candidate** | **String** | The candidate being represented. | [optional] |
|
10
10
|
| **submitted_at** | **Time** | When the information was submitted. | [optional] |
|
11
|
-
| **race** | [**RaceEnum**](RaceEnum.md) | The candidate's race. | [optional] |
|
12
|
-
| **gender** | [**GenderEnum**](GenderEnum.md) | The candidate's gender. | [optional] |
|
13
|
-
| **veteran_status** | [**VeteranStatusEnum**](VeteranStatusEnum.md) | The candidate's veteran status. | [optional] |
|
14
|
-
| **disability_status** | [**DisabilityStatusEnum**](DisabilityStatusEnum.md) | The candidate's disability status. | [optional] |
|
15
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
11
|
+
| **race** | [**RaceEnum**](RaceEnum.md) | The candidate's race. * `AMERICAN_INDIAN_OR_ALASKAN_NATIVE` - AMERICAN_INDIAN_OR_ALASKAN_NATIVE * `ASIAN` - ASIAN * `BLACK_OR_AFRICAN_AMERICAN` - BLACK_OR_AFRICAN_AMERICAN * `HISPANIC_OR_LATINO` - HISPANIC_OR_LATINO * `WHITE` - WHITE * `NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER` - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER * `TWO_OR_MORE_RACES` - TWO_OR_MORE_RACES * `DECLINE_TO_SELF_IDENTIFY` - DECLINE_TO_SELF_IDENTIFY | [optional] |
|
12
|
+
| **gender** | [**GenderEnum**](GenderEnum.md) | The candidate's gender. * `MALE` - MALE * `FEMALE` - FEMALE * `NON-BINARY` - NON-BINARY * `OTHER` - OTHER * `DECLINE_TO_SELF_IDENTIFY` - DECLINE_TO_SELF_IDENTIFY | [optional] |
|
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
|
+
| **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] |
|
16
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
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
18
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
17
19
|
|
18
20
|
## Example
|
19
21
|
|
@@ -29,8 +31,10 @@ instance = MergeATSClient::EEOC.new(
|
|
29
31
|
gender: FEMALE,
|
30
32
|
veteran_status: I_AM_NOT_A_PROTECTED_VETERAN,
|
31
33
|
disability_status: I_DONT_WISH_TO_ANSWER,
|
32
|
-
|
33
|
-
|
34
|
+
remote_was_deleted: null,
|
35
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
36
|
+
modified_at: 2021-10-16T00:00Z,
|
37
|
+
remote_data: [{"path":"/eeoc","data":["Varies by platform"]}]
|
34
38
|
)
|
35
39
|
```
|
36
40
|
|
data/docs/EeocsApi.md
CHANGED
@@ -39,11 +39,12 @@ opts = {
|
|
39
39
|
expand: 'candidate', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
40
40
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
41
41
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
42
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
43
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
42
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
43
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
44
44
|
page_size: 56, # Integer | Number of results to return per page.
|
45
|
-
remote_fields: 'disability_status', # String |
|
46
|
-
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
45
|
+
remote_fields: 'disability_status', # String | Deprecated. Use show_enum_origins.
|
46
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
47
|
+
show_enum_origins: 'disability_status' # String | Which fields should be returned in non-normalized form.
|
47
48
|
}
|
48
49
|
|
49
50
|
begin
|
@@ -85,11 +86,12 @@ end
|
|
85
86
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
86
87
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
87
88
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
88
|
-
| **modified_after** | **Time** | If provided,
|
89
|
-
| **modified_before** | **Time** | If provided,
|
89
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
90
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
90
91
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
91
|
-
| **remote_fields** | **String** |
|
92
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
92
93
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
94
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
93
95
|
|
94
96
|
### Return type
|
95
97
|
|
@@ -132,7 +134,8 @@ id = TODO # String |
|
|
132
134
|
opts = {
|
133
135
|
expand: 'candidate', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
134
136
|
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 |
|
137
|
+
remote_fields: 'disability_status', # String | Deprecated. Use show_enum_origins.
|
138
|
+
show_enum_origins: 'disability_status' # String | Which fields should be returned in non-normalized form.
|
136
139
|
}
|
137
140
|
|
138
141
|
begin
|
@@ -170,7 +173,8 @@ end
|
|
170
173
|
| **id** | [**String**](.md) | | |
|
171
174
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
172
175
|
| **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** |
|
176
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
177
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
174
178
|
|
175
179
|
### Return type
|
176
180
|
|
data/docs/EmailAddress.md
CHANGED
@@ -5,7 +5,8 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **value** | **String** | The email address. | [optional] |
|
8
|
-
| **email_address_type** | [**EmailAddressTypeEnum**](EmailAddressTypeEnum.md) | The type of email address. | [optional] |
|
8
|
+
| **email_address_type** | [**EmailAddressTypeEnum**](EmailAddressTypeEnum.md) | The type of email address. * `PERSONAL` - PERSONAL * `WORK` - WORK * `OTHER` - OTHER | [optional] |
|
9
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
9
10
|
|
10
11
|
## Example
|
11
12
|
|
@@ -14,7 +15,8 @@ require 'merge_ats_client'
|
|
14
15
|
|
15
16
|
instance = MergeATSClient::EmailAddress.new(
|
16
17
|
value: merge_is_hiring@merge.dev,
|
17
|
-
email_address_type: PERSONAL
|
18
|
+
email_address_type: PERSONAL,
|
19
|
+
modified_at: 2021-10-16T00:00Z
|
18
20
|
)
|
19
21
|
```
|
20
22
|
|
data/docs/EmailAddressRequest.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **value** | **String** | The email address. | [optional] |
|
8
|
-
| **email_address_type** | [**EmailAddressTypeEnum**](EmailAddressTypeEnum.md) | The type of email address. | [optional] |
|
8
|
+
| **email_address_type** | [**EmailAddressTypeEnum**](EmailAddressTypeEnum.md) | The type of email address. * `PERSONAL` - PERSONAL * `WORK` - WORK * `OTHER` - OTHER | [optional] |
|
9
9
|
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
10
10
|
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
11
11
|
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeATSClient::EnabledActionsEnum
|
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::EnabledActionsEnum.new()
|
14
|
+
```
|
15
|
+
|
@@ -11,6 +11,7 @@
|
|
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
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] |
|
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] |
|
14
15
|
|
15
16
|
## Example
|
16
17
|
|
@@ -24,7 +25,8 @@ instance = MergeATSClient::EndUserDetailsRequest.new(
|
|
24
25
|
categories: null,
|
25
26
|
integration: null,
|
26
27
|
link_expiry_mins: null,
|
27
|
-
should_create_magic_link_url: null
|
28
|
+
should_create_magic_link_url: null,
|
29
|
+
common_models: null
|
28
30
|
)
|
29
31
|
```
|
30
32
|
|
data/docs/ForceResyncApi.md
CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
13
13
|
|
14
14
|
|
15
15
|
|
16
|
-
Force re-sync of all models. This is
|
16
|
+
Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Core, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
|
17
17
|
|
18
18
|
### Examples
|
19
19
|
|
data/docs/InterviewsApi.md
CHANGED
@@ -4,10 +4,91 @@ 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 | |
|
9
|
+
| [**interviews_meta_post_retrieve**](InterviewsApi.md#interviews_meta_post_retrieve) | **GET** /interviews/meta/post | |
|
8
10
|
| [**interviews_retrieve**](InterviewsApi.md#interviews_retrieve) | **GET** /interviews/{id} | |
|
9
11
|
|
10
12
|
|
13
|
+
## interviews_create
|
14
|
+
|
15
|
+
> <ScheduledInterviewResponse> interviews_create(x_account_token, scheduled_interview_endpoint_request, opts)
|
16
|
+
|
17
|
+
|
18
|
+
|
19
|
+
Creates a `ScheduledInterview` object with the given values.
|
20
|
+
|
21
|
+
### Examples
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'time'
|
25
|
+
require 'merge_ats_client'
|
26
|
+
# setup authorization
|
27
|
+
MergeATSClient.configure do |config|
|
28
|
+
# Configure API key authorization: tokenAuth
|
29
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
30
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
31
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
32
|
+
end
|
33
|
+
|
34
|
+
api_instance = MergeATSClient::InterviewsApi.new
|
35
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
36
|
+
scheduled_interview_endpoint_request = MergeATSClient::ScheduledInterviewEndpointRequest.new({model: MergeATSClient::ScheduledInterviewRequest.new, remote_user_id: 'remote_user_id_example'}) # ScheduledInterviewEndpointRequest |
|
37
|
+
opts = {
|
38
|
+
is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
|
39
|
+
run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
|
44
|
+
result = api_instance.interviews_create(x_account_token, scheduled_interview_endpoint_request, opts)
|
45
|
+
p result
|
46
|
+
rescue MergeATSClient::ApiError => e
|
47
|
+
puts "Error when calling InterviewsApi->interviews_create: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
#### Using the interviews_create_with_http_info variant
|
52
|
+
|
53
|
+
This returns an Array which contains the response data, status code and headers.
|
54
|
+
|
55
|
+
> <Array(<ScheduledInterviewResponse>, Integer, Hash)> interviews_create_with_http_info(x_account_token, scheduled_interview_endpoint_request, opts)
|
56
|
+
|
57
|
+
```ruby
|
58
|
+
begin
|
59
|
+
|
60
|
+
data, status_code, headers = api_instance.interviews_create_with_http_info(x_account_token, scheduled_interview_endpoint_request, opts)
|
61
|
+
p status_code # => 2xx
|
62
|
+
p headers # => { ... }
|
63
|
+
p data # => <ScheduledInterviewResponse>
|
64
|
+
rescue MergeATSClient::ApiError => e
|
65
|
+
puts "Error when calling InterviewsApi->interviews_create_with_http_info: #{e}"
|
66
|
+
end
|
67
|
+
```
|
68
|
+
|
69
|
+
### Parameters
|
70
|
+
|
71
|
+
| Name | Type | Description | Notes |
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
73
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
74
|
+
| **scheduled_interview_endpoint_request** | [**ScheduledInterviewEndpointRequest**](ScheduledInterviewEndpointRequest.md) | | |
|
75
|
+
| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
|
76
|
+
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
77
|
+
|
78
|
+
### Return type
|
79
|
+
|
80
|
+
[**ScheduledInterviewResponse**](ScheduledInterviewResponse.md)
|
81
|
+
|
82
|
+
### Authorization
|
83
|
+
|
84
|
+
[tokenAuth](../README.md#tokenAuth)
|
85
|
+
|
86
|
+
### HTTP request headers
|
87
|
+
|
88
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
89
|
+
- **Accept**: application/json
|
90
|
+
|
91
|
+
|
11
92
|
## interviews_list
|
12
93
|
|
13
94
|
> <PaginatedScheduledInterviewList> interviews_list(x_account_token, opts)
|
@@ -40,12 +121,13 @@ opts = {
|
|
40
121
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
41
122
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
42
123
|
job_interview_stage_id: 'job_interview_stage_id_example', # String | If provided, will only return interviews at this stage.
|
43
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
44
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
124
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
125
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
45
126
|
organizer_id: 'organizer_id_example', # String | If provided, will only return interviews organized by this user.
|
46
127
|
page_size: 56, # Integer | Number of results to return per page.
|
47
|
-
remote_fields: 'status', # String |
|
48
|
-
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
128
|
+
remote_fields: 'status', # String | Deprecated. Use show_enum_origins.
|
129
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
130
|
+
show_enum_origins: 'status' # String | Which fields should be returned in non-normalized form.
|
49
131
|
}
|
50
132
|
|
51
133
|
begin
|
@@ -88,12 +170,13 @@ end
|
|
88
170
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
89
171
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
90
172
|
| **job_interview_stage_id** | **String** | If provided, will only return interviews at this stage. | [optional] |
|
91
|
-
| **modified_after** | **Time** | If provided,
|
92
|
-
| **modified_before** | **Time** | If provided,
|
173
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
174
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
93
175
|
| **organizer_id** | **String** | If provided, will only return interviews organized by this user. | [optional] |
|
94
176
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
95
|
-
| **remote_fields** | **String** |
|
177
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
96
178
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
179
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
97
180
|
|
98
181
|
### Return type
|
99
182
|
|
@@ -109,6 +192,77 @@ end
|
|
109
192
|
- **Accept**: application/json
|
110
193
|
|
111
194
|
|
195
|
+
## interviews_meta_post_retrieve
|
196
|
+
|
197
|
+
> <MetaResponse> interviews_meta_post_retrieve(x_account_token)
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
Returns metadata for `ScheduledInterview` POSTs.
|
202
|
+
|
203
|
+
### Examples
|
204
|
+
|
205
|
+
```ruby
|
206
|
+
require 'time'
|
207
|
+
require 'merge_ats_client'
|
208
|
+
# setup authorization
|
209
|
+
MergeATSClient.configure do |config|
|
210
|
+
# Configure API key authorization: tokenAuth
|
211
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
212
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
213
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
214
|
+
end
|
215
|
+
|
216
|
+
api_instance = MergeATSClient::InterviewsApi.new
|
217
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
218
|
+
|
219
|
+
begin
|
220
|
+
|
221
|
+
result = api_instance.interviews_meta_post_retrieve(x_account_token)
|
222
|
+
p result
|
223
|
+
rescue MergeATSClient::ApiError => e
|
224
|
+
puts "Error when calling InterviewsApi->interviews_meta_post_retrieve: #{e}"
|
225
|
+
end
|
226
|
+
```
|
227
|
+
|
228
|
+
#### Using the interviews_meta_post_retrieve_with_http_info variant
|
229
|
+
|
230
|
+
This returns an Array which contains the response data, status code and headers.
|
231
|
+
|
232
|
+
> <Array(<MetaResponse>, Integer, Hash)> interviews_meta_post_retrieve_with_http_info(x_account_token)
|
233
|
+
|
234
|
+
```ruby
|
235
|
+
begin
|
236
|
+
|
237
|
+
data, status_code, headers = api_instance.interviews_meta_post_retrieve_with_http_info(x_account_token)
|
238
|
+
p status_code # => 2xx
|
239
|
+
p headers # => { ... }
|
240
|
+
p data # => <MetaResponse>
|
241
|
+
rescue MergeATSClient::ApiError => e
|
242
|
+
puts "Error when calling InterviewsApi->interviews_meta_post_retrieve_with_http_info: #{e}"
|
243
|
+
end
|
244
|
+
```
|
245
|
+
|
246
|
+
### Parameters
|
247
|
+
|
248
|
+
| Name | Type | Description | Notes |
|
249
|
+
| ---- | ---- | ----------- | ----- |
|
250
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
251
|
+
|
252
|
+
### Return type
|
253
|
+
|
254
|
+
[**MetaResponse**](MetaResponse.md)
|
255
|
+
|
256
|
+
### Authorization
|
257
|
+
|
258
|
+
[tokenAuth](../README.md#tokenAuth)
|
259
|
+
|
260
|
+
### HTTP request headers
|
261
|
+
|
262
|
+
- **Content-Type**: Not defined
|
263
|
+
- **Accept**: application/json
|
264
|
+
|
265
|
+
|
112
266
|
## interviews_retrieve
|
113
267
|
|
114
268
|
> <ScheduledInterview> interviews_retrieve(x_account_token, id, opts)
|
@@ -136,7 +290,8 @@ id = TODO # String |
|
|
136
290
|
opts = {
|
137
291
|
expand: 'application', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
138
292
|
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 |
|
293
|
+
remote_fields: 'status', # String | Deprecated. Use show_enum_origins.
|
294
|
+
show_enum_origins: 'status' # String | Which fields should be returned in non-normalized form.
|
140
295
|
}
|
141
296
|
|
142
297
|
begin
|
@@ -174,7 +329,8 @@ end
|
|
174
329
|
| **id** | [**String**](.md) | | |
|
175
330
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
176
331
|
| **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** |
|
332
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
333
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
178
334
|
|
179
335
|
### Return type
|
180
336
|
|
data/docs/Issue.md
CHANGED
@@ -5,12 +5,13 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
|
-
| **status** | [**IssueStatusEnum**](IssueStatusEnum.md) | | [optional] |
|
8
|
+
| **status** | [**IssueStatusEnum**](IssueStatusEnum.md) | Status of the issue. Options: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED | [optional] |
|
9
9
|
| **error_description** | **String** | | |
|
10
10
|
| **end_user** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
11
11
|
| **first_incident_time** | **Time** | | [optional] |
|
12
12
|
| **last_incident_time** | **Time** | | [optional] |
|
13
13
|
| **is_muted** | **Boolean** | | [optional][readonly] |
|
14
|
+
| **error_details** | **Array<String>** | | [optional][readonly] |
|
14
15
|
|
15
16
|
## Example
|
16
17
|
|
@@ -18,13 +19,14 @@
|
|
18
19
|
require 'merge_ats_client'
|
19
20
|
|
20
21
|
instance = MergeATSClient::Issue.new(
|
21
|
-
id:
|
22
|
-
status:
|
23
|
-
error_description:
|
24
|
-
end_user:
|
25
|
-
first_incident_time:
|
26
|
-
last_incident_time:
|
27
|
-
is_muted:
|
22
|
+
id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
|
23
|
+
status: ONGOING,
|
24
|
+
error_description: string,
|
25
|
+
end_user: b82302de-852e-4e60-b050-edf9da3b7c02,
|
26
|
+
first_incident_time: 2022-12-05T16:19:15.161Z,
|
27
|
+
last_incident_time: 2022-12-05T16:19:15.161Z,
|
28
|
+
is_muted: true,
|
29
|
+
error_details: ["Missing employee permissions.","Missing time off permissions."]
|
28
30
|
)
|
29
31
|
```
|
30
32
|
|