https://github.com/merge-api/merge-crm-go
The Go API Client for the Merge CRM API.
https://github.com/merge-api/merge-crm-go
Last synced: 5 months ago
JSON representation
The Go API Client for the Merge CRM API.
- Host: GitHub
- URL: https://github.com/merge-api/merge-crm-go
- Owner: merge-api
- License: other
- Created: 2022-06-15T21:44:12.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-20T20:35:41.000Z (almost 3 years ago)
- Last Synced: 2024-06-21T09:45:26.522Z (almost 2 years ago)
- Language: Shell
- Size: 432 KB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) 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/](https://www.merge.dev/)
## Installation
Install the following dependencies:
```shell
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:
```golang
import sw "./merge_crm_client"
```
To use a proxy, set the environment variable `HTTP_PROXY`:
```golang
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`.
```golang
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`.
```golang
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**](docs/AccountDetailsApi.md#accountdetailsretrieve) | **Get** /account-details |
*AccountTokenApi* | [**AccountTokenRetrieve**](docs/AccountTokenApi.md#accounttokenretrieve) | **Get** /account-token/{public_token} |
*AccountsApi* | [**AccountsCreate**](docs/AccountsApi.md#accountscreate) | **Post** /accounts |
*AccountsApi* | [**AccountsList**](docs/AccountsApi.md#accountslist) | **Get** /accounts |
*AccountsApi* | [**AccountsMetaPatchRetrieve**](docs/AccountsApi.md#accountsmetapatchretrieve) | **Get** /accounts/meta/patch/{id} |
*AccountsApi* | [**AccountsMetaPostRetrieve**](docs/AccountsApi.md#accountsmetapostretrieve) | **Get** /accounts/meta/post |
*AccountsApi* | [**AccountsPartialUpdate**](docs/AccountsApi.md#accountspartialupdate) | **Patch** /accounts/{id} |
*AccountsApi* | [**AccountsRemoteFieldClassesList**](docs/AccountsApi.md#accountsremotefieldclasseslist) | **Get** /accounts/remote-field-classes |
*AccountsApi* | [**AccountsRetrieve**](docs/AccountsApi.md#accountsretrieve) | **Get** /accounts/{id} |
*AssociationTypesApi* | [**CustomObjectClassesAssociationTypesCreate**](docs/AssociationTypesApi.md#customobjectclassesassociationtypescreate) | **Post** /custom-object-classes/{custom_object_class_id}/association-types |
*AssociationTypesApi* | [**CustomObjectClassesAssociationTypesList**](docs/AssociationTypesApi.md#customobjectclassesassociationtypeslist) | **Get** /custom-object-classes/{custom_object_class_id}/association-types |
*AssociationTypesApi* | [**CustomObjectClassesAssociationTypesMetaPostRetrieve**](docs/AssociationTypesApi.md#customobjectclassesassociationtypesmetapostretrieve) | **Get** /custom-object-classes/{custom_object_class_id}/association-types/meta/post |
*AssociationTypesApi* | [**CustomObjectClassesAssociationTypesRetrieve**](docs/AssociationTypesApi.md#customobjectclassesassociationtypesretrieve) | **Get** /custom-object-classes/{custom_object_class_id}/association-types/{id} |
*AssociationsApi* | [**CustomObjectClassesCustomObjectsAssociationsList**](docs/AssociationsApi.md#customobjectclassescustomobjectsassociationslist) | **Get** /custom-object-classes/{custom_object_class_id}/custom-objects/{object_id}/associations |
*AssociationsApi* | [**CustomObjectClassesCustomObjectsAssociationsUpdate**](docs/AssociationsApi.md#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**](docs/AvailableActionsApi.md#availableactionsretrieve) | **Get** /available-actions |
*ContactsApi* | [**ContactsCreate**](docs/ContactsApi.md#contactscreate) | **Post** /contacts |
*ContactsApi* | [**ContactsIgnoreCreate**](docs/ContactsApi.md#contactsignorecreate) | **Post** /contacts/ignore/{model_id} |
*ContactsApi* | [**ContactsList**](docs/ContactsApi.md#contactslist) | **Get** /contacts |
*ContactsApi* | [**ContactsMetaPatchRetrieve**](docs/ContactsApi.md#contactsmetapatchretrieve) | **Get** /contacts/meta/patch/{id} |
*ContactsApi* | [**ContactsMetaPostRetrieve**](docs/ContactsApi.md#contactsmetapostretrieve) | **Get** /contacts/meta/post |
*ContactsApi* | [**ContactsPartialUpdate**](docs/ContactsApi.md#contactspartialupdate) | **Patch** /contacts/{id} |
*ContactsApi* | [**ContactsRemoteFieldClassesList**](docs/ContactsApi.md#contactsremotefieldclasseslist) | **Get** /contacts/remote-field-classes |
*ContactsApi* | [**ContactsRetrieve**](docs/ContactsApi.md#contactsretrieve) | **Get** /contacts/{id} |
*CustomObjectClassesApi* | [**CustomObjectClassesGeneratorUpdate**](docs/CustomObjectClassesApi.md#customobjectclassesgeneratorupdate) | **Put** /custom-object-classes/generator/{generator_id} |
*CustomObjectClassesApi* | [**CustomObjectClassesList**](docs/CustomObjectClassesApi.md#customobjectclasseslist) | **Get** /custom-object-classes |
*CustomObjectClassesApi* | [**CustomObjectClassesRetrieve**](docs/CustomObjectClassesApi.md#customobjectclassesretrieve) | **Get** /custom-object-classes/{id} |
*CustomObjectsApi* | [**CustomObjectClassesCustomObjectsCreate**](docs/CustomObjectsApi.md#customobjectclassescustomobjectscreate) | **Post** /custom-object-classes/{custom_object_class_id}/custom-objects |
*CustomObjectsApi* | [**CustomObjectClassesCustomObjectsList**](docs/CustomObjectsApi.md#customobjectclassescustomobjectslist) | **Get** /custom-object-classes/{custom_object_class_id}/custom-objects |
*CustomObjectsApi* | [**CustomObjectClassesCustomObjectsMetaPatchRetrieve**](docs/CustomObjectsApi.md#customobjectclassescustomobjectsmetapatchretrieve) | **Get** /custom-object-classes/{custom_object_class_id}/custom-objects/meta/patch/{id} |
*CustomObjectsApi* | [**CustomObjectClassesCustomObjectsMetaPostRetrieve**](docs/CustomObjectsApi.md#customobjectclassescustomobjectsmetapostretrieve) | **Get** /custom-object-classes/{custom_object_class_id}/custom-objects/meta/post |
*CustomObjectsApi* | [**CustomObjectClassesCustomObjectsPartialUpdate**](docs/CustomObjectsApi.md#customobjectclassescustomobjectspartialupdate) | **Patch** /custom-object-classes/{custom_object_class_id}/custom-objects/{id} |
*CustomObjectsApi* | [**CustomObjectClassesCustomObjectsRetrieve**](docs/CustomObjectsApi.md#customobjectclassescustomobjectsretrieve) | **Get** /custom-object-classes/{custom_object_class_id}/custom-objects/{id} |
*DeleteAccountApi* | [**DeleteAccountCreate**](docs/DeleteAccountApi.md#deleteaccountcreate) | **Post** /delete-account |
*EngagementTypesApi* | [**EngagementTypesList**](docs/EngagementTypesApi.md#engagementtypeslist) | **Get** /engagement-types |
*EngagementTypesApi* | [**EngagementTypesRemoteFieldClassesList**](docs/EngagementTypesApi.md#engagementtypesremotefieldclasseslist) | **Get** /engagement-types/remote-field-classes |
*EngagementTypesApi* | [**EngagementTypesRetrieve**](docs/EngagementTypesApi.md#engagementtypesretrieve) | **Get** /engagement-types/{id} |
*EngagementsApi* | [**EngagementsCreate**](docs/EngagementsApi.md#engagementscreate) | **Post** /engagements |
*EngagementsApi* | [**EngagementsList**](docs/EngagementsApi.md#engagementslist) | **Get** /engagements |
*EngagementsApi* | [**EngagementsMetaPatchRetrieve**](docs/EngagementsApi.md#engagementsmetapatchretrieve) | **Get** /engagements/meta/patch/{id} |
*EngagementsApi* | [**EngagementsMetaPostRetrieve**](docs/EngagementsApi.md#engagementsmetapostretrieve) | **Get** /engagements/meta/post |
*EngagementsApi* | [**EngagementsPartialUpdate**](docs/EngagementsApi.md#engagementspartialupdate) | **Patch** /engagements/{id} |
*EngagementsApi* | [**EngagementsRemoteFieldClassesList**](docs/EngagementsApi.md#engagementsremotefieldclasseslist) | **Get** /engagements/remote-field-classes |
*EngagementsApi* | [**EngagementsRetrieve**](docs/EngagementsApi.md#engagementsretrieve) | **Get** /engagements/{id} |
*ForceResyncApi* | [**SyncStatusResyncCreate**](docs/ForceResyncApi.md#syncstatusresynccreate) | **Post** /sync-status/resync |
*GenerateKeyApi* | [**GenerateKeyCreate**](docs/GenerateKeyApi.md#generatekeycreate) | **Post** /generate-key |
*IssuesApi* | [**IssuesList**](docs/IssuesApi.md#issueslist) | **Get** /issues |
*IssuesApi* | [**IssuesRetrieve**](docs/IssuesApi.md#issuesretrieve) | **Get** /issues/{id} |
*LeadsApi* | [**LeadsCreate**](docs/LeadsApi.md#leadscreate) | **Post** /leads |
*LeadsApi* | [**LeadsList**](docs/LeadsApi.md#leadslist) | **Get** /leads |
*LeadsApi* | [**LeadsMetaPostRetrieve**](docs/LeadsApi.md#leadsmetapostretrieve) | **Get** /leads/meta/post |
*LeadsApi* | [**LeadsRemoteFieldClassesList**](docs/LeadsApi.md#leadsremotefieldclasseslist) | **Get** /leads/remote-field-classes |
*LeadsApi* | [**LeadsRetrieve**](docs/LeadsApi.md#leadsretrieve) | **Get** /leads/{id} |
*LinkTokenApi* | [**LinkTokenCreate**](docs/LinkTokenApi.md#linktokencreate) | **Post** /link-token |
*LinkedAccountsApi* | [**LinkedAccountsList**](docs/LinkedAccountsApi.md#linkedaccountslist) | **Get** /linked-accounts |
*NotesApi* | [**NotesCreate**](docs/NotesApi.md#notescreate) | **Post** /notes |
*NotesApi* | [**NotesList**](docs/NotesApi.md#noteslist) | **Get** /notes |
*NotesApi* | [**NotesMetaPostRetrieve**](docs/NotesApi.md#notesmetapostretrieve) | **Get** /notes/meta/post |
*NotesApi* | [**NotesRemoteFieldClassesList**](docs/NotesApi.md#notesremotefieldclasseslist) | **Get** /notes/remote-field-classes |
*NotesApi* | [**NotesRetrieve**](docs/NotesApi.md#notesretrieve) | **Get** /notes/{id} |
*OpportunitiesApi* | [**OpportunitiesCreate**](docs/OpportunitiesApi.md#opportunitiescreate) | **Post** /opportunities |
*OpportunitiesApi* | [**OpportunitiesList**](docs/OpportunitiesApi.md#opportunitieslist) | **Get** /opportunities |
*OpportunitiesApi* | [**OpportunitiesMetaPatchRetrieve**](docs/OpportunitiesApi.md#opportunitiesmetapatchretrieve) | **Get** /opportunities/meta/patch/{id} |
*OpportunitiesApi* | [**OpportunitiesMetaPostRetrieve**](docs/OpportunitiesApi.md#opportunitiesmetapostretrieve) | **Get** /opportunities/meta/post |
*OpportunitiesApi* | [**OpportunitiesPartialUpdate**](docs/OpportunitiesApi.md#opportunitiespartialupdate) | **Patch** /opportunities/{id} |
*OpportunitiesApi* | [**OpportunitiesRemoteFieldClassesList**](docs/OpportunitiesApi.md#opportunitiesremotefieldclasseslist) | **Get** /opportunities/remote-field-classes |
*OpportunitiesApi* | [**OpportunitiesRetrieve**](docs/OpportunitiesApi.md#opportunitiesretrieve) | **Get** /opportunities/{id} |
*PassthroughApi* | [**PassthroughCreate**](docs/PassthroughApi.md#passthroughcreate) | **Post** /passthrough |
*RegenerateKeyApi* | [**RegenerateKeyCreate**](docs/RegenerateKeyApi.md#regeneratekeycreate) | **Post** /regenerate-key |
*SelectiveSyncApi* | [**SelectiveSyncConfigurationsList**](docs/SelectiveSyncApi.md#selectivesyncconfigurationslist) | **Get** /selective-sync/configurations |
*SelectiveSyncApi* | [**SelectiveSyncConfigurationsUpdate**](docs/SelectiveSyncApi.md#selectivesyncconfigurationsupdate) | **Put** /selective-sync/configurations |
*SelectiveSyncApi* | [**SelectiveSyncMetaList**](docs/SelectiveSyncApi.md#selectivesyncmetalist) | **Get** /selective-sync/meta |
*StagesApi* | [**StagesList**](docs/StagesApi.md#stageslist) | **Get** /stages |
*StagesApi* | [**StagesRemoteFieldClassesList**](docs/StagesApi.md#stagesremotefieldclasseslist) | **Get** /stages/remote-field-classes |
*StagesApi* | [**StagesRetrieve**](docs/StagesApi.md#stagesretrieve) | **Get** /stages/{id} |
*SyncStatusApi* | [**SyncStatusList**](docs/SyncStatusApi.md#syncstatuslist) | **Get** /sync-status |
*TasksApi* | [**TasksCreate**](docs/TasksApi.md#taskscreate) | **Post** /tasks |
*TasksApi* | [**TasksList**](docs/TasksApi.md#taskslist) | **Get** /tasks |
*TasksApi* | [**TasksMetaPatchRetrieve**](docs/TasksApi.md#tasksmetapatchretrieve) | **Get** /tasks/meta/patch/{id} |
*TasksApi* | [**TasksMetaPostRetrieve**](docs/TasksApi.md#tasksmetapostretrieve) | **Get** /tasks/meta/post |
*TasksApi* | [**TasksPartialUpdate**](docs/TasksApi.md#taskspartialupdate) | **Patch** /tasks/{id} |
*TasksApi* | [**TasksRemoteFieldClassesList**](docs/TasksApi.md#tasksremotefieldclasseslist) | **Get** /tasks/remote-field-classes |
*TasksApi* | [**TasksRetrieve**](docs/TasksApi.md#tasksretrieve) | **Get** /tasks/{id} |
*UsersApi* | [**UsersIgnoreCreate**](docs/UsersApi.md#usersignorecreate) | **Post** /users/ignore/{model_id} |
*UsersApi* | [**UsersList**](docs/UsersApi.md#userslist) | **Get** /users |
*UsersApi* | [**UsersRemoteFieldClassesList**](docs/UsersApi.md#usersremotefieldclasseslist) | **Get** /users/remote-field-classes |
*UsersApi* | [**UsersRetrieve**](docs/UsersApi.md#usersretrieve) | **Get** /users/{id} |
*WebhookReceiversApi* | [**WebhookReceiversCreate**](docs/WebhookReceiversApi.md#webhookreceiverscreate) | **Post** /webhook-receivers |
*WebhookReceiversApi* | [**WebhookReceiversList**](docs/WebhookReceiversApi.md#webhookreceiverslist) | **Get** /webhook-receivers |
## Documentation For Models
- [Account](docs/Account.md)
- [AccountDetails](docs/AccountDetails.md)
- [AccountDetailsAndActions](docs/AccountDetailsAndActions.md)
- [AccountDetailsAndActionsIntegration](docs/AccountDetailsAndActionsIntegration.md)
- [AccountDetailsAndActionsStatusEnum](docs/AccountDetailsAndActionsStatusEnum.md)
- [AccountIntegration](docs/AccountIntegration.md)
- [AccountRequest](docs/AccountRequest.md)
- [AccountToken](docs/AccountToken.md)
- [ActivityTypeEnum](docs/ActivityTypeEnum.md)
- [Address](docs/Address.md)
- [AddressRequest](docs/AddressRequest.md)
- [AddressTypeEnum](docs/AddressTypeEnum.md)
- [Association](docs/Association.md)
- [AssociationSubType](docs/AssociationSubType.md)
- [AssociationType](docs/AssociationType.md)
- [AssociationTypeRequestRequest](docs/AssociationTypeRequestRequest.md)
- [AvailableActions](docs/AvailableActions.md)
- [CRMAccountEndpointRequest](docs/CRMAccountEndpointRequest.md)
- [CRMAccountResponse](docs/CRMAccountResponse.md)
- [CRMAssociationTypeEndpointRequest](docs/CRMAssociationTypeEndpointRequest.md)
- [CRMAssociationTypeResponse](docs/CRMAssociationTypeResponse.md)
- [CRMContactEndpointRequest](docs/CRMContactEndpointRequest.md)
- [CRMContactResponse](docs/CRMContactResponse.md)
- [CRMCustomObjectEndpointRequest](docs/CRMCustomObjectEndpointRequest.md)
- [CRMCustomObjectResponse](docs/CRMCustomObjectResponse.md)
- [CardinalityEnum](docs/CardinalityEnum.md)
- [CategoriesEnum](docs/CategoriesEnum.md)
- [CategoryEnum](docs/CategoryEnum.md)
- [CommonModelScopesBodyRequest](docs/CommonModelScopesBodyRequest.md)
- [ConditionSchema](docs/ConditionSchema.md)
- [ConditionTypeEnum](docs/ConditionTypeEnum.md)
- [Contact](docs/Contact.md)
- [ContactRequest](docs/ContactRequest.md)
- [CountryEnum](docs/CountryEnum.md)
- [CustomObject](docs/CustomObject.md)
- [CustomObjectClass](docs/CustomObjectClass.md)
- [CustomObjectRequest](docs/CustomObjectRequest.md)
- [DataPassthroughRequest](docs/DataPassthroughRequest.md)
- [DebugModeLog](docs/DebugModeLog.md)
- [DebugModelLogSummary](docs/DebugModelLogSummary.md)
- [DirectionEnum](docs/DirectionEnum.md)
- [EmailAddress](docs/EmailAddress.md)
- [EmailAddressRequest](docs/EmailAddressRequest.md)
- [EnabledActionsEnum](docs/EnabledActionsEnum.md)
- [EncodingEnum](docs/EncodingEnum.md)
- [EndUserDetailsRequest](docs/EndUserDetailsRequest.md)
- [Engagement](docs/Engagement.md)
- [EngagementEndpointRequest](docs/EngagementEndpointRequest.md)
- [EngagementRequest](docs/EngagementRequest.md)
- [EngagementResponse](docs/EngagementResponse.md)
- [EngagementType](docs/EngagementType.md)
- [ErrorValidationProblem](docs/ErrorValidationProblem.md)
- [FieldFormatEnum](docs/FieldFormatEnum.md)
- [FieldTypeEnum](docs/FieldTypeEnum.md)
- [GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md)
- [IgnoreCommonModelRequest](docs/IgnoreCommonModelRequest.md)
- [Issue](docs/Issue.md)
- [IssueStatusEnum](docs/IssueStatusEnum.md)
- [ItemSchema](docs/ItemSchema.md)
- [Lead](docs/Lead.md)
- [LeadEndpointRequest](docs/LeadEndpointRequest.md)
- [LeadRequest](docs/LeadRequest.md)
- [LeadResponse](docs/LeadResponse.md)
- [LinkToken](docs/LinkToken.md)
- [LinkedAccountCondition](docs/LinkedAccountCondition.md)
- [LinkedAccountConditionRequest](docs/LinkedAccountConditionRequest.md)
- [LinkedAccountSelectiveSyncConfiguration](docs/LinkedAccountSelectiveSyncConfiguration.md)
- [LinkedAccountSelectiveSyncConfigurationListRequest](docs/LinkedAccountSelectiveSyncConfigurationListRequest.md)
- [LinkedAccountSelectiveSyncConfigurationRequest](docs/LinkedAccountSelectiveSyncConfigurationRequest.md)
- [LinkedAccountStatus](docs/LinkedAccountStatus.md)
- [MetaResponse](docs/MetaResponse.md)
- [MethodEnum](docs/MethodEnum.md)
- [ModelOperation](docs/ModelOperation.md)
- [MultipartFormFieldRequest](docs/MultipartFormFieldRequest.md)
- [Note](docs/Note.md)
- [NoteEndpointRequest](docs/NoteEndpointRequest.md)
- [NoteRequest](docs/NoteRequest.md)
- [NoteResponse](docs/NoteResponse.md)
- [ObjectClassDescriptionRequest](docs/ObjectClassDescriptionRequest.md)
- [OperatorSchema](docs/OperatorSchema.md)
- [Opportunity](docs/Opportunity.md)
- [OpportunityEndpointRequest](docs/OpportunityEndpointRequest.md)
- [OpportunityRequest](docs/OpportunityRequest.md)
- [OpportunityResponse](docs/OpportunityResponse.md)
- [OpportunityStatusEnum](docs/OpportunityStatusEnum.md)
- [OriginTypeEnum](docs/OriginTypeEnum.md)
- [PaginatedAccountDetailsAndActionsList](docs/PaginatedAccountDetailsAndActionsList.md)
- [PaginatedAccountList](docs/PaginatedAccountList.md)
- [PaginatedAssociationList](docs/PaginatedAssociationList.md)
- [PaginatedAssociationTypeList](docs/PaginatedAssociationTypeList.md)
- [PaginatedConditionSchemaList](docs/PaginatedConditionSchemaList.md)
- [PaginatedContactList](docs/PaginatedContactList.md)
- [PaginatedCustomObjectClassList](docs/PaginatedCustomObjectClassList.md)
- [PaginatedCustomObjectList](docs/PaginatedCustomObjectList.md)
- [PaginatedEngagementList](docs/PaginatedEngagementList.md)
- [PaginatedEngagementTypeList](docs/PaginatedEngagementTypeList.md)
- [PaginatedIssueList](docs/PaginatedIssueList.md)
- [PaginatedLeadList](docs/PaginatedLeadList.md)
- [PaginatedNoteList](docs/PaginatedNoteList.md)
- [PaginatedOpportunityList](docs/PaginatedOpportunityList.md)
- [PaginatedRemoteFieldClassList](docs/PaginatedRemoteFieldClassList.md)
- [PaginatedStageList](docs/PaginatedStageList.md)
- [PaginatedSyncStatusList](docs/PaginatedSyncStatusList.md)
- [PaginatedTaskList](docs/PaginatedTaskList.md)
- [PaginatedUserList](docs/PaginatedUserList.md)
- [PatchedAccountRequest](docs/PatchedAccountRequest.md)
- [PatchedCRMAccountEndpointRequest](docs/PatchedCRMAccountEndpointRequest.md)
- [PatchedCRMContactEndpointRequest](docs/PatchedCRMContactEndpointRequest.md)
- [PatchedCRMCustomObjectEndpointRequest](docs/PatchedCRMCustomObjectEndpointRequest.md)
- [PatchedContactRequest](docs/PatchedContactRequest.md)
- [PatchedEngagementEndpointRequest](docs/PatchedEngagementEndpointRequest.md)
- [PatchedEngagementRequest](docs/PatchedEngagementRequest.md)
- [PatchedOpportunityEndpointRequest](docs/PatchedOpportunityEndpointRequest.md)
- [PatchedOpportunityRequest](docs/PatchedOpportunityRequest.md)
- [PatchedTaskEndpointRequest](docs/PatchedTaskEndpointRequest.md)
- [PatchedTaskRequest](docs/PatchedTaskRequest.md)
- [PhoneNumber](docs/PhoneNumber.md)
- [PhoneNumberRequest](docs/PhoneNumberRequest.md)
- [ReasonEnum](docs/ReasonEnum.md)
- [RemoteData](docs/RemoteData.md)
- [RemoteField](docs/RemoteField.md)
- [RemoteFieldClass](docs/RemoteFieldClass.md)
- [RemoteFieldClassForCustomObjectClass](docs/RemoteFieldClassForCustomObjectClass.md)
- [RemoteFieldClassForCustomObjectClassItemSchema](docs/RemoteFieldClassForCustomObjectClassItemSchema.md)
- [RemoteFieldRequest](docs/RemoteFieldRequest.md)
- [RemoteKey](docs/RemoteKey.md)
- [RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
- [RemoteResponse](docs/RemoteResponse.md)
- [RequestFormatEnum](docs/RequestFormatEnum.md)
- [ResponseTypeEnum](docs/ResponseTypeEnum.md)
- [SelectiveSyncConfigurationsUsageEnum](docs/SelectiveSyncConfigurationsUsageEnum.md)
- [Stage](docs/Stage.md)
- [SyncStatus](docs/SyncStatus.md)
- [SyncStatusStatusEnum](docs/SyncStatusStatusEnum.md)
- [Task](docs/Task.md)
- [TaskEndpointRequest](docs/TaskEndpointRequest.md)
- [TaskRequest](docs/TaskRequest.md)
- [TaskResponse](docs/TaskResponse.md)
- [TaskStatusEnum](docs/TaskStatusEnum.md)
- [User](docs/User.md)
- [ValidationProblemSource](docs/ValidationProblemSource.md)
- [WarningValidationProblem](docs/WarningValidationProblem.md)
- [WebhookReceiver](docs/WebhookReceiver.md)
- [WebhookReceiverRequest](docs/WebhookReceiverRequest.md)
## 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