merge_crm_client 1.0.0

data/docs/PaginatedOpportunityList.md

@@ -0,0 +1,22 @@
+# MergeCRMClient::PaginatedOpportunityList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<Opportunity>**](Opportunity.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::PaginatedOpportunityList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PaginatedStageList.md

@@ -0,0 +1,22 @@
+# MergeCRMClient::PaginatedStageList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<Stage>**](Stage.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::PaginatedStageList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PaginatedSyncStatusList.md

@@ -0,0 +1,22 @@
+# MergeCRMClient::PaginatedSyncStatusList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<SyncStatus>**](SyncStatus.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::PaginatedSyncStatusList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PaginatedTaskList.md

@@ -0,0 +1,22 @@
+# MergeCRMClient::PaginatedTaskList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<Task>**](Task.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::PaginatedTaskList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PaginatedUserList.md

@@ -0,0 +1,22 @@
+# MergeCRMClient::PaginatedUserList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<User>**](User.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::PaginatedUserList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PassthroughApi.md

@@ -0,0 +1,81 @@
+# MergeCRMClient::PassthroughApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**passthrough_create**](PassthroughApi.md#passthrough_create) | **POST** /passthrough |  |
+
+
+## passthrough_create
+
+> <RemoteResponse> passthrough_create(x_account_token, data_passthrough_request)
+
+
+
+Pull data from an endpoint not currently supported by Merge.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_crm_client'
+# setup authorization
+MergeCRMClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = '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['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeCRMClient::PassthroughApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+data_passthrough_request = MergeCRMClient::DataPassthroughRequest.new({method: MergeCRMClient::MethodEnum::GET, path: '/scooters'}) # DataPassthroughRequest | 
+
+begin
+  
+  result = api_instance.passthrough_create(x_account_token, data_passthrough_request)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling PassthroughApi->passthrough_create: #{e}"
+end
+```
+
+#### Using the passthrough_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RemoteResponse>, Integer, Hash)> passthrough_create_with_http_info(x_account_token, data_passthrough_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.passthrough_create_with_http_info(x_account_token, data_passthrough_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RemoteResponse>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling PassthroughApi->passthrough_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **data_passthrough_request** | [**DataPassthroughRequest**](DataPassthroughRequest.md) |  |  |
+
+### Return type
+
+[**RemoteResponse**](RemoteResponse.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/PhoneNumber.md

@@ -0,0 +1,20 @@
+# MergeCRMClient::PhoneNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | The phone number. | [optional] |
+| **phone_number_type** | **String** | The phone number's type. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::PhoneNumber.new(
+  phone_number: +3198675309,
+  phone_number_type: Mobile
+)
+```
+

data/docs/PhoneNumberRequest.md

@@ -0,0 +1,20 @@
+# MergeCRMClient::PhoneNumberRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | The phone number. | [optional] |
+| **phone_number_type** | **String** | The phone number's type. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::PhoneNumberRequest.new(
+  phone_number: +3198675309,
+  phone_number_type: Mobile
+)
+```
+

data/docs/RegenerateKeyApi.md

@@ -0,0 +1,79 @@
+# MergeCRMClient::RegenerateKeyApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/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_crm_client'
+# setup authorization
+MergeCRMClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = '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['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeCRMClient::RegenerateKeyApi.new
+remote_key_for_regeneration_request = MergeCRMClient::RemoteKeyForRegenerationRequest.new({name: 'Remote Deployment Key 1'}) # RemoteKeyForRegenerationRequest | 
+
+begin
+  
+  result = api_instance.regenerate_key_create(remote_key_for_regeneration_request)
+  p result
+rescue MergeCRMClient::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 MergeCRMClient::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/RemoteData.md

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

data/docs/RemoteKey.md

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

data/docs/RemoteKeyForRegenerationRequest.md

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

data/docs/RemoteResponse.md

@@ -0,0 +1,28 @@
+# MergeCRMClient::RemoteResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **method** | **String** |  |  |
+| **path** | **String** |  |  |
+| **status** | **Integer** |  |  |
+| **response** | [**Hash<String, AnyType>**](AnyType.md) |  |  |
+| **response_headers** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+| **headers** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::RemoteResponse.new(
+  method: GET,
+  path: /scooters,
+  status: 200,
+  response: {"scooters":[{"company":"Lime","model":"Gen 2.5"},{"company":"Bird","model":"Bird Zero"}]},
+  response_headers: {"X-Page-Token":"value"},
+  headers: {"EXTRA-HEADER":"value","Authorization":"<redacted>"}
+)
+```
+

data/docs/RequestFormatEnum.md

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

data/docs/Stage.md

@@ -0,0 +1,26 @@
+# MergeCRMClient::Stage
+
+## 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 stage's name. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::Stage.new(
+  id: 0358cbc6-2040-430a-848e-aafacbadf3aa,
+  remote_id: 19202938,
+  name: Proposal,
+  remote_data: [{"path":"/stages","data":["Varies by platform"]}],
+  remote_was_deleted: null
+)
+```
+

data/docs/StagesApi.md

@@ -0,0 +1,177 @@
+# MergeCRMClient::StagesApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**stages_list**](StagesApi.md#stages_list) | **GET** /stages |  |
+| [**stages_retrieve**](StagesApi.md#stages_retrieve) | **GET** /stages/{id} |  |
+
+
+## stages_list
+
+> <PaginatedStageList> stages_list(x_account_token, opts)
+
+
+
+Returns a list of `Stage` objects.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_crm_client'
+# setup authorization
+MergeCRMClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = '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['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeCRMClient::StagesApi.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_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
+  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.stages_list(x_account_token, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling StagesApi->stages_list: #{e}"
+end
+```
+
+#### Using the stages_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedStageList>, Integer, Hash)> stages_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.stages_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedStageList>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling StagesApi->stages_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_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [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
+
+[**PaginatedStageList**](PaginatedStageList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## stages_retrieve
+
+> <Stage> stages_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `Stage` object with the given `id`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_crm_client'
+# setup authorization
+MergeCRMClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = '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['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeCRMClient::StagesApi.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.stages_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling StagesApi->stages_retrieve: #{e}"
+end
+```
+
+#### Using the stages_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Stage>, Integer, Hash)> stages_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.stages_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Stage>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling StagesApi->stages_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
+
+[**Stage**](Stage.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SyncStatus.md

@@ -0,0 +1,28 @@
+# MergeCRMClient::SyncStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model_name** | **String** |  |  |
+| **model_id** | **String** |  |  |
+| **last_sync_start** | **Time** |  |  |
+| **next_sync_start** | **Time** |  |  |
+| **status** | [**SyncStatusStatusEnum**](SyncStatusStatusEnum.md) |  |  |
+| **is_initial_sync** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::SyncStatus.new(
+  model_name: Candidate,
+  model_id: ats.Candidate,
+  last_sync_start: 2021-03-30T19:44:18.695973Z,
+  next_sync_start: 2021-03-30T20:44:18.662942Z,
+  status: SYNCING,
+  is_initial_sync: true
+)
+```
+