merge_crm_client 1.0.0

data/docs/LeadsApi.md

@@ -0,0 +1,339 @@
+# MergeCRMClient::LeadsApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**leads_create**](LeadsApi.md#leads_create) | **POST** /leads |  |
+| [**leads_list**](LeadsApi.md#leads_list) | **GET** /leads |  |
+| [**leads_meta_post_retrieve**](LeadsApi.md#leads_meta_post_retrieve) | **GET** /leads/meta/post |  |
+| [**leads_retrieve**](LeadsApi.md#leads_retrieve) | **GET** /leads/{id} |  |
+
+
+## leads_create
+
+> <LeadResponse> leads_create(x_account_token, lead_endpoint_request, opts)
+
+
+
+Creates a `Lead` 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::LeadsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+lead_endpoint_request = MergeCRMClient::LeadEndpointRequest.new({model: MergeCRMClient::LeadRequest.new}) # LeadEndpointRequest | 
+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.leads_create(x_account_token, lead_endpoint_request, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling LeadsApi->leads_create: #{e}"
+end
+```
+
+#### Using the leads_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LeadResponse>, Integer, Hash)> leads_create_with_http_info(x_account_token, lead_endpoint_request, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.leads_create_with_http_info(x_account_token, lead_endpoint_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LeadResponse>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling LeadsApi->leads_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **lead_endpoint_request** | [**LeadEndpointRequest**](LeadEndpointRequest.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
+
+[**LeadResponse**](LeadResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## leads_list
+
+> <PaginatedLeadList> leads_list(x_account_token, opts)
+
+
+
+Returns a list of `Lead` 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::LeadsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  converted_account_id: 'converted_account_id_example', # String | If provided, will only return leads with this account.
+  converted_contact_id: 'converted_contact_id_example', # String | If provided, will only return leads with this contact.
+  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: 'converted_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.
+  owner_id: 'owner_id_example', # String | If provided, will only return leads 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.leads_list(x_account_token, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling LeadsApi->leads_list: #{e}"
+end
+```
+
+#### Using the leads_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedLeadList>, Integer, Hash)> leads_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.leads_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedLeadList>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling LeadsApi->leads_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **converted_account_id** | **String** | If provided, will only return leads with this account. | [optional] |
+| **converted_contact_id** | **String** | If provided, will only return leads with this contact. | [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] |
+| **owner_id** | **String** | If provided, will only return leads 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
+
+[**PaginatedLeadList**](PaginatedLeadList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## leads_meta_post_retrieve
+
+> <MetaResponse> leads_meta_post_retrieve(x_account_token)
+
+
+
+Returns metadata for `Lead` 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::LeadsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.leads_meta_post_retrieve(x_account_token)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling LeadsApi->leads_meta_post_retrieve: #{e}"
+end
+```
+
+#### Using the leads_meta_post_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MetaResponse>, Integer, Hash)> leads_meta_post_retrieve_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.leads_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 LeadsApi->leads_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
+
+
+## leads_retrieve
+
+> <Lead> leads_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `Lead` 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::LeadsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  expand: 'converted_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.leads_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling LeadsApi->leads_retrieve: #{e}"
+end
+```
+
+#### Using the leads_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Lead>, Integer, Hash)> leads_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.leads_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Lead>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling LeadsApi->leads_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
+
+[**Lead**](Lead.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/LinkToken.md

@@ -0,0 +1,22 @@
+# MergeCRMClient::LinkToken
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **link_token** | **String** |  |  |
+| **integration_name** | **String** |  |  |
+| **magic_link_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::LinkToken.new(
+  link_token: necdP7FtdASl1fQwm62be2_dM4wBG8_GactqoUV0,
+  integration_name: Lever,
+  magic_link_url: https://link.merge.dev/asdfjkl12345jsndfgi2i83n
+)
+```
+

data/docs/LinkTokenApi.md

@@ -0,0 +1,79 @@
+# MergeCRMClient::LinkTokenApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**link_token_create**](LinkTokenApi.md#link_token_create) | **POST** /link-token |  |
+
+
+## link_token_create
+
+> <LinkToken> link_token_create(end_user_details_request)
+
+
+
+Creates a link token to be used when linking a new end user.
+
+### 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::LinkTokenApi.new
+end_user_details_request = MergeCRMClient::EndUserDetailsRequest.new({end_user_email_address: 'end_user_email_address_example', end_user_organization_name: 'end_user_organization_name_example', end_user_origin_id: 'end_user_origin_id_example', categories: [MergeCRMClient::CategoriesEnum::HRIS]}) # EndUserDetailsRequest | 
+
+begin
+  
+  result = api_instance.link_token_create(end_user_details_request)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling LinkTokenApi->link_token_create: #{e}"
+end
+```
+
+#### Using the link_token_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LinkToken>, Integer, Hash)> link_token_create_with_http_info(end_user_details_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.link_token_create_with_http_info(end_user_details_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LinkToken>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling LinkTokenApi->link_token_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **end_user_details_request** | [**EndUserDetailsRequest**](EndUserDetailsRequest.md) |  |  |
+
+### Return type
+
+[**LinkToken**](LinkToken.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/LinkedAccountStatus.md

@@ -0,0 +1,20 @@
+# MergeCRMClient::LinkedAccountStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **linked_account_status** | **String** |  |  |
+| **can_make_request** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::LinkedAccountStatus.new(
+  linked_account_status: null,
+  can_make_request: null
+)
+```
+

data/docs/LinkedAccountsApi.md

@@ -0,0 +1,105 @@
+# MergeCRMClient::LinkedAccountsApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**linked_accounts_list**](LinkedAccountsApi.md#linked_accounts_list) | **GET** /linked-accounts |  |
+
+
+## linked_accounts_list
+
+> <PaginatedAccountDetailsAndActionsList> linked_accounts_list(opts)
+
+
+
+List linked accounts for your organization.
+
+### 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::LinkedAccountsApi.new
+opts = {
+  category: 'accounting', # String | 
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  end_user_email_address: 'end_user_email_address_example', # String | If provided, will only return linked accounts associated with the given email address.
+  end_user_organization_name: 'end_user_organization_name_example', # String | If provided, will only return linked accounts associated with the given organization name.
+  end_user_origin_id: 'end_user_origin_id_example', # String | If provided, will only return linked accounts associated with the given origin ID.
+  end_user_origin_ids: 'end_user_origin_ids_example', # String | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+  id: TODO, # String | 
+  ids: 'ids_example', # String | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+  include_duplicates: true, # Boolean | If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+  integration_name: 'integration_name_example', # String | If provided, will only return linked accounts associated with the given integration name.
+  is_test_account: 'is_test_account_example', # String | If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+  page_size: 56, # Integer | Number of results to return per page.
+  status: 'status_example' # String | Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+}
+
+begin
+  
+  result = api_instance.linked_accounts_list(opts)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling LinkedAccountsApi->linked_accounts_list: #{e}"
+end
+```
+
+#### Using the linked_accounts_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedAccountDetailsAndActionsList>, Integer, Hash)> linked_accounts_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.linked_accounts_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedAccountDetailsAndActionsList>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling LinkedAccountsApi->linked_accounts_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category** | **String** |  | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **end_user_email_address** | **String** | If provided, will only return linked accounts associated with the given email address. | [optional] |
+| **end_user_organization_name** | **String** | If provided, will only return linked accounts associated with the given organization name. | [optional] |
+| **end_user_origin_id** | **String** | If provided, will only return linked accounts associated with the given origin ID. | [optional] |
+| **end_user_origin_ids** | **String** | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. | [optional] |
+| **id** | [**String**](.md) |  | [optional] |
+| **ids** | **String** | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. | [optional] |
+| **include_duplicates** | **Boolean** | If &#x60;true&#x60;, will include complete production duplicates of the account specified by the &#x60;id&#x60; query parameter in the response. &#x60;id&#x60; must be for a complete production linked account. | [optional] |
+| **integration_name** | **String** | If provided, will only return linked accounts associated with the given integration name. | [optional] |
+| **is_test_account** | **String** | If included, will only include test linked accounts. If not included, will only include non-test linked accounts. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **status** | **String** | Filter by status. Options: &#x60;COMPLETE&#x60;, &#x60;INCOMPLETE&#x60;, &#x60;RELINK_NEEDED&#x60; | [optional] |
+
+### Return type
+
+[**PaginatedAccountDetailsAndActionsList**](PaginatedAccountDetailsAndActionsList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/MetaResponse.md

@@ -0,0 +1,24 @@
+# MergeCRMClient::MetaResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_schema** | [**Hash<String, AnyType>**](AnyType.md) |  |  |
+| **status** | [**LinkedAccountStatus**](LinkedAccountStatus.md) |  | [optional] |
+| **has_conditional_params** | **Boolean** |  |  |
+| **has_required_linked_account_params** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::MetaResponse.new(
+  request_schema: null,
+  status: null,
+  has_conditional_params: null,
+  has_required_linked_account_params: null
+)
+```
+

data/docs/MethodEnum.md

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

data/docs/ModelOperation.md

@@ -0,0 +1,24 @@
+# MergeCRMClient::ModelOperation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model_name** | **String** |  |  |
+| **available_operations** | **Array<String>** |  |  |
+| **required_post_parameters** | **Array<String>** |  |  |
+| **supported_fields** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::ModelOperation.new(
+  model_name: Candidate,
+  available_operations: ["FETCH","CREATE"],
+  required_post_parameters: ["remote_user_id"],
+  supported_fields: ["first_name","last_name","company","title"]
+)
+```
+

data/docs/MultipartFormFieldRequest.md

@@ -0,0 +1,26 @@
+# MergeCRMClient::MultipartFormFieldRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the form field |  |
+| **data** | **String** | The data for the form field. |  |
+| **encoding** | [**EncodingEnum**](EncodingEnum.md) | The encoding of the value of `data`. Defaults to `RAW` if not defined. | [optional] |
+| **file_name** | **String** | The file name of the form field, if the field is for a file. | [optional] |
+| **content_type** | **String** | The MIME type of the file, if the field is for a file. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::MultipartFormFieldRequest.new(
+  name: resume,
+  data: SW50ZWdyYXRlIGZhc3QKSW50ZWdyYXRlIG9uY2U=,
+  encoding: BASE64,
+  file_name: resume.pdf,
+  content_type: application/pdf
+)
+```
+