merge_ats_client 2.0.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (179) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE.md +16 -0
  3. data/README.md +20 -6
  4. data/docs/AccountDetails.md +3 -1
  5. data/docs/AccountDetailsAndActions.md +2 -0
  6. data/docs/ActivitiesApi.md +7 -3
  7. data/docs/Activity.md +1 -1
  8. data/docs/ApplicationsApi.md +84 -2
  9. data/docs/AttachmentsApi.md +7 -3
  10. data/docs/CandidatesApi.md +2 -2
  11. data/docs/ConditionSchema.md +30 -0
  12. data/docs/ConditionTypeEnum.md +15 -0
  13. data/docs/DataPassthroughRequest.md +3 -1
  14. data/docs/Department.md +1 -1
  15. data/docs/DepartmentsApi.md +2 -2
  16. data/docs/EEOC.md +1 -1
  17. data/docs/EeocsApi.md +7 -3
  18. data/docs/EmailAddressRequest.md +5 -1
  19. data/docs/EndUserDetailsRequest.md +9 -7
  20. data/docs/InterviewsApi.md +7 -3
  21. data/docs/Job.md +4 -2
  22. data/docs/JobInterviewStage.md +2 -2
  23. data/docs/JobInterviewStagesApi.md +2 -2
  24. data/docs/JobsApi.md +7 -3
  25. data/docs/LinkToken.md +3 -1
  26. data/docs/LinkedAccountCondition.md +28 -0
  27. data/docs/LinkedAccountConditionRequest.md +22 -0
  28. data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
  29. data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
  30. data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
  31. data/docs/LinkedAccountsApi.md +2 -0
  32. data/docs/Offer.md +1 -1
  33. data/docs/OffersApi.md +7 -3
  34. data/docs/Office.md +1 -1
  35. data/docs/OfficesApi.md +2 -2
  36. data/docs/OperatorSchema.md +20 -0
  37. data/docs/PaginatedConditionSchemaList.md +22 -0
  38. data/docs/PhoneNumberRequest.md +5 -1
  39. data/docs/RejectReason.md +1 -1
  40. data/docs/RejectReasonsApi.md +2 -2
  41. data/docs/RemoteResponse.md +5 -1
  42. data/docs/RemoteUser.md +1 -1
  43. data/docs/ResponseTypeEnum.md +15 -0
  44. data/docs/ScheduledInterview.md +1 -1
  45. data/docs/Scorecard.md +1 -1
  46. data/docs/ScorecardsApi.md +7 -3
  47. data/docs/SelectiveSyncApi.md +233 -0
  48. data/docs/SyncStatus.md +2 -2
  49. data/docs/SyncStatusApi.md +1 -1
  50. data/docs/Tag.md +1 -1
  51. data/docs/TagsApi.md +2 -2
  52. data/docs/UpdateApplicationStageRequest.md +20 -0
  53. data/docs/UrlRequest.md +5 -1
  54. data/docs/UsersApi.md +7 -3
  55. data/lib/merge_ats_client/api/activities_api.rb +16 -2
  56. data/lib/merge_ats_client/api/applications_api.rb +80 -2
  57. data/lib/merge_ats_client/api/attachments_api.rb +16 -2
  58. data/lib/merge_ats_client/api/candidates_api.rb +2 -2
  59. data/lib/merge_ats_client/api/departments_api.rb +2 -2
  60. data/lib/merge_ats_client/api/eeocs_api.rb +16 -2
  61. data/lib/merge_ats_client/api/interviews_api.rb +16 -2
  62. data/lib/merge_ats_client/api/job_interview_stages_api.rb +2 -2
  63. data/lib/merge_ats_client/api/jobs_api.rb +16 -2
  64. data/lib/merge_ats_client/api/linked_accounts_api.rb +3 -0
  65. data/lib/merge_ats_client/api/offers_api.rb +16 -2
  66. data/lib/merge_ats_client/api/offices_api.rb +2 -2
  67. data/lib/merge_ats_client/api/reject_reasons_api.rb +2 -2
  68. data/lib/merge_ats_client/api/scorecards_api.rb +16 -2
  69. data/lib/merge_ats_client/api/selective_sync_api.rb +225 -0
  70. data/lib/merge_ats_client/api/sync_status_api.rb +2 -2
  71. data/lib/merge_ats_client/api/tags_api.rb +2 -2
  72. data/lib/merge_ats_client/api/users_api.rb +16 -2
  73. data/lib/merge_ats_client/models/access_role_enum.rb +17 -7
  74. data/lib/merge_ats_client/models/account_details.rb +15 -4
  75. data/lib/merge_ats_client/models/account_details_and_actions.rb +12 -1
  76. data/lib/merge_ats_client/models/account_details_and_actions_status_enum.rb +17 -7
  77. data/lib/merge_ats_client/models/activity.rb +1 -1
  78. data/lib/merge_ats_client/models/activity_type_enum.rb +17 -7
  79. data/lib/merge_ats_client/models/application.rb +1 -1
  80. data/lib/merge_ats_client/models/application_request.rb +3 -3
  81. data/lib/merge_ats_client/models/attachment_request.rb +2 -2
  82. data/lib/merge_ats_client/models/attachment_type_enum.rb +17 -7
  83. data/lib/merge_ats_client/models/candidate.rb +1 -1
  84. data/lib/merge_ats_client/models/candidate_request.rb +3 -3
  85. data/lib/merge_ats_client/models/categories_enum.rb +17 -7
  86. data/lib/merge_ats_client/models/category_enum.rb +17 -7
  87. data/lib/merge_ats_client/models/condition_schema.rb +297 -0
  88. data/lib/merge_ats_client/models/condition_type_enum.rb +50 -0
  89. data/lib/merge_ats_client/models/data_passthrough_request.rb +15 -6
  90. data/lib/merge_ats_client/models/department.rb +1 -1
  91. data/lib/merge_ats_client/models/disability_status_enum.rb +17 -7
  92. data/lib/merge_ats_client/models/eeoc.rb +1 -1
  93. data/lib/merge_ats_client/models/email_address_request.rb +29 -5
  94. data/lib/merge_ats_client/models/email_address_type_enum.rb +17 -7
  95. data/lib/merge_ats_client/models/encoding_enum.rb +18 -7
  96. data/lib/merge_ats_client/models/end_user_details_request.rb +28 -11
  97. data/lib/merge_ats_client/models/gender_enum.rb +17 -7
  98. data/lib/merge_ats_client/models/issue.rb +1 -1
  99. data/lib/merge_ats_client/models/issue_status_enum.rb +17 -7
  100. data/lib/merge_ats_client/models/job.rb +14 -3
  101. data/lib/merge_ats_client/models/job_interview_stage.rb +3 -2
  102. data/lib/merge_ats_client/models/job_status_enum.rb +17 -7
  103. data/lib/merge_ats_client/models/link_token.rb +13 -4
  104. data/lib/merge_ats_client/models/linked_account_condition.rb +282 -0
  105. data/lib/merge_ats_client/models/linked_account_condition_request.rb +269 -0
  106. data/lib/merge_ats_client/models/linked_account_selective_sync_configuration.rb +221 -0
  107. data/lib/merge_ats_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
  108. data/lib/merge_ats_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
  109. data/lib/merge_ats_client/models/meta_response.rb +1 -1
  110. data/lib/merge_ats_client/models/method_enum.rb +17 -7
  111. data/lib/merge_ats_client/models/offer.rb +1 -1
  112. data/lib/merge_ats_client/models/offer_status_enum.rb +17 -7
  113. data/lib/merge_ats_client/models/office.rb +1 -1
  114. data/lib/merge_ats_client/models/operator_schema.rb +229 -0
  115. data/lib/merge_ats_client/models/overall_recommendation_enum.rb +17 -7
  116. data/lib/merge_ats_client/models/{remote_data_request.rb → paginated_condition_schema_list.rb} +28 -41
  117. data/lib/merge_ats_client/models/phone_number_request.rb +29 -5
  118. data/lib/merge_ats_client/models/phone_number_type_enum.rb +17 -7
  119. data/lib/merge_ats_client/models/race_enum.rb +17 -7
  120. data/lib/merge_ats_client/models/reason_enum.rb +17 -7
  121. data/lib/merge_ats_client/models/reject_reason.rb +1 -1
  122. data/lib/merge_ats_client/models/remote_response.rb +23 -9
  123. data/lib/merge_ats_client/models/remote_user.rb +1 -1
  124. data/lib/merge_ats_client/models/request_format_enum.rb +17 -7
  125. data/lib/merge_ats_client/models/response_type_enum.rb +45 -0
  126. data/lib/merge_ats_client/models/scheduled_interview.rb +2 -2
  127. data/lib/merge_ats_client/models/scheduled_interview_status_enum.rb +17 -7
  128. data/lib/merge_ats_client/models/scorecard.rb +2 -2
  129. data/lib/merge_ats_client/models/sync_status.rb +0 -10
  130. data/lib/merge_ats_client/models/sync_status_status_enum.rb +18 -7
  131. data/lib/merge_ats_client/models/tag.rb +2 -2
  132. data/lib/merge_ats_client/models/update_application_stage_request.rb +244 -0
  133. data/lib/merge_ats_client/models/url.rb +1 -1
  134. data/lib/merge_ats_client/models/url_request.rb +30 -6
  135. data/lib/merge_ats_client/models/url_type_enum.rb +18 -7
  136. data/lib/merge_ats_client/models/veteran_status_enum.rb +17 -7
  137. data/lib/merge_ats_client/models/visibility_enum.rb +17 -7
  138. data/lib/merge_ats_client/version.rb +1 -1
  139. data/lib/merge_ats_client.rb +12 -1
  140. data/spec/api/activities_api_spec.rb +3 -1
  141. data/spec/api/applications_api_spec.rb +16 -1
  142. data/spec/api/attachments_api_spec.rb +3 -1
  143. data/spec/api/candidates_api_spec.rb +1 -1
  144. data/spec/api/departments_api_spec.rb +1 -1
  145. data/spec/api/eeocs_api_spec.rb +3 -1
  146. data/spec/api/interviews_api_spec.rb +3 -1
  147. data/spec/api/job_interview_stages_api_spec.rb +1 -1
  148. data/spec/api/jobs_api_spec.rb +3 -1
  149. data/spec/api/linked_accounts_api_spec.rb +1 -0
  150. data/spec/api/offers_api_spec.rb +3 -1
  151. data/spec/api/offices_api_spec.rb +1 -1
  152. data/spec/api/reject_reasons_api_spec.rb +1 -1
  153. data/spec/api/scorecards_api_spec.rb +3 -1
  154. data/spec/api/selective_sync_api_spec.rb +72 -0
  155. data/spec/api/sync_status_api_spec.rb +1 -1
  156. data/spec/api/tags_api_spec.rb +1 -1
  157. data/spec/api/users_api_spec.rb +3 -1
  158. data/spec/models/account_details_and_actions_spec.rb +6 -0
  159. data/spec/models/account_details_spec.rb +6 -0
  160. data/spec/models/condition_schema_spec.rb +70 -0
  161. data/spec/models/condition_type_enum_spec.rb +28 -0
  162. data/spec/models/data_passthrough_request_spec.rb +6 -0
  163. data/spec/models/email_address_request_spec.rb +12 -0
  164. data/spec/models/end_user_details_request_spec.rb +6 -0
  165. data/spec/models/job_spec.rb +6 -0
  166. data/spec/models/link_token_spec.rb +6 -0
  167. data/spec/models/linked_account_condition_request_spec.rb +46 -0
  168. data/spec/models/linked_account_condition_spec.rb +64 -0
  169. data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
  170. data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
  171. data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
  172. data/spec/models/operator_schema_spec.rb +40 -0
  173. data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
  174. data/spec/models/phone_number_request_spec.rb +12 -0
  175. data/spec/models/remote_response_spec.rb +12 -0
  176. data/spec/models/response_type_enum_spec.rb +28 -0
  177. data/spec/models/update_application_stage_request_spec.rb +40 -0
  178. data/spec/models/url_request_spec.rb +12 -0
  179. metadata +153 -105
