merge_crm_client 1.0.0

data/docs/ErrorValidationProblem.md

@@ -0,0 +1,24 @@
+# MergeCRMClient::ErrorValidationProblem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source** | [**ValidationProblemSource**](ValidationProblemSource.md) |  | [optional] |
+| **title** | **String** |  |  |
+| **detail** | **String** |  |  |
+| **problem_type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::ErrorValidationProblem.new(
+  source: null,
+  title: Missing Required Field,
+  detail: custom_fields is a required field on model.,
+  problem_type: MISSING_REQUIRED_FIELD
+)
+```
+

data/docs/ForceResyncApi.md

@@ -0,0 +1,79 @@
+# MergeCRMClient::ForceResyncApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**sync_status_resync_create**](ForceResyncApi.md#sync_status_resync_create) | **POST** /sync-status/resync |  |
+
+
+## sync_status_resync_create
+
+> <Array<SyncStatus>> sync_status_resync_create(x_account_token)
+
+
+
+Force re-sync of all models. This is only available for organizations on Merge's Grow and Expand plans.
+
+### 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::ForceResyncApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.sync_status_resync_create(x_account_token)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling ForceResyncApi->sync_status_resync_create: #{e}"
+end
+```
+
+#### Using the sync_status_resync_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<SyncStatus>>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.sync_status_resync_create_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<SyncStatus>>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling ForceResyncApi->sync_status_resync_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+[**Array&lt;SyncStatus&gt;**](SyncStatus.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/GenerateKeyApi.md

@@ -0,0 +1,79 @@
+# MergeCRMClient::GenerateKeyApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/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_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::GenerateKeyApi.new
+generate_remote_key_request = MergeCRMClient::GenerateRemoteKeyRequest.new({name: 'Remote Deployment Key 1'}) # GenerateRemoteKeyRequest | 
+
+begin
+  
+  result = api_instance.generate_key_create(generate_remote_key_request)
+  p result
+rescue MergeCRMClient::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 MergeCRMClient::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 @@
+# MergeCRMClient::GenerateRemoteKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::GenerateRemoteKeyRequest.new(
+  name: Remote Deployment Key 1
+)
+```
+

data/docs/Issue.md

@@ -0,0 +1,30 @@
+# MergeCRMClient::Issue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **status** | [**IssueStatusEnum**](IssueStatusEnum.md) |  | [optional] |
+| **error_description** | **String** |  |  |
+| **end_user** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional][readonly] |
+| **first_incident_time** | **Time** |  | [optional] |
+| **last_incident_time** | **Time** |  | [optional] |
+| **is_muted** | **Boolean** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::Issue.new(
+  id: null,
+  status: null,
+  error_description: null,
+  end_user: null,
+  first_incident_time: null,
+  last_incident_time: null,
+  is_muted: null
+)
+```
+

data/docs/IssueStatusEnum.md

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

data/docs/IssuesApi.md

