merge_ats_client 1.0.1

data/docs/PatchedApplicationRequest.md

@@ -0,0 +1,34 @@
+# MergeATSClient::PatchedApplicationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **candidate** | **String** | The candidate applying. | [optional] |
+| **job** | **String** | The job being applied for. | [optional] |
+| **applied_at** | **Time** | When the application was submitted. | [optional] |
+| **rejected_at** | **Time** | When the application was rejected. | [optional] |
+| **source** | **String** | The application's source. | [optional] |
+| **credited_to** | **String** | The user credited for this application. | [optional] |
+| **current_stage** | **String** | The application's current stage. | [optional] |
+| **reject_reason** | **String** | The application's reason for rejection. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::PatchedApplicationRequest.new(
+  remote_id: 98796,
+  candidate: 2872ba14-4084-492b-be96-e5eee6fc33ef,
+  job: 52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633,
+  applied_at: null,
+  rejected_at: null,
+  source: Campus recruiting event,
+  credited_to: 58166795-8d68-4b30-9bfb-bfd402479484,
+  current_stage: d578dfdc-7b0a-4ab6-a2b0-4b40f20eb9ea,
+  reject_reason: 59b25f2b-da02-40f5-9656-9fa0db555784
+)
+```
+

data/docs/PhoneNumber.md

@@ -0,0 +1,20 @@
+# MergeATSClient::PhoneNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** | The phone number. | [optional] |
+| **phone_number_type** | [**PhoneNumberTypeEnum**](PhoneNumberTypeEnum.md) | The type of phone number. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::PhoneNumber.new(
+  value: +3198675309,
+  phone_number_type: HOME
+)
+```
+

data/docs/PhoneNumberRequest.md

@@ -0,0 +1,20 @@
+# MergeATSClient::PhoneNumberRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** | The phone number. | [optional] |
+| **phone_number_type** | [**PhoneNumberTypeEnum**](PhoneNumberTypeEnum.md) | The type of phone number. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::PhoneNumberRequest.new(
+  value: +3198675309,
+  phone_number_type: HOME
+)
+```
+

data/docs/PhoneNumberTypeEnum.md

@@ -0,0 +1,15 @@
+# MergeATSClient::PhoneNumberTypeEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::PhoneNumberTypeEnum.new()
+```
+

data/docs/RaceEnum.md

@@ -0,0 +1,15 @@
+# MergeATSClient::RaceEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::RaceEnum.new()
+```
+

data/docs/RegenerateKeyApi.md

@@ -0,0 +1,79 @@
+# MergeATSClient::RegenerateKeyApi
+
+All URIs are relative to *https://api.merge.dev/api/ats/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**regenerate_key_create**](RegenerateKeyApi.md#regenerate_key_create) | **POST** /regenerate-key |  |
+
+
+## regenerate_key_create
+
+> <RemoteKey> regenerate_key_create(remote_key_for_regeneration_request)
+
+
+
+Exchange remote keys.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_ats_client'
+# setup authorization
+MergeATSClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = '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'
+end
+
+api_instance = MergeATSClient::RegenerateKeyApi.new
+remote_key_for_regeneration_request = MergeATSClient::RemoteKeyForRegenerationRequest.new({name: 'Remote Deployment Key 1'}) # RemoteKeyForRegenerationRequest | 
+
+begin
+  
+  result = api_instance.regenerate_key_create(remote_key_for_regeneration_request)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling RegenerateKeyApi->regenerate_key_create: #{e}"
+end
+```
+
+#### Using the regenerate_key_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RemoteKey>, Integer, Hash)> regenerate_key_create_with_http_info(remote_key_for_regeneration_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.regenerate_key_create_with_http_info(remote_key_for_regeneration_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RemoteKey>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling RegenerateKeyApi->regenerate_key_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_key_for_regeneration_request** | [**RemoteKeyForRegenerationRequest**](RemoteKeyForRegenerationRequest.md) |  |  |
+
+### Return type
+
+[**RemoteKey**](RemoteKey.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/RejectReason.md

@@ -0,0 +1,24 @@
+# MergeATSClient::RejectReason
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **name** | **String** | The rejection reason’s name. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::RejectReason.new(
+  id: 8be99a4a-f8d4-4339-bf1e-30eac970e217,
+  remote_id: 876556788,
+  name: Not passionate enough about APIs.,
+  remote_data: [{"path":"/rejection-reasons","data":["Varies by platform"]}]
+)
+```
+

data/docs/RejectReasonsApi.md

@@ -0,0 +1,175 @@
+# MergeATSClient::RejectReasonsApi
+
+All URIs are relative to *https://api.merge.dev/api/ats/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**reject_reasons_list**](RejectReasonsApi.md#reject_reasons_list) | **GET** /reject-reasons |  |
+| [**reject_reasons_retrieve**](RejectReasonsApi.md#reject_reasons_retrieve) | **GET** /reject-reasons/{id} |  |
+
+
+## reject_reasons_list
+
+> <PaginatedRejectReasonList> reject_reasons_list(x_account_token, opts)
+
+
+
+Returns a list of `RejectReason` objects.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_ats_client'
+# setup authorization
+MergeATSClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = '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'
+end
+
+api_instance = MergeATSClient::RejectReasonsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+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_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.
+  page_size: 56, # Integer | Number of results to return per page.
+  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+}
+
+begin
+  
+  result = api_instance.reject_reasons_list(x_account_token, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling RejectReasonsApi->reject_reasons_list: #{e}"
+end
+```
+
+#### Using the reject_reasons_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedRejectReasonList>, Integer, Hash)> reject_reasons_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.reject_reasons_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedRejectReasonList>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling RejectReasonsApi->reject_reasons_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **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_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] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+
+### Return type
+
+[**PaginatedRejectReasonList**](PaginatedRejectReasonList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## reject_reasons_retrieve
+
+> <RejectReason> reject_reasons_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `RejectReason` object with the given `id`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_ats_client'
+# setup authorization
+MergeATSClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = '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'
+end
+
+api_instance = MergeATSClient::RejectReasonsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+}
+
+begin
+  
+  result = api_instance.reject_reasons_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling RejectReasonsApi->reject_reasons_retrieve: #{e}"
+end
+```
+
+#### Using the reject_reasons_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RejectReason>, Integer, Hash)> reject_reasons_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.reject_reasons_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RejectReason>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling RejectReasonsApi->reject_reasons_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**RejectReason**](RejectReason.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RemoteData.md

@@ -0,0 +1,20 @@
+# MergeATSClient::RemoteData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** |  |  |
+| **data** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::RemoteData.new(
+  path: null,
+  data: null
+)
+```
+

data/docs/RemoteDataRequest.md

@@ -0,0 +1,20 @@
+# MergeATSClient::RemoteDataRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** |  |  |
+| **data** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::RemoteDataRequest.new(
+  path: null,
+  data: null
+)
+```
+

data/docs/RemoteKey.md

@@ -0,0 +1,20 @@
+# MergeATSClient::RemoteKey
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **key** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::RemoteKey.new(
+  name: Remote Deployment Key 1,
+  key: hXY57W0g0WkdRHjCaPvwijK63fwfN-o_Wh7f30SLTq_uPCOLo-WFcA
+)
+```
+