@@ -0,0 +1,233 @@
1
+ # MergeATSClient::SelectiveSyncApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/ats/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**selective_sync_configurations_list**](SelectiveSyncApi.md#selective_sync_configurations_list) | **GET** /selective-sync/configurations | |
8
+ | [**selective_sync_configurations_update**](SelectiveSyncApi.md#selective_sync_configurations_update) | **PUT** /selective-sync/configurations | |
9
+ | [**selective_sync_meta_list**](SelectiveSyncApi.md#selective_sync_meta_list) | **GET** /selective-sync/meta | |
10
+
11
+
12
+ ## selective_sync_configurations_list
13
+
14
+ > <Array<LinkedAccountSelectiveSyncConfiguration>> selective_sync_configurations_list(x_account_token)
15
+
16
+
17
+
18
+ Get a linked account's selective syncs.
19
+
20
+ ### Examples
21
+
22
+ ```ruby
23
+ require 'time'
24
+ require 'merge_ats_client'
25
+ # setup authorization
26
+ MergeATSClient.configure do |config|
27
+ # Configure API key authorization: tokenAuth
28
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
29
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
31
+ end
32
+
33
+ api_instance = MergeATSClient::SelectiveSyncApi.new
34
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
35
+
36
+ begin
37
+
38
+ result = api_instance.selective_sync_configurations_list(x_account_token)
39
+ p result
40
+ rescue MergeATSClient::ApiError => e
41
+ puts "Error when calling SelectiveSyncApi->selective_sync_configurations_list: #{e}"
42
+ end
43
+ ```
44
+
45
+ #### Using the selective_sync_configurations_list_with_http_info variant
46
+
47
+ This returns an Array which contains the response data, status code and headers.
48
+
49
+ > <Array(<Array<LinkedAccountSelectiveSyncConfiguration>>, Integer, Hash)> selective_sync_configurations_list_with_http_info(x_account_token)
50
+
51
+ ```ruby
52
+ begin
53
+
54
+ data, status_code, headers = api_instance.selective_sync_configurations_list_with_http_info(x_account_token)
55
+ p status_code # => 2xx
56
+ p headers # => { ... }
57
+ p data # => <Array<LinkedAccountSelectiveSyncConfiguration>>
58
+ rescue MergeATSClient::ApiError => e
59
+ puts "Error when calling SelectiveSyncApi->selective_sync_configurations_list_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
+
69
+ ### Return type
70
+
71
+ [**Array&lt;LinkedAccountSelectiveSyncConfiguration&gt;**](LinkedAccountSelectiveSyncConfiguration.md)
72
+
73
+ ### Authorization
74
+
75
+ [tokenAuth](../README.md#tokenAuth)
76
+
77
+ ### HTTP request headers
78
+
79
+ - **Content-Type**: Not defined
80
+ - **Accept**: application/json
81
+
82
+
83
+ ## selective_sync_configurations_update
84
+
85
+ > <Array<LinkedAccountSelectiveSyncConfiguration>> selective_sync_configurations_update(x_account_token, linked_account_selective_sync_configuration_list_request)
86
+
87
+
88
+
89
+ Replace a linked account's selective syncs.
90
+
91
+ ### Examples
92
+
93
+ ```ruby
94
+ require 'time'
95
+ require 'merge_ats_client'
96
+ # setup authorization
97
+ MergeATSClient.configure do |config|
98
+ # Configure API key authorization: tokenAuth
99
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
100
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
101
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
102
+ end
103
+
104
+ api_instance = MergeATSClient::SelectiveSyncApi.new
105
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
106
+ linked_account_selective_sync_configuration_list_request = MergeATSClient::LinkedAccountSelectiveSyncConfigurationListRequest.new({sync_configurations: [MergeATSClient::LinkedAccountSelectiveSyncConfigurationRequest.new({linked_account_conditions: [MergeATSClient::LinkedAccountConditionRequest.new({condition_schema_id: 'condition_schema_id_example', operator: 'operator_example', value: TODO})]})]}) # LinkedAccountSelectiveSyncConfigurationListRequest |
107
+
108
+ begin
109
+
110
+ result = api_instance.selective_sync_configurations_update(x_account_token, linked_account_selective_sync_configuration_list_request)
111
+ p result
112
+ rescue MergeATSClient::ApiError => e
113
+ puts "Error when calling SelectiveSyncApi->selective_sync_configurations_update: #{e}"
114
+ end
115
+ ```
116
+
117
+ #### Using the selective_sync_configurations_update_with_http_info variant
118
+
119
+ This returns an Array which contains the response data, status code and headers.
120
+
121
+ > <Array(<Array<LinkedAccountSelectiveSyncConfiguration>>, Integer, Hash)> selective_sync_configurations_update_with_http_info(x_account_token, linked_account_selective_sync_configuration_list_request)
122
+
123
+ ```ruby
124
+ begin
125
+
126
+ data, status_code, headers = api_instance.selective_sync_configurations_update_with_http_info(x_account_token, linked_account_selective_sync_configuration_list_request)
127
+ p status_code # => 2xx
128
+ p headers # => { ... }
129
+ p data # => <Array<LinkedAccountSelectiveSyncConfiguration>>
130
+ rescue MergeATSClient::ApiError => e
131
+ puts "Error when calling SelectiveSyncApi->selective_sync_configurations_update_with_http_info: #{e}"
132
+ end
133
+ ```
134
+
135
+ ### Parameters
136
+
137
+ | Name | Type | Description | Notes |
138
+ | ---- | ---- | ----------- | ----- |
139
+ | **x_account_token** | **String** | Token identifying the end user. | |
140
+ | **linked_account_selective_sync_configuration_list_request** | [**LinkedAccountSelectiveSyncConfigurationListRequest**](LinkedAccountSelectiveSyncConfigurationListRequest.md) | | |
141
+
142
+ ### Return type
143
+
144
+ [**Array&lt;LinkedAccountSelectiveSyncConfiguration&gt;**](LinkedAccountSelectiveSyncConfiguration.md)
145
+
146
+ ### Authorization
147
+
148
+ [tokenAuth](../README.md#tokenAuth)
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: application/json
153
+ - **Accept**: application/json
154
+
155
+
156
+ ## selective_sync_meta_list
157
+
158
+ > <PaginatedConditionSchemaList> selective_sync_meta_list(x_account_token, opts)
159
+
160
+
161
+
162
+ Get metadata for the conditions available to a linked account.
163
+
164
+ ### Examples
165
+
166
+ ```ruby
167
+ require 'time'
168
+ require 'merge_ats_client'
169
+ # setup authorization
170
+ MergeATSClient.configure do |config|
171
+ # Configure API key authorization: tokenAuth
172
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
173
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
174
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
175
+ end
176
+
177
+ api_instance = MergeATSClient::SelectiveSyncApi.new
178
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
179
+ opts = {
180
+ common_model: 'common_model_example', # String |
181
+ cursor: 56, # Integer | The pagination cursor value.
182
+ page_size: 56 # Integer | Number of results to return per page.
183
+ }
184
+
185
+ begin
186
+
187
+ result = api_instance.selective_sync_meta_list(x_account_token, opts)
188
+ p result
189
+ rescue MergeATSClient::ApiError => e
190
+ puts "Error when calling SelectiveSyncApi->selective_sync_meta_list: #{e}"
191
+ end
192
+ ```
193
+
194
+ #### Using the selective_sync_meta_list_with_http_info variant
195
+
196
+ This returns an Array which contains the response data, status code and headers.
197
+
198
+ > <Array(<PaginatedConditionSchemaList>, Integer, Hash)> selective_sync_meta_list_with_http_info(x_account_token, opts)
199
+
200
+ ```ruby
201
+ begin
202
+
203
+ data, status_code, headers = api_instance.selective_sync_meta_list_with_http_info(x_account_token, opts)
204
+ p status_code # => 2xx
205
+ p headers # => { ... }
206
+ p data # => <PaginatedConditionSchemaList>
207
+ rescue MergeATSClient::ApiError => e
208
+ puts "Error when calling SelectiveSyncApi->selective_sync_meta_list_with_http_info: #{e}"
209
+ end
210
+ ```
211
+
212
+ ### Parameters
213
+
214
+ | Name | Type | Description | Notes |
215
+ | ---- | ---- | ----------- | ----- |
216
+ | **x_account_token** | **String** | Token identifying the end user. | |
217
+ | **common_model** | **String** | | [optional] |
218
+ | **cursor** | **Integer** | The pagination cursor value. | [optional] |
219
+ | **page_size** | **Integer** | Number of results to return per page. | [optional] |
220
+
221
+ ### Return type
222
+
223
+ [**PaginatedConditionSchemaList**](PaginatedConditionSchemaList.md)
224
+
225
+ ### Authorization
226
+
227
+ [tokenAuth](../README.md#tokenAuth)
228
+
229
+ ### HTTP request headers
230
+
231
+ - **Content-Type**: Not defined
232
+ - **Accept**: application/json
233
+
data/docs/SyncStatus.md CHANGED
@@ -6,8 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **model_name** | **String** | | |
8
8
  | **model_id** | **String** | | |
9
- | **last_sync_start** | **Time** | | |
10
- | **next_sync_start** | **Time** | | |
9
+ | **last_sync_start** | **Time** | | [optional] |
10
+ | **next_sync_start** | **Time** | | [optional] |
11
11
  | **status** | [**SyncStatusStatusEnum**](SyncStatusStatusEnum.md) | | |
12
12
  | **is_initial_sync** | **Boolean** | | |
13
13
 
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
13
13
 
14
14
 
15
15
 
16
- Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `SYNCING`
16
+ Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PAUSED`, `SYNCING`
17
17
 
18
18
  ### Examples
19
19
 
data/docs/Tag.md CHANGED
@@ -7,7 +7,7 @@
7
7
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
8
8
  | **name** | **String** | The tag&#39;s name. | [optional] |
9
9
  | **remote_data** | **Array&lt;Hash&lt;String, AnyType&gt;&gt;** | | [optional] |
10
- | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional] |
10
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
11
11
 
12
12
  ## Example
13
13
 
data/docs/TagsApi.md CHANGED
@@ -34,7 +34,7 @@ opts = {
34
34
  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
35
35
  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
36
36
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
37
- include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
37
+ include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
38
38
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
39
39
  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
40
40
  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
@@ -77,7 +77,7 @@ end
77
77
  | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
78
78
  | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
79
79
  | **cursor** | **String** | The pagination cursor value. | [optional] |
80
- | **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
80
+ | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
81
81
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
82
82
  | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
83
83
  | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
@@ -0,0 +1,20 @@
1
+ # MergeATSClient::UpdateApplicationStageRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **job_interview_stage** | **String** | The interview stage to move the application to. | [optional] |
8
+ | **remote_user_id** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'merge_ats_client'
14
+
15
+ instance = MergeATSClient::UpdateApplicationStageRequest.new(
16
+ job_interview_stage: null,
17
+ remote_user_id: null
18
+ )
19
+ ```
20
+
data/docs/UrlRequest.md CHANGED
@@ -6,6 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **value** | **String** | The site&#39;s url. | [optional] |
8
8
  | **url_type** | [**UrlTypeEnum**](UrlTypeEnum.md) | The type of site. | [optional] |
9
+ | **integration_params** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
10
+ | **linked_account_params** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
9
11
 
10
12
  ## Example
11
13
 
@@ -14,7 +16,9 @@ require 'merge_ats_client'
14
16
 
15
17
  instance = MergeATSClient::UrlRequest.new(
16
18
  value: http://alturl.com/p749b,
17
- url_type: PERSONAL
19
+ url_type: PERSONAL,
20
+ integration_params: {&quot;unique_integration_field&quot;:&quot;unique_integration_field_value&quot;},
21
+ linked_account_params: {&quot;unique_linked_account_field&quot;:&quot;unique_linked_account_field_value&quot;}
18
22
  )
19
23
  ```
20
24
 
data/docs/UsersApi.md CHANGED
@@ -36,11 +36,12 @@ opts = {
36
36
  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
37
37
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
38
38
  email: TODO, # String | If provided, will only return remote users with the given email address
39
- include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
39
+ include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
40
40
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
41
41
  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
42
42
  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
43
43
  page_size: 56, # Integer | Number of results to return per page.
44
+ remote_fields: 'access_role', # String | Which fields should be returned in non-normalized form.
44
45
  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
45
46
  }
46
47
 
@@ -80,11 +81,12 @@ end
80
81
  | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
81
82
  | **cursor** | **String** | The pagination cursor value. | [optional] |
82
83
  | **email** | [**String**](.md) | If provided, will only return remote users with the given email address | [optional] |
83
- | **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
84
+ | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
84
85
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
85
86
  | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
86
87
  | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
87
88
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
89
+ | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
88
90
  | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
89
91
 
90
92
  ### Return type
@@ -126,7 +128,8 @@ api_instance = MergeATSClient::UsersApi.new
126
128
  x_account_token = 'x_account_token_example' # String | Token identifying the end user.
127
129
  id = TODO # String |
128
130
  opts = {
129
- include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
131
+ include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
132
+ remote_fields: 'access_role' # String | Which fields should be returned in non-normalized form.
130
133
  }
131
134
 
132
135
  begin
@@ -163,6 +166,7 @@ end
163
166
  | **x_account_token** | **String** | Token identifying the end user. | |
164
167
  | **id** | [**String**](.md) | | |
165
168
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
169
+ | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
166
170
 
167
171
  ### Return type
168
172
 
@@ -26,11 +26,12 @@ module MergeATSClient
26
26
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
28
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
29
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
29
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
30
30
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
31
31
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
32
32
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
33
33
  # @option opts [Integer] :page_size Number of results to return per page.
34
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
34
35
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
35
36
  # @option opts [String] :user_id If provided, will only return activities done by this user.
36
37
  # @return [PaginatedActivityList]
@@ -46,11 +47,12 @@ module MergeATSClient
46
47
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
47
48
  # @option opts [String] :cursor The pagination cursor value.
48
49
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
49
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
50
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
50
51
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
51
52
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
52
53
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
53
54
  # @option opts [Integer] :page_size Number of results to return per page.
55
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
54
56
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
55
57
  # @option opts [String] :user_id If provided, will only return activities done by this user.
56
58
  # @return [Array<(PaginatedActivityList, Integer, Hash)>] PaginatedActivityList data, response status code and response headers
@@ -66,6 +68,10 @@ module MergeATSClient
66
68
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
67
69
  fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
68
70
  end
71
+ allowable_values = ["activity_type", "activity_type,visibility", "visibility"]
72
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
73
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
74
+ end
69
75
  # resource path
70
76
  local_var_path = '/activities'
71
77
 
@@ -80,6 +86,7 @@ module MergeATSClient
80
86
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
81
87
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
82
88
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
89
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
83
90
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
84
91
  query_params[:'user_id'] = opts[:'user_id'] if !opts[:'user_id'].nil?
85
92
 
@@ -124,6 +131,7 @@ module MergeATSClient
124
131
  # @param [Hash] opts the optional parameters
125
132
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
126
133
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
134
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
127
135
  # @return [Activity]
128
136
  def activities_retrieve(x_account_token, id, opts = {})
129
137
  data, _status_code, _headers = activities_retrieve_with_http_info(x_account_token, id, opts)
@@ -136,6 +144,7 @@ module MergeATSClient
136
144
  # @param [Hash] opts the optional parameters
137
145
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
138
146
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
147
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
139
148
  # @return [Array<(Activity, Integer, Hash)>] Activity data, response status code and response headers
140
149
  def activities_retrieve_with_http_info(x_account_token, id, opts = {})
141
150
  if @api_client.config.debugging
@@ -153,6 +162,10 @@ module MergeATSClient
153
162
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
154
163
  fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
155
164
  end
165
+ allowable_values = ["activity_type", "activity_type,visibility", "visibility"]
166
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
167
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
168
+ end
156
169
  # resource path
157
170
  local_var_path = '/activities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
158
171
 
@@ -160,6 +173,7 @@ module MergeATSClient
160
173
  query_params = opts[:query_params] || {}
161
174
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
162
175
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
176
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
163
177
 
164
178
  # header parameters
165
179
  header_params = opts[:header_params] || {}
@@ -19,6 +19,84 @@ module MergeATSClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Updates the `current_stage` field of an `Application` object
23
+ # @param x_account_token [String] Token identifying the end user.
24
+ # @param id [String]
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [Boolean] :is_debug_mode Whether to include debug fields (such as log file links) in the response.
27
+ # @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously.
28
+ # @option opts [UpdateApplicationStageRequest] :update_application_stage_request
29
+ # @return [ApplicationResponse]
30
+ def applications_change_stage_create(x_account_token, id, opts = {})
31
+ data, _status_code, _headers = applications_change_stage_create_with_http_info(x_account_token, id, opts)
32
+ data
33
+ end
34
+
35
+ # Updates the &#x60;current_stage&#x60; field of an &#x60;Application&#x60; object
36
+ # @param x_account_token [String] Token identifying the end user.
37
+ # @param id [String]
38
+ # @param [Hash] opts the optional parameters
39
+ # @option opts [Boolean] :is_debug_mode Whether to include debug fields (such as log file links) in the response.
40
+ # @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously.
41
+ # @option opts [UpdateApplicationStageRequest] :update_application_stage_request
42
+ # @return [Array<(ApplicationResponse, Integer, Hash)>] ApplicationResponse data, response status code and response headers
43
+ def applications_change_stage_create_with_http_info(x_account_token, id, opts = {})
44
+ if @api_client.config.debugging
45
+ @api_client.config.logger.debug 'Calling API: ApplicationsApi.applications_change_stage_create ...'
46
+ end
47
+ # verify the required parameter 'x_account_token' is set
48
+ if @api_client.config.client_side_validation && x_account_token.nil?
49
+ fail ArgumentError, "Missing the required parameter 'x_account_token' when calling ApplicationsApi.applications_change_stage_create"
50
+ end
51
+ # verify the required parameter 'id' is set
52
+ if @api_client.config.client_side_validation && id.nil?
53
+ fail ArgumentError, "Missing the required parameter 'id' when calling ApplicationsApi.applications_change_stage_create"
54
+ end
55
+ # resource path
56
+ local_var_path = '/applications/{id}/change-stage'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
57
+
58
+ # query parameters
59
+ query_params = opts[:query_params] || {}
60
+ query_params[:'is_debug_mode'] = opts[:'is_debug_mode'] if !opts[:'is_debug_mode'].nil?
61
+ query_params[:'run_async'] = opts[:'run_async'] if !opts[:'run_async'].nil?
62
+
63
+ # header parameters
64
+ header_params = opts[:header_params] || {}
65
+ # HTTP header 'Accept' (if needed)
66
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
67
+ # HTTP header 'Content-Type'
68
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
69
+ header_params[:'X-Account-Token'] = x_account_token
70
+
71
+ # form parameters
72
+ form_params = opts[:form_params] || {}
73
+
74
+ # http body (model)
75
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'update_application_stage_request'])
76
+
77
+ # return_type
78
+ return_type = opts[:debug_return_type] || 'ApplicationResponse'
79
+
80
+ # auth_names
81
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
82
+
83
+ new_options = opts.merge(
84
+ :operation => :"ApplicationsApi.applications_change_stage_create",
85
+ :header_params => header_params,
86
+ :query_params => query_params,
87
+ :form_params => form_params,
88
+ :body => post_body,
89
+ :auth_names => auth_names,
90
+ :return_type => return_type
91
+ )
92
+
93
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
94
+ if @api_client.config.debugging
95
+ @api_client.config.logger.debug "API called: ApplicationsApi#applications_change_stage_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
96
+ end
97
+ return data, status_code, headers
98
+ end
99
+
22
100
  # Creates an `Application` object with the given values.
