merge_crm_client 1.0.0

data/docs/EndUserDetailsRequest.md

@@ -0,0 +1,30 @@
+# MergeCRMClient::EndUserDetailsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **end_user_email_address** | **String** | Your end user's email address. |  |
+| **end_user_organization_name** | **String** | Your end user's organization. |  |
+| **end_user_origin_id** | **String** | Unique ID for your end user. |  |
+| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | The integration categories to show in Merge Link. |  |
+| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://www.merge.dev/docs/basics/integration-metadata/. | [optional] |
+| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. | [optional][default to 30] |
+| **should_create_magic_link_url** | **Boolean** | Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/product/integrations,-fast.-say-hello-to-magic-link/. | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::EndUserDetailsRequest.new(
+  end_user_email_address: null,
+  end_user_organization_name: null,
+  end_user_origin_id: null,
+  categories: null,
+  integration: null,
+  link_expiry_mins: null,
+  should_create_magic_link_url: null
+)
+```
+

data/docs/Engagement.md

@@ -0,0 +1,40 @@
+# MergeCRMClient::Engagement
+
+## 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] |
+| **content** | **String** | The engagement's content. | [optional] |
+| **subject** | **String** | The engagement's subject. | [optional] |
+| **direction** | [**DirectionEnum**](DirectionEnum.md) | The engagement's direction. | [optional] |
+| **engagement_type** | **String** |  | [optional] |
+| **start_time** | **Time** | The time at which the engagement started. | [optional] |
+| **end_time** | **Time** | The time at which the engagement ended. | [optional] |
+| **account** | **String** |  | [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::Engagement.new(
+  id: null,
+  remote_id: 19202938,
+  owner: 0358cbc6-2040-430a-848e-aafacbadf3aa,
+  content: Call for negotiation,
+  subject: Call from customer,
+  direction: INBOUND,
+  engagement_type: 0358cbc6-2040-430a-848e-aafacbadf3aa,
+  start_time: 2022-02-10T00:00Z,
+  end_time: 2022-02-10T00:05Z,
+  account: null,
+  remote_data: [{"path":"/engagements","data":["Varies by platform"]}],
+  remote_was_deleted: null
+)
+```
+

data/docs/EngagementEndpointRequest.md

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

data/docs/EngagementRequest.md

@@ -0,0 +1,38 @@
+# MergeCRMClient::EngagementRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **owner** | **String** |  | [optional] |
+| **content** | **String** | The engagement's content. | [optional] |
+| **subject** | **String** | The engagement's subject. | [optional] |
+| **direction** | [**DirectionEnum**](DirectionEnum.md) | The engagement's direction. | [optional] |
+| **engagement_type** | **String** |  | [optional] |
+| **start_time** | **Time** | The time at which the engagement started. | [optional] |
+| **end_time** | **Time** | The time at which the engagement ended. | [optional] |
+| **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::EngagementRequest.new(
+  remote_id: 19202938,
+  owner: 0358cbc6-2040-430a-848e-aafacbadf3aa,
+  content: Call for negotiation,
+  subject: Call from customer,
+  direction: INBOUND,
+  engagement_type: 0358cbc6-2040-430a-848e-aafacbadf3aa,
+  start_time: 2022-02-10T00:00Z,
+  end_time: 2022-02-10T00:05Z,
+  account: null,
+  integration_params: null,
+  linked_account_params: null
+)
+```
+

data/docs/EngagementResponse.md

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

data/docs/EngagementType.md

@@ -0,0 +1,24 @@
+# MergeCRMClient::EngagementType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **activity_type** | [**ActivityTypeEnum**](ActivityTypeEnum.md) | The engagement type's activity type. | [optional] |
+| **name** | **String** | The engagement type's name. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::EngagementType.new(
+  id: null,
+  remote_id: 19202938,
+  activity_type: CALL,
+  name: First Call
+)
+```
+

data/docs/EngagementTypesApi.md

