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.1
  • 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.1.gem

(for development, run gem install --dev ./merge_crm_client-1.0.1.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.1'

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_example' # String | Token identifying the end user.

begin
  result = api_instance.()
  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_post_retrieve GET /accounts/meta/post
MergeCRMClient::AccountsApi accounts_retrieve GET /accounts/id
MergeCRMClient::AvailableActionsApi available_actions_retrieve GET /available-actions
MergeCRMClient::ContactsApi contacts_create POST /contacts
MergeCRMClient::ContactsApi contacts_list GET /contacts
MergeCRMClient::ContactsApi contacts_meta_post_retrieve GET /contacts/meta/post
MergeCRMClient::ContactsApi contacts_retrieve GET /contacts/id
MergeCRMClient::DeleteAccountApi delete_account_create POST /delete-account
MergeCRMClient::EngagementTypesApi engagement_types_list GET /engagement-types
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_post_retrieve GET /engagements/meta/post
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_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_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_retrieve GET /opportunities/id
MergeCRMClient::PassthroughApi passthrough_create POST /passthrough
MergeCRMClient::RegenerateKeyApi regenerate_key_create POST /regenerate-key
MergeCRMClient::StagesApi stages_list GET /stages
MergeCRMClient::StagesApi stages_retrieve GET /stages/id
MergeCRMClient::SyncStatusApi sync_status_list GET /sync-status
MergeCRMClient::TasksApi tasks_list GET /tasks
MergeCRMClient::TasksApi tasks_retrieve GET /tasks/id
MergeCRMClient::UsersApi users_list GET /users
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

Documentation for Authorization

tokenAuth

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