23
101
  # @param x_account_token [String] Token identifying the end user.
24
102
  # @param application_endpoint_request [ApplicationEndpointRequest]
@@ -105,7 +183,7 @@ module MergeATSClient
105
183
  # @option opts [String] :current_stage_id If provided, will only return applications at this interview stage.
106
184
  # @option opts [String] :cursor The pagination cursor value.
107
185
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
108
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
186
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
109
187
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
110
188
  # @option opts [String] :job_id If provided, will only return applications for this job.
111
189
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
@@ -130,7 +208,7 @@ module MergeATSClient
130
208
  # @option opts [String] :current_stage_id If provided, will only return applications at this interview stage.
131
209
  # @option opts [String] :cursor The pagination cursor value.
132
210
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
133
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
211
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
134
212
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
135
213
  # @option opts [String] :job_id If provided, will only return applications for this job.
136
214
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
@@ -103,11 +103,12 @@ module MergeATSClient
103
103
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
104
104
  # @option opts [String] :cursor The pagination cursor value.
105
105
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
106
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
106
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
107
107
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
108
108
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
109
109
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
110
110
  # @option opts [Integer] :page_size Number of results to return per page.
111
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
111
112
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
112
113
  # @return [PaginatedAttachmentList]
113
114
  def attachments_list(x_account_token, opts = {})