@@ -0,0 +1,177 @@
+# MergeCRMClient::EngagementTypesApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**engagement_types_list**](EngagementTypesApi.md#engagement_types_list) | **GET** /engagement-types |  |
+| [**engagement_types_retrieve**](EngagementTypesApi.md#engagement_types_retrieve) | **GET** /engagement-types/{id} |  |
+
+
+## engagement_types_list
+
+> <PaginatedEngagementTypeList> engagement_types_list(x_account_token, opts)
+
+
+
+Returns a list of `EngagementType` 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::EngagementTypesApi.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.engagement_types_list(x_account_token, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling EngagementTypesApi->engagement_types_list: #{e}"
+end
+```
+
+#### Using the engagement_types_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedEngagementTypeList>, Integer, Hash)> engagement_types_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.engagement_types_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedEngagementTypeList>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling EngagementTypesApi->engagement_types_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
+
+[**PaginatedEngagementTypeList**](PaginatedEngagementTypeList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## engagement_types_retrieve
+
+> <EngagementType> engagement_types_retrieve(x_account_token, id, opts)
+
+
+
+Returns an `EngagementType` 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::EngagementTypesApi.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.engagement_types_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling EngagementTypesApi->engagement_types_retrieve: #{e}"
+end
+```
+
+#### Using the engagement_types_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EngagementType>, Integer, Hash)> engagement_types_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.engagement_types_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EngagementType>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling EngagementTypesApi->engagement_types_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
+
+[**EngagementType**](EngagementType.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/EngagementsApi.md

@@ -0,0 +1,333 @@
+# MergeCRMClient::EngagementsApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**engagements_create**](EngagementsApi.md#engagements_create) | **POST** /engagements |  |
+| [**engagements_list**](EngagementsApi.md#engagements_list) | **GET** /engagements |  |
+| [**engagements_meta_post_retrieve**](EngagementsApi.md#engagements_meta_post_retrieve) | **GET** /engagements/meta/post |  |
+| [**engagements_retrieve**](EngagementsApi.md#engagements_retrieve) | **GET** /engagements/{id} |  |
+
+
+## engagements_create
+
+> <EngagementResponse> engagements_create(x_account_token, engagement_endpoint_request, opts)
+
+
+
+Creates an `Engagement` 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::EngagementsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+engagement_endpoint_request = MergeCRMClient::EngagementEndpointRequest.new({model: MergeCRMClient::EngagementRequest.new}) # EngagementEndpointRequest | 
+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.engagements_create(x_account_token, engagement_endpoint_request, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling EngagementsApi->engagements_create: #{e}"
+end
+```
+
+#### Using the engagements_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EngagementResponse>, Integer, Hash)> engagements_create_with_http_info(x_account_token, engagement_endpoint_request, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.engagements_create_with_http_info(x_account_token, engagement_endpoint_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EngagementResponse>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling EngagementsApi->engagements_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **engagement_endpoint_request** | [**EngagementEndpointRequest**](EngagementEndpointRequest.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
+
+[**EngagementResponse**](EngagementResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## engagements_list
+
+> <PaginatedEngagementList> engagements_list(x_account_token, opts)
+
+
+
+Returns a list of `Engagement` 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::EngagementsApi.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: '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.engagements_list(x_account_token, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling EngagementsApi->engagements_list: #{e}"
+end
+```
+
+#### Using the engagements_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedEngagementList>, Integer, Hash)> engagements_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.engagements_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedEngagementList>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling EngagementsApi->engagements_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] |
+| **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
+
+[**PaginatedEngagementList**](PaginatedEngagementList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## engagements_meta_post_retrieve
+
+> <MetaResponse> engagements_meta_post_retrieve(x_account_token)
+
+
+
+Returns metadata for `Engagement` 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::EngagementsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.engagements_meta_post_retrieve(x_account_token)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling EngagementsApi->engagements_meta_post_retrieve: #{e}"
+end
+```
+
+#### Using the engagements_meta_post_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MetaResponse>, Integer, Hash)> engagements_meta_post_retrieve_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.engagements_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 EngagementsApi->engagements_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
+
+
+## engagements_retrieve
+
+> <Engagement> engagements_retrieve(x_account_token, id, opts)
+
+
+
+Returns an `Engagement` 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::EngagementsApi.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.engagements_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling EngagementsApi->engagements_retrieve: #{e}"
+end
+```
+
+#### Using the engagements_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Engagement>, Integer, Hash)> engagements_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.engagements_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Engagement>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling EngagementsApi->engagements_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
+
+[**Engagement**](Engagement.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+