merge_ats_client 3.0.0 → 3.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (205) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -6
  3. data/docs/AccountIntegration.md +6 -2
  4. data/docs/ActivitiesApi.md +164 -8
  5. data/docs/Activity.md +12 -6
  6. data/docs/ActivityEndpointRequest.md +20 -0
  7. data/docs/ActivityRequest.md +32 -0
  8. data/docs/ActivityResponse.md +24 -0
  9. data/docs/Application.md +12 -10
  10. data/docs/ApplicationRequest.md +5 -9
  11. data/docs/ApplicationsApi.md +4 -4
  12. data/docs/AsyncPassthroughApi.md +155 -0
  13. data/docs/AsyncPassthroughReciept.md +18 -0
  14. data/docs/Attachment.md +8 -4
  15. data/docs/AttachmentRequest.md +1 -3
  16. data/docs/AttachmentsApi.md +13 -9
  17. data/docs/Candidate.md +8 -6
  18. data/docs/CandidateRequest.md +1 -9
  19. data/docs/CandidatesApi.md +172 -13
  20. data/docs/CommonModelScopesBodyRequest.md +22 -0
  21. data/docs/ConditionSchema.md +1 -1
  22. data/docs/DataPassthroughRequest.md +1 -1
  23. data/docs/DeleteAccountApi.md +9 -9
  24. data/docs/Department.md +7 -3
  25. data/docs/DepartmentsApi.md +4 -4
  26. data/docs/EEOC.md +12 -8
  27. data/docs/EeocsApi.md +13 -9
  28. data/docs/EmailAddress.md +4 -2
  29. data/docs/EmailAddressRequest.md +1 -1
  30. data/docs/EnabledActionsEnum.md +15 -0
  31. data/docs/EndUserDetailsRequest.md +4 -2
  32. data/docs/ForceResyncApi.md +1 -1
  33. data/docs/InterviewsApi.md +165 -9
  34. data/docs/Issue.md +10 -8
  35. data/docs/IssuesApi.md +6 -6
  36. data/docs/Job.md +8 -4
  37. data/docs/JobInterviewStage.md +10 -4
  38. data/docs/JobInterviewStagesApi.md +4 -4
  39. data/docs/JobsApi.md +16 -10
  40. data/docs/LinkToken.md +1 -1
  41. data/docs/LinkedAccountsApi.md +2 -2
  42. data/docs/MetaResponse.md +2 -0
  43. data/docs/MultipartFormFieldRequest.md +1 -1
  44. data/docs/Offer.md +10 -6
  45. data/docs/OffersApi.md +13 -9
  46. data/docs/Office.md +7 -3
  47. data/docs/OfficesApi.md +4 -4
  48. data/docs/PaginatedConditionSchemaList.md +2 -2
  49. data/docs/PatchedCandidateEndpointRequest.md +20 -0
  50. data/docs/PatchedCandidateRequest.md +50 -0
  51. data/docs/PhoneNumber.md +4 -2
  52. data/docs/PhoneNumberRequest.md +1 -1
  53. data/docs/RejectReason.md +7 -3
  54. data/docs/RejectReasonsApi.md +4 -4
  55. data/docs/RemoteData.md +1 -1
  56. data/docs/RemoteUser.md +8 -4
  57. data/docs/ScheduledInterview.md +11 -7
  58. data/docs/ScheduledInterviewEndpointRequest.md +20 -0
  59. data/docs/ScheduledInterviewRequest.md +36 -0
  60. data/docs/ScheduledInterviewResponse.md +24 -0
  61. data/docs/Scorecard.md +11 -7
  62. data/docs/ScorecardsApi.md +13 -9
  63. data/docs/SelectiveSyncApi.md +2 -2
  64. data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
  65. data/docs/SyncStatus.md +3 -1
  66. data/docs/SyncStatusApi.md +1 -1
  67. data/docs/Tag.md +7 -3
  68. data/docs/TagsApi.md +4 -4
  69. data/docs/Url.md +4 -2
  70. data/docs/UrlRequest.md +1 -1
  71. data/docs/UsersApi.md +13 -9
  72. data/lib/merge_ats_client/api/activities_api.rb +160 -8
  73. data/lib/merge_ats_client/api/applications_api.rb +4 -4
  74. data/lib/merge_ats_client/api/async_passthrough_api.rb +160 -0
  75. data/lib/merge_ats_client/api/attachments_api.rb +22 -8
  76. data/lib/merge_ats_client/api/candidates_api.rb +165 -11
  77. data/lib/merge_ats_client/api/delete_account_api.rb +7 -7
  78. data/lib/merge_ats_client/api/departments_api.rb +4 -4
  79. data/lib/merge_ats_client/api/eeocs_api.rb +22 -8
  80. data/lib/merge_ats_client/api/force_resync_api.rb +2 -2
  81. data/lib/merge_ats_client/api/interviews_api.rb +160 -8
  82. data/lib/merge_ats_client/api/issues_api.rb +6 -6
  83. data/lib/merge_ats_client/api/job_interview_stages_api.rb +4 -4
  84. data/lib/merge_ats_client/api/jobs_api.rb +27 -10
  85. data/lib/merge_ats_client/api/linked_accounts_api.rb +3 -3
  86. data/lib/merge_ats_client/api/offers_api.rb +22 -8
  87. data/lib/merge_ats_client/api/offices_api.rb +4 -4
  88. data/lib/merge_ats_client/api/reject_reasons_api.rb +4 -4
  89. data/lib/merge_ats_client/api/scorecards_api.rb +22 -8
  90. data/lib/merge_ats_client/api/selective_sync_api.rb +2 -2
  91. data/lib/merge_ats_client/api/sync_status_api.rb +2 -2
  92. data/lib/merge_ats_client/api/tags_api.rb +4 -4
  93. data/lib/merge_ats_client/api/users_api.rb +22 -8
  94. data/lib/merge_ats_client/models/account_integration.rb +30 -8
  95. data/lib/merge_ats_client/models/activity.rb +50 -16
  96. data/lib/merge_ats_client/models/activity_endpoint_request.rb +237 -0
  97. data/lib/merge_ats_client/models/activity_request.rb +300 -0
  98. data/lib/merge_ats_client/models/activity_response.rb +266 -0
  99. data/lib/merge_ats_client/models/application.rb +40 -26
  100. data/lib/merge_ats_client/models/application_request.rb +7 -26
  101. data/lib/merge_ats_client/models/async_passthrough_reciept.rb +223 -0
  102. data/lib/merge_ats_client/models/attachment.rb +38 -16
  103. data/lib/merge_ats_client/models/attachment_request.rb +3 -14
  104. data/lib/merge_ats_client/models/candidate.rb +36 -27
  105. data/lib/merge_ats_client/models/candidate_request.rb +3 -49
  106. data/lib/merge_ats_client/models/categories_enum.rb +3 -1
  107. data/lib/merge_ats_client/models/category_enum.rb +3 -1
  108. data/lib/merge_ats_client/models/common_model_scopes_body_request.rb +274 -0
  109. data/lib/merge_ats_client/models/condition_schema.rb +1 -0
  110. data/lib/merge_ats_client/models/data_passthrough_request.rb +1 -0
  111. data/lib/merge_ats_client/models/department.rb +36 -14
  112. data/lib/merge_ats_client/models/eeoc.rb +42 -19
  113. data/lib/merge_ats_client/models/email_address.rb +16 -6
  114. data/lib/merge_ats_client/models/email_address_request.rb +1 -1
  115. data/lib/merge_ats_client/models/enabled_actions_enum.rb +45 -0
  116. data/lib/merge_ats_client/models/end_user_details_request.rb +19 -6
  117. data/lib/merge_ats_client/models/issue.rb +16 -4
  118. data/lib/merge_ats_client/models/job.rb +38 -16
  119. data/lib/merge_ats_client/models/job_interview_stage.rb +72 -15
  120. data/lib/merge_ats_client/models/link_token.rb +0 -5
  121. data/lib/merge_ats_client/models/meta_response.rb +12 -1
  122. data/lib/merge_ats_client/models/multipart_form_field_request.rb +1 -1
  123. data/lib/merge_ats_client/models/offer.rb +40 -16
  124. data/lib/merge_ats_client/models/office.rb +37 -15
  125. data/lib/merge_ats_client/models/patched_candidate_endpoint_request.rb +237 -0
  126. data/lib/merge_ats_client/models/patched_candidate_request.rb +418 -0
  127. data/lib/merge_ats_client/models/phone_number.rb +16 -6
  128. data/lib/merge_ats_client/models/phone_number_request.rb +1 -1
  129. data/lib/merge_ats_client/models/reject_reason.rb +37 -15
  130. data/lib/merge_ats_client/models/remote_data.rb +3 -4
  131. data/lib/merge_ats_client/models/remote_user.rb +38 -16
  132. data/lib/merge_ats_client/models/scheduled_interview.rb +41 -16
  133. data/lib/merge_ats_client/models/scheduled_interview_endpoint_request.rb +237 -0
  134. data/lib/merge_ats_client/models/scheduled_interview_request.rb +323 -0
  135. data/lib/merge_ats_client/models/scheduled_interview_response.rb +266 -0
  136. data/lib/merge_ats_client/models/scorecard.rb +41 -16
  137. data/lib/merge_ats_client/models/selective_sync_configurations_usage_enum.rb +45 -0
  138. data/lib/merge_ats_client/models/sync_status.rb +13 -4
  139. data/lib/merge_ats_client/models/sync_status_status_enum.rb +2 -1
  140. data/lib/merge_ats_client/models/tag.rb +36 -14
  141. data/lib/merge_ats_client/models/url.rb +16 -6
  142. data/lib/merge_ats_client/models/url_request.rb +1 -1
  143. data/lib/merge_ats_client/version.rb +1 -1
  144. data/lib/merge_ats_client.rb +13 -1
  145. data/spec/api/activities_api_spec.rb +31 -4
  146. data/spec/api/applications_api_spec.rb +2 -2
  147. data/spec/api/async_passthrough_api_spec.rb +59 -0
  148. data/spec/api/attachments_api_spec.rb +6 -4
  149. data/spec/api/candidates_api_spec.rb +32 -3
  150. data/spec/api/delete_account_api_spec.rb +2 -2
  151. data/spec/api/departments_api_spec.rb +2 -2
  152. data/spec/api/eeocs_api_spec.rb +6 -4
  153. data/spec/api/force_resync_api_spec.rb +1 -1
  154. data/spec/api/interviews_api_spec.rb +31 -4
  155. data/spec/api/issues_api_spec.rb +3 -3
  156. data/spec/api/job_interview_stages_api_spec.rb +2 -2
  157. data/spec/api/jobs_api_spec.rb +8 -5
  158. data/spec/api/linked_accounts_api_spec.rb +1 -1
  159. data/spec/api/offers_api_spec.rb +6 -4
  160. data/spec/api/offices_api_spec.rb +2 -2
  161. data/spec/api/reject_reasons_api_spec.rb +2 -2
  162. data/spec/api/scorecards_api_spec.rb +6 -4
  163. data/spec/api/selective_sync_api_spec.rb +1 -1
  164. data/spec/api/sync_status_api_spec.rb +1 -1
  165. data/spec/api/tags_api_spec.rb +2 -2
  166. data/spec/api/users_api_spec.rb +6 -4
  167. data/spec/models/account_integration_spec.rb +12 -0
  168. data/spec/models/{ignore_common_model_spec.rb → activity_endpoint_request_spec.rb} +8 -8
  169. data/spec/models/activity_request_spec.rb +76 -0
  170. data/spec/models/activity_response_spec.rb +52 -0
  171. data/spec/models/activity_spec.rb +19 -1
  172. data/spec/models/application_request_spec.rb +0 -12
  173. data/spec/models/application_spec.rb +9 -3
  174. data/spec/models/async_passthrough_reciept_spec.rb +34 -0
  175. data/spec/models/attachment_request_spec.rb +0 -6
  176. data/spec/models/attachment_spec.rb +14 -2
  177. data/spec/models/candidate_request_spec.rb +0 -24
  178. data/spec/models/candidate_spec.rb +9 -3
  179. data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
  180. data/spec/models/department_spec.rb +14 -2
  181. data/spec/models/eeoc_spec.rb +14 -2
  182. data/spec/models/email_address_spec.rb +6 -0
  183. data/spec/models/enabled_actions_enum_spec.rb +28 -0
  184. data/spec/models/end_user_details_request_spec.rb +6 -0
  185. data/spec/models/issue_spec.rb +6 -0
  186. data/spec/models/job_interview_stage_spec.rb +19 -1
  187. data/spec/models/job_spec.rb +14 -2
  188. data/spec/models/meta_response_spec.rb +6 -0
  189. data/spec/models/offer_spec.rb +14 -2
  190. data/spec/models/office_spec.rb +14 -2
  191. data/spec/models/{remote_data_request_spec.rb → patched_candidate_endpoint_request_spec.rb} +8 -8
  192. data/spec/models/patched_candidate_request_spec.rb +130 -0
  193. data/spec/models/phone_number_spec.rb +6 -0
  194. data/spec/models/reject_reason_spec.rb +14 -2
  195. data/spec/models/remote_user_spec.rb +14 -2
  196. data/spec/models/scheduled_interview_endpoint_request_spec.rb +40 -0
  197. data/spec/models/scheduled_interview_request_spec.rb +88 -0
  198. data/spec/models/scheduled_interview_response_spec.rb +52 -0
  199. data/spec/models/scheduled_interview_spec.rb +14 -2
  200. data/spec/models/scorecard_spec.rb +14 -2
  201. data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
  202. data/spec/models/sync_status_spec.rb +6 -0
  203. data/spec/models/tag_spec.rb +14 -2
  204. data/spec/models/url_spec.rb +6 -0
  205. metadata +167 -119
