merge_ats_client 1.0.1

data/docs/Attachment.md

@@ -0,0 +1,28 @@
+# MergeATSClient::Attachment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **file_name** | **String** | The attachment's name. | [optional] |
+| **file_url** | **String** | The attachment's url. | [optional] |
+| **candidate** | **String** |  | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::Attachment.new(
+  id: c640b80b-fac9-409f-aa19-1f9221aec445,
+  remote_id: 11167,
+  file_name: Candidate Resume,
+  file_url: http://alturl.com/p749b,
+  candidate: 2872ba14-4084-492b-be96-e5eee6fc33ef,
+  remote_data: [{"path":"/attachments","data":["Varies by platform"]}]
+)
+```
+

data/docs/AttachmentsApi.md

@@ -0,0 +1,177 @@
+# MergeATSClient::AttachmentsApi
+
+All URIs are relative to *https://api.merge.dev/api/ats/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**attachments_list**](AttachmentsApi.md#attachments_list) | **GET** /attachments |  |
+| [**attachments_retrieve**](AttachmentsApi.md#attachments_retrieve) | **GET** /attachments/{id} |  |
+
+
+## attachments_list
+
+> <PaginatedAttachmentList> attachments_list(x_account_token, opts)
+
+
+
+Returns a list of `Attachment` 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::AttachmentsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  candidate_id: 'candidate_id_example', # String | If provided, will only return attachments for this candidate.
+  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.attachments_list(x_account_token, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling AttachmentsApi->attachments_list: #{e}"
+end
+```
+
+#### Using the attachments_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedAttachmentList>, Integer, Hash)> attachments_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.attachments_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedAttachmentList>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling AttachmentsApi->attachments_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **candidate_id** | **String** | If provided, will only return attachments for this candidate. | [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] |
+| **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
+
+[**PaginatedAttachmentList**](PaginatedAttachmentList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## attachments_retrieve
+
+> <Attachment> attachments_retrieve(x_account_token, id, opts)
+
+
+
+Returns an `Attachment` 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::AttachmentsApi.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.attachments_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling AttachmentsApi->attachments_retrieve: #{e}"
+end
+```
+
+#### Using the attachments_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Attachment>, Integer, Hash)> attachments_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.attachments_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Attachment>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling AttachmentsApi->attachments_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
+
+[**Attachment**](Attachment.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AvailableActions.md

@@ -0,0 +1,22 @@
+# MergeATSClient::AvailableActions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **integration** | [**AccountIntegration**](AccountIntegration.md) |  |  |
+| **passthrough_available** | **Boolean** |  |  |
+| **available_model_operations** | [**Array<ModelOperation>**](ModelOperation.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::AvailableActions.new(
+  integration: null,
+  passthrough_available: true,
+  available_model_operations: [{"model_name":"Candidate","available_operations":["FETCH","CREATE"]}]
+)
+```
+

data/docs/AvailableActionsApi.md

@@ -0,0 +1,79 @@
+# MergeATSClient::AvailableActionsApi
+
+All URIs are relative to *https://api.merge.dev/api/ats/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**available_actions_retrieve**](AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions |  |
+
+
+## available_actions_retrieve
+
+> <AvailableActions> available_actions_retrieve(x_account_token)
+
+
+
+Returns a list of models and actions available for an account.
+
+### 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::AvailableActionsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.available_actions_retrieve(x_account_token)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling AvailableActionsApi->available_actions_retrieve: #{e}"
+end
+```
+
+#### Using the available_actions_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AvailableActions>, Integer, Hash)> available_actions_retrieve_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.available_actions_retrieve_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AvailableActions>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling AvailableActionsApi->available_actions_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+[**AvailableActions**](AvailableActions.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Candidate.md

@@ -0,0 +1,54 @@
+# MergeATSClient::Candidate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **first_name** | **String** | The candidate's first name. | [optional] |
+| **last_name** | **String** | The candidate's last name. | [optional] |
+| **company** | **String** | The candidate's current company. | [optional] |
+| **title** | **String** | The candidate's current title. | [optional] |
+| **remote_created_at** | **Time** | When the third party's candidate was created. | [optional] |
+| **remote_updated_at** | **Time** | When the third party's candidate was updated. | [optional] |
+| **last_interaction_at** | **Time** | When the most recent candidate interaction occurred. | [optional] |
+| **is_private** | **Boolean** | Whether or not the candidate is private. | [optional] |
+| **can_email** | **Boolean** | Whether or not the candidate can be emailed. | [optional] |
+| **locations** | **Array<String>** | The candidate's locations. | [optional] |
+| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) |  | [optional] |
+| **email_addresses** | [**Array<EmailAddress>**](EmailAddress.md) |  | [optional] |
+| **urls** | [**Array<Url>**](Url.md) |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **applications** | **Array<String>** |  | [optional][readonly] |
+| **attachments** | **Array<String>** |  | [optional][readonly] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::Candidate.new(
+  id: 521b18c2-4d01-4297-b451-19858d07c133,
+  remote_id: 21198,
+  first_name: Gil,
+  last_name: Feig,
+  company: Columbia Dining App.,
+  title: Software Engineer,
+  remote_created_at: null,
+  remote_updated_at: null,
+  last_interaction_at: null,
+  is_private: true,
+  can_email: true,
+  locations: ["San Francisco","New York","Miami"],
+  phone_numbers: [{"value":"+1234567890","phone_number_type":"MOBILE"}],
+  email_addresses: [{"value":"hello@merge.dev","email_address_type":"PERSONAL"}],
+  urls: [{"value":"http://alturl.com/p749b","url_type":"BLOG"}],
+  tags: ["High-Priority"],
+  applications: ["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],
+  attachments: ["bea08964-32b4-4a20-8bb4-2612ba09de1d"],
+  remote_data: [{"path":"/candidates","data":["Varies by platform"]}]
+)
+```
+

data/docs/CandidateRequest.md

@@ -0,0 +1,46 @@
+# MergeATSClient::CandidateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **first_name** | **String** | The candidate's first name. | [optional] |
+| **last_name** | **String** | The candidate's last name. | [optional] |
+| **company** | **String** | The candidate's current company. | [optional] |
+| **title** | **String** | The candidate's current title. | [optional] |
+| **remote_created_at** | **Time** | When the third party's candidate was created. | [optional] |
+| **remote_updated_at** | **Time** | When the third party's candidate was updated. | [optional] |
+| **last_interaction_at** | **Time** | When the most recent candidate interaction occurred. | [optional] |
+| **is_private** | **Boolean** | Whether or not the candidate is private. | [optional] |
+| **can_email** | **Boolean** | Whether or not the candidate can be emailed. | [optional] |
+| **locations** | **Array<String>** | The candidate's locations. | [optional] |
+| **phone_numbers** | [**Array<PhoneNumberRequest>**](PhoneNumberRequest.md) |  | [optional] |
+| **email_addresses** | [**Array<EmailAddressRequest>**](EmailAddressRequest.md) |  | [optional] |
+| **urls** | [**Array<UrlRequest>**](UrlRequest.md) |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::CandidateRequest.new(
+  remote_id: 21198,
+  first_name: Gil,
+  last_name: Feig,
+  company: Columbia Dining App.,
+  title: Software Engineer,
+  remote_created_at: null,
+  remote_updated_at: null,
+  last_interaction_at: null,
+  is_private: true,
+  can_email: true,
+  locations: ["San Francisco","New York","Miami"],
+  phone_numbers: [{"value":"+1234567890","phone_number_type":"MOBILE"}],
+  email_addresses: [{"value":"hello@merge.dev","email_address_type":"PERSONAL"}],
+  urls: [{"value":"http://alturl.com/p749b","url_type":"BLOG"}],
+  tags: ["High-Priority"]
+)
+```
+

data/docs/CandidatesApi.md

@@ -0,0 +1,259 @@
+# MergeATSClient::CandidatesApi
+
+All URIs are relative to *https://api.merge.dev/api/ats/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**candidates_create**](CandidatesApi.md#candidates_create) | **POST** /candidates |  |
+| [**candidates_list**](CandidatesApi.md#candidates_list) | **GET** /candidates |  |
+| [**candidates_retrieve**](CandidatesApi.md#candidates_retrieve) | **GET** /candidates/{id} |  |
+
+
+## candidates_create
+
+> <Candidate> candidates_create(x_account_token, remote_user_id, opts)
+
+
+
+Creates a `Candidate` 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['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::CandidatesApi.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.
+  candidate_request: MergeATSClient::CandidateRequest.new # CandidateRequest | 
+}
+
+begin
+  
+  result = api_instance.candidates_create(x_account_token, remote_user_id, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling CandidatesApi->candidates_create: #{e}"
+end
+```
+
+#### Using the candidates_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Candidate>, Integer, Hash)> candidates_create_with_http_info(x_account_token, remote_user_id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.candidates_create_with_http_info(x_account_token, remote_user_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Candidate>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling CandidatesApi->candidates_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] |
+| **candidate_request** | [**CandidateRequest**](CandidateRequest.md) |  | [optional] |
+
+### Return type
+
+[**Candidate**](Candidate.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## candidates_list
+
+> <PaginatedCandidateList> candidates_list(x_account_token, opts)
+
+
+
+Returns a list of `Candidate` 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::CandidatesApi.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.
+  expand: 'applications', # 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.candidates_list(x_account_token, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling CandidatesApi->candidates_list: #{e}"
+end
+```
+
+#### Using the candidates_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedCandidateList>, Integer, Hash)> candidates_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.candidates_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedCandidateList>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling CandidatesApi->candidates_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] |
+| **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
+
+[**PaginatedCandidateList**](PaginatedCandidateList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## candidates_retrieve
+
+> <Candidate> candidates_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `Candidate` 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::CandidatesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  expand: 'applications', # 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.candidates_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling CandidatesApi->candidates_retrieve: #{e}"
+end
+```
+
+#### Using the candidates_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Candidate>, Integer, Hash)> candidates_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.candidates_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Candidate>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling CandidatesApi->candidates_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
+
+[**Candidate**](Candidate.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+