Go API client for merge_crm_client

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

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

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

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./merge_crm_client"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AccountDetailsApi	AccountDetailsRetrieve	Get /account-details
AccountTokenApi	AccountTokenRetrieve	Get /account-token/{public_token}
AccountsApi	AccountsCreate	Post /accounts
AccountsApi	AccountsList	Get /accounts
AccountsApi	AccountsMetaPatchRetrieve	Get /accounts/meta/patch/{id}
AccountsApi	AccountsMetaPostRetrieve	Get /accounts/meta/post
AccountsApi	AccountsPartialUpdate	Patch /accounts/{id}
AccountsApi	AccountsRemoteFieldClassesList	Get /accounts/remote-field-classes
AccountsApi	AccountsRetrieve	Get /accounts/{id}
AssociationTypesApi	CustomObjectClassesAssociationTypesCreate	Post /custom-object-classes/{custom_object_class_id}/association-types
AssociationTypesApi	CustomObjectClassesAssociationTypesList	Get /custom-object-classes/{custom_object_class_id}/association-types
AssociationTypesApi	CustomObjectClassesAssociationTypesMetaPostRetrieve	Get /custom-object-classes/{custom_object_class_id}/association-types/meta/post
AssociationTypesApi	CustomObjectClassesAssociationTypesRetrieve	Get /custom-object-classes/{custom_object_class_id}/association-types/{id}
AssociationsApi	CustomObjectClassesCustomObjectsAssociationsList	Get /custom-object-classes/{custom_object_class_id}/custom-objects/{object_id}/associations
AssociationsApi	CustomObjectClassesCustomObjectsAssociationsUpdate	Put /custom-object-classes/{source_class_id}/custom-objects/{source_object_id}/associations/{target_class_id}/{target_object_id}/{association_type_id}
AvailableActionsApi	AvailableActionsRetrieve	Get /available-actions
ContactsApi	ContactsCreate	Post /contacts
ContactsApi	ContactsIgnoreCreate	Post /contacts/ignore/{model_id}
ContactsApi	ContactsList	Get /contacts
ContactsApi	ContactsMetaPatchRetrieve	Get /contacts/meta/patch/{id}
ContactsApi	ContactsMetaPostRetrieve	Get /contacts/meta/post
ContactsApi	ContactsPartialUpdate	Patch /contacts/{id}
ContactsApi	ContactsRemoteFieldClassesList	Get /contacts/remote-field-classes
ContactsApi	ContactsRetrieve	Get /contacts/{id}
CustomObjectClassesApi	CustomObjectClassesGeneratorUpdate	Put /custom-object-classes/generator/{generator_id}
CustomObjectClassesApi	CustomObjectClassesList	Get /custom-object-classes
CustomObjectClassesApi	CustomObjectClassesRetrieve	Get /custom-object-classes/{id}
CustomObjectsApi	CustomObjectClassesCustomObjectsCreate	Post /custom-object-classes/{custom_object_class_id}/custom-objects
CustomObjectsApi	CustomObjectClassesCustomObjectsList	Get /custom-object-classes/{custom_object_class_id}/custom-objects
CustomObjectsApi	CustomObjectClassesCustomObjectsMetaPatchRetrieve	Get /custom-object-classes/{custom_object_class_id}/custom-objects/meta/patch/{id}
CustomObjectsApi	CustomObjectClassesCustomObjectsMetaPostRetrieve	Get /custom-object-classes/{custom_object_class_id}/custom-objects/meta/post
CustomObjectsApi	CustomObjectClassesCustomObjectsPartialUpdate	Patch /custom-object-classes/{custom_object_class_id}/custom-objects/{id}
CustomObjectsApi	CustomObjectClassesCustomObjectsRetrieve	Get /custom-object-classes/{custom_object_class_id}/custom-objects/{id}
DeleteAccountApi	DeleteAccountCreate	Post /delete-account
EngagementTypesApi	EngagementTypesList	Get /engagement-types
EngagementTypesApi	EngagementTypesRemoteFieldClassesList	Get /engagement-types/remote-field-classes
EngagementTypesApi	EngagementTypesRetrieve	Get /engagement-types/{id}
EngagementsApi	EngagementsCreate	Post /engagements
EngagementsApi	EngagementsList	Get /engagements
EngagementsApi	EngagementsMetaPatchRetrieve	Get /engagements/meta/patch/{id}
EngagementsApi	EngagementsMetaPostRetrieve	Get /engagements/meta/post
EngagementsApi	EngagementsPartialUpdate	Patch /engagements/{id}
EngagementsApi	EngagementsRemoteFieldClassesList	Get /engagements/remote-field-classes
EngagementsApi	EngagementsRetrieve	Get /engagements/{id}
ForceResyncApi	SyncStatusResyncCreate	Post /sync-status/resync
GenerateKeyApi	GenerateKeyCreate	Post /generate-key
IssuesApi	IssuesList	Get /issues
IssuesApi	IssuesRetrieve	Get /issues/{id}
LeadsApi	LeadsCreate	Post /leads
LeadsApi	LeadsList	Get /leads
LeadsApi	LeadsMetaPostRetrieve	Get /leads/meta/post
LeadsApi	LeadsRemoteFieldClassesList	Get /leads/remote-field-classes
LeadsApi	LeadsRetrieve	Get /leads/{id}
LinkTokenApi	LinkTokenCreate	Post /link-token
LinkedAccountsApi	LinkedAccountsList	Get /linked-accounts
NotesApi	NotesCreate	Post /notes
NotesApi	NotesList	Get /notes
NotesApi	NotesMetaPostRetrieve	Get /notes/meta/post
NotesApi	NotesRemoteFieldClassesList	Get /notes/remote-field-classes
NotesApi	NotesRetrieve	Get /notes/{id}
OpportunitiesApi	OpportunitiesCreate	Post /opportunities
OpportunitiesApi	OpportunitiesList	Get /opportunities
OpportunitiesApi	OpportunitiesMetaPatchRetrieve	Get /opportunities/meta/patch/{id}
OpportunitiesApi	OpportunitiesMetaPostRetrieve	Get /opportunities/meta/post
OpportunitiesApi	OpportunitiesPartialUpdate	Patch /opportunities/{id}
OpportunitiesApi	OpportunitiesRemoteFieldClassesList	Get /opportunities/remote-field-classes
OpportunitiesApi	OpportunitiesRetrieve	Get /opportunities/{id}
PassthroughApi	PassthroughCreate	Post /passthrough
RegenerateKeyApi	RegenerateKeyCreate	Post /regenerate-key
SelectiveSyncApi	SelectiveSyncConfigurationsList	Get /selective-sync/configurations
SelectiveSyncApi	SelectiveSyncConfigurationsUpdate	Put /selective-sync/configurations
SelectiveSyncApi	SelectiveSyncMetaList	Get /selective-sync/meta
StagesApi	StagesList	Get /stages
StagesApi	StagesRemoteFieldClassesList	Get /stages/remote-field-classes
StagesApi	StagesRetrieve	Get /stages/{id}
SyncStatusApi	SyncStatusList	Get /sync-status
TasksApi	TasksCreate	Post /tasks
TasksApi	TasksList	Get /tasks
TasksApi	TasksMetaPatchRetrieve	Get /tasks/meta/patch/{id}
TasksApi	TasksMetaPostRetrieve	Get /tasks/meta/post
TasksApi	TasksPartialUpdate	Patch /tasks/{id}
TasksApi	TasksRemoteFieldClassesList	Get /tasks/remote-field-classes
TasksApi	TasksRetrieve	Get /tasks/{id}
UsersApi	UsersIgnoreCreate	Post /users/ignore/{model_id}
UsersApi	UsersList	Get /users
UsersApi	UsersRemoteFieldClassesList	Get /users/remote-field-classes
UsersApi	UsersRetrieve	Get /users/{id}
WebhookReceiversApi	WebhookReceiversCreate	Post /webhook-receivers
WebhookReceiversApi	WebhookReceiversList	Get /webhook-receivers

Documentation For Models

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

Documentation For Authorization

tokenAuth

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

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

hello@merge.dev