merge_ats_client 1.0.1

data/docs/MethodEnum.md

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

data/docs/ModelOperation.md

@@ -0,0 +1,22 @@
+# MergeATSClient::ModelOperation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model_name** | **String** |  |  |
+| **available_operations** | **Array<String>** |  |  |
+| **required_post_parameters** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::ModelOperation.new(
+  model_name: Candidate,
+  available_operations: ["FETCH","CREATE"],
+  required_post_parameters: ["remote_user_id"]
+)
+```
+

data/docs/Offer.md

@@ -0,0 +1,36 @@
+# MergeATSClient::Offer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **application** | **String** | The application who is receiving the offer. | [optional] |
+| **creator** | **String** | The user who created the offer. | [optional] |
+| **remote_created_at** | **Time** | When the third party's offer was created. | [optional] |
+| **closed_at** | **Time** | When the offer was closed. | [optional] |
+| **sent_at** | **Time** | When the offer was sent. | [optional] |
+| **start_date** | **Time** | The employment start date on the offer. | [optional] |
+| **status** | [**OfferStatusEnum**](OfferStatusEnum.md) | The offer's status. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::Offer.new(
+  id: dd85625c-6a59-446f-a317-6de64d83bae7,
+  remote_id: 9876,
+  application: 2872ba14-4084-492b-be96-e5eee6fc33ef,
+  creator: 52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633,
+  remote_created_at: null,
+  closed_at: null,
+  sent_at: null,
+  start_date: null,
+  status: SENT,
+  remote_data: [{"path":"/offers","data":["Varies by platform"]}]
+)
+```
+

data/docs/OfferStatusEnum.md

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

data/docs/OffersApi.md

@@ -0,0 +1,183 @@
+# MergeATSClient::OffersApi
+
+All URIs are relative to *https://api.merge.dev/api/ats/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**offers_list**](OffersApi.md#offers_list) | **GET** /offers |  |
+| [**offers_retrieve**](OffersApi.md#offers_retrieve) | **GET** /offers/{id} |  |
+
+
+## offers_list
+
+> <PaginatedOfferList> offers_list(x_account_token, opts)
+
+
+
+Returns a list of `Offer` 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::OffersApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  application_id: 'application_id_example', # String | If provided, will only return offers for this application.
+  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.
+  creator_id: 'creator_id_example', # String | If provided, will only return offers created by this user.
+  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_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.offers_list(x_account_token, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling OffersApi->offers_list: #{e}"
+end
+```
+
+#### Using the offers_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedOfferList>, Integer, Hash)> offers_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.offers_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedOfferList>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling OffersApi->offers_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **application_id** | **String** | If provided, will only return offers for this application. | [optional] |
+| **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] |
+| **creator_id** | **String** | If provided, will only return offers created by this user. | [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_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
+
+[**PaginatedOfferList**](PaginatedOfferList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## offers_retrieve
+
+> <Offer> offers_retrieve(x_account_token, id, opts)
+
+
+
+Returns an `Offer` 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::OffersApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  expand: 'application', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  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.offers_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling OffersApi->offers_retrieve: #{e}"
+end
+```
+
+#### Using the offers_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Offer>, Integer, Hash)> offers_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.offers_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Offer>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling OffersApi->offers_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**Offer**](Offer.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Office.md

@@ -0,0 +1,26 @@
+# MergeATSClient::Office
+
+## 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 office's name. | [optional] |
+| **location** | **String** | The office's location. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::Office.new(
+  id: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46,
+  remote_id: 876556788,
+  name: SF Office,
+  location: Embarcadero Center 2,
+  remote_data: [{"path":"/locations","data":["Varies by platform"]}]
+)
+```
+

data/docs/OfficesApi.md

@@ -0,0 +1,175 @@
+# MergeATSClient::OfficesApi
+
+All URIs are relative to *https://api.merge.dev/api/ats/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**offices_list**](OfficesApi.md#offices_list) | **GET** /offices |  |
+| [**offices_retrieve**](OfficesApi.md#offices_retrieve) | **GET** /offices/{id} |  |
+
+
+## offices_list
+
+> <PaginatedOfficeList> offices_list(x_account_token, opts)
+
+
+
+Returns a list of `Office` 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::OfficesApi.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.offices_list(x_account_token, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling OfficesApi->offices_list: #{e}"
+end
+```
+
+#### Using the offices_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedOfficeList>, Integer, Hash)> offices_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.offices_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedOfficeList>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling OfficesApi->offices_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
+
+[**PaginatedOfficeList**](PaginatedOfficeList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## offices_retrieve
+
+> <Office> offices_retrieve(x_account_token, id, opts)
+
+
+
+Returns an `Office` 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::OfficesApi.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.offices_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling OfficesApi->offices_retrieve: #{e}"
+end
+```
+
+#### Using the offices_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Office>, Integer, Hash)> offices_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.offices_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Office>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling OfficesApi->offices_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
+
+[**Office**](Office.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+