merge_ats_client 2.0.1 → 3.0.0
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 +16 -4
- data/docs/ConditionSchema.md +30 -0
- data/docs/ConditionTypeEnum.md +15 -0
- data/docs/EmailAddressRequest.md +5 -1
- data/docs/EndUserDetailsRequest.md +2 -2
- 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/OperatorSchema.md +20 -0
- data/docs/PaginatedConditionSchemaList.md +22 -0
- data/docs/PhoneNumberRequest.md +5 -1
- data/docs/SelectiveSyncApi.md +233 -0
- data/docs/UrlRequest.md +5 -1
- data/lib/merge_ats_client/api/selective_sync_api.rb +225 -0
- 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/activity_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/attachment_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/categories_enum.rb +1 -1
- data/lib/merge_ats_client/models/category_enum.rb +1 -1
- data/lib/merge_ats_client/models/condition_schema.rb +297 -0
- data/lib/merge_ats_client/models/condition_type_enum.rb +50 -0
- data/lib/merge_ats_client/models/disability_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/email_address_request.rb +29 -5
- data/lib/merge_ats_client/models/email_address_type_enum.rb +1 -1
- data/lib/merge_ats_client/models/encoding_enum.rb +1 -1
- data/lib/merge_ats_client/models/end_user_details_request.rb +2 -2
- data/lib/merge_ats_client/models/gender_enum.rb +1 -1
- data/lib/merge_ats_client/models/job_status_enum.rb +1 -1
- 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/method_enum.rb +1 -1
- data/lib/merge_ats_client/models/offer_status_enum.rb +1 -1
- 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_request.rb +29 -5
- 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/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_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/sync_status_status_enum.rb +1 -1
- data/lib/merge_ats_client/models/url.rb +1 -1
- data/lib/merge_ats_client/models/url_request.rb +30 -6
- 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 +10 -0
- data/spec/api/selective_sync_api_spec.rb +72 -0
- data/spec/models/condition_schema_spec.rb +70 -0
- data/spec/models/condition_type_enum_spec.rb +28 -0
- data/spec/models/email_address_request_spec.rb +12 -0
- 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/operator_schema_spec.rb +40 -0
- data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
- data/spec/models/phone_number_request_spec.rb +12 -0
- data/spec/models/url_request_spec.rb +12 -0
- metadata +152 -111
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b96ca252f3f665761dd7925ec034a5c29a4b12be44075efab43da5f981fb12bd
|
4
|
+
data.tar.gz: c6145ab496e08fcafa23164a70897195011f49b50ad85e098167d790867a4468
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6983eed0bc6aa05eabe8ab9c9c79ab6f62060cc63bdc150b72399d32b8348b529fdc284f803abe1f2a8acd1d02e0e4c80d409b0d365a036655d8306498c726c2
|
7
|
+
data.tar.gz: 0d899f143d0ca14a15fa1972bead6590bdf63f2f542a163a3d06a40022b2531ec4f07b2385d8d626e13257b12684cea35dcf1b1896907c2633dcf4d418168132
|
data/LICENSE.md
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
_Last updated: April 21, 2022_
|
2
|
+
|
3
|
+
**Merge SDK & Code Snippets License**
|
4
|
+
|
5
|
+
Merge makes available to Customers various software development kits ("**SDKs**") and code snippets ("**Snippets**") (together, the "**Merge Assets**") to assist with Merge Integrations and making connections to their Customer Application. Merge Assets are deemed Software under the MSA (defined below). All terms applicable to Software under the MSA apply with equal force and effect to the Merge Assets under this Merge SDK and Code Snippets License ("**License**").
|
6
|
+
|
7
|
+
"**Customer**" means a person or entity that uses any of the Merge Assets. By using any Merge Asset, Customer agrees to the terms of this License.
|
8
|
+
|
9
|
+
"**MSA**" for the purpose of this License means: (a) for Merge "Launch" Customers, the Subscriber Agreement (available at: [https://merge.dev/subscriber-agreement](https://merge.dev/subscriber-agreement)); and (b) for Merge "Growth" and/or "Expand" Customers, Merge's Master Services Agreement (available at [https://merge.dev/msa](https://merge.dev/msa)), unless Merge and Customer have entered into a separate written agreement governing the Customer's use of the Service. Customer's use of any Merge Asset will be governed by the applicable MSA as well as the additional terms of this License. Capitalized terms used but not defined herein shall have the meaning as set forth in the MSA. In the event of any inconsistency between the terms of the MSA and this License, the terms of the MSA will prevail.
|
10
|
+
|
11
|
+
Merge reserves the right to modify or update this License in its sole discretion, the effective date of such updates and/or modifications will be the earlier of: (i) 30 days from the date of such update or modification; or (ii) Customer's continued use of any Merge Asset.
|
12
|
+
|
13
|
+
1. **SDK and Snippets License**. Customer's right to access and use the Service under Section 1 of the MSA is extended to include use of the Merge Assets but solely during the Term and subject to the terms of the MSA.
|
14
|
+
2. **Use with the Service Only**. Customer may use the Merge Assets but only in connections with the Service and Merge Integrations. Any other use of the Merge Assets requires Merge's prior written consent.
|
15
|
+
3. **Limitations**. Customer's use of the Merge Assets may be subject to bandwidth limitations that Merge may impose from time to time during the Subscription. Merge will make commercially reasonable efforts to notify Customer of such limitations in advance via the location where Customer gained access to the applicable Merge Asset(s).
|
16
|
+
4. **Merge Assets & Intellectual Property Rights**. Any modifications or derivatives (together, "**Asset Derivatives**") made by Customer to the Merge Assets are deemed "works made for hire" as that term is defined in the United States Copyright Act and are the sole property of Merge. To the extent that ownership of any Asset Derivative does not by operation of law vest in Merge, Customer hereby assigns to Merge all right, title and interest in and to the Asset Derivative, including all related intellectual property rights. Asset Derivatives will be governed by the terms of this License.
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The unified API for building rich integrations with multiple Applicant Tracking
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 1.0
|
10
|
-
- Package version:
|
10
|
+
- Package version: 3.0.0
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build merge_ats_client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./merge_ats_client-
|
27
|
+
gem install ./merge_ats_client-3.0.0.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./merge_ats_client-
|
30
|
+
(for development, run `gem install --dev ./merge_ats_client-3.0.0.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'merge_ats_client', '~>
|
36
|
+
gem 'merge_ats_client', '~> 3.0.0'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -129,6 +129,9 @@ Class | Method | HTTP request | Description
|
|
129
129
|
*MergeATSClient::RejectReasonsApi* | [**reject_reasons_retrieve**](docs/RejectReasonsApi.md#reject_reasons_retrieve) | **GET** /reject-reasons/{id} |
|
130
130
|
*MergeATSClient::ScorecardsApi* | [**scorecards_list**](docs/ScorecardsApi.md#scorecards_list) | **GET** /scorecards |
|
131
131
|
*MergeATSClient::ScorecardsApi* | [**scorecards_retrieve**](docs/ScorecardsApi.md#scorecards_retrieve) | **GET** /scorecards/{id} |
|
132
|
+
*MergeATSClient::SelectiveSyncApi* | [**selective_sync_configurations_list**](docs/SelectiveSyncApi.md#selective_sync_configurations_list) | **GET** /selective-sync/configurations |
|
133
|
+
*MergeATSClient::SelectiveSyncApi* | [**selective_sync_configurations_update**](docs/SelectiveSyncApi.md#selective_sync_configurations_update) | **PUT** /selective-sync/configurations |
|
134
|
+
*MergeATSClient::SelectiveSyncApi* | [**selective_sync_meta_list**](docs/SelectiveSyncApi.md#selective_sync_meta_list) | **GET** /selective-sync/meta |
|
132
135
|
*MergeATSClient::SyncStatusApi* | [**sync_status_list**](docs/SyncStatusApi.md#sync_status_list) | **GET** /sync-status |
|
133
136
|
*MergeATSClient::TagsApi* | [**tags_list**](docs/TagsApi.md#tags_list) | **GET** /tags |
|
134
137
|
*MergeATSClient::UsersApi* | [**users_list**](docs/UsersApi.md#users_list) | **GET** /users |
|
@@ -164,6 +167,8 @@ Class | Method | HTTP request | Description
|
|
164
167
|
- [MergeATSClient::CandidateResponse](docs/CandidateResponse.md)
|
165
168
|
- [MergeATSClient::CategoriesEnum](docs/CategoriesEnum.md)
|
166
169
|
- [MergeATSClient::CategoryEnum](docs/CategoryEnum.md)
|
170
|
+
- [MergeATSClient::ConditionSchema](docs/ConditionSchema.md)
|
171
|
+
- [MergeATSClient::ConditionTypeEnum](docs/ConditionTypeEnum.md)
|
167
172
|
- [MergeATSClient::DataPassthroughRequest](docs/DataPassthroughRequest.md)
|
168
173
|
- [MergeATSClient::DebugModeLog](docs/DebugModeLog.md)
|
169
174
|
- [MergeATSClient::DebugModelLogSummary](docs/DebugModelLogSummary.md)
|
@@ -186,6 +191,11 @@ Class | Method | HTTP request | Description
|
|
186
191
|
- [MergeATSClient::JobInterviewStage](docs/JobInterviewStage.md)
|
187
192
|
- [MergeATSClient::JobStatusEnum](docs/JobStatusEnum.md)
|
188
193
|
- [MergeATSClient::LinkToken](docs/LinkToken.md)
|
194
|
+
- [MergeATSClient::LinkedAccountCondition](docs/LinkedAccountCondition.md)
|
195
|
+
- [MergeATSClient::LinkedAccountConditionRequest](docs/LinkedAccountConditionRequest.md)
|
196
|
+
- [MergeATSClient::LinkedAccountSelectiveSyncConfiguration](docs/LinkedAccountSelectiveSyncConfiguration.md)
|
197
|
+
- [MergeATSClient::LinkedAccountSelectiveSyncConfigurationListRequest](docs/LinkedAccountSelectiveSyncConfigurationListRequest.md)
|
198
|
+
- [MergeATSClient::LinkedAccountSelectiveSyncConfigurationRequest](docs/LinkedAccountSelectiveSyncConfigurationRequest.md)
|
189
199
|
- [MergeATSClient::LinkedAccountStatus](docs/LinkedAccountStatus.md)
|
190
200
|
- [MergeATSClient::MetaResponse](docs/MetaResponse.md)
|
191
201
|
- [MergeATSClient::MethodEnum](docs/MethodEnum.md)
|
@@ -194,12 +204,14 @@ Class | Method | HTTP request | Description
|
|
194
204
|
- [MergeATSClient::Offer](docs/Offer.md)
|
195
205
|
- [MergeATSClient::OfferStatusEnum](docs/OfferStatusEnum.md)
|
196
206
|
- [MergeATSClient::Office](docs/Office.md)
|
207
|
+
- [MergeATSClient::OperatorSchema](docs/OperatorSchema.md)
|
197
208
|
- [MergeATSClient::OverallRecommendationEnum](docs/OverallRecommendationEnum.md)
|
198
209
|
- [MergeATSClient::PaginatedAccountDetailsAndActionsList](docs/PaginatedAccountDetailsAndActionsList.md)
|
199
210
|
- [MergeATSClient::PaginatedActivityList](docs/PaginatedActivityList.md)
|
200
211
|
- [MergeATSClient::PaginatedApplicationList](docs/PaginatedApplicationList.md)
|
201
212
|
- [MergeATSClient::PaginatedAttachmentList](docs/PaginatedAttachmentList.md)
|
202
213
|
- [MergeATSClient::PaginatedCandidateList](docs/PaginatedCandidateList.md)
|
214
|
+
- [MergeATSClient::PaginatedConditionSchemaList](docs/PaginatedConditionSchemaList.md)
|
203
215
|
- [MergeATSClient::PaginatedDepartmentList](docs/PaginatedDepartmentList.md)
|
204
216
|
- [MergeATSClient::PaginatedEEOCList](docs/PaginatedEEOCList.md)
|
205
217
|
- [MergeATSClient::PaginatedIssueList](docs/PaginatedIssueList.md)
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# MergeATSClient::ConditionSchema
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The ID of the condition schema. This ID is used when updating selective syncs for a linked account. | |
|
8
|
+
| **common_model** | **String** | The common model for which a condition schema is defined. | [optional][readonly] |
|
9
|
+
| **native_name** | **String** | User-facing *native condition* name. e.g. \"Skip Manager\". | |
|
10
|
+
| **field_name** | **String** | The name of the field on the common model that this condition corresponds to, if they conceptually match. e.g. \"location_type\". | |
|
11
|
+
| **is_unique** | **Boolean** | Whether this condition can only be applied once. If false, the condition can be AND'd together multiple times. | [optional] |
|
12
|
+
| **condition_type** | [**ConditionTypeEnum**](ConditionTypeEnum.md) | | |
|
13
|
+
| **operators** | [**Array<OperatorSchema>**](OperatorSchema.md) | The schemas for the operators that can be used on a condition. | |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'merge_ats_client'
|
19
|
+
|
20
|
+
instance = MergeATSClient::ConditionSchema.new(
|
21
|
+
id: null,
|
22
|
+
common_model: null,
|
23
|
+
native_name: null,
|
24
|
+
field_name: null,
|
25
|
+
is_unique: null,
|
26
|
+
condition_type: null,
|
27
|
+
operators: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeATSClient::ConditionTypeEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'merge_ats_client'
|
12
|
+
|
13
|
+
instance = MergeATSClient::ConditionTypeEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/EmailAddressRequest.md
CHANGED
@@ -6,6 +6,8 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **value** | **String** | The email address. | [optional] |
|
8
8
|
| **email_address_type** | [**EmailAddressTypeEnum**](EmailAddressTypeEnum.md) | The type of email address. | [optional] |
|
9
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
10
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
9
11
|
|
10
12
|
## Example
|
11
13
|
|
@@ -14,7 +16,9 @@ require 'merge_ats_client'
|
|
14
16
|
|
15
17
|
instance = MergeATSClient::EmailAddressRequest.new(
|
16
18
|
value: merge_is_hiring@merge.dev,
|
17
|
-
email_address_type: PERSONAL
|
19
|
+
email_address_type: PERSONAL,
|
20
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
21
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
18
22
|
)
|
19
23
|
```
|
20
24
|
|
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **end_user_email_address** | **String** | Your end user's email address. | |
|
7
|
+
| **end_user_email_address** | **String** | Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent. | |
|
8
8
|
| **end_user_organization_name** | **String** | Your end user's organization. | |
|
9
|
-
| **end_user_origin_id** | **String** |
|
9
|
+
| **end_user_origin_id** | **String** | This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers. | |
|
10
10
|
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | The integration categories to show in Merge Link. | |
|
11
11
|
| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://www.merge.dev/docs/basics/integration-metadata/. | [optional] |
|
12
12
|
| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. | [optional][default to 30] |
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# MergeATSClient::LinkedAccountCondition
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **condition_schema_id** | **String** | The ID indicating which condition schema to use for a specific condition. | |
|
8
|
+
| **common_model** | **String** | The common model for a specific condition. | [optional][readonly] |
|
9
|
+
| **native_name** | **String** | User-facing *native condition* name. e.g. \"Skip Manager\". | |
|
10
|
+
| **operator** | **String** | The operator for a specific condition. | |
|
11
|
+
| **value** | [**AnyType**](.md) | The value for a condition. | [optional][readonly] |
|
12
|
+
| **field_name** | **String** | The name of the field on the common model that this condition corresponds to, if they conceptually match. e.g. \"location_type\". | |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'merge_ats_client'
|
18
|
+
|
19
|
+
instance = MergeATSClient::LinkedAccountCondition.new(
|
20
|
+
condition_schema_id: null,
|
21
|
+
common_model: null,
|
22
|
+
native_name: null,
|
23
|
+
operator: null,
|
24
|
+
value: null,
|
25
|
+
field_name: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeATSClient::LinkedAccountConditionRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **condition_schema_id** | **String** | The ID indicating which condition schema to use for a specific condition. | |
|
8
|
+
| **operator** | **String** | The operator for a specific condition. | |
|
9
|
+
| **value** | [**AnyType**](.md) | The value for a specific condition. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_ats_client'
|
15
|
+
|
16
|
+
instance = MergeATSClient::LinkedAccountConditionRequest.new(
|
17
|
+
condition_schema_id: null,
|
18
|
+
operator: null,
|
19
|
+
value: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeATSClient::LinkedAccountSelectiveSyncConfiguration
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **linked_account_conditions** | [**Array<LinkedAccountCondition>**](LinkedAccountCondition.md) | The conditions belonging to a selective sync. | [optional][readonly] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_ats_client'
|
13
|
+
|
14
|
+
instance = MergeATSClient::LinkedAccountSelectiveSyncConfiguration.new(
|
15
|
+
linked_account_conditions: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeATSClient::LinkedAccountSelectiveSyncConfigurationListRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **sync_configurations** | [**Array<LinkedAccountSelectiveSyncConfigurationRequest>**](LinkedAccountSelectiveSyncConfigurationRequest.md) | The selective syncs associated with a linked account. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_ats_client'
|
13
|
+
|
14
|
+
instance = MergeATSClient::LinkedAccountSelectiveSyncConfigurationListRequest.new(
|
15
|
+
sync_configurations: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeATSClient::LinkedAccountSelectiveSyncConfigurationRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **linked_account_conditions** | [**Array<LinkedAccountConditionRequest>**](LinkedAccountConditionRequest.md) | The conditions belonging to a selective sync. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_ats_client'
|
13
|
+
|
14
|
+
instance = MergeATSClient::LinkedAccountSelectiveSyncConfigurationRequest.new(
|
15
|
+
linked_account_conditions: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeATSClient::OperatorSchema
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **operator** | **String** | The operator for which an operator schema is defined. | [optional][readonly] |
|
8
|
+
| **is_unique** | **Boolean** | Whether the operator can be repeated multiple times. | [optional][readonly] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_ats_client'
|
14
|
+
|
15
|
+
instance = MergeATSClient::OperatorSchema.new(
|
16
|
+
operator: null,
|
17
|
+
is_unique: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeATSClient::PaginatedConditionSchemaList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **_next** | **String** | | [optional] |
|
8
|
+
| **previous** | **String** | | [optional] |
|
9
|
+
| **results** | [**Array<ConditionSchema>**](ConditionSchema.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_ats_client'
|
15
|
+
|
16
|
+
instance = MergeATSClient::PaginatedConditionSchemaList.new(
|
17
|
+
_next: null,
|
18
|
+
previous: null,
|
19
|
+
results: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/PhoneNumberRequest.md
CHANGED
@@ -6,6 +6,8 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **value** | **String** | The phone number. | [optional] |
|
8
8
|
| **phone_number_type** | [**PhoneNumberTypeEnum**](PhoneNumberTypeEnum.md) | The type of phone number. | [optional] |
|
9
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
10
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
9
11
|
|
10
12
|
## Example
|
11
13
|
|
@@ -14,7 +16,9 @@ require 'merge_ats_client'
|
|
14
16
|
|
15
17
|
instance = MergeATSClient::PhoneNumberRequest.new(
|
16
18
|
value: +3198675309,
|
17
|
-
phone_number_type: HOME
|
19
|
+
phone_number_type: HOME,
|
20
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
21
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
18
22
|
)
|
19
23
|
```
|
20
24
|
|
@@ -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<LinkedAccountSelectiveSyncConfiguration>**](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<LinkedAccountSelectiveSyncConfiguration>**](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/UrlRequest.md
CHANGED
@@ -6,6 +6,8 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **value** | **String** | The site's url. | [optional] |
|
8
8
|
| **url_type** | [**UrlTypeEnum**](UrlTypeEnum.md) | The type of site. | [optional] |
|
9
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
10
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](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: {"unique_integration_field":"unique_integration_field_value"},
|
21
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
18
22
|
)
|
19
23
|
```
|
20
24
|
|