merge_ats_client 1.0.2 → 2.0.0

data/docs/Scorecard.md

@@ -6,13 +6,14 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
-| **application** | **String** | The application being scored. | [optional] |
-| **interview** | **String** | The interview being scored. | [optional] |
-| **interviewer** | **String** | The interviewer doing the scoring. | [optional] |
+| **application** | **String** |  | [optional] |
+| **interview** | **String** |  | [optional] |
+| **interviewer** | **String** |  | [optional] |
 | **remote_created_at** | **Time** | When the third party's scorecard was created. | [optional] |
 | **submitted_at** | **Time** | When the scorecard was submitted. | [optional] |
 | **overall_recommendation** | [**OverallRecommendationEnum**](OverallRecommendationEnum.md) | The inteviewer's recommendation. | [optional] |
 | **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
 
 ## Example
 
@@ -25,10 +26,11 @@ instance = MergeATSClient::Scorecard.new(
   application: 2872ba14-4084-492b-be96-e5eee6fc33ef,
   interview: 52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633,
   interviewer: bbb519a3-246e-4b95-b6b3-dba16107ba6b,
-  remote_created_at: null,
-  submitted_at: null,
+  remote_created_at: 2021-10-15T00:00Z,
+  submitted_at: 2021-10-15T00:00Z,
   overall_recommendation: STRONG_YES,
-  remote_data: [{"path":"/ratings","data":["Varies by platform"]}]
+  remote_data: [{"path":"/ratings","data":["Varies by platform"]}],
+  remote_was_deleted: null
 )
 ```
 

data/docs/ScorecardsApi.md

@@ -4,90 +4,10 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**scorecards_create**](ScorecardsApi.md#scorecards_create) | **POST** /scorecards |  |
 | [**scorecards_list**](ScorecardsApi.md#scorecards_list) | **GET** /scorecards |  |
 | [**scorecards_retrieve**](ScorecardsApi.md#scorecards_retrieve) | **GET** /scorecards/{id} |  |
 
 
-## scorecards_create
-
-> <Scorecard> scorecards_create(x_account_token, remote_user_id, opts)
-
-
-
-Creates a `Scorecard` object with the given values.
-
-### Examples
-
-```ruby
-require 'time'
-require 'merge_ats_client'
-# setup authorization
-MergeATSClient.configure do |config|
-  # Configure API key authorization: tokenAuth
-  config.api_key['tokenAuth'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['tokenAuth'] = 'Bearer'
-end
-
-api_instance = MergeATSClient::ScorecardsApi.new
-x_account_token = 'x_account_token_example' # String | Token identifying the end user.
-remote_user_id = 'remote_user_id_example' # String | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.
-opts = {
-  run_async: true, # Boolean | Whether or not third-party updates should be run asynchronously.
-  scorecard_request: MergeATSClient::ScorecardRequest.new # ScorecardRequest | 
-}
-
-begin
-  
-  result = api_instance.scorecards_create(x_account_token, remote_user_id, opts)
-  p result
-rescue MergeATSClient::ApiError => e
-  puts "Error when calling ScorecardsApi->scorecards_create: #{e}"
-end
-```
-
-#### Using the scorecards_create_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Scorecard>, Integer, Hash)> scorecards_create_with_http_info(x_account_token, remote_user_id, opts)
-
-```ruby
-begin
-  
-  data, status_code, headers = api_instance.scorecards_create_with_http_info(x_account_token, remote_user_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Scorecard>
-rescue MergeATSClient::ApiError => e
-  puts "Error when calling ScorecardsApi->scorecards_create_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **x_account_token** | **String** | Token identifying the end user. |  |
-| **remote_user_id** | **String** | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. |  |
-| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
-| **scorecard_request** | [**ScorecardRequest**](ScorecardRequest.md) |  | [optional] |
-
-### Return type
-
-[**Scorecard**](Scorecard.md)
-
-### Authorization
-
-[tokenAuth](../README.md#tokenAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
 ## scorecards_list
 
 > <PaginatedScorecardList> scorecards_list(x_account_token, opts)
@@ -104,9 +24,9 @@ require 'merge_ats_client'
 # setup authorization
 MergeATSClient.configure do |config|
   # Configure API key authorization: tokenAuth
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Authorization'] = 'Bearer'
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
 end
 
 api_instance = MergeATSClient::ScorecardsApi.new
@@ -117,6 +37,7 @@ opts = {
   created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
   cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
   expand: 'application', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
   include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
   interview_id: 'interview_id_example', # String | If provided, will only return scorecards for this interview.
   interviewer_id: 'interviewer_id_example', # String | If provided, will only return scorecards for this interviewer.
@@ -163,6 +84,7 @@ end
 | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
 | **cursor** | **String** | The pagination cursor value. | [optional] |
 | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
 | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
 | **interview_id** | **String** | If provided, will only return scorecards for this interview. | [optional] |
 | **interviewer_id** | **String** | If provided, will only return scorecards for this interviewer. | [optional] |
@@ -201,9 +123,9 @@ require 'merge_ats_client'
 # setup authorization
 MergeATSClient.configure do |config|
   # Configure API key authorization: tokenAuth
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Authorization'] = 'Bearer'
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
 end
 
 api_instance = MergeATSClient::ScorecardsApi.new

data/docs/SyncStatusApi.md

@@ -5,7 +5,6 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**sync_status_list**](SyncStatusApi.md#sync_status_list) | **GET** /sync-status |  |
-| [**sync_status_resync_create**](SyncStatusApi.md#sync_status_resync_create) | **POST** /sync-status/resync |  |
 
 
 ## sync_status_list
@@ -14,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
 
 
 
-Get syncing status.
+Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `SYNCING`
 
 ### Examples
 
@@ -32,7 +31,7 @@ end
 api_instance = MergeATSClient::SyncStatusApi.new
 x_account_token = 'x_account_token_example' # String | Token identifying the end user.
 opts = {
-  cursor: 56, # Integer | The pagination cursor value.
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
   page_size: 56 # Integer | Number of results to return per page.
 }
 
@@ -68,7 +67,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **x_account_token** | **String** | Token identifying the end user. |  |
-| **cursor** | **Integer** | The pagination cursor value. | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
 | **page_size** | **Integer** | Number of results to return per page. | [optional] |
 
 ### Return type
@@ -84,74 +83,3 @@ end
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
-
-## sync_status_resync_create
-
-> <SyncStatus> sync_status_resync_create(x_account_token)
-
-
-
-Force resync of all models.
-
-### Examples
-
-```ruby
-require 'time'
-require 'merge_ats_client'
-# setup authorization
-MergeATSClient.configure do |config|
-  # Configure API key authorization: tokenAuth
-  config.api_key['tokenAuth'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['tokenAuth'] = 'Bearer'
-end
-
-api_instance = MergeATSClient::SyncStatusApi.new
-x_account_token = 'x_account_token_example' # String | Token identifying the end user.
-
-begin
-  
-  result = api_instance.sync_status_resync_create(x_account_token)
-  p result
-rescue MergeATSClient::ApiError => e
-  puts "Error when calling SyncStatusApi->sync_status_resync_create: #{e}"
-end
-```
-
-#### Using the sync_status_resync_create_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<SyncStatus>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)
-
-```ruby
-begin
-  
-  data, status_code, headers = api_instance.sync_status_resync_create_with_http_info(x_account_token)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <SyncStatus>
-rescue MergeATSClient::ApiError => e
-  puts "Error when calling SyncStatusApi->sync_status_resync_create_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **x_account_token** | **String** | Token identifying the end user. |  |
-
-### Return type
-
-[**SyncStatus**](SyncStatus.md)
-
-### Authorization
-
-[tokenAuth](../README.md#tokenAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/Tag.md

@@ -7,6 +7,7 @@
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
 | **name** | **String** | The tag's name. | [optional] |
 | **remote_data** | **Array<Hash<String, AnyType>>** |  | [optional] |
+| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'merge_ats_client'
 instance = MergeATSClient::Tag.new(
   remote_id: 4567,
   name: High-Priority,
-  remote_data: [{"path":"/tags","data":["Varies by platform"]}]
+  remote_data: [{"path":"/tags","data":["Varies by platform"]}],
+  remote_was_deleted: null
 )
 ```
 

data/docs/TagsApi.md

@@ -23,9 +23,9 @@ require 'merge_ats_client'
 # setup authorization
 MergeATSClient.configure do |config|
   # Configure API key authorization: tokenAuth
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Authorization'] = 'Bearer'
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
 end
 
 api_instance = MergeATSClient::TagsApi.new
@@ -34,6 +34,7 @@ opts = {
   created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
   created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
   cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
   include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
   modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
   modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
@@ -76,6 +77,7 @@ end
 | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
 | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
 | **cursor** | **String** | The pagination cursor value. | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
 | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
 | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
 | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |

data/docs/UsersApi.md

@@ -4,90 +4,10 @@ All URIs are relative to *https://api.merge.dev/api/ats/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**users_create**](UsersApi.md#users_create) | **POST** /users |  |
 | [**users_list**](UsersApi.md#users_list) | **GET** /users |  |
 | [**users_retrieve**](UsersApi.md#users_retrieve) | **GET** /users/{id} |  |
 
 
-## users_create
-
-> <RemoteUser> users_create(x_account_token, remote_user_id, opts)
-
-
-
-Creates a `RemoteUser` object with the given values.
-
-### Examples
-
-```ruby
-require 'time'
-require 'merge_ats_client'
-# setup authorization
-MergeATSClient.configure do |config|
-  # Configure API key authorization: tokenAuth
-  config.api_key['tokenAuth'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['tokenAuth'] = 'Bearer'
-end
-
-api_instance = MergeATSClient::UsersApi.new
-x_account_token = 'x_account_token_example' # String | Token identifying the end user.
-remote_user_id = 'remote_user_id_example' # String | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.
-opts = {
-  run_async: true, # Boolean | Whether or not third-party updates should be run asynchronously.
-  remote_user_request: MergeATSClient::RemoteUserRequest.new # RemoteUserRequest | 
-}
-
-begin
-  
-  result = api_instance.users_create(x_account_token, remote_user_id, opts)
-  p result
-rescue MergeATSClient::ApiError => e
-  puts "Error when calling UsersApi->users_create: #{e}"
-end
-```
-
-#### Using the users_create_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<RemoteUser>, Integer, Hash)> users_create_with_http_info(x_account_token, remote_user_id, opts)
-
-```ruby
-begin
-  
-  data, status_code, headers = api_instance.users_create_with_http_info(x_account_token, remote_user_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <RemoteUser>
-rescue MergeATSClient::ApiError => e
-  puts "Error when calling UsersApi->users_create_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **x_account_token** | **String** | Token identifying the end user. |  |
-| **remote_user_id** | **String** | The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table. |  |
-| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
-| **remote_user_request** | [**RemoteUserRequest**](RemoteUserRequest.md) |  | [optional] |
-
-### Return type
-
-[**RemoteUser**](RemoteUser.md)
-
-### Authorization
-
-[tokenAuth](../README.md#tokenAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
 ## users_list
 
 > <PaginatedRemoteUserList> users_list(x_account_token, opts)
@@ -104,9 +24,9 @@ require 'merge_ats_client'
 # setup authorization
 MergeATSClient.configure do |config|
   # Configure API key authorization: tokenAuth
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Authorization'] = 'Bearer'
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
 end
 
 api_instance = MergeATSClient::UsersApi.new
@@ -115,6 +35,8 @@ opts = {
   created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
   created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
   cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  email: TODO, # String | If provided, will only return remote users with the given email address
+  include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
   include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
   modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
   modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
@@ -158,6 +80,7 @@ end
 | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
 | **cursor** | **String** | The pagination cursor value. | [optional] |
 | **email** | [**String**](.md) | If provided, will only return remote users with the given email address | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
 | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
 | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
 | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
@@ -194,9 +117,9 @@ require 'merge_ats_client'
 # setup authorization
 MergeATSClient.configure do |config|
   # Configure API key authorization: tokenAuth
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Authorization'] = 'Bearer'
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
 end
 
 api_instance = MergeATSClient::UsersApi.new

data/docs/ValidationProblemSource.md

@@ -0,0 +1,18 @@
+# MergeATSClient::ValidationProblemSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pointer** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::ValidationProblemSource.new(
+  pointer: null
+)
+```
+

data/docs/WarningValidationProblem.md

@@ -0,0 +1,24 @@
+# MergeATSClient::WarningValidationProblem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source** | [**ValidationProblemSource**](ValidationProblemSource.md) |  | [optional] |
+| **title** | **String** |  |  |
+| **detail** | **String** |  |  |
+| **problem_type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::WarningValidationProblem.new(
+  source: null,
+  title: Unrecognized Field,
+  detail: An unrecognized field, age, was passed in with request data.,
+  problem_type: UNRECOGNIZED_FIELD
+)
+```
+

data/docs/WebhookReceiver.md

@@ -0,0 +1,22 @@
+# MergeATSClient::WebhookReceiver
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** |  |  |
+| **is_active** | **Boolean** |  |  |
+| **key** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::WebhookReceiver.new(
+  event: null,
+  is_active: null,
+  key: null
+)
+```
+

data/docs/WebhookReceiverRequest.md

@@ -0,0 +1,22 @@
+# MergeATSClient::WebhookReceiverRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** |  |  |
+| **is_active** | **Boolean** |  |  |
+| **key** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::WebhookReceiverRequest.new(
+  event: null,
+  is_active: null,
+  key: null
+)
+```
+