merge_crm_client

MergeCRMClient - the Ruby gem for the Merge CRM API

The unified API for building rich integrations with multiple CRM platforms.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0.3
• Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://www.merge.dev/

Installation

Build a gem

To build the Ruby code into a gem:

gem build merge_crm_client.gemspec

Then either install the gem locally:

gem install ./merge_crm_client-1.0.3.gem

(for development, run gem install --dev ./merge_crm_client-1.0.3.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'merge_crm_client', '~> 1.0.3'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/merge-api/merge-crm-ruby, then add the following in the Gemfile:

gem 'merge_crm_client', :git => 'https://github.com/merge-api/merge-crm-ruby.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
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::AccountDetailsApi.new
x_account_token = 'x_account_token_example' # String | Token identifying the end user.

begin
  result = api_instance.account_details_retrieve(x_account_token)
  p result
rescue MergeCRMClient::ApiError => e
  puts "Exception when calling AccountDetailsApi->account_details_retrieve: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.merge.dev/api/crm/v1

Class	Method	HTTP request	Description
MergeCRMClient::AccountDetailsApi	account_details_retrieve	GET /account-details
MergeCRMClient::AccountTokenApi	account_token_retrieve	GET /account-token/{public_token}
MergeCRMClient::AccountsApi	accounts_create	POST /accounts
MergeCRMClient::AccountsApi	accounts_list	GET /accounts
MergeCRMClient::AccountsApi	accounts_meta_patch_retrieve	GET /accounts/meta/patch/{id}
MergeCRMClient::AccountsApi	accounts_meta_post_retrieve	GET /accounts/meta/post
MergeCRMClient::AccountsApi	accounts_partial_update	PATCH /accounts/{id}
MergeCRMClient::AccountsApi	accounts_remote_field_classes_list	GET /accounts/remote-field-classes
MergeCRMClient::AccountsApi	accounts_retrieve	GET /accounts/{id}
MergeCRMClient::AssociationTypesApi	custom_object_classes_association_types_create	POST /custom-object-classes/{custom_object_class_id}/association-types
MergeCRMClient::AssociationTypesApi	custom_object_classes_association_types_list	GET /custom-object-classes/{custom_object_class_id}/association-types
MergeCRMClient::AssociationTypesApi	custom_object_classes_association_types_meta_post_retrieve	GET /custom-object-classes/{custom_object_class_id}/association-types/meta/post
MergeCRMClient::AssociationTypesApi	custom_object_classes_association_types_retrieve	GET /custom-object-classes/{custom_object_class_id}/association-types/{id}
MergeCRMClient::AssociationsApi	custom_object_classes_custom_objects_associations_list	GET /custom-object-classes/{custom_object_class_id}/custom-objects/{object_id}/associations
MergeCRMClient::AssociationsApi	custom_object_classes_custom_objects_associations_update	PUT /custom-object-classes/{source_class_id}/custom-objects/{source_object_id}/associations/{target_class_id}/{target_object_id}/{association_type_id}
MergeCRMClient::AsyncPassthroughApi	async_passthrough_create	POST /async-passthrough
MergeCRMClient::AsyncPassthroughApi	async_passthrough_retrieve	GET /async-passthrough/{async_passthrough_receipt_id}
MergeCRMClient::AvailableActionsApi	available_actions_retrieve	GET /available-actions
MergeCRMClient::ContactsApi	contacts_create	POST /contacts
MergeCRMClient::ContactsApi	contacts_ignore_create	POST /contacts/ignore/{model_id}
MergeCRMClient::ContactsApi	contacts_list	GET /contacts
MergeCRMClient::ContactsApi	contacts_meta_patch_retrieve	GET /contacts/meta/patch/{id}
MergeCRMClient::ContactsApi	contacts_meta_post_retrieve	GET /contacts/meta/post
MergeCRMClient::ContactsApi	contacts_partial_update	PATCH /contacts/{id}
MergeCRMClient::ContactsApi	contacts_remote_field_classes_list	GET /contacts/remote-field-classes
MergeCRMClient::ContactsApi	contacts_retrieve	GET /contacts/{id}
MergeCRMClient::CustomObjectClassesApi	custom_object_classes_generator_update	PUT /custom-object-classes/generator/{generator_id}
MergeCRMClient::CustomObjectClassesApi	custom_object_classes_list	GET /custom-object-classes
MergeCRMClient::CustomObjectClassesApi	custom_object_classes_retrieve	GET /custom-object-classes/{id}
MergeCRMClient::CustomObjectsApi	custom_object_classes_custom_objects_create	POST /custom-object-classes/{custom_object_class_id}/custom-objects
MergeCRMClient::CustomObjectsApi	custom_object_classes_custom_objects_list	GET /custom-object-classes/{custom_object_class_id}/custom-objects
MergeCRMClient::CustomObjectsApi	custom_object_classes_custom_objects_meta_patch_retrieve	GET /custom-object-classes/{custom_object_class_id}/custom-objects/meta/patch/{id}
MergeCRMClient::CustomObjectsApi	custom_object_classes_custom_objects_meta_post_retrieve	GET /custom-object-classes/{custom_object_class_id}/custom-objects/meta/post
MergeCRMClient::CustomObjectsApi	custom_object_classes_custom_objects_partial_update	PATCH /custom-object-classes/{custom_object_class_id}/custom-objects/{id}
MergeCRMClient::CustomObjectsApi	custom_object_classes_custom_objects_retrieve	GET /custom-object-classes/{custom_object_class_id}/custom-objects/{id}
MergeCRMClient::DeleteAccountApi	delete_account_delete	POST /delete-account
MergeCRMClient::EngagementTypesApi	engagement_types_list	GET /engagement-types
MergeCRMClient::EngagementTypesApi	engagement_types_remote_field_classes_list	GET /engagement-types/remote-field-classes
MergeCRMClient::EngagementTypesApi	engagement_types_retrieve	GET /engagement-types/{id}
MergeCRMClient::EngagementsApi	engagements_create	POST /engagements
MergeCRMClient::EngagementsApi	engagements_list	GET /engagements
MergeCRMClient::EngagementsApi	engagements_meta_patch_retrieve	GET /engagements/meta/patch/{id}
MergeCRMClient::EngagementsApi	engagements_meta_post_retrieve	GET /engagements/meta/post
MergeCRMClient::EngagementsApi	engagements_partial_update	PATCH /engagements/{id}
MergeCRMClient::EngagementsApi	engagements_remote_field_classes_list	GET /engagements/remote-field-classes
MergeCRMClient::EngagementsApi	engagements_retrieve	GET /engagements/{id}
MergeCRMClient::ForceResyncApi	sync_status_resync_create	POST /sync-status/resync
MergeCRMClient::GenerateKeyApi	generate_key_create	POST /generate-key
MergeCRMClient::IssuesApi	issues_list	GET /issues
MergeCRMClient::IssuesApi	issues_retrieve	GET /issues/{id}
MergeCRMClient::LeadsApi	leads_create	POST /leads
MergeCRMClient::LeadsApi	leads_list	GET /leads
MergeCRMClient::LeadsApi	leads_meta_post_retrieve	GET /leads/meta/post
MergeCRMClient::LeadsApi	leads_remote_field_classes_list	GET /leads/remote-field-classes
MergeCRMClient::LeadsApi	leads_retrieve	GET /leads/{id}
MergeCRMClient::LinkTokenApi	link_token_create	POST /link-token
MergeCRMClient::LinkedAccountsApi	linked_accounts_list	GET /linked-accounts
MergeCRMClient::NotesApi	notes_create	POST /notes
MergeCRMClient::NotesApi	notes_list	GET /notes
MergeCRMClient::NotesApi	notes_meta_post_retrieve	GET /notes/meta/post
MergeCRMClient::NotesApi	notes_remote_field_classes_list	GET /notes/remote-field-classes
MergeCRMClient::NotesApi	notes_retrieve	GET /notes/{id}
MergeCRMClient::OpportunitiesApi	opportunities_create	POST /opportunities
MergeCRMClient::OpportunitiesApi	opportunities_list	GET /opportunities
MergeCRMClient::OpportunitiesApi	opportunities_meta_patch_retrieve	GET /opportunities/meta/patch/{id}
MergeCRMClient::OpportunitiesApi	opportunities_meta_post_retrieve	GET /opportunities/meta/post
MergeCRMClient::OpportunitiesApi	opportunities_partial_update	PATCH /opportunities/{id}
MergeCRMClient::OpportunitiesApi	opportunities_remote_field_classes_list	GET /opportunities/remote-field-classes
MergeCRMClient::OpportunitiesApi	opportunities_retrieve	GET /opportunities/{id}
MergeCRMClient::PassthroughApi	passthrough_create	POST /passthrough
MergeCRMClient::RegenerateKeyApi	regenerate_key_create	POST /regenerate-key
MergeCRMClient::SelectiveSyncApi	selective_sync_configurations_list	GET /selective-sync/configurations
MergeCRMClient::SelectiveSyncApi	selective_sync_configurations_update	PUT /selective-sync/configurations
MergeCRMClient::SelectiveSyncApi	selective_sync_meta_list	GET /selective-sync/meta
MergeCRMClient::StagesApi	stages_list	GET /stages
MergeCRMClient::StagesApi	stages_remote_field_classes_list	GET /stages/remote-field-classes
MergeCRMClient::StagesApi	stages_retrieve	GET /stages/{id}
MergeCRMClient::SyncStatusApi	sync_status_list	GET /sync-status
MergeCRMClient::TasksApi	tasks_create	POST /tasks
MergeCRMClient::TasksApi	tasks_list	GET /tasks
MergeCRMClient::TasksApi	tasks_meta_patch_retrieve	GET /tasks/meta/patch/{id}
MergeCRMClient::TasksApi	tasks_meta_post_retrieve	GET /tasks/meta/post
MergeCRMClient::TasksApi	tasks_partial_update	PATCH /tasks/{id}
MergeCRMClient::TasksApi	tasks_remote_field_classes_list	GET /tasks/remote-field-classes
MergeCRMClient::TasksApi	tasks_retrieve	GET /tasks/{id}
MergeCRMClient::UsersApi	users_ignore_create	POST /users/ignore/{model_id}
MergeCRMClient::UsersApi	users_list	GET /users
MergeCRMClient::UsersApi	users_remote_field_classes_list	GET /users/remote-field-classes
MergeCRMClient::UsersApi	users_retrieve	GET /users/{id}
MergeCRMClient::WebhookReceiversApi	webhook_receivers_create	POST /webhook-receivers
MergeCRMClient::WebhookReceiversApi	webhook_receivers_list	GET /webhook-receivers

Documentation for Models

• MergeCRMClient::Account
• MergeCRMClient::AccountDetails
• MergeCRMClient::AccountDetailsAndActions
• MergeCRMClient::AccountDetailsAndActionsIntegration
• MergeCRMClient::AccountDetailsAndActionsStatusEnum
• MergeCRMClient::AccountIntegration
• MergeCRMClient::AccountRequest
• MergeCRMClient::AccountToken
• MergeCRMClient::ActivityTypeEnum
• MergeCRMClient::Address
• MergeCRMClient::AddressRequest
• MergeCRMClient::AddressTypeEnum
• MergeCRMClient::Association
• MergeCRMClient::AssociationSubType
• MergeCRMClient::AssociationType
• MergeCRMClient::AssociationTypeRequestRequest
• MergeCRMClient::AsyncPassthroughReciept
• MergeCRMClient::AvailableActions
• MergeCRMClient::CRMAccountEndpointRequest
• MergeCRMClient::CRMAccountResponse
• MergeCRMClient::CRMAssociationTypeEndpointRequest
• MergeCRMClient::CRMAssociationTypeResponse
• MergeCRMClient::CRMContactEndpointRequest
• MergeCRMClient::CRMContactResponse
• MergeCRMClient::CRMCustomObjectEndpointRequest
• MergeCRMClient::CRMCustomObjectResponse
• MergeCRMClient::CardinalityEnum
• MergeCRMClient::CategoriesEnum
• MergeCRMClient::CategoryEnum
• MergeCRMClient::CommonModelScopesBodyRequest
• MergeCRMClient::ConditionSchema
• MergeCRMClient::ConditionTypeEnum
• MergeCRMClient::Contact
• MergeCRMClient::ContactRequest
• MergeCRMClient::CountryEnum
• MergeCRMClient::CustomObject
• MergeCRMClient::CustomObjectClass
• MergeCRMClient::CustomObjectRequest
• MergeCRMClient::DataPassthroughRequest
• MergeCRMClient::DebugModeLog
• MergeCRMClient::DebugModelLogSummary
• MergeCRMClient::DirectionEnum
• MergeCRMClient::EmailAddress
• MergeCRMClient::EmailAddressRequest
• MergeCRMClient::EnabledActionsEnum
• MergeCRMClient::EncodingEnum
• MergeCRMClient::EndUserDetailsRequest
• MergeCRMClient::Engagement
• MergeCRMClient::EngagementEndpointRequest
• MergeCRMClient::EngagementRequest
• MergeCRMClient::EngagementResponse
• MergeCRMClient::EngagementType
• MergeCRMClient::ErrorValidationProblem
• MergeCRMClient::FieldFormatEnum
• MergeCRMClient::FieldTypeEnum
• MergeCRMClient::GenerateRemoteKeyRequest
• MergeCRMClient::IgnoreCommonModelRequest
• MergeCRMClient::Issue
• MergeCRMClient::IssueStatusEnum
• MergeCRMClient::ItemFormatEnum
• MergeCRMClient::ItemSchema
• MergeCRMClient::ItemTypeEnum
• MergeCRMClient::Lead
• MergeCRMClient::LeadEndpointRequest
• MergeCRMClient::LeadRequest
• MergeCRMClient::LeadResponse
• MergeCRMClient::LinkToken
• MergeCRMClient::LinkedAccountCondition
• MergeCRMClient::LinkedAccountConditionRequest
• MergeCRMClient::LinkedAccountSelectiveSyncConfiguration
• MergeCRMClient::LinkedAccountSelectiveSyncConfigurationListRequest
• MergeCRMClient::LinkedAccountSelectiveSyncConfigurationRequest
• MergeCRMClient::LinkedAccountStatus
• MergeCRMClient::MetaResponse
• MergeCRMClient::MethodEnum
• MergeCRMClient::ModelOperation
• MergeCRMClient::MultipartFormFieldRequest
• MergeCRMClient::Note
• MergeCRMClient::NoteEndpointRequest
• MergeCRMClient::NoteRequest
• MergeCRMClient::NoteResponse
• MergeCRMClient::ObjectClassDescriptionRequest
• MergeCRMClient::OperatorSchema
• MergeCRMClient::Opportunity
• MergeCRMClient::OpportunityEndpointRequest
• MergeCRMClient::OpportunityRequest
• MergeCRMClient::OpportunityResponse
• MergeCRMClient::OpportunityStatusEnum
• MergeCRMClient::OriginTypeEnum
• MergeCRMClient::PaginatedAccountDetailsAndActionsList
• MergeCRMClient::PaginatedAccountList
• MergeCRMClient::PaginatedAssociationList
• MergeCRMClient::PaginatedAssociationTypeList
• MergeCRMClient::PaginatedConditionSchemaList
• MergeCRMClient::PaginatedContactList
• MergeCRMClient::PaginatedCustomObjectClassList
• MergeCRMClient::PaginatedCustomObjectList
• MergeCRMClient::PaginatedEngagementList
• MergeCRMClient::PaginatedEngagementTypeList
• MergeCRMClient::PaginatedIssueList
• MergeCRMClient::PaginatedLeadList
• MergeCRMClient::PaginatedNoteList
• MergeCRMClient::PaginatedOpportunityList
• MergeCRMClient::PaginatedRemoteFieldClassList
• MergeCRMClient::PaginatedStageList
• MergeCRMClient::PaginatedSyncStatusList
• MergeCRMClient::PaginatedTaskList
• MergeCRMClient::PaginatedUserList
• MergeCRMClient::PatchedAccountRequest
• MergeCRMClient::PatchedCRMAccountEndpointRequest
• MergeCRMClient::PatchedCRMContactEndpointRequest
• MergeCRMClient::PatchedCRMCustomObjectEndpointRequest
• MergeCRMClient::PatchedContactRequest
• MergeCRMClient::PatchedEngagementEndpointRequest
• MergeCRMClient::PatchedEngagementRequest
• MergeCRMClient::PatchedOpportunityEndpointRequest
• MergeCRMClient::PatchedOpportunityRequest
• MergeCRMClient::PatchedTaskEndpointRequest
• MergeCRMClient::PatchedTaskRequest
• MergeCRMClient::PhoneNumber
• MergeCRMClient::PhoneNumberRequest
• MergeCRMClient::ReasonEnum
• MergeCRMClient::RemoteData
• MergeCRMClient::RemoteField
• MergeCRMClient::RemoteFieldClass
• MergeCRMClient::RemoteFieldClassForCustomObjectClass
• MergeCRMClient::RemoteFieldClassForCustomObjectClassItemSchema
• MergeCRMClient::RemoteFieldRequest
• MergeCRMClient::RemoteKey
• MergeCRMClient::RemoteKeyForRegenerationRequest
• MergeCRMClient::RemoteResponse
• MergeCRMClient::RequestFormatEnum
• MergeCRMClient::ResponseTypeEnum
• MergeCRMClient::SelectiveSyncConfigurationsUsageEnum
• MergeCRMClient::Stage
• MergeCRMClient::SyncStatus
• MergeCRMClient::SyncStatusStatusEnum
• MergeCRMClient::Task
• MergeCRMClient::TaskEndpointRequest
• MergeCRMClient::TaskRequest
• MergeCRMClient::TaskResponse
• MergeCRMClient::TaskStatusEnum
• MergeCRMClient::User
• MergeCRMClient::ValidationProblemSource
• MergeCRMClient::WarningValidationProblem
• MergeCRMClient::WebhookReceiver
• MergeCRMClient::WebhookReceiverRequest

Documentation for Authorization

tokenAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header