merge_ats_client 1.0.1

data/docs/EmailAddress.md

@@ -0,0 +1,20 @@
+# MergeATSClient::EmailAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** | The email address. | [optional] |
+| **email_address_type** | [**EmailAddressTypeEnum**](EmailAddressTypeEnum.md) | The type of email address. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::EmailAddress.new(
+  value: merge_is_hiring@gmail.com,
+  email_address_type: PERSONAL
+)
+```
+

data/docs/EmailAddressRequest.md

@@ -0,0 +1,20 @@
+# MergeATSClient::EmailAddressRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** | The email address. | [optional] |
+| **email_address_type** | [**EmailAddressTypeEnum**](EmailAddressTypeEnum.md) | The type of email address. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::EmailAddressRequest.new(
+  value: merge_is_hiring@gmail.com,
+  email_address_type: PERSONAL
+)
+```
+

data/docs/EmailAddressTypeEnum.md

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

data/docs/EndUserDetails.md

@@ -0,0 +1,24 @@
+# MergeATSClient::EndUserDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **end_user_email_address** | **String** |  |  |
+| **end_user_organization_name** | **String** |  |  |
+| **end_user_origin_id** | **String** |  |  |
+| **categories** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::EndUserDetails.new(
+  end_user_email_address: null,
+  end_user_organization_name: null,
+  end_user_origin_id: null,
+  categories: null
+)
+```
+

data/docs/EndUserDetailsRequest.md

@@ -0,0 +1,26 @@
+# MergeATSClient::EndUserDetailsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **end_user_email_address** | **String** |  |  |
+| **end_user_organization_name** | **String** |  |  |
+| **end_user_origin_id** | **String** |  |  |
+| **categories** | **Array<String>** |  |  |
+| **integration** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::EndUserDetailsRequest.new(
+  end_user_email_address: null,
+  end_user_organization_name: null,
+  end_user_origin_id: null,
+  categories: null,
+  integration: null
+)
+```
+

data/docs/GenderEnum.md

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

data/docs/GenerateKeyApi.md

@@ -0,0 +1,79 @@
+# MergeATSClient::GenerateKeyApi
+
+All URIs are relative to *https://api.merge.dev/api/ats/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**generate_key_create**](GenerateKeyApi.md#generate_key_create) | **POST** /generate-key |  |
+
+
+## generate_key_create
+
+> <RemoteKey> generate_key_create(generate_remote_key_request)
+
+
+
+Create a remote key.
+
+### 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::GenerateKeyApi.new
+generate_remote_key_request = MergeATSClient::GenerateRemoteKeyRequest.new({name: 'Remote Deployment Key 1'}) # GenerateRemoteKeyRequest | 
+
+begin
+  
+  result = api_instance.generate_key_create(generate_remote_key_request)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling GenerateKeyApi->generate_key_create: #{e}"
+end
+```
+
+#### Using the generate_key_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RemoteKey>, Integer, Hash)> generate_key_create_with_http_info(generate_remote_key_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.generate_key_create_with_http_info(generate_remote_key_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RemoteKey>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling GenerateKeyApi->generate_key_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **generate_remote_key_request** | [**GenerateRemoteKeyRequest**](GenerateRemoteKeyRequest.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/GenerateRemoteKeyRequest.md

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

data/docs/InterviewsApi.md

@@ -0,0 +1,185 @@
+# MergeATSClient::InterviewsApi
+
+All URIs are relative to *https://api.merge.dev/api/ats/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**interviews_list**](InterviewsApi.md#interviews_list) | **GET** /interviews |  |
+| [**interviews_retrieve**](InterviewsApi.md#interviews_retrieve) | **GET** /interviews/{id} |  |
+
+
+## interviews_list
+
+> <PaginatedScheduledInterviewList> interviews_list(x_account_token, opts)
+
+
+
+Returns a list of `ScheduledInterview` 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::InterviewsApi.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 interviews 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.
+  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.
+  job_interview_stage_id: 'job_interview_stage_id_example', # String | If provided, will only return interviews at this stage.
+  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.
+  organizer_id: 'organizer_id_example', # String | If provided, will only return interviews organized by this user.
+  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.interviews_list(x_account_token, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling InterviewsApi->interviews_list: #{e}"
+end
+```
+
+#### Using the interviews_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedScheduledInterviewList>, Integer, Hash)> interviews_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.interviews_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedScheduledInterviewList>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling InterviewsApi->interviews_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 interviews 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] |
+| **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_interview_stage_id** | **String** | If provided, will only return interviews at this stage. | [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] |
+| **organizer_id** | **String** | If provided, will only return interviews organized by this user. | [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
+
+[**PaginatedScheduledInterviewList**](PaginatedScheduledInterviewList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## interviews_retrieve
+
+> <ScheduledInterview> interviews_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `ScheduledInterview` 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::InterviewsApi.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.interviews_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling InterviewsApi->interviews_retrieve: #{e}"
+end
+```
+
+#### Using the interviews_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ScheduledInterview>, Integer, Hash)> interviews_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.interviews_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ScheduledInterview>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling InterviewsApi->interviews_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
+
+[**ScheduledInterview**](ScheduledInterview.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Job.md

@@ -0,0 +1,40 @@
+# MergeATSClient::Job
+
+## 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 job's name. | [optional] |
+| **description** | **String** | The job's description. | [optional] |
+| **status** | [**JobStatusEnum**](JobStatusEnum.md) | The job's status. | [optional] |
+| **remote_created_at** | **Time** | When the third party's job was created. | [optional] |
+| **remote_updated_at** | **Time** | When the third party's job was updated. | [optional] |
+| **confidential** | **Boolean** | Whether the job is confidential. | [optional] |
+| **departments** | **Array<String>** |  | [optional] |
+| **offices** | **Array<String>** |  | [optional] |
+| **hiring_managers** | **Array<String>** |  | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_ats_client'
+
+instance = MergeATSClient::Job.new(
+  id: 022a2bef-57e5-4def-8ed2-7c41bd9a5ed8,
+  remote_id: 8765432,
+  name: Software Engineer (Merge is actually hiring btw),
+  description: If you're reading this documentation. You might be a good fit!,
+  status: OPEN,
+  remote_created_at: null,
+  remote_updated_at: null,
+  confidential: true,
+  departments: ["5b3c1341-a20f-4e51-b72c-f3830a16c97b","d6e687d6-0c36-48a1-8114-35324b5cb38f"],
+  offices: ["9871b4a9-f5d2-4f3b-a66b-dfedbed42c46"],
+  hiring_managers: ["787ed912-33ec-444e-a215-8d71cc42fc12"],
+  remote_data: [{"path":"/positions","data":["Varies by platform"]}]
+)
+```
+