# README

Go API client for engagedigital

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

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
go get github.com/antihax/optional

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

import "./engagedigital"

Documentation for API Endpoints

All URIs are relative to https://DOMAIN.api.engagement.dimelo.com/1.0

ClassMethodHTTP requestDescription
AgentStatusApiChangeAgentStatusPut /status/{agentId}Changing an agent's status
AgentStatusApiGetAgentStatusGet /status/{agentId}Get a connected agent status
AgentStatusApiGetAllAgentStatusGet /statusGet all connected agents status
AttachmentsApiCreateAttachmentPost /attachmentsCreating an attachment
AttachmentsApiGetAllAttachmentsGet /attachmentsGetting all attachments
AttachmentsApiGetAttachmentGet /attachments/{attachmentId}Getting an attachment from its id
CategoriesApiCreateCategoryPost /categoriesCreating a category
CategoriesApiDeleteCategoryDelete /categories/{categoryId}Deleting a category
CategoriesApiGetAllCategoriesGet /categoriesGetting all categories
CategoriesApiGetCategoryGet /categories/{categoryId}Getting a category from its id
CategoriesApiUpdateCategoryPut /categories/{categoryId}Updating a category
ChannelsApiGetAllChannelsGet /channelsGetting all channels
ChannelsApiGetChannelGet /channels/{channelId}Getting a channel from its id
ChannelsApiUpdateChannelPut /channels/{channelId}Updating a channel
CommunitiesApiGetAllCommunitiesGet /communitiesGetting all communities
CommunitiesApiGetCommunityGet /communities/{communityId}Getting a community from its id
ContentsApiCategorizeContentPut /contents/{contentId}/update_categoriesCategorizing a content
ContentsApiCreateContentPost /contentsCreating a content
ContentsApiGetAllContentsGet /contentsContents
ContentsApiGetContentGet /contents/{contentId}Getting a content from its id
ContentsApiIgnoreContentPut /contents/{contentId}/ignoreIgnoring a content
CustomFieldsApiCreateCustomFieldPost /custom_fieldsCreating a custom field
CustomFieldsApiDeleteCustomFieldDelete /custom_fields/{customFieldId}Deleting a custom field
CustomFieldsApiGetAllCustomFieldsGet /custom_fieldsGetting all custom fields
CustomFieldsApiGetCustomFieldGet /custom_fields/{customFieldId}Getting a custom field from its id
CustomFieldsApiUpdateCustomFieldPut /custom_fields/{customFieldId}Updating a custom field
EventsApiGetAllEventsGet /eventsGetting all events
EventsApiGetEventGet /events/{eventId}Getting an event from its id
FoldersApiCreateFolderPost /foldersCreating a folder
FoldersApiDeleteFolderDelete /folders/{folderId}Deleting a folder
FoldersApiGetAllFoldersGet /foldersGetting all folders
FoldersApiGetFolderGet /folders/{folderId}Getting a folder from its id
FoldersApiUpdateFolderPut /folders/{folderId}Updating a folder
IdentitiesApiGetAllIdentitiesGet /identitiesGetting all identities
IdentitiesApiGetIdentityGet /identities/{identityId}Getting an identity from its id
IdentityGroupsApiGetAllIdentityGroupsGet /identity_groupsGetting all identity groups
IdentityGroupsApiGetIdentityGroupGet /identity_groups/{identityGroupId}Getting an identity group from its id
IdentityGroupsApiUpdateIdentityGroupPut /identity_groups/{identityGroupId}Updating an identity group
InterventionCommentsApiCreateInterventionCommentPost /intervention_commentsCreating an intervention comment
InterventionCommentsApiDeleteInterventionCommentDelete /intervention_comments/{interventionCommentId}Deleting an intervention comment
InterventionCommentsApiGetAllInterventionCommentsGet /intervention_commentsGetting all intervention comments
InterventionCommentsApiGetInterventionCommentGet /intervention_comments/{interventionCommentId}Getting an intervention comment from its id
InterventionsApiCancelInterventionDelete /interventions/{interventionId}/cancelCancelling an intervention
InterventionsApiCategorizeInterventionPut /interventions/{interventionId}/update_categoriesCategorizing an intervention
InterventionsApiCloseInterventionPut /interventions/{interventionId}/closeClosing an intervention
InterventionsApiCreateInterventionPost /interventionsCreating an intervention
InterventionsApiGetAllInterventionsGet /interventionsGetting all interventions
InterventionsApiGetInterventionGet /interventions/{interventionId}Getting an intervention from its id
InterventionsApiReassignInterventionPut /interventions/{interventionId}/reassignReassigning an intervention
LocalesApiGetAllLocalesGet /localesGetting all locales
PresenceStatusApiCreatePresenceStatusPost /presence_statusCreating a presence status
PresenceStatusApiDeletePresenceStatusDelete /presence_status/{presenceStatusId}Deleting a presence status
PresenceStatusApiGetAllPresenceStatusGet /presence_statusGetting all presence statuses
PresenceStatusApiGetPresenceStatusGet /presence_status/{presenceStatusId}Getting a presence status from its id
PresenceStatusApiUpdatePresenceStatusPut /presence_status/{presenceStatusId}Updating a presence status
ReplyAssistantEntriesApiCreateReplyAssistantEntryPost /reply_assistant/entriesCreating an entry
ReplyAssistantEntriesApiDeleteReplyAssistantEntryDelete /reply_assistant/entries/{replyAssistantEntryId}Deleting a reply assistant entry
ReplyAssistantEntriesApiGetAllReplyAssistantEntriesGet /reply_assistant/entriesGetting​ a​ll​ reply assistant e​ntries
ReplyAssistantEntriesApiGetReplyAssistantEntryGet /reply_assistant/entries/{replyAssistantEntryId}Getting a reply assistant entry from its id
ReplyAssistantEntriesApiUpdateReplyAssistantEntryPut /reply_assistant/entries/{replyAssistantEntryId}Updating a reply assistant entry
ReplyAssistantGroupsApiCreateReplyAssistantGroupPost /reply_assistant/groupsCreating a reply assistant group
ReplyAssistantGroupsApiDeleteReplyAssistantGroupDelete /reply_assistant/groups/{replyAssistantGroupId}Deleting a reply assistant group
ReplyAssistantGroupsApiGetAllReplyAssistantGroupsGet /reply_assistant/groupsGetting​ a​ll​ reply assistant groups
ReplyAssistantGroupsApiGetReplyAssistantGroupGet /reply_assistant/groups/{replyAssistantGroupId}Getting a reply assistant group from its id
ReplyAssistantGroupsApiUpdateReplyAssistantGroupPut /reply_assistant/groups/{replyAssistantGroupId}Updating a reply assistant group
ReplyAssistantVersionsApiCreateReplyAssistantVersionPost /reply_assistant/versionsCreating a reply assistant version
ReplyAssistantVersionsApiDeleteReplyAssistantVersionDelete /reply_assistant/versions/{replyAssistantVersionId}Deleting a reply assistant version
ReplyAssistantVersionsApiGetAllReplyAssistantVersionsGet /reply_assistant/versionsGetting​ a​ll​ reply assistant versions
ReplyAssistantVersionsApiGetReplyAssistantVersionGet /reply_assistant/versions/{replyAssistantVersionId}Getting a reply assistant version from its id
ReplyAssistantVersionsApiUpdateReplyAssistantVersionPut /reply_assistant/versions/{replyAssistantVersionId}Updating a reply assistant version
RolesApiCreateRolePost /rolesCreating a role
RolesApiGetAllRolesGet /rolesGetting all roles
RolesApiGetRoleGet /roles/{roleId}Getting a role from its id
RolesApiUpdateRolePut /roles/{roleId}Updating a role
SettingsApiGetAllSettingsGet /settingsGetting all settings
SettingsApiUpdateSettingsPut /settingsUpdating settings
SourcesApiGetAllSourcesGet /content_sourcesGetting all sources
SourcesApiGetSourceGet /content_sources/{sourceId}Getting a source from its id
SourcesApiUpdateSourcePut /content_sources/{sourceId}Updating a source
TagsApiCreateTagPost /tagsCreating a tag
TagsApiDeleteTagDelete /tags/{tagId}Deleting a tag
TagsApiGetAllTagsGet /tagsGetting all tags
TagsApiGetTagGet /tags/{tagId}Getting a tag from its id
TagsApiUpdateTagPut /tags/{tagId}Updating a tag
TasksApiGetAllTasksGet /tasksGetting all tasks
TasksApiGetTaskGet /tasks/{taskId}Getting a task from its id
TasksApiMoveTaskDelete /tasks/{taskId}/moveMove a task to another queue
TasksApiTransferTaskPut /tasks/{taskId}/transferTransferring a task
TeamsApiCreateTeamPost /teamsCreating a team
TeamsApiDeleteTeamDelete /teams/{teamId}Deleting a team
TeamsApiGetAllTeamsGet /teamsGetting all teams
TeamsApiGetTeamGet /teams/{teamId}Getting a team from its id
TeamsApiUpdateTeamPut /teams/{teamId}Updating a team
ThreadsApiArchiveThreadPut /content_threads/{threadId}/ignoreArchiving a thread
ThreadsApiCategorizeThreadPut /content_threads/{threadId}/update_categoriesCategorizing a thread
ThreadsApiCloseThreadPut /content_threads/{threadId}/closeClose a thread
ThreadsApiGetAllThreadsGet /content_threadsGetting all threads
ThreadsApiGetThreadGet /content_threads/{threadId}Getting a thread from its id
ThreadsApiOpenThreadGet /content_threads/{threadId}/openOpen a thread
TimeSheetsApiCreateTimeSheetPost /time_sheetsCreating a time sheet
TimeSheetsApiDeleteTimeSheetDelete /time_sheets/{timeSheetId}Deleting a time sheet
TimeSheetsApiGetAllTimeSheetsGet /time_sheetsGetting all time sheets
TimeSheetsApiGetTimeSheetGet /time_sheets/{timeSheetId}Getting a time sheet from its id
TimeSheetsApiUpdateTimeSheetPut /time_sheets/{timeSheetId}Updating a time sheet
TimezonesApiGetAllTimezonesGet /timezonesGetting all timezones
UsersApiCreateUserPost /usersCreating a user
UsersApiDeleteUserDelete /users/{userId}Deleting a user
UsersApiGetAllUsersGet /usersGetting all users
UsersApiGetUserGet /users/{userId}Getting a user from its id
UsersApiInviteUserPost /users/inviteInviting a user
UsersApiUpdateUserPut /users/{userId}Updating a user
WebhooksApiCreateWebhookPost /webhooksCreating a webhook
WebhooksApiDeleteWebhookDelete /webhooks/{webhookId}Deleting a webhook
WebhooksApiGetAllWebhooksGet /webhooksGetting all webhooks
WebhooksApiGetWebhookGet /webhooks/{webhookId}Getting a webhook from its id
WebhooksApiUpdateWebhookPut /webhooks/{webhookId}Updating a webhook

Documentation For Models

Documentation For Authorization

bearerAuth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.

# Structs

The \"custom_status\" attribute represent the custom \"away\" status selected, it can either be: * 1.
No description provided by the author
No description provided by the author
APIClient manages communication with the Engage Digital API API v1.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
always contains text a​nd​ html versions.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
attributes in extra_infos are optional and unspecified/not guaranteed, don’t rely on it for critical tasks, this is provided as information only.
No description provided by the author
GenericOpenAPIError Provides access to the body, error and model on returned errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author