merge_crm_client 1.0.0

data/docs/CategoriesEnum.md

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

data/docs/CategoryEnum.md

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

data/docs/Contact.md

@@ -0,0 +1,40 @@
+# MergeCRMClient::Contact
+
+## 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 contact's first name. | [optional] |
+| **last_name** | **String** | The contact's last name. | [optional] |
+| **account** | **String** |  | [optional] |
+| **addresses** | [**Array<Address>**](Address.md) |  | [optional][readonly] |
+| **email_addresses** | [**Array<EmailAddress>**](EmailAddress.md) |  | [optional][readonly] |
+| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) |  | [optional][readonly] |
+| **last_activity_at** | **Time** | When the contact's last activity occurred. | [optional] |
+| **remote_created_at** | **Time** | When the third party's contact was created. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+| **remote_was_deleted** | **Boolean** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::Contact.new(
+  id: null,
+  remote_id: 19202938,
+  first_name: Gil,
+  last_name: Feig,
+  account: 0958cbc6-6040-430a-848e-aafacbadf4ae,
+  addresses: [{"street_1":"50 Bowling Green Dr","street_2":"Golden Gate Park","city":"San Francisco","state":"CA","postal_code":"94122","country":"USA","address_type":"Shipping"}],
+  email_addresses: [{"email_address":"hello@merge.dev","email_address_type":"Work"}],
+  phone_numbers: [{"phone_number":"+13785579223","phone_number_type":"Mobile"}],
+  last_activity_at: 2022-02-10T00:00Z,
+  remote_created_at: 2021-11-10T00:00Z,
+  remote_data: [{"path":"/contacts","data":["Varies by platform"]}],
+  remote_was_deleted: null
+)
+```
+

data/docs/ContactRequest.md

@@ -0,0 +1,32 @@
+# MergeCRMClient::ContactRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **first_name** | **String** | The contact's first name. | [optional] |
+| **last_name** | **String** | The contact's last name. | [optional] |
+| **account** | **String** |  | [optional] |
+| **last_activity_at** | **Time** | When the contact's last activity occurred. | [optional] |
+| **remote_created_at** | **Time** | When the third party's contact was created. | [optional] |
+| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::ContactRequest.new(
+  remote_id: 19202938,
+  first_name: Gil,
+  last_name: Feig,
+  account: 0958cbc6-6040-430a-848e-aafacbadf4ae,
+  last_activity_at: 2022-02-10T00:00Z,
+  remote_created_at: 2021-11-10T00:00Z,
+  integration_params: null,
+  linked_account_params: null
+)
+```
+

data/docs/ContactsApi.md