@@ -123,11 +124,12 @@ module MergeATSClient
123
124
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
124
125
  # @option opts [String] :cursor The pagination cursor value.
125
126
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
126
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
127
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
127
128
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
128
129
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
129
130
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
130
131
  # @option opts [Integer] :page_size Number of results to return per page.
132
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
131
133
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
132
134
  # @return [Array<(PaginatedAttachmentList, Integer, Hash)>] PaginatedAttachmentList data, response status code and response headers
133
135
  def attachments_list_with_http_info(x_account_token, opts = {})
@@ -142,6 +144,10 @@ module MergeATSClient
142
144
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
143
145
  fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
144
146
  end
147
+ allowable_values = ["attachment_type"]
148
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
149
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
150
+ end
145
151
  # resource path
146
152
  local_var_path = '/attachments'
147
153
 
@@ -157,6 +163,7 @@ module MergeATSClient
157
163
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
158
164
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
159
165
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
166
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
160
167
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
161
168
 
162
169
  # header parameters
@@ -262,6 +269,7 @@ module MergeATSClient
262
269
  # @param [Hash] opts the optional parameters
263
270
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
264
271
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
272
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
265
273
  # @return [Attachment]
266
274
  def attachments_retrieve(x_account_token, id, opts = {})
267
275
  data, _status_code, _headers = attachments_retrieve_with_http_info(x_account_token, id, opts)
@@ -274,6 +282,7 @@ module MergeATSClient
274
282
  # @param [Hash] opts the optional parameters
275
283
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
276
284
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
285
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
277
286
  # @return [Array<(Attachment, Integer, Hash)>] Attachment data, response status code and response headers
278
287
  def attachments_retrieve_with_http_info(x_account_token, id, opts = {})
279
288
  if @api_client.config.debugging
@@ -291,6 +300,10 @@ module MergeATSClient
291
300
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
292
301
  fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
293
302
  end
303
+ allowable_values = ["attachment_type"]
304
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
305
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
306
+ end
294
307
  # resource path
295
308
  local_var_path = '/attachments/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
296
309
 
@@ -298,6 +311,7 @@ module MergeATSClient
298
311
  query_params = opts[:query_params] || {}
299
312
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
300
313
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
314
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
301
315
 
302
316
  # header parameters
303
317
  header_params = opts[:header_params] || {}