@@ -0,0 +1,177 @@
+# MergeCRMClient::IssuesApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**issues_list**](IssuesApi.md#issues_list) | **GET** /issues |  |
+| [**issues_retrieve**](IssuesApi.md#issues_retrieve) | **GET** /issues/{id} |  |
+
+
+## issues_list
+
+> <PaginatedIssueList> issues_list(opts)
+
+
+
+Gets issues.
+
+### 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::IssuesApi.new
+opts = {
+  account_token: 'account_token_example', # String | 
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  end_date: 'end_date_example', # String | If included, will only include issues whose most recent action occurred before this time
+  end_user_organization_name: 'end_user_organization_name_example', # String | 
+  first_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
+  first_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
+  include_muted: 'include_muted_example', # String | If True, will include muted issues
+  integration_name: 'integration_name_example', # String | 
+  last_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
+  last_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
+  page_size: 56, # Integer | Number of results to return per page.
+  start_date: 'start_date_example', # String | If included, will only include issues whose most recent action occurred after this time
+  status: 'ONGOING' # String | 
+}
+
+begin
+  
+  result = api_instance.issues_list(opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling IssuesApi->issues_list: #{e}"
+end
+```
+
+#### Using the issues_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedIssueList>, Integer, Hash)> issues_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.issues_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedIssueList>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling IssuesApi->issues_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_token** | **String** |  | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **end_date** | **String** | If included, will only include issues whose most recent action occurred before this time | [optional] |
+| **end_user_organization_name** | **String** |  | [optional] |
+| **first_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
+| **first_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
+| **include_muted** | **String** | If True, will include muted issues | [optional] |
+| **integration_name** | **String** |  | [optional] |
+| **last_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
+| **last_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **start_date** | **String** | If included, will only include issues whose most recent action occurred after this time | [optional] |
+| **status** | **String** |  | [optional] |
+
+### Return type
+
+[**PaginatedIssueList**](PaginatedIssueList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## issues_retrieve
+
+> <Issue> issues_retrieve(id)
+
+
+
+Get a specific issue.
+
+### 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::IssuesApi.new
+id = TODO # String | 
+
+begin
+  
+  result = api_instance.issues_retrieve(id)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling IssuesApi->issues_retrieve: #{e}"
+end
+```
+
+#### Using the issues_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Issue>, Integer, Hash)> issues_retrieve_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.issues_retrieve_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Issue>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling IssuesApi->issues_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | [**String**](.md) |  |  |
+
+### Return type
+
+[**Issue**](Issue.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Lead.md

@@ -0,0 +1,52 @@
+# MergeCRMClient::Lead
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **owner** | **String** |  | [optional] |
+| **lead_source** | **String** | The lead's source. | [optional] |
+| **title** | **String** | The lead's title. | [optional] |
+| **company** | **String** | The lead's company. | [optional] |
+| **first_name** | **String** | The lead's first name. | [optional] |
+| **last_name** | **String** | The lead's last name. | [optional] |
+| **addresses** | [**Array<Address>**](Address.md) |  | [optional][readonly] |
+| **email_addresses** | [**Array<EmailAddress>**](EmailAddress.md) |  | [optional][readonly] |
+| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) |  | [optional][readonly] |
+| **remote_updated_at** | **Time** | When the third party's lead was updated. | [optional] |
+| **remote_created_at** | **Time** | When the third party's lead was created. | [optional] |
+| **converted_date** | **Time** | When the lead was converted. | [optional] |
+| **converted_contact** | **String** |  | [optional] |
+| **converted_account** | **String** |  | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+| **remote_was_deleted** | **Boolean** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::Lead.new(
+  id: null,
+  remote_id: 19202938,
+  owner: 0358cbc6-2040-430a-848e-aafacbadf3aa,
+  lead_source: API Blogger,
+  title: Co-Founder,
+  company: Merge API,
+  first_name: Gil,
+  last_name: Feig,
+  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":"+16789932455","phone_number_type":"Mobile"}],
+  remote_updated_at: 2022-02-10T00:00Z,
+  remote_created_at: 2021-11-10T00:00Z,
+  converted_date: 2022-03-10T00:00Z,
+  converted_contact: null,
+  converted_account: 9c9de072-29cf-48e3-9578-1ca5b145b40e,
+  remote_data: [{"path":"/leads","data":["Varies by platform"]}],
+  remote_was_deleted: null
+)
+```
+

data/docs/LeadEndpointRequest.md

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

data/docs/LeadRequest.md

@@ -0,0 +1,44 @@
+# MergeCRMClient::LeadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **owner** | **String** |  | [optional] |
+| **lead_source** | **String** | The lead's source. | [optional] |
+| **title** | **String** | The lead's title. | [optional] |
+| **company** | **String** | The lead's company. | [optional] |
+| **first_name** | **String** | The lead's first name. | [optional] |
+| **last_name** | **String** | The lead's last name. | [optional] |
+| **remote_updated_at** | **Time** | When the third party's lead was updated. | [optional] |
+| **remote_created_at** | **Time** | When the third party's lead was created. | [optional] |
+| **converted_date** | **Time** | When the lead was converted. | [optional] |
+| **converted_contact** | **String** |  | [optional] |
+| **converted_account** | **String** |  | [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::LeadRequest.new(
+  remote_id: 19202938,
+  owner: 0358cbc6-2040-430a-848e-aafacbadf3aa,
+  lead_source: API Blogger,
+  title: Co-Founder,
+  company: Merge API,
+  first_name: Gil,
+  last_name: Feig,
+  remote_updated_at: 2022-02-10T00:00Z,
+  remote_created_at: 2021-11-10T00:00Z,
+  converted_date: 2022-03-10T00:00Z,
+  converted_contact: null,
+  converted_account: 9c9de072-29cf-48e3-9578-1ca5b145b40e,
+  integration_params: null,
+  linked_account_params: null
+)
+```
+

data/docs/LeadResponse.md

@@ -0,0 +1,24 @@
+# MergeCRMClient::LeadResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | [**Lead**](Lead.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::LeadResponse.new(
+  model: null,
+  warnings: null,
+  errors: null,
+  logs: null
+)
+```
+