@@ -0,0 +1,335 @@
+# MergeCRMClient::ContactsApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**contacts_create**](ContactsApi.md#contacts_create) | **POST** /contacts |  |
+| [**contacts_list**](ContactsApi.md#contacts_list) | **GET** /contacts |  |
+| [**contacts_meta_post_retrieve**](ContactsApi.md#contacts_meta_post_retrieve) | **GET** /contacts/meta/post |  |
+| [**contacts_retrieve**](ContactsApi.md#contacts_retrieve) | **GET** /contacts/{id} |  |
+
+
+## contacts_create
+
+> <CRMContactResponse> contacts_create(x_account_token, crm_contact_endpoint_request, opts)
+
+
+
+Creates a `Contact` 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::ContactsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+crm_contact_endpoint_request = MergeCRMClient::CRMContactEndpointRequest.new({model: MergeCRMClient::ContactRequest.new}) # CRMContactEndpointRequest | 
+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.contacts_create(x_account_token, crm_contact_endpoint_request, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling ContactsApi->contacts_create: #{e}"
+end
+```
+
+#### Using the contacts_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CRMContactResponse>, Integer, Hash)> contacts_create_with_http_info(x_account_token, crm_contact_endpoint_request, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.contacts_create_with_http_info(x_account_token, crm_contact_endpoint_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CRMContactResponse>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling ContactsApi->contacts_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **crm_contact_endpoint_request** | [**CRMContactEndpointRequest**](CRMContactEndpointRequest.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
+
+[**CRMContactResponse**](CRMContactResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## contacts_list
+
+> <PaginatedContactList> contacts_list(x_account_token, opts)
+
+
+
+Returns a list of `Contact` 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::ContactsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  account_id: 'account_id_example', # String | If provided, will only return contacts with this account.
+  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: 'account', # 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.
+  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.contacts_list(x_account_token, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling ContactsApi->contacts_list: #{e}"
+end
+```
+
+#### Using the contacts_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedContactList>, Integer, Hash)> contacts_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.contacts_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedContactList>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling ContactsApi->contacts_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **account_id** | **String** | If provided, will only return contacts with this account. | [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_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
+
+[**PaginatedContactList**](PaginatedContactList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## contacts_meta_post_retrieve
+
+> <MetaResponse> contacts_meta_post_retrieve(x_account_token)
+
+
+
+Returns metadata for `CRMContact` 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::ContactsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.contacts_meta_post_retrieve(x_account_token)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling ContactsApi->contacts_meta_post_retrieve: #{e}"
+end
+```
+
+#### Using the contacts_meta_post_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MetaResponse>, Integer, Hash)> contacts_meta_post_retrieve_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.contacts_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 ContactsApi->contacts_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
+
+
+## contacts_retrieve
+
+> <Contact> contacts_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `Contact` 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::ContactsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  expand: 'account', # 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.contacts_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling ContactsApi->contacts_retrieve: #{e}"
+end
+```
+
+#### Using the contacts_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Contact>, Integer, Hash)> contacts_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.contacts_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Contact>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling ContactsApi->contacts_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
+
+[**Contact**](Contact.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CountryEnum.md

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

data/docs/DataPassthroughRequest.md

@@ -0,0 +1,32 @@
+# MergeCRMClient::DataPassthroughRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **method** | [**MethodEnum**](MethodEnum.md) |  |  |
+| **path** | **String** |  |  |
+| **base_url_override** | **String** |  | [optional] |
+| **data** | **String** |  | [optional] |
+| **multipart_form_data** | [**Array<MultipartFormFieldRequest>**](MultipartFormFieldRequest.md) | Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`. | [optional] |
+| **headers** | [**Hash<String, AnyType>**](AnyType.md) | The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. | [optional] |
+| **request_format** | [**RequestFormatEnum**](RequestFormatEnum.md) |  | [optional] |
+| **normalize_response** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::DataPassthroughRequest.new(
+  method: POST,
+  path: /scooters,
+  base_url_override: null,
+  data: {"company": "Lime", "model": "Gen 2.5"},
+  multipart_form_data: null,
+  headers: {"EXTRA-HEADER":"value"},
+  request_format: JSON,
+  normalize_response: null
+)
+```
+

data/docs/DebugModeLog.md

@@ -0,0 +1,22 @@
+# MergeCRMClient::DebugModeLog
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **log_id** | **String** |  |  |
+| **dashboard_view** | **String** |  |  |
+| **log_summary** | [**DebugModelLogSummary**](DebugModelLogSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::DebugModeLog.new(
+  log_id: 99433219-8017-4acd-bb3c-ceb23d663832,
+  dashboard_view: https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832,
+  log_summary: null
+)
+```
+

data/docs/DebugModelLogSummary.md

@@ -0,0 +1,22 @@
+# MergeCRMClient::DebugModelLogSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** |  |  |
+| **method** | **String** |  |  |
+| **status_code** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::DebugModelLogSummary.new(
+  url: https://harvest.greenhouse.io/v1/candidates/,
+  method: POST,
+  status_code: 200
+)
+```
+

data/docs/DeleteAccountApi.md

@@ -0,0 +1,78 @@
+# MergeCRMClient::DeleteAccountApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_account_create**](DeleteAccountApi.md#delete_account_create) | **POST** /delete-account |  |
+
+
+## delete_account_create
+
+> delete_account_create(x_account_token)
+
+
+
+Delete a linked 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::DeleteAccountApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  api_instance.delete_account_create(x_account_token)
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling DeleteAccountApi->delete_account_create: #{e}"
+end
+```
+
+#### Using the delete_account_create_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_account_create_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.delete_account_create_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling DeleteAccountApi->delete_account_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/DirectionEnum.md

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

data/docs/EmailAddress.md

@@ -0,0 +1,20 @@
+# MergeCRMClient::EmailAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_address** | **String** | The email address. | [optional] |
+| **email_address_type** | **String** | The email address's type. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::EmailAddress.new(
+  email_address: merge_is_hiring@merge.dev,
+  email_address_type: Work
+)
+```
+

data/docs/EmailAddressRequest.md

@@ -0,0 +1,20 @@
+# MergeCRMClient::EmailAddressRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_address** | **String** | The email address. | [optional] |
+| **email_address_type** | **String** | The email address's type. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::EmailAddressRequest.new(
+  email_address: merge_is_hiring@merge.dev,
+  email_address_type: Work
+)
+```
+

data/docs/EncodingEnum.md

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