merge_ats_client 2.0.1 → 3.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE.md +16 -0
- data/README.md +186 -167
- data/docs/AccountIntegration.md +6 -2
- data/docs/ActivitiesApi.md +164 -8
- data/docs/Activity.md +12 -6
- data/docs/ActivityEndpointRequest.md +20 -0
- data/docs/ActivityRequest.md +32 -0
- data/docs/ActivityResponse.md +24 -0
- data/docs/Application.md +12 -10
- data/docs/ApplicationRequest.md +5 -9
- data/docs/ApplicationsApi.md +4 -4
- data/docs/Attachment.md +8 -4
- data/docs/AttachmentRequest.md +1 -3
- data/docs/AttachmentsApi.md +13 -9
- data/docs/Candidate.md +8 -6
- data/docs/CandidateRequest.md +1 -9
- data/docs/CandidatesApi.md +16 -13
- data/docs/CommonModelScopesBodyRequest.md +22 -0
- data/docs/ConditionSchema.md +30 -0
- data/docs/ConditionTypeEnum.md +15 -0
- data/docs/DataPassthroughRequest.md +1 -1
- data/docs/Department.md +7 -3
- data/docs/DepartmentsApi.md +4 -4
- data/docs/EEOC.md +12 -8
- data/docs/EeocsApi.md +13 -9
- data/docs/EmailAddress.md +4 -2
- data/docs/EmailAddressRequest.md +6 -2
- data/docs/EnabledActionsEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +5 -3
- data/docs/ForceResyncApi.md +1 -1
- data/docs/InterviewsApi.md +165 -9
- data/docs/Issue.md +10 -8
- data/docs/IssuesApi.md +6 -6
- data/docs/Job.md +8 -4
- data/docs/JobInterviewStage.md +10 -4
- data/docs/JobInterviewStagesApi.md +4 -4
- data/docs/JobsApi.md +16 -10
- data/docs/LinkToken.md +1 -1
- data/docs/LinkedAccountCondition.md +28 -0
- data/docs/LinkedAccountConditionRequest.md +22 -0
- data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/MetaResponse.md +2 -0
- data/docs/MultipartFormFieldRequest.md +1 -1
- data/docs/Offer.md +10 -6
- data/docs/OffersApi.md +13 -9
- data/docs/Office.md +7 -3
- data/docs/OfficesApi.md +4 -4
- data/docs/OperatorSchema.md +20 -0
- data/docs/PaginatedConditionSchemaList.md +22 -0
- data/docs/PhoneNumber.md +4 -2
- data/docs/PhoneNumberRequest.md +6 -2
- data/docs/RejectReason.md +7 -3
- data/docs/RejectReasonsApi.md +4 -4
- data/docs/RemoteUser.md +8 -4
- data/docs/ScheduledInterview.md +11 -7
- data/docs/ScheduledInterviewEndpointRequest.md +20 -0
- data/docs/ScheduledInterviewRequest.md +36 -0
- data/docs/ScheduledInterviewResponse.md +24 -0
- data/docs/Scorecard.md +11 -7
- data/docs/ScorecardsApi.md +13 -9
- data/docs/SelectiveSyncApi.md +233 -0
- data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
- data/docs/SyncStatus.md +3 -1
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tag.md +7 -3
- data/docs/TagsApi.md +4 -4
- data/docs/Url.md +4 -2
- data/docs/UrlRequest.md +6 -2
- data/docs/UsersApi.md +13 -9
- data/lib/merge_ats_client/api/activities_api.rb +160 -8
- data/lib/merge_ats_client/api/applications_api.rb +4 -4
- data/lib/merge_ats_client/api/attachments_api.rb +22 -8
- data/lib/merge_ats_client/api/candidates_api.rb +15 -11
- data/lib/merge_ats_client/api/departments_api.rb +4 -4
- data/lib/merge_ats_client/api/eeocs_api.rb +22 -8
- data/lib/merge_ats_client/api/force_resync_api.rb +2 -2
- data/lib/merge_ats_client/api/interviews_api.rb +160 -8
- data/lib/merge_ats_client/api/issues_api.rb +6 -6
- data/lib/merge_ats_client/api/job_interview_stages_api.rb +4 -4
- data/lib/merge_ats_client/api/jobs_api.rb +27 -10
- data/lib/merge_ats_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_ats_client/api/offers_api.rb +22 -8
- data/lib/merge_ats_client/api/offices_api.rb +4 -4
- data/lib/merge_ats_client/api/reject_reasons_api.rb +4 -4
- data/lib/merge_ats_client/api/scorecards_api.rb +22 -8
- data/lib/merge_ats_client/api/selective_sync_api.rb +225 -0
- data/lib/merge_ats_client/api/sync_status_api.rb +2 -2
- data/lib/merge_ats_client/api/tags_api.rb +4 -4
- data/lib/merge_ats_client/api/users_api.rb +22 -8
- data/lib/merge_ats_client/models/access_role_enum.rb +1 -1
- data/lib/merge_ats_client/models/account_details_and_actions_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/account_integration.rb +30 -8
- data/lib/merge_ats_client/models/activity.rb +50 -16
- data/lib/merge_ats_client/models/activity_endpoint_request.rb +237 -0
- data/lib/merge_ats_client/models/activity_request.rb +300 -0
- data/lib/merge_ats_client/models/activity_response.rb +266 -0
- data/lib/merge_ats_client/models/activity_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/application.rb +40 -26
- data/lib/merge_ats_client/models/application_request.rb +7 -26
- data/lib/merge_ats_client/models/attachment.rb +38 -16
- data/lib/merge_ats_client/models/attachment_request.rb +3 -14
- data/lib/merge_ats_client/models/attachment_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/candidate.rb +36 -27
- data/lib/merge_ats_client/models/candidate_request.rb +3 -49
- data/lib/merge_ats_client/models/categories_enum.rb +4 -2
- data/lib/merge_ats_client/models/category_enum.rb +4 -2
- data/lib/merge_ats_client/models/common_model_scopes_body_request.rb +274 -0
- data/lib/merge_ats_client/models/condition_schema.rb +298 -0
- data/lib/merge_ats_client/models/condition_type_enum.rb +50 -0
- data/lib/merge_ats_client/models/data_passthrough_request.rb +1 -0
- data/lib/merge_ats_client/models/department.rb +36 -14
- data/lib/merge_ats_client/models/disability_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/eeoc.rb +42 -19
- data/lib/merge_ats_client/models/email_address.rb +16 -6
- data/lib/merge_ats_client/models/email_address_request.rb +30 -6
- data/lib/merge_ats_client/models/email_address_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/enabled_actions_enum.rb +45 -0
- data/lib/merge_ats_client/models/encoding_enum.rb +1 -1
- data/lib/merge_ats_client/models/end_user_details_request.rb +20 -7
- data/lib/merge_ats_client/models/gender_enum.rb +1 -1
- data/lib/merge_ats_client/models/issue.rb +16 -4
- data/lib/merge_ats_client/models/job.rb +38 -16
- data/lib/merge_ats_client/models/job_interview_stage.rb +72 -15
- data/lib/merge_ats_client/models/job_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/link_token.rb +0 -5
- data/lib/merge_ats_client/models/linked_account_condition.rb +282 -0
- data/lib/merge_ats_client/models/linked_account_condition_request.rb +269 -0
- data/lib/merge_ats_client/models/linked_account_selective_sync_configuration.rb +221 -0
- data/lib/merge_ats_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
- data/lib/merge_ats_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
- data/lib/merge_ats_client/models/meta_response.rb +12 -1
- data/lib/merge_ats_client/models/method_enum.rb +1 -1
- data/lib/merge_ats_client/models/multipart_form_field_request.rb +1 -1
- data/lib/merge_ats_client/models/offer.rb +40 -16
- data/lib/merge_ats_client/models/offer_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/office.rb +37 -15
- data/lib/merge_ats_client/models/operator_schema.rb +229 -0
- data/lib/merge_ats_client/models/overall_recommendation_enum.rb +1 -1
- data/lib/merge_ats_client/models/paginated_condition_schema_list.rb +240 -0
- data/lib/merge_ats_client/models/phone_number.rb +16 -6
- data/lib/merge_ats_client/models/phone_number_request.rb +30 -6
- data/lib/merge_ats_client/models/phone_number_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/race_enum.rb +1 -1
- data/lib/merge_ats_client/models/reason_enum.rb +1 -1
- data/lib/merge_ats_client/models/reject_reason.rb +37 -15
- data/lib/merge_ats_client/models/remote_user.rb +38 -16
- data/lib/merge_ats_client/models/request_format_enum.rb +1 -1
- data/lib/merge_ats_client/models/response_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/scheduled_interview.rb +41 -16
- data/lib/merge_ats_client/models/scheduled_interview_endpoint_request.rb +237 -0
- data/lib/merge_ats_client/models/scheduled_interview_request.rb +323 -0
- data/lib/merge_ats_client/models/scheduled_interview_response.rb +266 -0
- data/lib/merge_ats_client/models/scheduled_interview_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/scorecard.rb +41 -16
- data/lib/merge_ats_client/models/selective_sync_configurations_usage_enum.rb +45 -0
- data/lib/merge_ats_client/models/sync_status.rb +13 -4
- data/lib/merge_ats_client/models/sync_status_status_enum.rb +3 -2
- data/lib/merge_ats_client/models/tag.rb +36 -14
- data/lib/merge_ats_client/models/url.rb +17 -7
- data/lib/merge_ats_client/models/url_request.rb +31 -7
- data/lib/merge_ats_client/models/url_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/veteran_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/visibility_enum.rb +1 -1
- data/lib/merge_ats_client/version.rb +1 -1
- data/lib/merge_ats_client.rb +19 -1
- data/spec/api/activities_api_spec.rb +31 -4
- data/spec/api/applications_api_spec.rb +2 -2
- data/spec/api/attachments_api_spec.rb +6 -4
- data/spec/api/candidates_api_spec.rb +5 -3
- data/spec/api/departments_api_spec.rb +2 -2
- data/spec/api/eeocs_api_spec.rb +6 -4
- data/spec/api/force_resync_api_spec.rb +1 -1
- data/spec/api/interviews_api_spec.rb +31 -4
- data/spec/api/issues_api_spec.rb +3 -3
- data/spec/api/job_interview_stages_api_spec.rb +2 -2
- data/spec/api/jobs_api_spec.rb +8 -5
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/offers_api_spec.rb +6 -4
- data/spec/api/offices_api_spec.rb +2 -2
- data/spec/api/reject_reasons_api_spec.rb +2 -2
- data/spec/api/scorecards_api_spec.rb +6 -4
- data/spec/api/selective_sync_api_spec.rb +72 -0
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/api/tags_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +6 -4
- data/spec/models/account_integration_spec.rb +12 -0
- data/spec/models/{ignore_common_model_spec.rb → activity_endpoint_request_spec.rb} +8 -8
- data/spec/models/activity_request_spec.rb +76 -0
- data/spec/models/activity_response_spec.rb +52 -0
- data/spec/models/activity_spec.rb +19 -1
- data/spec/models/application_request_spec.rb +0 -12
- data/spec/models/application_spec.rb +9 -3
- data/spec/models/attachment_request_spec.rb +0 -6
- data/spec/models/attachment_spec.rb +14 -2
- data/spec/models/candidate_request_spec.rb +0 -24
- data/spec/models/candidate_spec.rb +9 -3
- data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
- data/spec/models/condition_schema_spec.rb +70 -0
- data/spec/models/condition_type_enum_spec.rb +28 -0
- data/spec/models/department_spec.rb +14 -2
- data/spec/models/eeoc_spec.rb +14 -2
- data/spec/models/email_address_request_spec.rb +12 -0
- data/spec/models/email_address_spec.rb +6 -0
- data/spec/models/enabled_actions_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/issue_spec.rb +6 -0
- data/spec/models/job_interview_stage_spec.rb +19 -1
- data/spec/models/job_spec.rb +14 -2
- data/spec/models/linked_account_condition_request_spec.rb +46 -0
- data/spec/models/linked_account_condition_spec.rb +64 -0
- data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
- data/spec/models/meta_response_spec.rb +6 -0
- data/spec/models/offer_spec.rb +14 -2
- data/spec/models/office_spec.rb +14 -2
- data/spec/models/{remote_data_request_spec.rb → operator_schema_spec.rb} +8 -8
- data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
- data/spec/models/phone_number_request_spec.rb +12 -0
- data/spec/models/phone_number_spec.rb +6 -0
- data/spec/models/reject_reason_spec.rb +14 -2
- data/spec/models/remote_user_spec.rb +14 -2
- data/spec/models/scheduled_interview_endpoint_request_spec.rb +40 -0
- data/spec/models/scheduled_interview_request_spec.rb +88 -0
- data/spec/models/scheduled_interview_response_spec.rb +52 -0
- data/spec/models/scheduled_interview_spec.rb +14 -2
- data/spec/models/scorecard_spec.rb +14 -2
- data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
- data/spec/models/sync_status_spec.rb +6 -0
- data/spec/models/tag_spec.rb +14 -2
- data/spec/models/url_request_spec.rb +12 -0
- data/spec/models/url_spec.rb +6 -0
- metadata +182 -109
data/docs/ActivitiesApi.md
CHANGED
@@ -4,10 +4,91 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**activities_create**](ActivitiesApi.md#activities_create) | **POST** /activities | |
|
7
8
|
| [**activities_list**](ActivitiesApi.md#activities_list) | **GET** /activities | |
|
9
|
+
| [**activities_meta_post_retrieve**](ActivitiesApi.md#activities_meta_post_retrieve) | **GET** /activities/meta/post | |
|
8
10
|
| [**activities_retrieve**](ActivitiesApi.md#activities_retrieve) | **GET** /activities/{id} | |
|
9
11
|
|
10
12
|
|
13
|
+
## activities_create
|
14
|
+
|
15
|
+
> <ActivityResponse> activities_create(x_account_token, activity_endpoint_request, opts)
|
16
|
+
|
17
|
+
|
18
|
+
|
19
|
+
Creates an `Activity` object with the given values.
|
20
|
+
|
21
|
+
### Examples
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'time'
|
25
|
+
require 'merge_ats_client'
|
26
|
+
# setup authorization
|
27
|
+
MergeATSClient.configure do |config|
|
28
|
+
# Configure API key authorization: tokenAuth
|
29
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
30
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
31
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
32
|
+
end
|
33
|
+
|
34
|
+
api_instance = MergeATSClient::ActivitiesApi.new
|
35
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
36
|
+
activity_endpoint_request = MergeATSClient::ActivityEndpointRequest.new({model: MergeATSClient::ActivityRequest.new, remote_user_id: 'remote_user_id_example'}) # ActivityEndpointRequest |
|
37
|
+
opts = {
|
38
|
+
is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
|
39
|
+
run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
|
44
|
+
result = api_instance.activities_create(x_account_token, activity_endpoint_request, opts)
|
45
|
+
p result
|
46
|
+
rescue MergeATSClient::ApiError => e
|
47
|
+
puts "Error when calling ActivitiesApi->activities_create: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
#### Using the activities_create_with_http_info variant
|
52
|
+
|
53
|
+
This returns an Array which contains the response data, status code and headers.
|
54
|
+
|
55
|
+
> <Array(<ActivityResponse>, Integer, Hash)> activities_create_with_http_info(x_account_token, activity_endpoint_request, opts)
|
56
|
+
|
57
|
+
```ruby
|
58
|
+
begin
|
59
|
+
|
60
|
+
data, status_code, headers = api_instance.activities_create_with_http_info(x_account_token, activity_endpoint_request, opts)
|
61
|
+
p status_code # => 2xx
|
62
|
+
p headers # => { ... }
|
63
|
+
p data # => <ActivityResponse>
|
64
|
+
rescue MergeATSClient::ApiError => e
|
65
|
+
puts "Error when calling ActivitiesApi->activities_create_with_http_info: #{e}"
|
66
|
+
end
|
67
|
+
```
|
68
|
+
|
69
|
+
### Parameters
|
70
|
+
|
71
|
+
| Name | Type | Description | Notes |
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
73
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
74
|
+
| **activity_endpoint_request** | [**ActivityEndpointRequest**](ActivityEndpointRequest.md) | | |
|
75
|
+
| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
|
76
|
+
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
77
|
+
|
78
|
+
### Return type
|
79
|
+
|
80
|
+
[**ActivityResponse**](ActivityResponse.md)
|
81
|
+
|
82
|
+
### Authorization
|
83
|
+
|
84
|
+
[tokenAuth](../README.md#tokenAuth)
|
85
|
+
|
86
|
+
### HTTP request headers
|
87
|
+
|
88
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
89
|
+
- **Accept**: application/json
|
90
|
+
|
91
|
+
|
11
92
|
## activities_list
|
12
93
|
|
13
94
|
> <PaginatedActivityList> activities_list(x_account_token, opts)
|
@@ -38,11 +119,12 @@ opts = {
|
|
38
119
|
expand: 'user', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
39
120
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
40
121
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
42
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
122
|
+
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.
|
123
|
+
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.
|
43
124
|
page_size: 56, # Integer | Number of results to return per page.
|
44
|
-
remote_fields: 'activity_type', # String |
|
125
|
+
remote_fields: 'activity_type', # String | Deprecated. Use show_enum_origins.
|
45
126
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
127
|
+
show_enum_origins: 'activity_type', # String | Which fields should be returned in non-normalized form.
|
46
128
|
user_id: 'user_id_example' # String | If provided, will only return activities done by this user.
|
47
129
|
}
|
48
130
|
|
@@ -84,11 +166,12 @@ end
|
|
84
166
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
85
167
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
86
168
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
87
|
-
| **modified_after** | **Time** | If provided,
|
88
|
-
| **modified_before** | **Time** | If provided,
|
169
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
170
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
89
171
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
90
|
-
| **remote_fields** | **String** |
|
172
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
91
173
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
174
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
92
175
|
| **user_id** | **String** | If provided, will only return activities done by this user. | [optional] |
|
93
176
|
|
94
177
|
### Return type
|
@@ -105,6 +188,77 @@ end
|
|
105
188
|
- **Accept**: application/json
|
106
189
|
|
107
190
|
|
191
|
+
## activities_meta_post_retrieve
|
192
|
+
|
193
|
+
> <MetaResponse> activities_meta_post_retrieve(x_account_token)
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
Returns metadata for `Activity` POSTs.
|
198
|
+
|
199
|
+
### Examples
|
200
|
+
|
201
|
+
```ruby
|
202
|
+
require 'time'
|
203
|
+
require 'merge_ats_client'
|
204
|
+
# setup authorization
|
205
|
+
MergeATSClient.configure do |config|
|
206
|
+
# Configure API key authorization: tokenAuth
|
207
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
208
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
209
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
210
|
+
end
|
211
|
+
|
212
|
+
api_instance = MergeATSClient::ActivitiesApi.new
|
213
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
214
|
+
|
215
|
+
begin
|
216
|
+
|
217
|
+
result = api_instance.activities_meta_post_retrieve(x_account_token)
|
218
|
+
p result
|
219
|
+
rescue MergeATSClient::ApiError => e
|
220
|
+
puts "Error when calling ActivitiesApi->activities_meta_post_retrieve: #{e}"
|
221
|
+
end
|
222
|
+
```
|
223
|
+
|
224
|
+
#### Using the activities_meta_post_retrieve_with_http_info variant
|
225
|
+
|
226
|
+
This returns an Array which contains the response data, status code and headers.
|
227
|
+
|
228
|
+
> <Array(<MetaResponse>, Integer, Hash)> activities_meta_post_retrieve_with_http_info(x_account_token)
|
229
|
+
|
230
|
+
```ruby
|
231
|
+
begin
|
232
|
+
|
233
|
+
data, status_code, headers = api_instance.activities_meta_post_retrieve_with_http_info(x_account_token)
|
234
|
+
p status_code # => 2xx
|
235
|
+
p headers # => { ... }
|
236
|
+
p data # => <MetaResponse>
|
237
|
+
rescue MergeATSClient::ApiError => e
|
238
|
+
puts "Error when calling ActivitiesApi->activities_meta_post_retrieve_with_http_info: #{e}"
|
239
|
+
end
|
240
|
+
```
|
241
|
+
|
242
|
+
### Parameters
|
243
|
+
|
244
|
+
| Name | Type | Description | Notes |
|
245
|
+
| ---- | ---- | ----------- | ----- |
|
246
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
247
|
+
|
248
|
+
### Return type
|
249
|
+
|
250
|
+
[**MetaResponse**](MetaResponse.md)
|
251
|
+
|
252
|
+
### Authorization
|
253
|
+
|
254
|
+
[tokenAuth](../README.md#tokenAuth)
|
255
|
+
|
256
|
+
### HTTP request headers
|
257
|
+
|
258
|
+
- **Content-Type**: Not defined
|
259
|
+
- **Accept**: application/json
|
260
|
+
|
261
|
+
|
108
262
|
## activities_retrieve
|
109
263
|
|
110
264
|
> <Activity> activities_retrieve(x_account_token, id, opts)
|
@@ -132,7 +286,8 @@ id = TODO # String |
|
|
132
286
|
opts = {
|
133
287
|
expand: 'user', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
134
288
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
135
|
-
remote_fields: 'activity_type' # String |
|
289
|
+
remote_fields: 'activity_type', # String | Deprecated. Use show_enum_origins.
|
290
|
+
show_enum_origins: 'activity_type' # String | Which fields should be returned in non-normalized form.
|
136
291
|
}
|
137
292
|
|
138
293
|
begin
|
@@ -170,7 +325,8 @@ end
|
|
170
325
|
| **id** | [**String**](.md) | | |
|
171
326
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
172
327
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
173
|
-
| **remote_fields** | **String** |
|
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] |
|
174
330
|
|
175
331
|
### Return type
|
176
332
|
|
data/docs/Activity.md
CHANGED
@@ -6,14 +6,17 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
-
| **user** | **String** |
|
9
|
+
| **user** | **String** | The user that performed the action. | [optional] |
|
10
10
|
| **remote_created_at** | **Time** | When the third party's activity was created. | [optional] |
|
11
|
-
| **activity_type** | [**ActivityTypeEnum**](ActivityTypeEnum.md) | The activity's type. | [optional] |
|
11
|
+
| **activity_type** | [**ActivityTypeEnum**](ActivityTypeEnum.md) | The activity's type. * `NOTE` - NOTE * `EMAIL` - EMAIL * `OTHER` - OTHER | [optional] |
|
12
12
|
| **subject** | **String** | The activity's subject. | [optional] |
|
13
13
|
| **body** | **String** | The activity's body. | [optional] |
|
14
|
-
| **visibility** | [**VisibilityEnum**](VisibilityEnum.md) | The activity's visibility. | [optional] |
|
15
|
-
| **
|
14
|
+
| **visibility** | [**VisibilityEnum**](VisibilityEnum.md) | The activity's visibility. * `ADMIN_ONLY` - ADMIN_ONLY * `PUBLIC` - PUBLIC * `PRIVATE` - PRIVATE | [optional] |
|
15
|
+
| **candidate** | **String** | The activity’s candidate. | [optional] |
|
16
16
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
17
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
18
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
19
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
17
20
|
|
18
21
|
## Example
|
19
22
|
|
@@ -29,8 +32,11 @@ instance = MergeATSClient::Activity.new(
|
|
29
32
|
subject: Gil Feig's interview,
|
30
33
|
body: Candidate loves integrations!!.,
|
31
34
|
visibility: PRIVATE,
|
32
|
-
|
33
|
-
remote_was_deleted: null
|
35
|
+
candidate: 03455bc6-6040-430a-848e-aafacbfdf4fg,
|
36
|
+
remote_was_deleted: null,
|
37
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
38
|
+
modified_at: 2021-10-16T00:00Z,
|
39
|
+
remote_data: [{"path":"/actions","data":["Varies by platform"]}]
|
34
40
|
)
|
35
41
|
```
|
36
42
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeATSClient::ActivityEndpointRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**ActivityRequest**](ActivityRequest.md) | | |
|
8
|
+
| **remote_user_id** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_ats_client'
|
14
|
+
|
15
|
+
instance = MergeATSClient::ActivityEndpointRequest.new(
|
16
|
+
model: null,
|
17
|
+
remote_user_id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# MergeATSClient::ActivityRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **user** | **String** | The user that performed the action. | [optional] |
|
8
|
+
| **activity_type** | [**ActivityTypeEnum**](ActivityTypeEnum.md) | The activity's type. * `NOTE` - NOTE * `EMAIL` - EMAIL * `OTHER` - OTHER | [optional] |
|
9
|
+
| **subject** | **String** | The activity's subject. | [optional] |
|
10
|
+
| **body** | **String** | The activity's body. | [optional] |
|
11
|
+
| **visibility** | [**VisibilityEnum**](VisibilityEnum.md) | The activity's visibility. * `ADMIN_ONLY` - ADMIN_ONLY * `PUBLIC` - PUBLIC * `PRIVATE` - PRIVATE | [optional] |
|
12
|
+
| **candidate** | **String** | The activity’s candidate. | [optional] |
|
13
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
14
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'merge_ats_client'
|
20
|
+
|
21
|
+
instance = MergeATSClient::ActivityRequest.new(
|
22
|
+
user: 9d892439-5fab-4dbb-8bd8-34f7f96c7912,
|
23
|
+
activity_type: NOTE,
|
24
|
+
subject: Gil Feig's interview,
|
25
|
+
body: Candidate loves integrations!!.,
|
26
|
+
visibility: PRIVATE,
|
27
|
+
candidate: 03455bc6-6040-430a-848e-aafacbfdf4fg,
|
28
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
29
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeATSClient::ActivityResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**Activity**](Activity.md) | | |
|
8
|
+
| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) | | |
|
9
|
+
| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) | | |
|
10
|
+
| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'merge_ats_client'
|
16
|
+
|
17
|
+
instance = MergeATSClient::ActivityResponse.new(
|
18
|
+
model: null,
|
19
|
+
warnings: null,
|
20
|
+
errors: null,
|
21
|
+
logs: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/Application.md
CHANGED
@@ -6,17 +6,18 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
-
| **candidate** | **String** |
|
10
|
-
| **job** | **String** |
|
9
|
+
| **candidate** | **String** | The candidate applying. | [optional] |
|
10
|
+
| **job** | **String** | The job being applied for. | [optional] |
|
11
11
|
| **applied_at** | **Time** | When the application was submitted. | [optional] |
|
12
12
|
| **rejected_at** | **Time** | When the application was rejected. | [optional] |
|
13
13
|
| **source** | **String** | The application's source. | [optional] |
|
14
|
-
| **credited_to** | **String** |
|
15
|
-
| **current_stage** | **String** |
|
16
|
-
| **reject_reason** | **String** |
|
17
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
18
|
-
| **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
|
14
|
+
| **credited_to** | **String** | The user credited for this application. | [optional] |
|
15
|
+
| **current_stage** | **String** | The application's current stage. | [optional] |
|
16
|
+
| **reject_reason** | **String** | The application's reason for rejection. | [optional] |
|
19
17
|
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
18
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
19
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
20
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
20
21
|
|
21
22
|
## Example
|
22
23
|
|
@@ -34,9 +35,10 @@ instance = MergeATSClient::Application.new(
|
|
34
35
|
credited_to: 58166795-8d68-4b30-9bfb-bfd402479484,
|
35
36
|
current_stage: d578dfdc-7b0a-4ab6-a2b0-4b40f20eb9ea,
|
36
37
|
reject_reason: 59b25f2b-da02-40f5-9656-9fa0db555784,
|
37
|
-
|
38
|
-
|
39
|
-
|
38
|
+
remote_was_deleted: null,
|
39
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
40
|
+
modified_at: 2021-10-16T00:00Z,
|
41
|
+
remote_data: [{"path":"/candidacies","data":["Varies by platform"]}]
|
40
42
|
)
|
41
43
|
```
|
42
44
|
|
data/docs/ApplicationRequest.md
CHANGED
@@ -4,16 +4,14 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **
|
9
|
-
| **job** | **String** | | [optional] |
|
7
|
+
| **candidate** | **String** | The candidate applying. | [optional] |
|
8
|
+
| **job** | **String** | The job being applied for. | [optional] |
|
10
9
|
| **applied_at** | **Time** | When the application was submitted. | [optional] |
|
11
10
|
| **rejected_at** | **Time** | When the application was rejected. | [optional] |
|
12
11
|
| **source** | **String** | The application's source. | [optional] |
|
13
|
-
| **credited_to** | **String** |
|
14
|
-
| **current_stage** | **String** |
|
15
|
-
| **reject_reason** | **String** |
|
16
|
-
| **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
|
12
|
+
| **credited_to** | **String** | The user credited for this application. | [optional] |
|
13
|
+
| **current_stage** | **String** | The application's current stage. | [optional] |
|
14
|
+
| **reject_reason** | **String** | The application's reason for rejection. | [optional] |
|
17
15
|
| **remote_template_id** | **String** | | [optional] |
|
18
16
|
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
19
17
|
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
@@ -24,7 +22,6 @@
|
|
24
22
|
require 'merge_ats_client'
|
25
23
|
|
26
24
|
instance = MergeATSClient::ApplicationRequest.new(
|
27
|
-
remote_id: 98796,
|
28
25
|
candidate: 2872ba14-4084-492b-be96-e5eee6fc33ef,
|
29
26
|
job: 52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633,
|
30
27
|
applied_at: 2021-10-15T00:00Z,
|
@@ -33,7 +30,6 @@ instance = MergeATSClient::ApplicationRequest.new(
|
|
33
30
|
credited_to: 58166795-8d68-4b30-9bfb-bfd402479484,
|
34
31
|
current_stage: d578dfdc-7b0a-4ab6-a2b0-4b40f20eb9ea,
|
35
32
|
reject_reason: 59b25f2b-da02-40f5-9656-9fa0db555784,
|
36
|
-
custom_fields: null,
|
37
33
|
remote_template_id: 92830948203,
|
38
34
|
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
39
35
|
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
data/docs/ApplicationsApi.md
CHANGED
@@ -205,8 +205,8 @@ opts = {
|
|
205
205
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
206
206
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
207
207
|
job_id: 'job_id_example', # String | If provided, will only return applications for this job.
|
208
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
209
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
208
|
+
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.
|
209
|
+
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.
|
210
210
|
page_size: 56, # Integer | Number of results to return per page.
|
211
211
|
reject_reason_id: 'reject_reason_id_example', # String | If provided, will only return applications with this reject reason.
|
212
212
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
@@ -255,8 +255,8 @@ end
|
|
255
255
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
256
256
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
257
257
|
| **job_id** | **String** | If provided, will only return applications for this job. | [optional] |
|
258
|
-
| **modified_after** | **Time** | If provided,
|
259
|
-
| **modified_before** | **Time** | If provided,
|
258
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
259
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
260
260
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
261
261
|
| **reject_reason_id** | **String** | If provided, will only return applications with this reject reason. | [optional] |
|
262
262
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
data/docs/Attachment.md
CHANGED
@@ -9,9 +9,11 @@
|
|
9
9
|
| **file_name** | **String** | The attachment's name. | [optional] |
|
10
10
|
| **file_url** | **String** | The attachment's url. | [optional] |
|
11
11
|
| **candidate** | **String** | | [optional] |
|
12
|
-
| **attachment_type** | [**AttachmentTypeEnum**](AttachmentTypeEnum.md) | The attachment's type. | [optional] |
|
13
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
12
|
+
| **attachment_type** | [**AttachmentTypeEnum**](AttachmentTypeEnum.md) | The attachment's type. * `RESUME` - RESUME * `COVER_LETTER` - COVER_LETTER * `OFFER_LETTER` - OFFER_LETTER * `OTHER` - OTHER | [optional] |
|
14
13
|
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
14
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
15
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
16
|
+
| **remote_data** | [**Array<RemoteData>**](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
|
-
|
29
|
-
|
30
|
+
remote_was_deleted: null,
|
31
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
32
|
+
modified_at: 2021-10-16T00:00Z,
|
33
|
+
remote_data: [{"path":"/attachments","data":["Varies by platform"]}]
|
30
34
|
)
|
31
35
|
```
|
32
36
|
|
data/docs/AttachmentRequest.md
CHANGED
@@ -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's name. | [optional] |
|
9
8
|
| **file_url** | **String** | The attachment's url. | [optional] |
|
10
9
|
| **candidate** | **String** | | [optional] |
|
11
|
-
| **attachment_type** | [**AttachmentTypeEnum**](AttachmentTypeEnum.md) | The attachment's type. | [optional] |
|
10
|
+
| **attachment_type** | [**AttachmentTypeEnum**](AttachmentTypeEnum.md) | The attachment's type. * `RESUME` - RESUME * `COVER_LETTER` - COVER_LETTER * `OFFER_LETTER` - OFFER_LETTER * `OTHER` - OTHER | [optional] |
|
12
11
|
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
13
12
|
| **linked_account_params** | [**Hash<String, AnyType>**](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,
|
data/docs/AttachmentsApi.md
CHANGED
@@ -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,
|
124
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
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 |
|
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,
|
170
|
-
| **modified_before** | **Time** | If provided,
|
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** |
|
173
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
173
174
|
| **remote_id** | **String** | The API provider'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 |
|
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** |
|
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's current title. | [optional] |
|
13
13
|
| **remote_created_at** | **Time** | When the third party's candidate was created. | [optional] |
|
14
14
|
| **remote_updated_at** | **Time** | When the third party's candidate was updated. | [optional] |
|
15
|
-
| **last_interaction_at** | **Time** | When the most recent candidate
|
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<String>** | The candidate's locations. | [optional] |
|
@@ -22,9 +22,10 @@
|
|
22
22
|
| **tags** | **Array<String>** | Array of `Tag` names as strings. | [optional] |
|
23
23
|
| **applications** | **Array<String>** | Array of `Application` object IDs. | [optional] |
|
24
24
|
| **attachments** | **Array<String>** | Array of `Attachment` object IDs. | [optional] |
|
25
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
26
|
-
| **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
|
27
25
|
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
26
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
27
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
28
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
28
29
|
|
29
30
|
## Example
|
30
31
|
|
@@ -50,9 +51,10 @@ instance = MergeATSClient::Candidate.new(
|
|
50
51
|
tags: ["High-Priority"],
|
51
52
|
applications: ["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],
|
52
53
|
attachments: ["bea08964-32b4-4a20-8bb4-2612ba09de1d"],
|
53
|
-
|
54
|
-
|
55
|
-
|
54
|
+
remote_was_deleted: null,
|
55
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
56
|
+
modified_at: 2021-10-16T00:00Z,
|
57
|
+
remote_data: [{"path":"/candidates","data":["Varies by platform"]}]
|
56
58
|
)
|
57
59
|
```
|
58
60
|
|
data/docs/CandidateRequest.md
CHANGED
@@ -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's first name. | [optional] |
|
9
8
|
| **last_name** | **String** | The candidate's last name. | [optional] |
|
10
9
|
| **company** | **String** | The candidate's current company. | [optional] |
|
11
10
|
| **title** | **String** | The candidate's current title. | [optional] |
|
12
|
-
| **
|
13
|
-
| **remote_updated_at** | **Time** | When the third party'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<String>** | The candidate's locations. | [optional] |
|
@@ -21,7 +18,6 @@
|
|
21
18
|
| **tags** | **Array<String>** | Array of `Tag` names as strings. | [optional] |
|
22
19
|
| **applications** | **Array<String>** | Array of `Application` object IDs. | [optional] |
|
23
20
|
| **attachments** | **Array<String>** | Array of `Attachment` object IDs. | [optional] |
|
24
|
-
| **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
|
25
21
|
| **remote_template_id** | **String** | | [optional] |
|
26
22
|
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
27
23
|
| **linked_account_params** | [**Hash<String, AnyType>**](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: ["High-Priority"],
|
50
43
|
applications: ["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],
|
51
44
|
attachments: ["bea08964-32b4-4a20-8bb4-2612ba09de1d"],
|
52
|
-
custom_fields: null,
|
53
45
|
remote_template_id: 92830948203,
|
54
46
|
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
55
47
|
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|