merge_crm_client 1.0.0

data/docs/AccountTokenApi.md

@@ -0,0 +1,79 @@
+# MergeCRMClient::AccountTokenApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**account_token_retrieve**](AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} |  |
+
+
+## account_token_retrieve
+
+> <AccountToken> account_token_retrieve(public_token)
+
+
+
+Returns the account token for the end user with the provided public token.
+
+### 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::AccountTokenApi.new
+public_token = 'public_token_example' # String | 
+
+begin
+  
+  result = api_instance.account_token_retrieve(public_token)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling AccountTokenApi->account_token_retrieve: #{e}"
+end
+```
+
+#### Using the account_token_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccountToken>, Integer, Hash)> account_token_retrieve_with_http_info(public_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.account_token_retrieve_with_http_info(public_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccountToken>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling AccountTokenApi->account_token_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **public_token** | **String** |  |  |
+
+### Return type
+
+[**AccountToken**](AccountToken.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AccountsApi.md

@@ -0,0 +1,335 @@
+# MergeCRMClient::AccountsApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**accounts_create**](AccountsApi.md#accounts_create) | **POST** /accounts |  |
+| [**accounts_list**](AccountsApi.md#accounts_list) | **GET** /accounts |  |
+| [**accounts_meta_post_retrieve**](AccountsApi.md#accounts_meta_post_retrieve) | **GET** /accounts/meta/post |  |
+| [**accounts_retrieve**](AccountsApi.md#accounts_retrieve) | **GET** /accounts/{id} |  |
+
+
+## accounts_create
+
+> <CRMAccountResponse> accounts_create(x_account_token, crm_account_endpoint_request, opts)
+
+
+
+Creates an `Account` object with the given values.
+
+### 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::AccountsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+crm_account_endpoint_request = MergeCRMClient::CRMAccountEndpointRequest.new({model: MergeCRMClient::AccountRequest.new}) # CRMAccountEndpointRequest | 
+opts = {
+  is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
+  run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
+}
+
+begin
+  
+  result = api_instance.accounts_create(x_account_token, crm_account_endpoint_request, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling AccountsApi->accounts_create: #{e}"
+end
+```
+
+#### Using the accounts_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CRMAccountResponse>, Integer, Hash)> accounts_create_with_http_info(x_account_token, crm_account_endpoint_request, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.accounts_create_with_http_info(x_account_token, crm_account_endpoint_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CRMAccountResponse>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling AccountsApi->accounts_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **crm_account_endpoint_request** | [**CRMAccountEndpointRequest**](CRMAccountEndpointRequest.md) |  |  |
+| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
+| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
+
+### Return type
+
+[**CRMAccountResponse**](CRMAccountResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## accounts_list
+
+> <PaginatedAccountList> accounts_list(x_account_token, opts)
+
+
+
+Returns a list of `Account` 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::AccountsApi.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: 'owner', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  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.
+  owner_id: 'owner_id_example', # String | If provided, will only return accounts with this owner.
+  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.accounts_list(x_account_token, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling AccountsApi->accounts_list: #{e}"
+end
+```
+
+#### Using the accounts_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedAccountList>, Integer, Hash)> accounts_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.accounts_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedAccountList>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling AccountsApi->accounts_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_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] |
+| **owner_id** | **String** | If provided, will only return accounts with this owner. | [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
+
+[**PaginatedAccountList**](PaginatedAccountList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## accounts_meta_post_retrieve
+
+> <MetaResponse> accounts_meta_post_retrieve(x_account_token)
+
+
+
+Returns metadata for `CRMAccount` POSTs.
+
+### 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::AccountsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.accounts_meta_post_retrieve(x_account_token)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling AccountsApi->accounts_meta_post_retrieve: #{e}"
+end
+```
+
+#### Using the accounts_meta_post_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MetaResponse>, Integer, Hash)> accounts_meta_post_retrieve_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.accounts_meta_post_retrieve_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MetaResponse>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling AccountsApi->accounts_meta_post_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+[**MetaResponse**](MetaResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## accounts_retrieve
+
+> <Account> accounts_retrieve(x_account_token, id, opts)
+
+
+
+Returns an `Account` 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::AccountsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  expand: 'owner', # 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.accounts_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling AccountsApi->accounts_retrieve: #{e}"
+end
+```
+
+#### Using the accounts_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Account>, Integer, Hash)> accounts_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.accounts_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Account>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling AccountsApi->accounts_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
+
+[**Account**](Account.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ActivityTypeEnum.md

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

data/docs/Address.md

@@ -0,0 +1,30 @@
+# MergeCRMClient::Address
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **street_1** | **String** | Line 1 of the address's street. | [optional] |
+| **street_2** | **String** | Line 2 of the address's street. | [optional] |
+| **city** | **String** | The address's city. | [optional] |
+| **state** | **String** | The address's state. | [optional] |
+| **postal_code** | **String** | The address's postal code. | [optional] |
+| **country** | [**CountryEnum**](CountryEnum.md) | The address's country. | [optional] |
+| **address_type** | [**AddressTypeEnum**](AddressTypeEnum.md) | The address type. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::Address.new(
+  street_1: 50 Bowling Green Dr,
+  street_2: Golden Gate Park,
+  city: San Francisco,
+  state: CA,
+  postal_code: 94122,
+  country: USA,
+  address_type: Shipping
+)
+```
+

data/docs/AddressRequest.md

@@ -0,0 +1,30 @@
+# MergeCRMClient::AddressRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **street_1** | **String** | Line 1 of the address's street. | [optional] |
+| **street_2** | **String** | Line 2 of the address's street. | [optional] |
+| **city** | **String** | The address's city. | [optional] |
+| **state** | **String** | The address's state. | [optional] |
+| **postal_code** | **String** | The address's postal code. | [optional] |
+| **country** | [**CountryEnum**](CountryEnum.md) | The address's country. | [optional] |
+| **address_type** | [**AddressTypeEnum**](AddressTypeEnum.md) | The address type. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::AddressRequest.new(
+  street_1: 50 Bowling Green Dr,
+  street_2: Golden Gate Park,
+  city: San Francisco,
+  state: CA,
+  postal_code: 94122,
+  country: USA,
+  address_type: Shipping
+)
+```
+

data/docs/AddressTypeEnum.md

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

data/docs/AvailableActions.md

@@ -0,0 +1,22 @@
+# MergeCRMClient::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_crm_client'
+
+instance = MergeCRMClient::AvailableActions.new(
+  integration: null,
+  passthrough_available: true,
+  available_model_operations: [{"model_name":"Candidate","available_operations":["FETCH","CREATE"],"required_post_parameters":["remote_user_id"],"supported_fields":["first_name","last_name","company","title"]}]
+)
+```
+

data/docs/AvailableActionsApi.md

@@ -0,0 +1,79 @@
+# MergeCRMClient::AvailableActionsApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/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_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::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 MergeCRMClient::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 MergeCRMClient::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/CRMAccountEndpointRequest.md

@@ -0,0 +1,18 @@
+# MergeCRMClient::CRMAccountEndpointRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**AccountRequest**](AccountRequest.md) |  |  |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::CRMAccountEndpointRequest.new(
+  model: null
+)
+```
+

data/docs/CRMAccountResponse.md

@@ -0,0 +1,24 @@
+# MergeCRMClient::CRMAccountResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**Account**](Account.md) |  |  |
+| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) |  |  |
+| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) |  |  |
+| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::CRMAccountResponse.new(
+  model: null,
+  warnings: null,
+  errors: null,
+  logs: null
+)
+```
+

data/docs/CRMContactEndpointRequest.md

@@ -0,0 +1,18 @@
+# MergeCRMClient::CRMContactEndpointRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**ContactRequest**](ContactRequest.md) |  |  |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::CRMContactEndpointRequest.new(
+  model: null
+)
+```
+

data/docs/CRMContactResponse.md

@@ -0,0 +1,24 @@
+# MergeCRMClient::CRMContactResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**Contact**](Contact.md) |  |  |
+| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) |  |  |
+| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) |  |  |
+| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::CRMContactResponse.new(
+  model: null,
+  warnings: null,
+  errors: null,
+  logs: null
+)
+```
+