@@ -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
@@ -9,9 +9,11 @@
9
9
  | **file_name** | **String** | The attachment&#39;s name. | [optional] |
10
10
  | **file_url** | **String** | The attachment&#39;s url. | [optional] |
11
11
  | **candidate** | **String** | | [optional] |
12
- | **attachment_type** | [**AttachmentTypeEnum**](AttachmentTypeEnum.md) | The attachment&#39;s type. | [optional] |
13
- | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
12
+ | **attachment_type** | [**AttachmentTypeEnum**](AttachmentTypeEnum.md) | The attachment&#39;s type. * &#x60;RESUME&#x60; - RESUME * &#x60;COVER_LETTER&#x60; - COVER_LETTER * &#x60;OFFER_LETTER&#x60; - OFFER_LETTER * &#x60;OTHER&#x60; - OTHER | [optional] |
14
13
  | **remote_was_deleted** | **Boolean** | | [optional][readonly] |
14
+ | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
15
+ | **field_mappings** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional][readonly] |
16
+ | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
15
17
 
16
18
  ## Example
17
19
 
@@ -25,8 +27,10 @@ instance = MergeATSClient::Attachment.new(
25
27
  file_url: http://alturl.com/p749b,
26
28
  candidate: 2872ba14-4084-492b-be96-e5eee6fc33ef,
27
29
  attachment_type: RESUME,
28
- remote_data: [{&quot;path&quot;:&quot;/attachments&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}],
29
- remote_was_deleted: null
30
+ remote_was_deleted: null,
31
+ modified_at: 2021-10-16T00:00Z,
32
+ field_mappings: {&quot;organization_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;},&quot;linked_account_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;}},
33
+ remote_data: [{&quot;path&quot;:&quot;/attachments&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
30
34
  )
31
35
  ```
32
36
 
@@ -4,11 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
8
7
  | **file_name** | **String** | The attachment&#39;s name. | [optional] |
9
8
  | **file_url** | **String** | The attachment&#39;s url. | [optional] |
10
9
  | **candidate** | **String** | | [optional] |
11
- | **attachment_type** | [**AttachmentTypeEnum**](AttachmentTypeEnum.md) | The attachment&#39;s type. | [optional] |
10
+ | **attachment_type** | [**AttachmentTypeEnum**](AttachmentTypeEnum.md) | The attachment&#39;s type. * &#x60;RESUME&#x60; - RESUME * &#x60;COVER_LETTER&#x60; - COVER_LETTER * &#x60;OFFER_LETTER&#x60; - OFFER_LETTER * &#x60;OTHER&#x60; - OTHER | [optional] |
12
11
  | **integration_params** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
13
12
  | **linked_account_params** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
14
13
 
@@ -18,7 +17,6 @@
18
17
  require 'merge_ats_client'
19
18
 
20
19
  instance = MergeATSClient::AttachmentRequest.new(
21
- remote_id: 11167,
22
20
  file_name: Candidate Resume,
23
21
  file_url: http://alturl.com/p749b,
24
22
  candidate: 2872ba14-4084-492b-be96-e5eee6fc33ef,
@@ -120,11 +120,12 @@ opts = {
120
120
  expand: 'candidate', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
121
121
  include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
122
122
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
123
- modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
124
- modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
123
+ 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.
124
+ 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.
125
125
  page_size: 56, # Integer | Number of results to return per page.
126
- remote_fields: 'attachment_type', # String | Which fields should be returned in non-normalized form.
127
- remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
126
+ remote_fields: 'attachment_type', # String | Deprecated. Use show_enum_origins.
127
+ remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
128
+ show_enum_origins: 'attachment_type' # String | Which fields should be returned in non-normalized form.
128
129
  }
129
130
 
130
131
  begin
@@ -166,11 +167,12 @@ end
166
167
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
167
168
  | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
168
169
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
169
- | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
170
- | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
170
+ | **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
171
+ | **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
171
172
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
172
- | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
173
+ | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
173
174
  | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
175
+ | **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
174
176
 
175
177
  ### Return type
176
178
 
@@ -284,7 +286,8 @@ id = TODO # String |
284
286
  opts = {
285
287
  expand: 'candidate', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
286
288
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
287
- remote_fields: 'attachment_type' # String | Which fields should be returned in non-normalized form.
289
+ remote_fields: 'attachment_type', # String | Deprecated. Use show_enum_origins.
290
+ show_enum_origins: 'attachment_type' # String | Which fields should be returned in non-normalized form.
288
291
  }
289
292
 
290
293
  begin
@@ -322,7 +325,8 @@ end
322
325
  | **id** | [**String**](.md) | | |
323
326
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
324
327
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
325
- | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
328
+ | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
329
+ | **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
326
330
 
327
331
  ### Return type
328
332
 
data/docs/Candidate.md CHANGED
@@ -12,7 +12,7 @@
12
12
  | **title** | **String** | The candidate&#39;s current title. | [optional] |
13
13
  | **remote_created_at** | **Time** | When the third party&#39;s candidate was created. | [optional] |
14
14
  | **remote_updated_at** | **Time** | When the third party&#39;s candidate was updated. | [optional] |
15
- | **last_interaction_at** | **Time** | When the most recent candidate interaction occurred. | [optional] |
15
+ | **last_interaction_at** | **Time** | When the most recent interaction with the candidate occurred. | [optional] |
16
16
  | **is_private** | **Boolean** | Whether or not the candidate is private. | [optional] |
17
17
  | **can_email** | **Boolean** | Whether or not the candidate can be emailed. | [optional] |
18
18
  | **locations** | **Array&lt;String&gt;** | The candidate&#39;s locations. | [optional] |
@@ -22,9 +22,10 @@
22
22
  | **tags** | **Array&lt;String&gt;** | Array of &#x60;Tag&#x60; names as strings. | [optional] |
23
23
  | **applications** | **Array&lt;String&gt;** | Array of &#x60;Application&#x60; object IDs. | [optional] |
24
24
  | **attachments** | **Array&lt;String&gt;** | Array of &#x60;Attachment&#x60; object IDs. | [optional] |
25
- | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
26
- | **custom_fields** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | Custom fields configured for a given model. | [optional] |
27
25
  | **remote_was_deleted** | **Boolean** | | [optional][readonly] |
26
+ | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
27
+ | **field_mappings** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional][readonly] |
28
+ | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
28
29
 
29
30
  ## Example
30
31
 
@@ -50,9 +51,10 @@ instance = MergeATSClient::Candidate.new(
50
51
  tags: [&quot;High-Priority&quot;],
51
52
  applications: [&quot;29eb9867-ce2a-403f-b8ce-f2844b89f078&quot;,&quot;b4d08e5c-de00-4d64-a29f-66addac9af99&quot;,&quot;4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56&quot;],
52
53
  attachments: [&quot;bea08964-32b4-4a20-8bb4-2612ba09de1d&quot;],
53
- remote_data: [{&quot;path&quot;:&quot;/candidates&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}],
54
- custom_fields: null,
55
- remote_was_deleted: null
54
+ remote_was_deleted: null,
55
+ modified_at: 2021-10-16T00:00Z,
56
+ field_mappings: {&quot;organization_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;},&quot;linked_account_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;}},
57
+ remote_data: [{&quot;path&quot;:&quot;/candidates&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
56
58
  )
57
59
  ```
58
60
 
@@ -4,14 +4,11 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
8
7
  | **first_name** | **String** | The candidate&#39;s first name. | [optional] |
9
8
  | **last_name** | **String** | The candidate&#39;s last name. | [optional] |
10
9
  | **company** | **String** | The candidate&#39;s current company. | [optional] |
11
10
  | **title** | **String** | The candidate&#39;s current title. | [optional] |
12
- | **remote_created_at** | **Time** | When the third party&#39;s candidate was created. | [optional] |
13
- | **remote_updated_at** | **Time** | When the third party&#39;s candidate was updated. | [optional] |
14
- | **last_interaction_at** | **Time** | When the most recent candidate interaction occurred. | [optional] |
11
+ | **last_interaction_at** | **Time** | When the most recent interaction with the candidate occurred. | [optional] |
15
12
  | **is_private** | **Boolean** | Whether or not the candidate is private. | [optional] |
16
13
  | **can_email** | **Boolean** | Whether or not the candidate can be emailed. | [optional] |
17
14
  | **locations** | **Array&lt;String&gt;** | The candidate&#39;s locations. | [optional] |
@@ -21,7 +18,6 @@
21
18
  | **tags** | **Array&lt;String&gt;** | Array of &#x60;Tag&#x60; names as strings. | [optional] |
22
19
  | **applications** | **Array&lt;String&gt;** | Array of &#x60;Application&#x60; object IDs. | [optional] |
23
20
  | **attachments** | **Array&lt;String&gt;** | Array of &#x60;Attachment&#x60; object IDs. | [optional] |
24
- | **custom_fields** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | Custom fields configured for a given model. | [optional] |
25
21
  | **remote_template_id** | **String** | | [optional] |
26
22
  | **integration_params** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
27
23
  | **linked_account_params** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
@@ -32,13 +28,10 @@
32
28
  require 'merge_ats_client'
33
29
 
34
30
  instance = MergeATSClient::CandidateRequest.new(
35
- remote_id: 21198,
36
31
  first_name: Gil,
37
32
  last_name: Feig,
38
33
  company: Columbia Dining App.,
39
34
  title: Software Engineer,
40
- remote_created_at: 2021-10-15T00:00Z,
41
- remote_updated_at: 2021-10-16T00:00Z,
42
35
  last_interaction_at: 2021-10-17T00:00Z,
43
36
  is_private: true,
44
37
  can_email: true,
@@ -49,7 +42,6 @@ instance = MergeATSClient::CandidateRequest.new(
49
42
  tags: [&quot;High-Priority&quot;],
50
43
  applications: [&quot;29eb9867-ce2a-403f-b8ce-f2844b89f078&quot;,&quot;b4d08e5c-de00-4d64-a29f-66addac9af99&quot;,&quot;4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56&quot;],
51
44
  attachments: [&quot;bea08964-32b4-4a20-8bb4-2612ba09de1d&quot;],
52
- custom_fields: null,
53
45
  remote_template_id: 92830948203,
54
46
  integration_params: {&quot;unique_integration_field&quot;:&quot;unique_integration_field_value&quot;},
55
47
  linked_account_params: {&quot;unique_linked_account_field&quot;:&quot;unique_linked_account_field_value&quot;}
@@ -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
 
@@ -92,7 +94,7 @@ end
92
94
 
93
95
  ## candidates_ignore_create
94
96
 
95
- > <IgnoreCommonModel> candidates_ignore_create(x_account_token, model_id, ignore_common_model_request)
97
+ > candidates_ignore_create(x_account_token, model_id, ignore_common_model_request)
96
98
 
97
99
 
98
100
 
@@ -118,8 +120,7 @@ ignore_common_model_request = MergeATSClient::IgnoreCommonModelRequest.new({reas
118
120
 
119
121
  begin
120
122
 
121
- result = api_instance.candidates_ignore_create(x_account_token, model_id, ignore_common_model_request)
122
- p result
123
+ api_instance.candidates_ignore_create(x_account_token, model_id, ignore_common_model_request)
123
124
  rescue MergeATSClient::ApiError => e
124
125
  puts "Error when calling CandidatesApi->candidates_ignore_create: #{e}"
125
126
  end
@@ -127,9 +128,9 @@ end
127
128
 
128
129
  #### Using the candidates_ignore_create_with_http_info variant
129
130
 
130
- This returns an Array which contains the response data, status code and headers.
131
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
131
132
 
132
- > <Array(<IgnoreCommonModel>, Integer, Hash)> candidates_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
133
+ > <Array(nil, Integer, Hash)> candidates_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
133
134
 
134
135
  ```ruby
135
136
  begin
@@ -137,7 +138,7 @@ begin
137
138
  data, status_code, headers = api_instance.candidates_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
138
139
  p status_code # => 2xx
139
140
  p headers # => { ... }
140
- p data # => <IgnoreCommonModel>
141
+ p data # => nil
141
142
  rescue MergeATSClient::ApiError => e
142
143
  puts "Error when calling CandidatesApi->candidates_ignore_create_with_http_info: #{e}"
143
144
  end
@@ -153,7 +154,7 @@ end
153
154
 
154
155
  ### Return type
155
156
 
156
- [**IgnoreCommonModel**](IgnoreCommonModel.md)
157
+ nil (empty response body)
157
158
 
158
159
  ### Authorization
159
160
 
@@ -162,7 +163,7 @@ end
162
163
  ### HTTP request headers
163
164
 
164
165
  - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
165
- - **Accept**: application/json
166
+ - **Accept**: Not defined
166
167
 
167
168
 
168
169
  ## candidates_list
@@ -192,15 +193,17 @@ opts = {
192
193
  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
193
194
  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
194
195
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
196
+ email_addresses: 'email_addresses_example', # String | If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas.
195
197
  expand: 'applications', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
196
198
  first_name: 'first_name_example', # String | If provided, will only return candidates with this first name.
197
199
  include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
198
200
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
199
201
  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, will only return objects modified after this datetime.
201
- modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
202
+ 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.
203
+ 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
204
  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.
205
+ remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
206
+ tags: 'tags_example' # String | If provided, will only return candidates with these tags; multiple tags can be separated by commas.
204
207
  }
205
208
 
206
209
  begin
@@ -238,15 +241,17 @@ end
238
241
  | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
239
242
  | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
240
243
  | **cursor** | **String** | The pagination cursor value. | [optional] |
244
+ | **email_addresses** | **String** | If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas. | [optional] |
241
245
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
242
246
  | **first_name** | **String** | If provided, will only return candidates with this first name. | [optional] |
243
247
  | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
244
248
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
245
249
  | **last_name** | **String** | If provided, will only return candidates with this last name. | [optional] |
246
- | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
247
- | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
250
+ | **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
251
+ | **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
248
252
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
249
253
  | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
254
+ | **tags** | **String** | If provided, will only return candidates with these tags; multiple tags can be separated by commas. | [optional] |
250
255
 
251
256
  ### Return type
252
257
 
@@ -262,6 +267,79 @@ end
262
267
  - **Accept**: application/json
263
268
 
264
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
+
265
343
  ## candidates_meta_post_retrieve
266
344
 
267
345
  > <MetaResponse> candidates_meta_post_retrieve(x_account_token)
@@ -333,6 +411,87 @@ end
333
411
  - **Accept**: application/json
334
412
 
335
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
+
336
495
  ## candidates_retrieve
337
496
 
338
497
  > <Candidate> candidates_retrieve(x_account_token, id, opts)
@@ -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&lt;EnabledActionsEnum&gt;**](EnabledActionsEnum.md) | | |
9
+ | **disabled_fields** | **Array&lt;String&gt;** | | |
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: [&quot;READ&quot;,&quot;WRITE&quot;],
19
+ disabled_fields: [&quot;first_name&quot;]
20
+ )
21
+ ```
22
+
@@ -9,7 +9,7 @@
9
9
  | **native_name** | **String** | User-facing *native condition* name. e.g. \&quot;Skip Manager\&quot;. | |
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. \&quot;location_type\&quot;. | |
11
11
  | **is_unique** | **Boolean** | Whether this condition can only be applied once. If false, the condition can be AND&#39;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. * &#x60;BOOLEAN&#x60; - BOOLEAN * &#x60;DATE&#x60; - DATE * &#x60;DATE_TIME&#x60; - DATE_TIME * &#x60;INTEGER&#x60; - INTEGER * &#x60;FLOAT&#x60; - FLOAT * &#x60;STRING&#x60; - STRING * &#x60;LIST_OF_STRINGS&#x60; - LIST_OF_STRINGS | |
13
13
  | **operators** | [**Array&lt;OperatorSchema&gt;**](OperatorSchema.md) | The schemas for the operators that can be used on a condition. | |
14
14
 
15
15
  ## Example