merge_ticketing_client

MergeTicketingClient - the Ruby gem for the Merge Ticketing API

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

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0.5
• 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_ticketing_client.gemspec

Then either install the gem locally:

gem install ./merge_ticketing_client-1.0.5.gem

(for development, run gem install --dev ./merge_ticketing_client-1.0.5.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_ticketing_client', '~> 1.0.5'

Install from Git

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

gem 'merge_ticketing_client', :git => 'https://github.com/merge-api/merge-ticketing-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_ticketing_client'

# Setup authorization
MergeTicketingClient.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 = MergeTicketingClient::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 MergeTicketingClient::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/ticketing/v1

Class	Method	HTTP request	Description
MergeTicketingClient::AccountDetailsApi	account_details_retrieve	GET /account-details
MergeTicketingClient::AccountTokenApi	account_token_retrieve	GET /account-token/public_token
MergeTicketingClient::AccountsApi	accounts_list	GET /accounts
MergeTicketingClient::AccountsApi	accounts_retrieve	GET /accounts/id
MergeTicketingClient::AsyncPassthroughApi	async_passthrough_create	POST /async-passthrough
MergeTicketingClient::AsyncPassthroughApi	async_passthrough_retrieve	GET /async-passthrough/async_passthrough_receipt_id
MergeTicketingClient::AttachmentsApi	attachments_create	POST /attachments
MergeTicketingClient::AttachmentsApi	attachments_download_retrieve	GET /attachments/id/download
MergeTicketingClient::AttachmentsApi	attachments_list	GET /attachments
MergeTicketingClient::AttachmentsApi	attachments_meta_post_retrieve	GET /attachments/meta/post
MergeTicketingClient::AttachmentsApi	attachments_retrieve	GET /attachments/id
MergeTicketingClient::AvailableActionsApi	available_actions_retrieve	GET /available-actions
MergeTicketingClient::CollectionsApi	collections_list	GET /collections
MergeTicketingClient::CollectionsApi	collections_retrieve	GET /collections/id
MergeTicketingClient::CollectionsApi	collections_users_list	GET /collections/parent_id/users
MergeTicketingClient::CommentsApi	comments_create	POST /comments
MergeTicketingClient::CommentsApi	comments_list	GET /comments
MergeTicketingClient::CommentsApi	comments_meta_post_retrieve	GET /comments/meta/post
MergeTicketingClient::CommentsApi	comments_retrieve	GET /comments/id
MergeTicketingClient::ContactsApi	contacts_list	GET /contacts
MergeTicketingClient::ContactsApi	contacts_retrieve	GET /contacts/id
MergeTicketingClient::DeleteAccountApi	delete_account_delete	POST /delete-account
MergeTicketingClient::ForceResyncApi	sync_status_resync_create	POST /sync-status/resync
MergeTicketingClient::GenerateKeyApi	generate_key_create	POST /generate-key
MergeTicketingClient::IssuesApi	issues_list	GET /issues
MergeTicketingClient::IssuesApi	issues_retrieve	GET /issues/id
MergeTicketingClient::LinkTokenApi	link_token_create	POST /link-token
MergeTicketingClient::LinkedAccountsApi	linked_accounts_list	GET /linked-accounts
MergeTicketingClient::PassthroughApi	passthrough_create	POST /passthrough
MergeTicketingClient::ProjectsApi	projects_list	GET /projects
MergeTicketingClient::ProjectsApi	projects_retrieve	GET /projects/id
MergeTicketingClient::ProjectsApi	projects_users_list	GET /projects/parent_id/users
MergeTicketingClient::RegenerateKeyApi	regenerate_key_create	POST /regenerate-key
MergeTicketingClient::SelectiveSyncApi	selective_sync_configurations_list	GET /selective-sync/configurations
MergeTicketingClient::SelectiveSyncApi	selective_sync_configurations_update	PUT /selective-sync/configurations
MergeTicketingClient::SelectiveSyncApi	selective_sync_meta_list	GET /selective-sync/meta
MergeTicketingClient::SyncStatusApi	sync_status_list	GET /sync-status
MergeTicketingClient::TagsApi	tags_list	GET /tags
MergeTicketingClient::TagsApi	tags_retrieve	GET /tags/id
MergeTicketingClient::TeamsApi	teams_list	GET /teams
MergeTicketingClient::TeamsApi	teams_retrieve	GET /teams/id
MergeTicketingClient::TicketsApi	tickets_collaborators_list	GET /tickets/parent_id/collaborators
MergeTicketingClient::TicketsApi	tickets_create	POST /tickets
MergeTicketingClient::TicketsApi	tickets_list	GET /tickets
MergeTicketingClient::TicketsApi	tickets_meta_patch_retrieve	GET /tickets/meta/patch/id
MergeTicketingClient::TicketsApi	tickets_meta_post_retrieve	GET /tickets/meta/post
MergeTicketingClient::TicketsApi	tickets_partial_update	PATCH /tickets/id
MergeTicketingClient::TicketsApi	tickets_remote_field_classes_list	GET /tickets/remote-field-classes
MergeTicketingClient::TicketsApi	tickets_retrieve	GET /tickets/id
MergeTicketingClient::UsersApi	users_list	GET /users
MergeTicketingClient::UsersApi	users_retrieve	GET /users/id
MergeTicketingClient::WebhookReceiversApi	webhook_receivers_create	POST /webhook-receivers
MergeTicketingClient::WebhookReceiversApi	webhook_receivers_list	GET /webhook-receivers

Documentation for Models

• MergeTicketingClient::AccessLevelEnum
• MergeTicketingClient::Account
• MergeTicketingClient::AccountDetails
• MergeTicketingClient::AccountDetailsAndActions
• MergeTicketingClient::AccountDetailsAndActionsIntegration
• MergeTicketingClient::AccountDetailsAndActionsStatusEnum
• MergeTicketingClient::AccountIntegration
• MergeTicketingClient::AccountToken
• MergeTicketingClient::AsyncPassthroughReciept
• MergeTicketingClient::Attachment
• MergeTicketingClient::AttachmentRequest
• MergeTicketingClient::AvailableActions
• MergeTicketingClient::CategoriesEnum
• MergeTicketingClient::CategoryEnum
• MergeTicketingClient::Collection
• MergeTicketingClient::CollectionTypeEnum
• MergeTicketingClient::Comment
• MergeTicketingClient::CommentEndpointRequest
• MergeTicketingClient::CommentRequest
• MergeTicketingClient::CommentResponse
• MergeTicketingClient::CommonModelScopesBodyRequest
• MergeTicketingClient::ConditionSchema
• MergeTicketingClient::ConditionTypeEnum
• MergeTicketingClient::Contact
• MergeTicketingClient::DataPassthroughRequest
• MergeTicketingClient::DebugModeLog
• MergeTicketingClient::DebugModelLogSummary
• MergeTicketingClient::EnabledActionsEnum
• MergeTicketingClient::EncodingEnum
• MergeTicketingClient::EndUserDetailsRequest
• MergeTicketingClient::ErrorValidationProblem
• MergeTicketingClient::FieldFormatEnum
• MergeTicketingClient::FieldTypeEnum
• MergeTicketingClient::GenerateRemoteKeyRequest
• MergeTicketingClient::Issue
• MergeTicketingClient::IssueStatusEnum
• MergeTicketingClient::ItemFormatEnum
• MergeTicketingClient::ItemSchema
• MergeTicketingClient::ItemTypeEnum
• MergeTicketingClient::LinkToken
• MergeTicketingClient::LinkedAccountCondition
• MergeTicketingClient::LinkedAccountConditionRequest
• MergeTicketingClient::LinkedAccountSelectiveSyncConfiguration
• MergeTicketingClient::LinkedAccountSelectiveSyncConfigurationListRequest
• MergeTicketingClient::LinkedAccountSelectiveSyncConfigurationRequest
• MergeTicketingClient::LinkedAccountStatus
• MergeTicketingClient::MetaResponse
• MergeTicketingClient::MethodEnum
• MergeTicketingClient::ModelOperation
• MergeTicketingClient::MultipartFormFieldRequest
• MergeTicketingClient::OperatorSchema
• MergeTicketingClient::PaginatedAccountDetailsAndActionsList
• MergeTicketingClient::PaginatedAccountList
• MergeTicketingClient::PaginatedAttachmentList
• MergeTicketingClient::PaginatedCollectionList
• MergeTicketingClient::PaginatedCommentList
• MergeTicketingClient::PaginatedConditionSchemaList
• MergeTicketingClient::PaginatedContactList
• MergeTicketingClient::PaginatedIssueList
• MergeTicketingClient::PaginatedProjectList
• MergeTicketingClient::PaginatedRemoteFieldClassList
• MergeTicketingClient::PaginatedSyncStatusList
• MergeTicketingClient::PaginatedTagList
• MergeTicketingClient::PaginatedTeamList
• MergeTicketingClient::PaginatedTicketList
• MergeTicketingClient::PaginatedUserList
• MergeTicketingClient::PatchedTicketEndpointRequest
• MergeTicketingClient::PatchedTicketRequest
• MergeTicketingClient::PriorityEnum
• MergeTicketingClient::Project
• MergeTicketingClient::RemoteData
• MergeTicketingClient::RemoteField
• MergeTicketingClient::RemoteFieldClass
• MergeTicketingClient::RemoteFieldRequest
• MergeTicketingClient::RemoteKey
• MergeTicketingClient::RemoteKeyForRegenerationRequest
• MergeTicketingClient::RemoteResponse
• MergeTicketingClient::RequestFormatEnum
• MergeTicketingClient::ResponseTypeEnum
• MergeTicketingClient::SelectiveSyncConfigurationsUsageEnum
• MergeTicketingClient::SyncStatus
• MergeTicketingClient::SyncStatusStatusEnum
• MergeTicketingClient::Tag
• MergeTicketingClient::Team
• MergeTicketingClient::Ticket
• MergeTicketingClient::TicketEndpointRequest
• MergeTicketingClient::TicketRequest
• MergeTicketingClient::TicketResponse
• MergeTicketingClient::TicketStatusEnum
• MergeTicketingClient::TicketingAttachmentEndpointRequest
• MergeTicketingClient::TicketingAttachmentResponse
• MergeTicketingClient::User
• MergeTicketingClient::ValidationProblemSource
• MergeTicketingClient::WarningValidationProblem
• MergeTicketingClient::WebhookReceiver
• MergeTicketingClient::WebhookReceiverRequest

Documentation for Authorization

tokenAuth

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