merge_ats_client 1.0.1

data/docs/Activity.md

@@ -0,0 +1,34 @@
+# MergeATSClient::Activity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **user** | **String** | The user the performed the action. | [optional] |
+| **remote_created_at** | **Time** | When the third party's activity was created. | [optional] |
+| **activity_type** | [**ActivityTypeEnum**](ActivityTypeEnum.md) | The activity's type. | [optional] |
+| **subject** | **String** | The activity's subject. | [optional] |
+| **body** | **String** | The activity's body. | [optional] |
+| **visibility** | [**VisibilityEnum**](VisibilityEnum.md) | The activity's visibility. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::Activity.new(
+  id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4,
+  remote_id: 198123,
+  user: 9d892439-5fab-4dbb-8bd8-34f7f96c7912,
+  remote_created_at: null,
+  activity_type: NOTE,
+  subject: Gil Feig's applicant status,
+  body: Candidate will only join if we provide a Barry's subsidy.,
+  visibility: PRIVATE,
+  remote_data: [{"path":"/actions","data":["Varies by platform"]}]
+)
+```
+

data/docs/ActivityTypeEnum.md

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

data/docs/Application.md

@@ -0,0 +1,38 @@
+# MergeATSClient::Application
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **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] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::Application.new(
+  id: 92e8a369-fffe-430d-b93a-f7e8a16563f1,
+  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,
+  remote_data: [{"path":"/candidacies","data":["Varies by platform"]}]
+)
+```
+

data/docs/ApplicationRequest.md

@@ -0,0 +1,34 @@
+# MergeATSClient::ApplicationRequest
+
+## 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::ApplicationRequest.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/ApplicationsApi.md

@@ -0,0 +1,351 @@
+# MergeATSClient::ApplicationsApi
+
+All URIs are relative to *https://api.merge.dev/api/ats/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**applications_create**](ApplicationsApi.md#applications_create) | **POST** /applications |  |
+| [**applications_list**](ApplicationsApi.md#applications_list) | **GET** /applications |  |
+| [**applications_partial_update**](ApplicationsApi.md#applications_partial_update) | **PATCH** /applications/{id} |  |
+| [**applications_retrieve**](ApplicationsApi.md#applications_retrieve) | **GET** /applications/{id} |  |
+
+
+## applications_create
+
+> <Application> applications_create(x_account_token, remote_user_id, opts)
+
+
+
+Creates an `Application` 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::ApplicationsApi.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.
+  application_request: MergeATSClient::ApplicationRequest.new # ApplicationRequest | 
+}
+
+begin
+  
+  result = api_instance.applications_create(x_account_token, remote_user_id, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling ApplicationsApi->applications_create: #{e}"
+end
+```
+
+#### Using the applications_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Application>, Integer, Hash)> applications_create_with_http_info(x_account_token, remote_user_id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.applications_create_with_http_info(x_account_token, remote_user_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Application>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling ApplicationsApi->applications_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] |
+| **application_request** | [**ApplicationRequest**](ApplicationRequest.md) |  | [optional] |
+
+### Return type
+
+[**Application**](Application.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## applications_list
+
+> <PaginatedApplicationList> applications_list(x_account_token, opts)
+
+
+
+Returns a list of `Application` 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::ApplicationsApi.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 applications 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.
+  credited_to_id: 'credited_to_id_example', # String | If provided, will only return applications credited to this user.
+  current_stage_id: 'current_stage_id_example', # String | If provided, will only return applications at this interview stage.
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  expand: 'candidate', # 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.
+  job_id: 'job_id_example', # String | If provided, will only return applications for this job.
+  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.
+  reject_reason_id: 'reject_reason_id_example', # String | If provided, will only return applications with this reject reason.
+  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+}
+
+begin
+  
+  result = api_instance.applications_list(x_account_token, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling ApplicationsApi->applications_list: #{e}"
+end
+```
+
+#### Using the applications_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedApplicationList>, Integer, Hash)> applications_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.applications_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedApplicationList>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling ApplicationsApi->applications_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 applications 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] |
+| **credited_to_id** | **String** | If provided, will only return applications credited to this user. | [optional] |
+| **current_stage_id** | **String** | If provided, will only return applications at this interview stage. | [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] |
+| **job_id** | **String** | If provided, will only return applications for this job. | [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] |
+| **reject_reason_id** | **String** | If provided, will only return applications with this reject reason. | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+
+### Return type
+
+[**PaginatedApplicationList**](PaginatedApplicationList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## applications_partial_update
+
+> <Application> applications_partial_update(x_account_token, id, remote_user_id, opts)
+
+
+
+Updates an `Application` 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::ApplicationsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+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.
+  patched_application_request: MergeATSClient::PatchedApplicationRequest.new # PatchedApplicationRequest | 
+}
+
+begin
+  
+  result = api_instance.applications_partial_update(x_account_token, id, remote_user_id, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling ApplicationsApi->applications_partial_update: #{e}"
+end
+```
+
+#### Using the applications_partial_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Application>, Integer, Hash)> applications_partial_update_with_http_info(x_account_token, id, remote_user_id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.applications_partial_update_with_http_info(x_account_token, id, remote_user_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Application>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling ApplicationsApi->applications_partial_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **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] |
+| **patched_application_request** | [**PatchedApplicationRequest**](PatchedApplicationRequest.md) |  | [optional] |
+
+### Return type
+
+[**Application**](Application.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## applications_retrieve
+
+> <Application> applications_retrieve(x_account_token, id, opts)
+
+
+
+Returns an `Application` 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::ApplicationsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  expand: 'candidate', # 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.applications_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling ApplicationsApi->applications_retrieve: #{e}"
+end
+```
+
+#### Using the applications_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Application>, Integer, Hash)> applications_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.applications_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Application>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling ApplicationsApi->applications_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
+
+[**Application**](Application.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+