engagedigital

package
v0.3.17 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 28, 2023 License: MIT Imports: 21 Imported by: 0

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

Class Method HTTP request Description
AgentStatusApi ChangeAgentStatus Put /status/{agentId} Changing an agent's status
AgentStatusApi GetAgentStatus Get /status/{agentId} Get a connected agent status
AgentStatusApi GetAllAgentStatus Get /status Get all connected agents status
AttachmentsApi CreateAttachment Post /attachments Creating an attachment
AttachmentsApi GetAllAttachments Get /attachments Getting all attachments
AttachmentsApi GetAttachment Get /attachments/{attachmentId} Getting an attachment from its id
CategoriesApi CreateCategory Post /categories Creating a category
CategoriesApi DeleteCategory Delete /categories/{categoryId} Deleting a category
CategoriesApi GetAllCategories Get /categories Getting all categories
CategoriesApi GetCategory Get /categories/{categoryId} Getting a category from its id
CategoriesApi UpdateCategory Put /categories/{categoryId} Updating a category
ChannelsApi GetAllChannels Get /channels Getting all channels
ChannelsApi GetChannel Get /channels/{channelId} Getting a channel from its id
ChannelsApi UpdateChannel Put /channels/{channelId} Updating a channel
CommunitiesApi GetAllCommunities Get /communities Getting all communities
CommunitiesApi GetCommunity Get /communities/{communityId} Getting a community from its id
ContentsApi CategorizeContent Put /contents/{contentId}/update_categories Categorizing a content
ContentsApi CreateContent Post /contents Creating a content
ContentsApi GetAllContents Get /contents Contents
ContentsApi GetContent Get /contents/{contentId} Getting a content from its id
ContentsApi IgnoreContent Put /contents/{contentId}/ignore Ignoring a content
CustomFieldsApi CreateCustomField Post /custom_fields Creating a custom field
CustomFieldsApi DeleteCustomField Delete /custom_fields/{customFieldId} Deleting a custom field
CustomFieldsApi GetAllCustomFields Get /custom_fields Getting all custom fields
CustomFieldsApi GetCustomField Get /custom_fields/{customFieldId} Getting a custom field from its id
CustomFieldsApi UpdateCustomField Put /custom_fields/{customFieldId} Updating a custom field
EventsApi GetAllEvents Get /events Getting all events
EventsApi GetEvent Get /events/{eventId} Getting an event from its id
FoldersApi CreateFolder Post /folders Creating a folder
FoldersApi DeleteFolder Delete /folders/{folderId} Deleting a folder
FoldersApi GetAllFolders Get /folders Getting all folders
FoldersApi GetFolder Get /folders/{folderId} Getting a folder from its id
FoldersApi UpdateFolder Put /folders/{folderId} Updating a folder
IdentitiesApi GetAllIdentities Get /identities Getting all identities
IdentitiesApi GetIdentity Get /identities/{identityId} Getting an identity from its id
IdentityGroupsApi GetAllIdentityGroups Get /identity_groups Getting all identity groups
IdentityGroupsApi GetIdentityGroup Get /identity_groups/{identityGroupId} Getting an identity group from its id
IdentityGroupsApi UpdateIdentityGroup Put /identity_groups/{identityGroupId} Updating an identity group
InterventionCommentsApi CreateInterventionComment Post /intervention_comments Creating an intervention comment
InterventionCommentsApi DeleteInterventionComment Delete /intervention_comments/{interventionCommentId} Deleting an intervention comment
InterventionCommentsApi GetAllInterventionComments Get /intervention_comments Getting all intervention comments
InterventionCommentsApi GetInterventionComment Get /intervention_comments/{interventionCommentId} Getting an intervention comment from its id
InterventionsApi CancelIntervention Delete /interventions/{interventionId}/cancel Cancelling an intervention
InterventionsApi CategorizeIntervention Put /interventions/{interventionId}/update_categories Categorizing an intervention
InterventionsApi CloseIntervention Put /interventions/{interventionId}/close Closing an intervention
InterventionsApi CreateIntervention Post /interventions Creating an intervention
InterventionsApi GetAllInterventions Get /interventions Getting all interventions
InterventionsApi GetIntervention Get /interventions/{interventionId} Getting an intervention from its id
InterventionsApi ReassignIntervention Put /interventions/{interventionId}/reassign Reassigning an intervention
LocalesApi GetAllLocales Get /locales Getting all locales
PresenceStatusApi CreatePresenceStatus Post /presence_status Creating a presence status
PresenceStatusApi DeletePresenceStatus Delete /presence_status/{presenceStatusId} Deleting a presence status
PresenceStatusApi GetAllPresenceStatus Get /presence_status Getting all presence statuses
PresenceStatusApi GetPresenceStatus Get /presence_status/{presenceStatusId} Getting a presence status from its id
PresenceStatusApi UpdatePresenceStatus Put /presence_status/{presenceStatusId} Updating a presence status
ReplyAssistantEntriesApi CreateReplyAssistantEntry Post /reply_assistant/entries Creating an entry
ReplyAssistantEntriesApi DeleteReplyAssistantEntry Delete /reply_assistant/entries/{replyAssistantEntryId} Deleting a reply assistant entry
ReplyAssistantEntriesApi GetAllReplyAssistantEntries Get /reply_assistant/entries Getting​ a​ll​ reply assistant e​ntries
ReplyAssistantEntriesApi GetReplyAssistantEntry Get /reply_assistant/entries/{replyAssistantEntryId} Getting a reply assistant entry from its id
ReplyAssistantEntriesApi UpdateReplyAssistantEntry Put /reply_assistant/entries/{replyAssistantEntryId} Updating a reply assistant entry
ReplyAssistantGroupsApi CreateReplyAssistantGroup Post /reply_assistant/groups Creating a reply assistant group
ReplyAssistantGroupsApi DeleteReplyAssistantGroup Delete /reply_assistant/groups/{replyAssistantGroupId} Deleting a reply assistant group
ReplyAssistantGroupsApi GetAllReplyAssistantGroups Get /reply_assistant/groups Getting​ a​ll​ reply assistant groups
ReplyAssistantGroupsApi GetReplyAssistantGroup Get /reply_assistant/groups/{replyAssistantGroupId} Getting a reply assistant group from its id
ReplyAssistantGroupsApi UpdateReplyAssistantGroup Put /reply_assistant/groups/{replyAssistantGroupId} Updating a reply assistant group
ReplyAssistantVersionsApi CreateReplyAssistantVersion Post /reply_assistant/versions Creating a reply assistant version
ReplyAssistantVersionsApi DeleteReplyAssistantVersion Delete /reply_assistant/versions/{replyAssistantVersionId} Deleting a reply assistant version
ReplyAssistantVersionsApi GetAllReplyAssistantVersions Get /reply_assistant/versions Getting​ a​ll​ reply assistant versions
ReplyAssistantVersionsApi GetReplyAssistantVersion Get /reply_assistant/versions/{replyAssistantVersionId} Getting a reply assistant version from its id
ReplyAssistantVersionsApi UpdateReplyAssistantVersion Put /reply_assistant/versions/{replyAssistantVersionId} Updating a reply assistant version
RolesApi CreateRole Post /roles Creating a role
RolesApi GetAllRoles Get /roles Getting all roles
RolesApi GetRole Get /roles/{roleId} Getting a role from its id
RolesApi UpdateRole Put /roles/{roleId} Updating a role
SettingsApi GetAllSettings Get /settings Getting all settings
SettingsApi UpdateSettings Put /settings Updating settings
SourcesApi GetAllSources Get /content_sources Getting all sources
SourcesApi GetSource Get /content_sources/{sourceId} Getting a source from its id
SourcesApi UpdateSource Put /content_sources/{sourceId} Updating a source
TagsApi CreateTag Post /tags Creating a tag
TagsApi DeleteTag Delete /tags/{tagId} Deleting a tag
TagsApi GetAllTags Get /tags Getting all tags
TagsApi GetTag Get /tags/{tagId} Getting a tag from its id
TagsApi UpdateTag Put /tags/{tagId} Updating a tag
TasksApi GetAllTasks Get /tasks Getting all tasks
TasksApi GetTask Get /tasks/{taskId} Getting a task from its id
TasksApi MoveTask Delete /tasks/{taskId}/move Move a task to another queue
TasksApi TransferTask Put /tasks/{taskId}/transfer Transferring a task
TeamsApi CreateTeam Post /teams Creating a team
TeamsApi DeleteTeam Delete /teams/{teamId} Deleting a team
TeamsApi GetAllTeams Get /teams Getting all teams
TeamsApi GetTeam Get /teams/{teamId} Getting a team from its id
TeamsApi UpdateTeam Put /teams/{teamId} Updating a team
ThreadsApi ArchiveThread Put /content_threads/{threadId}/ignore Archiving a thread
ThreadsApi CategorizeThread Put /content_threads/{threadId}/update_categories Categorizing a thread
ThreadsApi CloseThread Put /content_threads/{threadId}/close Close a thread
ThreadsApi GetAllThreads Get /content_threads Getting all threads
ThreadsApi GetThread Get /content_threads/{threadId} Getting a thread from its id
ThreadsApi OpenThread Get /content_threads/{threadId}/open Open a thread
TimeSheetsApi CreateTimeSheet Post /time_sheets Creating a time sheet
TimeSheetsApi DeleteTimeSheet Delete /time_sheets/{timeSheetId} Deleting a time sheet
TimeSheetsApi GetAllTimeSheets Get /time_sheets Getting all time sheets
TimeSheetsApi GetTimeSheet Get /time_sheets/{timeSheetId} Getting a time sheet from its id
TimeSheetsApi UpdateTimeSheet Put /time_sheets/{timeSheetId} Updating a time sheet
TimezonesApi GetAllTimezones Get /timezones Getting all timezones
UsersApi CreateUser Post /users Creating a user
UsersApi DeleteUser Delete /users/{userId} Deleting a user
UsersApi GetAllUsers Get /users Getting all users
UsersApi GetUser Get /users/{userId} Getting a user from its id
UsersApi InviteUser Post /users/invite Inviting a user
UsersApi UpdateUser Put /users/{userId} Updating a user
WebhooksApi CreateWebhook Post /webhooks Creating a webhook
WebhooksApi DeleteWebhook Delete /webhooks/{webhookId} Deleting a webhook
WebhooksApi GetAllWebhooks Get /webhooks Getting all webhooks
WebhooksApi GetWebhook Get /webhooks/{webhookId} Getting a webhook from its id
WebhooksApi UpdateWebhook Put /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

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	AgentStatusApi *AgentStatusApiService

	AttachmentsApi *AttachmentsApiService

	CategoriesApi *CategoriesApiService

	ChannelsApi *ChannelsApiService

	CommunitiesApi *CommunitiesApiService

	ContentsApi *ContentsApiService

	CustomFieldsApi *CustomFieldsApiService

	EventsApi *EventsApiService

	FoldersApi *FoldersApiService

	IdentitiesApi *IdentitiesApiService

	IdentityGroupsApi *IdentityGroupsApiService

	InterventionCommentsApi *InterventionCommentsApiService

	InterventionsApi *InterventionsApiService

	LocalesApi *LocalesApiService

	PresenceStatusApi *PresenceStatusApiService

	ReplyAssistantEntriesApi *ReplyAssistantEntriesApiService

	ReplyAssistantGroupsApi *ReplyAssistantGroupsApiService

	ReplyAssistantVersionsApi *ReplyAssistantVersionsApiService

	RolesApi *RolesApiService

	SettingsApi *SettingsApiService

	SourcesApi *SourcesApiService

	TagsApi *TagsApiService

	TasksApi *TasksApiService

	TeamsApi *TeamsApiService

	ThreadsApi *ThreadsApiService

	TimeSheetsApi *TimeSheetsApiService

	TimezonesApi *TimezonesApiService

	UsersApi *UsersApiService

	WebhooksApi *WebhooksApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Engage Digital API API v1.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

func (*APIClient) HTTPClient 

func (apiClient *APIClient) HTTPClient() *http.Client

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AgentCustomStatus 

type AgentCustomStatus struct {
	Id string `json:"id,omitempty"`
}

The \"custom_status\" attribute represent the custom \"away\" status selected, it can either be: * 1. null — ​The agent is available or in the generic \"Away\" status 2. { \"id\":\"5582b1f4776562af9b000008\" } — ​The id of the custom status

type AgentStatus 

type AgentStatus struct {
	AgentId      string               `json:"agent_id,omitempty"`
	Channels     []AgentStatusChannel `json:"channels,omitempty"`
	CustomStatus AgentCustomStatus    `json:"custom_status,omitempty"`
}

type AgentStatusApiService 

type AgentStatusApiService service

func (*AgentStatusApiService) ChangeAgentStatus 

func (a *AgentStatusApiService) ChangeAgentStatus(ctx context.Context, agentId string, localVarOptionals *ChangeAgentStatusOpts) (AgentStatus, *http.Response, error)

func (*AgentStatusApiService) GetAgentStatus 

func (a *AgentStatusApiService) GetAgentStatus(ctx context.Context, agentId string) (AgentStatus, *http.Response, error)

AgentStatusApiService Get a connected agent status This method get the status of a connected agent. Returns a 404 if the user does not exist (not_found) or if he’s not connected (disconnected). Authorization​: only users that have the right to monitor the task view.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param agentId

@return AgentStatus

func (*AgentStatusApiService) GetAllAgentStatus 

func (a *AgentStatusApiService) GetAllAgentStatus(ctx context.Context) ([]AgentStatus, *http.Response, error)

AgentStatusApiService Get all connected agents status This method get all currently connected agents & their status. Authorization​: only users that have the right to monitor the task view.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []AgentStatus

type AgentStatusChannel 

type AgentStatusChannel struct {
	Busyness string `json:"busyness,omitempty"`
	Id       string `json:"id,omitempty"`
	Name     string `json:"name,omitempty"`
	Status   string `json:"status,omitempty"`
}

type Attachment 

type Attachment struct {
	ContentType   string    `json:"content_type,omitempty"`
	CreatedAt     time.Time `json:"created_at,omitempty"`
	Embed         bool      `json:"embed,omitempty"`
	Filename      string    `json:"filename,omitempty"`
	ForeignId     string    `json:"foreign_id,omitempty"`
	Id            string    `json:"id,omitempty"`
	Public        bool      `json:"public?,omitempty"`
	Size          int32     `json:"size,omitempty"`
	UpdatedAt     time.Time `json:"updated_at,omitempty"`
	Url           string    `json:"url,omitempty"`
	VideoMetadata []string  `json:"video_metadata,omitempty"`
}

type AttachmentsApiService 

type AttachmentsApiService service

func (*AttachmentsApiService) CreateAttachment 

func (a *AttachmentsApiService) CreateAttachment(ctx context.Context, localVarOptionals *CreateAttachmentOpts) (Attachment, *http.Response, error)

func (*AttachmentsApiService) GetAllAttachments 

func (a *AttachmentsApiService) GetAllAttachments(ctx context.Context, localVarOptionals *GetAllAttachmentsOpts) (GetAllAttachmentsResponse, *http.Response, error)

func (*AttachmentsApiService) GetAttachment 

func (a *AttachmentsApiService) GetAttachment(ctx context.Context, attachmentId string) (Attachment, *http.Response, error)

AttachmentsApiService Getting an attachment from its id This method renders an attachment from given id.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param attachmentId

@return Attachment

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type CategoriesApiService 

type CategoriesApiService service

func (*CategoriesApiService) CreateCategory 

func (a *CategoriesApiService) CreateCategory(ctx context.Context, localVarOptionals *CreateCategoryOpts) (Category, *http.Response, error)

func (*CategoriesApiService) DeleteCategory 

func (a *CategoriesApiService) DeleteCategory(ctx context.Context, categoryId string, localVarOptionals *DeleteCategoryOpts) (Category, *http.Response, error)

func (*CategoriesApiService) GetAllCategories 

func (a *CategoriesApiService) GetAllCategories(ctx context.Context, localVarOptionals *GetAllCategoriesOpts) (GetAllCategoriesResponse, *http.Response, error)

func (*CategoriesApiService) GetCategory 

func (a *CategoriesApiService) GetCategory(ctx context.Context, categoryId string) (Category, *http.Response, error)

CategoriesApiService Getting a category from its id This method renders a category from given id.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param categoryId

@return Category

func (*CategoriesApiService) UpdateCategory 

func (a *CategoriesApiService) UpdateCategory(ctx context.Context, categoryId string, localVarOptionals *UpdateCategoryOpts) (Category, *http.Response, error)

type CategorizeThreadOpts 

type CategorizeThreadOpts struct {
	ThreadCategoryIds optional.Interface
}

type Category 

type Category struct {
	Color             int32     `json:"color,omitempty"`
	CreatedAt         time.Time `json:"created_at,omitempty"`
	Id                string    `json:"id"`
	Mandatory         bool      `json:"mandatory,omitempty"`
	Multiple          bool      `json:"multiple,omitempty"`
	Name              string    `json:"name,omitempty"`
	ParentId          string    `json:"parent_id,omitempty"`
	PostQualification bool      `json:"post_qualification,omitempty"`
	SourceIds         []string  `json:"source_ids,omitempty"`
	Unselectable      bool      `json:"unselectable,omitempty"`
	UpdatedAt         time.Time `json:"updated_at,omitempty"`
}

type ChangeAgentStatusOpts 

type ChangeAgentStatusOpts struct {
	Status         optional.String
	CustomStatusId optional.String
}

type Channel 

type Channel struct {
	CreatedAt          time.Time `json:"created_at,omitempty"`
	HardCapability     int32     `json:"hard_capability,omitempty"`
	Id                 string    `json:"id,omitempty"`
	Label              string    `json:"label,omitempty"`
	Name               string    `json:"name,omitempty"`
	SoftCapability     int32     `json:"soft_capability,omitempty"`
	SourceIds          []string  `json:"source_ids,omitempty"`
	TaskTimeoutSeconds int32     `json:"task_timeout_seconds,omitempty"`
	UpdatedAt          time.Time `json:"updated_at,omitempty"`
}

type ChannelsApiService 

type ChannelsApiService service

func (*ChannelsApiService) GetAllChannels 

func (a *ChannelsApiService) GetAllChannels(ctx context.Context, localVarOptionals *GetAllChannelsOpts) (GetAllChannelsResponse, *http.Response, error)

func (*ChannelsApiService) GetChannel 

func (a *ChannelsApiService) GetChannel(ctx context.Context, channelId string) (Channel, *http.Response, error)

ChannelsApiService Getting a channel from its id This method renders a channel from given id.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param channelId

@return Channel

func (*ChannelsApiService) UpdateChannel 

func (a *ChannelsApiService) UpdateChannel(ctx context.Context, channelId string, localVarOptionals *UpdateChannelOpts) (Channel, *http.Response, error)

type CommunitiesApiService 

type CommunitiesApiService service

func (*CommunitiesApiService) GetAllCommunities 

func (a *CommunitiesApiService) GetAllCommunities(ctx context.Context, localVarOptionals *GetAllCommunitiesOpts) (GetAllCommunitiesResponse, *http.Response, error)

func (*CommunitiesApiService) GetCommunity 

func (a *CommunitiesApiService) GetCommunity(ctx context.Context, communityId string) (Community, *http.Response, error)

CommunitiesApiService Getting a community from its id This method renders a community from given id.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param communityId

@return Community

type Community 

type Community struct {
	Active    bool      `json:"active,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	Id        string    `json:"id,omitempty"`
	Name      string    `json:"name,omitempty"`
	Type      string    `json:"type,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type Content 

type Content struct {
	ApprovalRequired bool                 `json:"approval_required,omitempty"`
	Attachments      []ContentAttachment  `json:"attachments,omitempty"`
	AttachmentsCount int32                `json:"attachments_count,omitempty"`
	AuthorId         string               `json:"author_id,omitempty"`
	Body             string               `json:"body,omitempty"`
	BodyFormatted    ContentBodyFormatted `json:"body_formatted,omitempty"`
	// values can be: text or html.
	BodyInputFormat string `json:"body_input_format,omitempty"`
	// are content categories if none, they are default to intervention categories or thread categories
	CategoryIds []string `json:"category_ids,omitempty"`
	// is present only if the content has context_data associated. The context_data hash keys are the custom fields keys.
	ContextData           map[string]interface{} `json:"context_data,omitempty"`
	CreatedAt             time.Time              `json:"created_at,omitempty"`
	CreatedFrom           string                 `json:"created_from,omitempty"`
	CreatorId             string                 `json:"creator_id,omitempty"`
	ForeignId             string                 `json:"foreign_id,omitempty"`
	Id                    string                 `json:"id"`
	InReplyToAuthorId     string                 `json:"in_reply_to_author_id,omitempty"`
	InReplyToId           string                 `json:"in_reply_to_id,omitempty"`
	InterventionId        string                 `json:"intervention_id,omitempty"`
	Language              string                 `json:"language,omitempty"`
	PrivateMessage        bool                   `json:"private_message,omitempty"`
	Published             bool                   `json:"published,omitempty"`
	RemotelyDeleted       bool                   `json:"remotely_deleted,omitempty"`
	SourceId              string                 `json:"source_id,omitempty"`
	SourceType            string                 `json:"source_type,omitempty"`
	SourceUrl             string                 `json:"source_url,omitempty"`
	Status                string                 `json:"status,omitempty"`
	SynchronizationStatus string                 `json:"synchronization_status,omitempty"`
	ThreadId              string                 `json:"thread_id,omitempty"`
	Title                 string                 `json:"title,omitempty"`
	Type                  string                 `json:"type,omitempty"`
	UpdatedAt             time.Time              `json:"updated_at,omitempty"`
}

type ContentAttachment 

type ContentAttachment struct {
	ContentType string    `json:"content_type,omitempty"`
	CreatedAt   time.Time `json:"created_at,omitempty"`
	Embed       string    `json:"embed,omitempty"`
	Filename    string    `json:"filename,omitempty"`
	ForeignId   string    `json:"foreign_id,omitempty"`
	Id          string    `json:"id,omitempty"`
	Public      string    `json:"public?,omitempty"`
	Size        int32     `json:"size,omitempty"`
	UpdatedAt   time.Time `json:"updated_at,omitempty"`
	// You can download the attachments by using an API access token with the following URL: https://[your-domain].engagement.dimelo.com/attachments/[attachment_id]?access_token=[your_​ access_token]
	Url string `json:"url,omitempty"`
}

type ContentBodyFormatted 

type ContentBodyFormatted struct {
	Html string `json:"html,omitempty"`
	Text string `json:"text,omitempty"`
}

always contains text a​nd​ html versions.

type ContentsApiService 

type ContentsApiService service

func (*ContentsApiService) CategorizeContent 

func (a *ContentsApiService) CategorizeContent(ctx context.Context, contentId string, categoryIds []string) (Content, *http.Response, error)

ContentsApiService Categorizing a content This method updates the categories of a content. If token’s user does not have “read” on this content’s source a 404 HTTP response will be returned. Authorization​: no.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contentId
  • @param categoryIds An array containing the new categories to set on the content.

@return Content

func (*ContentsApiService) CreateContent 

func (a *ContentsApiService) CreateContent(ctx context.Context, body string, localVarOptionals *CreateContentOpts) (Content, *http.Response, error)

func (*ContentsApiService) GetAllContents 

func (a *ContentsApiService) GetAllContents(ctx context.Context, localVarOptionals *GetAllContentsOpts) (GetAllContentsResponse, *http.Response, error)

func (*ContentsApiService) GetContent 

func (a *ContentsApiService) GetContent(ctx context.Context, contentId string) (Content, *http.Response, error)

ContentsApiService Getting a content from its id This method renders a content from given id. If token’s user does not have “read” on content’s source a 404 HTTP response will be returned. Authorization​: no.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contentId

@return Content

func (*ContentsApiService) IgnoreContent 

func (a *ContentsApiService) IgnoreContent(ctx context.Context, contentId string) (Content, *http.Response, error)

ContentsApiService Ignoring a content Ignores a content. If token’s user does not have “read” on content’s source a 404 HTTP response will be returned. Authorization​: no.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contentId

@return Content

type CreateAttachmentOpts 

type CreateAttachmentOpts struct {
	File    optional.Interface
	Private optional.String
}

type CreateCategoryOpts 

type CreateCategoryOpts struct {
	Name              optional.String
	ParentId          optional.String
	Color             optional.Int32
	Mandatory         optional.Bool
	Multiple          optional.Bool
	PostQualification optional.Bool
	Unselectable      optional.Bool
	SourceIds         optional.Interface
}

type CreateContentOpts 

type CreateContentOpts struct {
	AuthorId      optional.String
	InReplyToId   optional.String
	Private       optional.Int32
	SourceId      optional.String
	AttachmentIds optional.Interface
	Title         optional.String
	To            optional.Interface
	Cc            optional.Interface
	Bcc           optional.Interface
}

type CreateCustomFieldOpts 

type CreateCustomFieldOpts struct {
	Key      optional.String
	Type_    optional.String
	Choices  optional.Interface
	Multiple optional.Bool
	Position optional.Int32
}

type CreateFolderOpts 

type CreateFolderOpts struct {
	Label               optional.String
	ParentId            optional.String
	Position            optional.Int32
	Query               optional.String
	RenderThreadsCount  optional.Bool
	RoleRestrictionOnly optional.Interface
	TeamRestrictionOnly optional.Interface
}

type CreateReplyAssistantGroupOpts 

type CreateReplyAssistantGroupOpts struct {
	EntryIds     optional.Interface
	Autocomplete optional.Bool
	Position     optional.Int32
}

type CreateReplyAssistantVersionOpts 

type CreateReplyAssistantVersionOpts struct {
	SourceIds optional.Interface
	Format    optional.String
	Language  optional.String
}

type CreateRoleOpts 

type CreateRoleOpts struct {
	AccessHelpCenter            optional.Bool
	AccessPreviousMessages      optional.Bool
	AccessPullMode              optional.Bool
	AdminStampAnswer            optional.Bool
	ApproveContent              optional.Bool
	AssignIntervention          optional.Bool
	AuthorBlockContent          optional.Bool
	CloseContentThread          optional.Bool
	CreateAndDestroyExtension   optional.Bool
	CreateCommunity             optional.Bool
	CreateContentSource         optional.Bool
	CreateUser                  optional.Bool
	DelayExportContent          optional.Bool
	DeleteContentThread         optional.Bool
	ImpersonateUser             optional.Bool
	InviteUser                  optional.Bool
	ManageApiAccessTokens       optional.Bool
	ManageAppSdkApplications    optional.Bool
	ManageAutomaticExportsTasks optional.Bool
	ManageCategories            optional.Bool
	ManageChat                  optional.Bool
	ManageCustomFields          optional.Bool
	ManageCustomNotifications   optional.Bool
	ManageEmailsTemplates       optional.Bool
	ManageFolders               optional.Bool
	ManageIce                   optional.Bool
	ManageIdentities            optional.Bool
	ManageOwnNotifications      optional.Bool
	ManageReplyAssistant        optional.Bool
	ManageRoles                 optional.Bool
	ManageRulesEngineRules      optional.Bool
	ManageSurveys               optional.Bool
	ManageTags                  optional.Bool
	ManageTeams                 optional.Bool
	ManageTopologies            optional.Bool
	ManageUsersOfMyTeams        optional.Bool
	MonitorTasks                optional.Bool
	MonitorTeamTasks            optional.Bool
	MuteContent                 optional.Bool
	OpenContentThread           optional.Bool
	PublishContent              optional.Bool
	ReadCommunity               optional.Bool
	ReadContentSource           optional.Bool
	ReadEvent                   optional.Bool
	ReadExport                  optional.Bool
	ReadIdentity                optional.Bool
	ReadOwnStats                optional.Bool
	ReadPresence                optional.Bool
	ReadStats                   optional.Bool
	ReadSurveys                 optional.Bool
	ReadUser                    optional.Bool
	ReceiveTasks                optional.Bool
	ReplyWithAssistant          optional.Bool
	SearchContents              optional.Bool
	SearchEvent                 optional.Bool
	UpdateCommunity             optional.Bool
	UpdateContentSource         optional.Bool
	UpdateExtension             optional.Bool
	UpdateIdentity              optional.Bool
	UpdateIntervention          optional.Bool
	UpdateOwnIntervention       optional.Bool
	UpdateSettings              optional.Bool
	UpdateTimeSheet             optional.Bool
	UpdateUser                  optional.Bool
	UseEmoji                    optional.Bool
}

type CreateTeamOpts 

type CreateTeamOpts struct {
	Name      optional.String
	LeaderIds optional.Interface
	UserIds   optional.Interface
}

type CreateTimeSheetOpts 

type CreateTimeSheetOpts struct {
	Active         optional.Bool
	SourceIds      optional.Interface
	HolidaysRegion optional.String
	Holidays       optional.String
	MondayHours    optional.String
	TuesdayHours   optional.String
	WednesdayHours optional.String
	ThursdayHours  optional.String
	FridayHours    optional.String
	SaturdayHours  optional.String
	SundayHours    optional.String
}

type CreateUserOpts 

type CreateUserOpts struct {
	CategoryIds     optional.Interface
	Enabled         optional.Bool
	ExternalId      optional.String
	Gender          optional.String
	IdentityIds     optional.Interface
	Locale          optional.String
	Nickname        optional.String
	TeamIds         optional.Interface
	Timezone        optional.String
	SpokenLanguages optional.Interface
}

type CreateWebhookOpts 

type CreateWebhookOpts struct {
	Active      optional.Bool
	StagingUse  optional.Bool
	VerifyToken optional.String
	Secret      optional.String
}

type CustomField 

type CustomField struct {
	AssociatedTypeName string    `json:"associated_type_name,omitempty"`
	CreatedAt          time.Time `json:"created_at,omitempty"`
	Id                 string    `json:"id"`
	Key                string    `json:"key,omitempty"`
	Label              string    `json:"label"`
	Multiple           bool      `json:"multiple,omitempty"`
	Position           int32     `json:"position,omitempty"`
	Type               string    `json:"type,omitempty"`
	UpdatedAt          time.Time `json:"updated_at,omitempty"`
}

type CustomFieldsApiService 

type CustomFieldsApiService service

func (*CustomFieldsApiService) CreateCustomField 

func (a *CustomFieldsApiService) CreateCustomField(ctx context.Context, associatedTypeName string, label string, localVarOptionals *CreateCustomFieldOpts) (CustomField, *http.Response, error)

func (*CustomFieldsApiService) DeleteCustomField 

func (a *CustomFieldsApiService) DeleteCustomField(ctx context.Context, customFieldId string) (CustomField, *http.Response, error)

CustomFieldsApiService Deleting a custom field This method destroys an existing custom field. It renders custom field itself. It renders a 404 if id is invalid. Authorization​: only users that are able to destroy custom fields..

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customFieldId

@return CustomField

func (*CustomFieldsApiService) GetAllCustomFields 

func (a *CustomFieldsApiService) GetAllCustomFields(ctx context.Context, localVarOptionals *GetAllCustomFieldsOpts) (GetAllCustomFieldsResponse, *http.Response, error)

func (*CustomFieldsApiService) GetCustomField 

func (a *CustomFieldsApiService) GetCustomField(ctx context.Context, customFieldId string) (CustomField, *http.Response, error)

CustomFieldsApiService Getting a custom field from its id This method renders a custom field from given id. Authorization​: only users that can see custom fields in administration section.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customFieldId

@return CustomField

func (*CustomFieldsApiService) UpdateCustomField 

func (a *CustomFieldsApiService) UpdateCustomField(ctx context.Context, customFieldId string, localVarOptionals *UpdateCustomFieldOpts) (CustomField, *http.Response, error)

type DeleteCategoryOpts 

type DeleteCategoryOpts struct {
	TakeOverCategoryId optional.String
}

type DeleteTeamOpts 

type DeleteTeamOpts struct {
	TakeOverCategoryId optional.String
}

type Event 

type Event struct {
	CreatedAt  time.Time      `json:"created_at,omitempty"`
	ExtraInfos EventExtraInfo `json:"extra_infos,omitempty"`
	Id         string         `json:"id"`
	Name       string         `json:"name,omitempty"`
	UpdatedAt  time.Time      `json:"updated_at,omitempty"`
	UserId     string         `json:"user_id,omitempty"`
}

type EventExtraInfo 

type EventExtraInfo struct {
	AuthenticationStrategy string                 `json:"authentication_strategy,omitempty"`
	BusinessTimeSheetId    string                 `json:"business/time_sheet_id,omitempty"`
	CategoryIds            []string               `json:"category_ids,omitempty"`
	ClosedAutomatically    string                 `json:"closed_automatically,omitempty"`
	ContentId              string                 `json:"content_id,omitempty"`
	ContentSourceId        string                 `json:"content_source_id,omitempty"`
	ContentThreadId        string                 `json:"content_thread_id,omitempty"`
	DeferredDuration       string                 `json:"deferred_duration,omitempty"`
	Deletions              map[string]interface{} `json:"deletions,omitempty"`
	// can be null
	ForeignId      string `json:"foreign_id,omitempty"`
	InterventionId string `json:"intervention_id,omitempty"`
	RequestIp      string `json:"request_ip,omitempty"`
	TaskId         string `json:"task_id,omitempty"`
	UserId         string `json:"user_id,omitempty"`
}

attributes in extra_infos are optional and unspecified/not guaranteed, don’t rely on it for critical tasks, this is provided as information only

type EventsApiService 

type EventsApiService service

func (*EventsApiService) GetAllEvents 

func (a *EventsApiService) GetAllEvents(ctx context.Context, localVarOptionals *GetAllEventsOpts) (GetAllEventsResponse, *http.Response, error)

func (*EventsApiService) GetEvent 

func (a *EventsApiService) GetEvent(ctx context.Context, eventId string) (Event, *http.Response, error)

EventsApiService Getting an event from its id This method renders an event from given id. If token’s user role does not have “search event” permission a 404 HTTP response will be returned. Authorization​: Only users who’s role can search event permission.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param eventId

@return Event

type Folder 

type Folder struct {
	CreatedAt          time.Time   `json:"created_at,omitempty"`
	Id                 string      `json:"id"`
	Label              string      `json:"label,omitempty"`
	ParentId           string      `json:"parent_id,omitempty"`
	Position           int32       `json:"position,omitempty"`
	Query              string      `json:"query,omitempty"`
	RenderThreadsCount bool        `json:"render_threads_count,omitempty"`
	RoleRestriction    Restriction `json:"role_restriction,omitempty"`
	UpdatedAt          time.Time   `json:"updated_at,omitempty"`
}

type FoldersApiService 

type FoldersApiService service

func (*FoldersApiService) CreateFolder 

func (a *FoldersApiService) CreateFolder(ctx context.Context, localVarOptionals *CreateFolderOpts) (Folder, *http.Response, error)

func (*FoldersApiService) DeleteFolder 

func (a *FoldersApiService) DeleteFolder(ctx context.Context, folderId string) (Folder, *http.Response, error)

FoldersApiService Deleting a folder This method destroys an existing folder. It renders the folder itself. It renders a 404 if id is invalid.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param folderId

@return Folder

func (*FoldersApiService) GetAllFolders 

func (a *FoldersApiService) GetAllFolders(ctx context.Context, localVarOptionals *GetAllFoldersOpts) (GetAllFoldersResponse, *http.Response, error)

func (*FoldersApiService) GetFolder 

func (a *FoldersApiService) GetFolder(ctx context.Context, folderId string) (Folder, *http.Response, error)

FoldersApiService Getting a folder from its id This method renders a folder from given id.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param folderId

@return Folder

func (*FoldersApiService) UpdateFolder 

func (a *FoldersApiService) UpdateFolder(ctx context.Context, folderId string, localVarOptionals *UpdateFolderOpts) (Folder, *http.Response, error)

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetAllAgentStatusResponse 

type GetAllAgentStatusResponse struct {
	Count   int32         `json:"count,omitempty"`
	Limit   int32         `json:"limit,omitempty"`
	Offset  int32         `json:"offset,omitempty"`
	Records []AgentStatus `json:"records,omitempty"`
}

type GetAllAttachmentsOpts 

type GetAllAttachmentsOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllAttachmentsResponse 

type GetAllAttachmentsResponse struct {
	Count   int32        `json:"count,omitempty"`
	Limit   int32        `json:"limit,omitempty"`
	Offset  int32        `json:"offset,omitempty"`
	Records []Attachment `json:"records,omitempty"`
}

type GetAllCategoriesOpts 

type GetAllCategoriesOpts struct {
	ParentId optional.String
	Offset   optional.Int32
	Limit    optional.Int32
}

type GetAllCategoriesResponse 

type GetAllCategoriesResponse struct {
	Count   int32      `json:"count,omitempty"`
	Limit   int32      `json:"limit,omitempty"`
	Offset  int32      `json:"offset,omitempty"`
	Records []Category `json:"records,omitempty"`
}

type GetAllChannelsOpts 

type GetAllChannelsOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllChannelsResponse 

type GetAllChannelsResponse struct {
	Count   int32     `json:"count,omitempty"`
	Limit   int32     `json:"limit,omitempty"`
	Offset  int32     `json:"offset,omitempty"`
	Records []Channel `json:"records,omitempty"`
}

type GetAllCommunitiesOpts 

type GetAllCommunitiesOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllCommunitiesResponse 

type GetAllCommunitiesResponse struct {
	Count   int32       `json:"count,omitempty"`
	Limit   int32       `json:"limit,omitempty"`
	Offset  int32       `json:"offset,omitempty"`
	Records []Community `json:"records,omitempty"`
}

type GetAllContentsOpts 

type GetAllContentsOpts struct {
	Q      optional.String
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllContentsResponse 

type GetAllContentsResponse struct {
	Count   int32     `json:"count,omitempty"`
	Limit   int32     `json:"limit,omitempty"`
	Offset  int32     `json:"offset,omitempty"`
	Records []Content `json:"records,omitempty"`
}

type GetAllCustomFieldsOpts 

type GetAllCustomFieldsOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllCustomFieldsResponse 

type GetAllCustomFieldsResponse struct {
	Count   int32         `json:"count,omitempty"`
	Limit   int32         `json:"limit,omitempty"`
	Offset  int32         `json:"offset,omitempty"`
	Records []CustomField `json:"records,omitempty"`
}

type GetAllEventsOpts 

type GetAllEventsOpts struct {
	Q      optional.String
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllEventsResponse 

type GetAllEventsResponse struct {
	Count   int32   `json:"count,omitempty"`
	Limit   int32   `json:"limit,omitempty"`
	Offset  int32   `json:"offset,omitempty"`
	Records []Event `json:"records,omitempty"`
}

type GetAllFoldersOpts 

type GetAllFoldersOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllFoldersResponse 

type GetAllFoldersResponse struct {
	Count   int32    `json:"count,omitempty"`
	Limit   int32    `json:"limit,omitempty"`
	Offset  int32    `json:"offset,omitempty"`
	Records []Folder `json:"records,omitempty"`
}

type GetAllIdentitiesOpts 

type GetAllIdentitiesOpts struct {
	CommunityId     optional.String
	IdentityGroupId optional.String
	UserId          optional.String
	Sort            optional.String
	ForeignId       optional.String
	Uuid            optional.String
	Offset          optional.Int32
	Limit           optional.Int32
}

type GetAllIdentitiesResponse 

type GetAllIdentitiesResponse struct {
	Count   int32      `json:"count,omitempty"`
	Limit   int32      `json:"limit,omitempty"`
	Offset  int32      `json:"offset,omitempty"`
	Records []Identity `json:"records,omitempty"`
}

type GetAllIdentityGroupsOpts 

type GetAllIdentityGroupsOpts struct {
	Firstname optional.String
	Lastname  optional.String
	Email     optional.String
	Uuid      optional.String
	Sort      optional.String
	Offset    optional.Int32
	Limit     optional.Int32
}

type GetAllIdentityGroupsResponse 

type GetAllIdentityGroupsResponse struct {
	Count   int32           `json:"count,omitempty"`
	Limit   int32           `json:"limit,omitempty"`
	Offset  int32           `json:"offset,omitempty"`
	Records []IdentityGroup `json:"records,omitempty"`
}

type GetAllInterventionCommentsOpts 

type GetAllInterventionCommentsOpts struct {
	InterventionId optional.String
	ThreadId       optional.String
	UserId         optional.String
	IdentityId     optional.String
	Offset         optional.Int32
	Limit          optional.Int32
}

type GetAllInterventionCommentsResponse 

type GetAllInterventionCommentsResponse struct {
	Count   int32                 `json:"count,omitempty"`
	Limit   int32                 `json:"limit,omitempty"`
	Offset  int32                 `json:"offset,omitempty"`
	Records []InterventionComment `json:"records,omitempty"`
}

type GetAllInterventionsOpts 

type GetAllInterventionsOpts struct {
	ThreadId        optional.String
	UserId          optional.String
	IdentityGroupId optional.String
	IdentityId      optional.Interface
	Sort            optional.String
	Offset          optional.Int32
	Limit           optional.Int32
}

type GetAllInterventionsResponse 

type GetAllInterventionsResponse struct {
	Count   int32          `json:"count,omitempty"`
	Limit   int32          `json:"limit,omitempty"`
	Offset  int32          `json:"offset,omitempty"`
	Records []Intervention `json:"records,omitempty"`
}

type GetAllPresenceStatusOpts 

type GetAllPresenceStatusOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllPresenceStatusResponse 

type GetAllPresenceStatusResponse struct {
	Count   int32            `json:"count,omitempty"`
	Limit   int32            `json:"limit,omitempty"`
	Offset  int32            `json:"offset,omitempty"`
	Records []PresenceStatus `json:"records,omitempty"`
}

type GetAllReplyAssistantEntriesOpts 

type GetAllReplyAssistantEntriesOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllReplyAssistantEntriesResponse 

type GetAllReplyAssistantEntriesResponse struct {
	Count   int32                 `json:"count,omitempty"`
	Limit   int32                 `json:"limit,omitempty"`
	Offset  int32                 `json:"offset,omitempty"`
	Records []ReplyAssistantEntry `json:"records,omitempty"`
}

type GetAllReplyAssistantGroupsOpts 

type GetAllReplyAssistantGroupsOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllReplyAssistantGroupsResponse 

type GetAllReplyAssistantGroupsResponse struct {
	Count   int32                 `json:"count,omitempty"`
	Limit   int32                 `json:"limit,omitempty"`
	Offset  int32                 `json:"offset,omitempty"`
	Records []ReplyAssistantGroup `json:"records,omitempty"`
}

type GetAllReplyAssistantVersionsOpts 

type GetAllReplyAssistantVersionsOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllReplyAssistantVersionsResponse 

type GetAllReplyAssistantVersionsResponse struct {
	Count   int32                   `json:"count,omitempty"`
	Limit   int32                   `json:"limit,omitempty"`
	Offset  int32                   `json:"offset,omitempty"`
	Records []ReplyAssistantVersion `json:"records,omitempty"`
}

type GetAllRolesOpts 

type GetAllRolesOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllRolesResponse 

type GetAllRolesResponse struct {
	Count   int32  `json:"count,omitempty"`
	Limit   int32  `json:"limit,omitempty"`
	Offset  int32  `json:"offset,omitempty"`
	Records []Role `json:"records,omitempty"`
}

type GetAllSourcesOpts 

type GetAllSourcesOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllSourcesResponse 

type GetAllSourcesResponse struct {
	Count   int32    `json:"count,omitempty"`
	Limit   int32    `json:"limit,omitempty"`
	Offset  int32    `json:"offset,omitempty"`
	Records []Source `json:"records,omitempty"`
}

type GetAllTagsOpts 

type GetAllTagsOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllTagsResponse 

type GetAllTagsResponse struct {
	Count   int32 `json:"count,omitempty"`
	Limit   int32 `json:"limit,omitempty"`
	Offset  int32 `json:"offset,omitempty"`
	Records []Tag `json:"records,omitempty"`
}

type GetAllTasksOpts 

type GetAllTasksOpts struct {
	Queue     optional.String
	ChannelId optional.String
	Step      optional.String
	Offset    optional.Int32
	Limit     optional.Int32
}

type GetAllTasksResponse 

type GetAllTasksResponse struct {
	Count   int32  `json:"count,omitempty"`
	Limit   int32  `json:"limit,omitempty"`
	Offset  int32  `json:"offset,omitempty"`
	Records []Task `json:"records,omitempty"`
}

type GetAllTeamsOpts 

type GetAllTeamsOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllTeamsResponse 

type GetAllTeamsResponse struct {
	Count   int32  `json:"count,omitempty"`
	Limit   int32  `json:"limit,omitempty"`
	Offset  int32  `json:"offset,omitempty"`
	Records []Team `json:"records,omitempty"`
}

type GetAllThreadsOpts 

type GetAllThreadsOpts struct {
	Q      optional.Int32
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllThreadsResponse 

type GetAllThreadsResponse struct {
	Count   int32    `json:"count,omitempty"`
	Limit   int32    `json:"limit,omitempty"`
	Offset  int32    `json:"offset,omitempty"`
	Records []Thread `json:"records,omitempty"`
}

type GetAllTimeSheetsOpts 

type GetAllTimeSheetsOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllTimeSheetsResponse 

type GetAllTimeSheetsResponse struct {
	Count   int32       `json:"count,omitempty"`
	Limit   int32       `json:"limit,omitempty"`
	Offset  int32       `json:"offset,omitempty"`
	Records []TimeSheet `json:"records,omitempty"`
}

type GetAllUsersOpts 

type GetAllUsersOpts struct {
	Email      optional.String
	CategoryId optional.String
	IdentityId optional.String
	ExternalId optional.String
	RoleId     optional.String
	TeamId     optional.String
	Offset     optional.Int32
	Limit      optional.Int32
}

type GetAllUsersResponse 

type GetAllUsersResponse struct {
	Count   int32  `json:"count,omitempty"`
	Limit   int32  `json:"limit,omitempty"`
	Offset  int32  `json:"offset,omitempty"`
	Records []User `json:"records,omitempty"`
}

type GetAllWebhooksOpts 

type GetAllWebhooksOpts struct {
	Offset optional.Int32
	Limit  optional.Int32
}

type GetAllWebhooksResponse 

type GetAllWebhooksResponse struct {
	Count   int32     `json:"count,omitempty"`
	Limit   int32     `json:"limit,omitempty"`
	Offset  int32     `json:"offset,omitempty"`
	Records []Webhook `json:"records,omitempty"`
}

type IdentitiesApiService 

type IdentitiesApiService service

func (*IdentitiesApiService) GetAllIdentities 

func (a *IdentitiesApiService) GetAllIdentities(ctx context.Context, localVarOptionals *GetAllIdentitiesOpts) (GetAllIdentitiesResponse, *http.Response, error)

func (*IdentitiesApiService) GetIdentity 

func (a *IdentitiesApiService) GetIdentity(ctx context.Context, identityId string) (Identity, *http.Response, error)

IdentitiesApiService Getting an identity from its id This method renders an identity from given id. If token’s user does not have “read” on identity’s source community a 404 HTTP response will be returned.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param identityId

@return Identity

type Identity 

type Identity struct {
	AvatarUrl    string                 `json:"avatar_url,omitempty"`
	CommunityId  string                 `json:"community_id,omitempty"`
	CommunityUrl string                 `json:"community_url,omitempty"`
	Company      string                 `json:"company,omitempty"`
	CreatedAt    time.Time              `json:"created_at,omitempty"`
	DisplayName  string                 `json:"display_name,omitempty"`
	Email        string                 `json:"email,omitempty"`
	ExtraValues  map[string]interface{} `json:"extra_values,omitempty"`
	Firstname    string                 `json:"firstname,omitempty"`
	ForeignId    string                 `json:"foreign_id,omitempty"`
	Gender       string                 `json:"gender,omitempty"`
	HomePhone    string                 `json:"home_phone,omitempty"`
	Id           string                 `json:"id,omitempty"`
	// The identity group id references the identity group that contains all informations (phone, notes, etc.). Many identities may belong to this group. If the identity group id is null, it means that identity does not have a group and any extra information. Please refer to identity groups API for more informations.
	IdentityGroupId string    `json:"identity_group_id,omitempty"`
	Lastname        string    `json:"lastname,omitempty"`
	MobilePhone     string    `json:"mobile_phone,omitempty"`
	Screenname      string    `json:"screenname,omitempty"`
	Type            string    `json:"type,omitempty"`
	UpdatedAt       time.Time `json:"updated_at,omitempty"`
	UserIds         []string  `json:"user_ids,omitempty"`
	Uuid            string    `json:"uuid,omitempty"`
}

type IdentityGroup 

type IdentityGroup struct {
	AvatarUrl         string                 `json:"avatar_url,omitempty"`
	Company           string                 `json:"company,omitempty"`
	CreatedAt         time.Time              `json:"created_at,omitempty"`
	CustomFieldValues map[string]interface{} `json:"custom_field_values,omitempty"`
	Emails            []string               `json:"emails,omitempty"`
	Firstname         string                 `json:"firstname,omitempty"`
	Gender            string                 `json:"gender,omitempty"`
	HomePhones        []string               `json:"home_phones,omitempty"`
	Id                string                 `json:"id"`
	IdentityIds       []string               `json:"identity_ids,omitempty"`
	Lastname          string                 `json:"lastname,omitempty"`
	MobilePhones      []string               `json:"mobile_phones,omitempty"`
	Notes             string                 `json:"notes,omitempty"`
	TagIds            []string               `json:"tag_ids,omitempty"`
	UpdatedAt         time.Time              `json:"updated_at,omitempty"`
}

type IdentityGroupsApiService 

type IdentityGroupsApiService service

func (*IdentityGroupsApiService) GetAllIdentityGroups 

func (a *IdentityGroupsApiService) GetAllIdentityGroups(ctx context.Context, localVarOptionals *GetAllIdentityGroupsOpts) (GetAllIdentityGroupsResponse, *http.Response, error)

func (*IdentityGroupsApiService) GetIdentityGroup 

func (a *IdentityGroupsApiService) GetIdentityGroup(ctx context.Context, identityGroupId string) (IdentityGroup, *http.Response, error)

IdentityGroupsApiService Getting an identity group from its id This method renders an identity group from given id.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param identityGroupId

@return IdentityGroup

func (*IdentityGroupsApiService) UpdateIdentityGroup 

func (a *IdentityGroupsApiService) UpdateIdentityGroup(ctx context.Context, identityGroupId string, localVarOptionals *UpdateIdentityGroupOpts) (IdentityGroup, *http.Response, error)

type Intervention 

type Intervention struct {
	CategoryIds             []string               `json:"category_ids,omitempty"`
	Closed                  bool                   `json:"closed,omitempty"`
	ClosedAt                time.Time              `json:"closed_at,omitempty"`
	CommentsCount           int32                  `json:"comments_count,omitempty"`
	ContentId               string                 `json:"content_id,omitempty"`
	CreatedAt               time.Time              `json:"created_at,omitempty"`
	CustomFields            map[string]interface{} `json:"custom_fields,omitempty"`
	DeferredAt              time.Time              `json:"deferred_at,omitempty"`
	FirstUserReplyId        string                 `json:"first_user_reply_id,omitempty"`
	FirstUserReplyIn        int32                  `json:"first_user_reply_in,omitempty"`
	FirstUserReplyInBh      int32                  `json:"first_user_reply_in_bh,omitempty"`
	Id                      string                 `json:"id"`
	IdentityId              string                 `json:"identity_id,omitempty"`
	LastUserReplyIn         int32                  `json:"last_user_reply_in,omitempty"`
	LastUserReplyInBh       int32                  `json:"last_user_reply_in_bh,omitempty"`
	SourceId                string                 `json:"source_id,omitempty"`
	Status                  string                 `json:"status,omitempty"`
	ThreadId                string                 `json:"thread_id,omitempty"`
	UpdatedAt               time.Time              `json:"updated_at,omitempty"`
	UserId                  string                 `json:"user_id,omitempty"`
	UserRepliesCount        int32                  `json:"user_replies_count,omitempty"`
	UserReplyInAverage      int32                  `json:"user_reply_in_average,omitempty"`
	UserReplyInAverageBh    int32                  `json:"user_reply_in_average_bh,omitempty"`
	UserReplyInAverageCount int32                  `json:"user_reply_in_average_count,omitempty"`
}

type InterventionComment 

type InterventionComment struct {
	Body           string    `json:"body,omitempty"`
	CreatedAt      time.Time `json:"created_at,omitempty"`
	Id             string    `json:"id,omitempty"`
	InterventionId string    `json:"intervention_id,omitempty"`
	ThreadId       string    `json:"thread_id,omitempty"`
	UpdatedAt      time.Time `json:"updated_at,omitempty"`
	UserId         string    `json:"user_id,omitempty"`
	VidentityId    string    `json:"videntity_id,omitempty"`
}

type InterventionCommentsApiService 

type InterventionCommentsApiService service

func (*InterventionCommentsApiService) CreateInterventionComment 

func (a *InterventionCommentsApiService) CreateInterventionComment(ctx context.Context, body string, interventionId string, userId string) (InterventionComment, *http.Response, error)

InterventionCommentsApiService Creating an intervention comment This method creates a new intervention comment. In case of success it renders the created comment, otherwise, it renders an error (422 HTTP code). It creates comment as token’s user. If token’s user does not have “read” on given intervention’s source a 404 HTTP response will be returned.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The comment body (mandatory).
  • @param interventionId The comment intervention id (mandatory).
  • @param userId The comment user id (mandatory).

@return InterventionComment

func (*InterventionCommentsApiService) DeleteInterventionComment 

func (a *InterventionCommentsApiService) DeleteInterventionComment(ctx context.Context, interventionCommentId string) (InterventionComment, *http.Response, error)

InterventionCommentsApiService Deleting an intervention comment This method destroys an intervention comment. It renders comment itself. If token’s user does not have “read” on comment’s source a 404 HTTP response will be returned. Authorization​: no.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param interventionCommentId

@return InterventionComment

func (*InterventionCommentsApiService) GetAllInterventionComments 

func (a *InterventionCommentsApiService) GetAllInterventionComments(ctx context.Context, localVarOptionals *GetAllInterventionCommentsOpts) (GetAllInterventionCommentsResponse, *http.Response, error)

func (*InterventionCommentsApiService) GetInterventionComment 

func (a *InterventionCommentsApiService) GetInterventionComment(ctx context.Context, interventionCommentId string) (InterventionComment, *http.Response, error)

InterventionCommentsApiService Getting an intervention comment from its id This method renders an intervention comment from given id. If token’s user does not have “read” on comment’s source a 404 HTTP response will be returned.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param interventionCommentId

@return InterventionComment

type InterventionsApiService 

type InterventionsApiService service

func (*InterventionsApiService) CancelIntervention 

func (a *InterventionsApiService) CancelIntervention(ctx context.Context, interventionId string) (Intervention, *http.Response, error)

InterventionsApiService Cancelling an intervention This method cancels (destroys) an intervention. It renders intervention itself. If token’s user does not have “read” on intervention’s source a 404 HTTP response will be returned. Caveats: * If the intervention is already being canceled, it will return a 409 error. * To be able to close an intervention, it must meet the following criteria otherwise a 403 will be raised: * Intervention MUST NOT already be closed * Intervention MUST NOT have agent replies * Access-Token agent MUST have read access on the source Authorization​: no, but it renders an error if intervention can’t be destroyed (see caveats).

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param interventionId

@return Intervention

func (*InterventionsApiService) CategorizeIntervention 

func (a *InterventionsApiService) CategorizeIntervention(ctx context.Context, interventionId string, categoryIds []string) (Intervention, *http.Response, error)

InterventionsApiService Categorizing an intervention This method updates the categories of an intervention. If token’s user does not have “read” on the intervention’s source a 404 HTTP response will be returned. Authorization​: no.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param interventionId
  • @param categoryIds

@return Intervention

func (*InterventionsApiService) CloseIntervention 

func (a *InterventionsApiService) CloseIntervention(ctx context.Context, interventionId string) (Intervention, *http.Response, error)

InterventionsApiService Closing an intervention This method closes an intervention. Caveats: * If the intervention is already being closed, it will return a 409 error. * To be able to close an intervention, it must meet the following criteria otherwise a 403 will be raised: * Intervention MUST NOT already be closed * Intervention MUST have agent replies * Access-Token agent MUST be the owner of the intervention or have the permission to edit permissions * Access-Token agent MUST have read access on the source Authorization​: no, but it renders an error if intervention can’t be closed (see caveats)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param interventionId

@return Intervention

func (*InterventionsApiService) CreateIntervention 

func (a *InterventionsApiService) CreateIntervention(ctx context.Context, contentId string) (GetAllInterventionsResponse, *http.Response, error)

InterventionsApiService Creating an intervention This method creates a new intervention or reopen it. In case of success it renders the intervention, otherwise, it renders an error (422 HTTP code). This method opens intervention as access token’s user. Authorization​: no, but it renders an error if intervention can’t be created or reopened (already opened, etc.).

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contentId The content to create intervention on (mandatory).

@return GetAllInterventionsResponse

func (*InterventionsApiService) GetAllInterventions 

func (a *InterventionsApiService) GetAllInterventions(ctx context.Context, localVarOptionals *GetAllInterventionsOpts) (GetAllInterventionsResponse, *http.Response, error)

func (*InterventionsApiService) GetIntervention 

func (a *InterventionsApiService) GetIntervention(ctx context.Context, interventionId string) (Intervention, *http.Response, error)

InterventionsApiService Getting an intervention from its id This method renders an intervention from given id. If token’s user does not have “read” on intervention’s source a 404 HTTP response will be returned. Authorization​: no.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param interventionId

@return Intervention

func (*InterventionsApiService) ReassignIntervention 

func (a *InterventionsApiService) ReassignIntervention(ctx context.Context, interventionId string, userId string) (Intervention, *http.Response, error)

InterventionsApiService Reassigning an intervention This method updates the user in charge of the intervention Authorization​: Only users who can update interventions.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param interventionId
  • @param userId

@return Intervention

type InviteUserOpts 

type InviteUserOpts struct {
	CategoryIds     optional.Interface
	Enabled         optional.Bool
	ExternalId      optional.String
	Gender          optional.String
	IdentityIds     optional.Interface
	Locale          optional.String
	Nickname        optional.String
	TeamIds         optional.Interface
	Timezone        optional.String
	SpokenLanguages optional.Interface
}

type Locale 

type Locale struct {
	Code      string `json:"code,omitempty"`
	Interface bool   `json:"interface,omitempty"`
	Name      string `json:"name,omitempty"`
}

type LocalesApiService 

type LocalesApiService service

func (*LocalesApiService) GetAllLocales 

func (a *LocalesApiService) GetAllLocales(ctx context.Context) ([]Locale, *http.Response, error)

LocalesApiService Getting all locales This method renders all available locales.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Locale

type PresenceStatus 

type PresenceStatus struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	Id        string    `json:"id"`
	Name      string    `json:"name"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type PresenceStatusApiService 

type PresenceStatusApiService service

func (*PresenceStatusApiService) CreatePresenceStatus 

func (a *PresenceStatusApiService) CreatePresenceStatus(ctx context.Context, name string) (PresenceStatus, *http.Response, error)

PresenceStatusApiService Creating a presence status This method creates a presence status. In case of success it renders the presence status, otherwise, it renders an error (422 HTTP code). Authorization​: only users that have the right to monitor the task view.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name The name of the presence status.

@return PresenceStatus

func (*PresenceStatusApiService) DeletePresenceStatus 

func (a *PresenceStatusApiService) DeletePresenceStatus(ctx context.Context, presenceStatusId string) (PresenceStatus, *http.Response, error)

PresenceStatusApiService Deleting a presence status This method destroys an existing presence status. It renders presence status itself. It renders a 404 if id is invalid. Authorization​: only users that have the right to monitor the task view.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param presenceStatusId

@return PresenceStatus

func (*PresenceStatusApiService) GetAllPresenceStatus 

func (a *PresenceStatusApiService) GetAllPresenceStatus(ctx context.Context, localVarOptionals *GetAllPresenceStatusOpts) (GetAllPresenceStatusResponse, *http.Response, error)

func (*PresenceStatusApiService) GetPresenceStatus 

func (a *PresenceStatusApiService) GetPresenceStatus(ctx context.Context, presenceStatusId string) (PresenceStatus, *http.Response, error)

PresenceStatusApiService Getting a presence status from its id This method renders a presence status from given id. Authorization​: only users that have the right to monitor the task view.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param presenceStatusId

@return PresenceStatus

func (*PresenceStatusApiService) UpdatePresenceStatus 

func (a *PresenceStatusApiService) UpdatePresenceStatus(ctx context.Context, presenceStatusId string, name string) (PresenceStatus, *http.Response, error)

PresenceStatusApiService Updating a presence status This method updates an existing presence status from given attributes and renders it in case of success. Authorization​: only users that have the right to monitor the task view.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param presenceStatusId
  • @param name The name of the presence status.

@return PresenceStatus

type ReplyAssistantEntriesApiService 

type ReplyAssistantEntriesApiService service

func (*ReplyAssistantEntriesApiService) CreateReplyAssistantEntry 

func (a *ReplyAssistantEntriesApiService) CreateReplyAssistantEntry(ctx context.Context, label string) (ReplyAssistantEntry, *http.Response, error)

ReplyAssistantEntriesApiService Creating an entry This method creates a reply assistant entry. In case of success it renders the entry, otherwise, it renders an error (422 HTTP code). Authorization​: only users that have the right to manage reply assistant.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param label The name of the entry.

@return ReplyAssistantEntry

func (*ReplyAssistantEntriesApiService) DeleteReplyAssistantEntry 

func (a *ReplyAssistantEntriesApiService) DeleteReplyAssistantEntry(ctx context.Context, replyAssistantEntryId string) (ReplyAssistantEntry, *http.Response, error)

ReplyAssistantEntriesApiService Deleting a reply assistant entry This method destroys an existing entry. It renders the entry itself. It renders a 404 if id is invalid. Authorization​: only users that have the right to manage reply assistant.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param replyAssistantEntryId

@return ReplyAssistantEntry

func (*ReplyAssistantEntriesApiService) GetAllReplyAssistantEntries 

func (a *ReplyAssistantEntriesApiService) GetAllReplyAssistantEntries(ctx context.Context, localVarOptionals *GetAllReplyAssistantEntriesOpts) (GetAllReplyAssistantEntriesResponse, *http.Response, error)

func (*ReplyAssistantEntriesApiService) GetReplyAssistantEntry 

func (a *ReplyAssistantEntriesApiService) GetReplyAssistantEntry(ctx context.Context, replyAssistantEntryId string) (ReplyAssistantEntry, *http.Response, error)

ReplyAssistantEntriesApiService Getting a reply assistant entry from its id This method renders an entry from given id. Authorization​: only users that have the right to manage reply assistant.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param replyAssistantEntryId

@return ReplyAssistantEntry

func (*ReplyAssistantEntriesApiService) UpdateReplyAssistantEntry 

func (a *ReplyAssistantEntriesApiService) UpdateReplyAssistantEntry(ctx context.Context, replyAssistantEntryId string, localVarOptionals *UpdateReplyAssistantEntryOpts) (ReplyAssistantEntry, *http.Response, error)

type ReplyAssistantEntry 

type ReplyAssistantEntry struct {
	CategoryIds  []string  `json:"category_ids,omitempty"`
	CreatedAt    time.Time `json:"created_at,omitempty"`
	EntryGroupId string    `json:"entry_group_id,omitempty"`
	ForeignId    string    `json:"foreign_id,omitempty"`
	Id           string    `json:"id"`
	Label        string    `json:"label,omitempty"`
	Shortcuts    string    `json:"shortcuts,omitempty"`
	SourceIds    []string  `json:"source_ids,omitempty"`
	UpdatedAt    time.Time `json:"updated_at,omitempty"`
	VersionIds   []string  `json:"version_ids,omitempty"`
}

type ReplyAssistantGroup 

type ReplyAssistantGroup struct {
	Autocomplete bool      `json:"autocomplete,omitempty"`
	CreatedAt    time.Time `json:"created_at,omitempty"`
	EntryIds     []string  `json:"entry_ids,omitempty"`
	Id           string    `json:"id"`
	Name         string    `json:"name,omitempty"`
	Position     int32     `json:"position,omitempty"`
	UpdatedAt    time.Time `json:"updated_at,omitempty"`
}

type ReplyAssistantGroupsApiService 

type ReplyAssistantGroupsApiService service

func (*ReplyAssistantGroupsApiService) CreateReplyAssistantGroup 

func (a *ReplyAssistantGroupsApiService) CreateReplyAssistantGroup(ctx context.Context, name string, localVarOptionals *CreateReplyAssistantGroupOpts) (ReplyAssistantGroup, *http.Response, error)

func (*ReplyAssistantGroupsApiService) DeleteReplyAssistantGroup 

func (a *ReplyAssistantGroupsApiService) DeleteReplyAssistantGroup(ctx context.Context, replyAssistantGroupId string) (ReplyAssistantGroup, *http.Response, error)

ReplyAssistantGroupsApiService Deleting a reply assistant group This method destroys an existing group. It renders the group itself. It renders a 404 if id is invalid. Authorization​: only users that have the right to manage reply assistant.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param replyAssistantGroupId

@return ReplyAssistantGroup

func (*ReplyAssistantGroupsApiService) GetAllReplyAssistantGroups 

func (a *ReplyAssistantGroupsApiService) GetAllReplyAssistantGroups(ctx context.Context, localVarOptionals *GetAllReplyAssistantGroupsOpts) (GetAllReplyAssistantGroupsResponse, *http.Response, error)

func (*ReplyAssistantGroupsApiService) GetReplyAssistantGroup 

func (a *ReplyAssistantGroupsApiService) GetReplyAssistantGroup(ctx context.Context, replyAssistantGroupId string) (ReplyAssistantGroup, *http.Response, error)

ReplyAssistantGroupsApiService Getting a reply assistant group from its id This method renders an entry group from given id. Authorization​: only users that have the right to manage reply assistant.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param replyAssistantGroupId

@return ReplyAssistantGroup

func (*ReplyAssistantGroupsApiService) UpdateReplyAssistantGroup 

func (a *ReplyAssistantGroupsApiService) UpdateReplyAssistantGroup(ctx context.Context, replyAssistantGroupId string, localVarOptionals *UpdateReplyAssistantGroupOpts) (ReplyAssistantGroup, *http.Response, error)

type ReplyAssistantVersion 

type ReplyAssistantVersion struct {
	AttachmentsCount int32     `json:"attachments_count,omitempty"`
	Body             string    `json:"body,omitempty"`
	CreatedAt        time.Time `json:"created_at,omitempty"`
	EntryId          string    `json:"entry_id,omitempty"`
	Format           string    `json:"format,omitempty"`
	Id               string    `json:"id"`
	Language         string    `json:"language,omitempty"`
	SourceIds        []string  `json:"source_ids,omitempty"`
	UpdatedAt        time.Time `json:"updated_at,omitempty"`
}

type ReplyAssistantVersionsApiService 

type ReplyAssistantVersionsApiService service

func (*ReplyAssistantVersionsApiService) CreateReplyAssistantVersion 

func (a *ReplyAssistantVersionsApiService) CreateReplyAssistantVersion(ctx context.Context, body string, entryId string, localVarOptionals *CreateReplyAssistantVersionOpts) (ReplyAssistantVersion, *http.Response, error)

func (*ReplyAssistantVersionsApiService) DeleteReplyAssistantVersion 

func (a *ReplyAssistantVersionsApiService) DeleteReplyAssistantVersion(ctx context.Context, replyAssistantVersionId string) (ReplyAssistantVersion, *http.Response, error)

ReplyAssistantVersionsApiService Deleting a reply assistant version This method destroys an existing version. It renders the version itself. It renders a 404 if id is invalid. Authorization​: only users that have the right to manage reply assistant.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param replyAssistantVersionId

@return ReplyAssistantVersion

func (*ReplyAssistantVersionsApiService) GetAllReplyAssistantVersions 

func (a *ReplyAssistantVersionsApiService) GetAllReplyAssistantVersions(ctx context.Context, localVarOptionals *GetAllReplyAssistantVersionsOpts) (GetAllReplyAssistantVersionsResponse, *http.Response, error)

func (*ReplyAssistantVersionsApiService) GetReplyAssistantVersion 

func (a *ReplyAssistantVersionsApiService) GetReplyAssistantVersion(ctx context.Context, replyAssistantVersionId string) (ReplyAssistantVersion, *http.Response, error)

ReplyAssistantVersionsApiService Getting a reply assistant version from its id This method renders a version from given id. Authorization​: only users that have the right to manage reply assistant.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param replyAssistantVersionId

@return ReplyAssistantVersion

func (*ReplyAssistantVersionsApiService) UpdateReplyAssistantVersion 

func (a *ReplyAssistantVersionsApiService) UpdateReplyAssistantVersion(ctx context.Context, replyAssistantVersionId string, localVarOptionals *UpdateReplyAssistantVersionOpts) (ReplyAssistantVersion, *http.Response, error)

type Restriction 

type Restriction struct {
	Only []string `json:"only,omitempty"`
}

type Role 

type Role struct {
	AccessHelpCenter          bool      `json:"access_help_center,omitempty"`
	AccessPreviousMessages    bool      `json:"access_previous_messages,omitempty"`
	AccessPullMode            bool      `json:"access_pull_mode,omitempty"`
	AdminStampAnswer          bool      `json:"admin_stamp_answer,omitempty"`
	AnonymizeIdentity         bool      `json:"anonymize_identity,omitempty"`
	ApproveContent            bool      `json:"approve_content,omitempty"`
	AssignIntervention        bool      `json:"assign_intervention,omitempty"`
	AuthorBlockContent        bool      `json:"author_block_content,omitempty"`
	CloseContentThread        bool      `json:"close_content_thread,omitempty"`
	CreateAndDestroyExtension bool      `json:"create_and_destroy_extension,omitempty"`
	CreateCommunity           bool      `json:"create_community,omitempty"`
	CreateContentSource       bool      `json:"create_content_source,omitempty"`
	CreateUser                bool      `json:"create_user,omitempty"`
	CreatedAt                 time.Time `json:"created_at,omitempty"`
	DelayExportContent        bool      `json:"delay_export_content,omitempty"`
	DeleteContentThread       bool      `json:"delete_content_thread,omitempty"`
	ExportIdentity            bool      `json:"export_identity,omitempty"`
	Id                        string    `json:"id,omitempty"`
	ImpersonateUser           bool      `json:"impersonate_user,omitempty"`
	InviteUser                bool      `json:"invite_user,omitempty"`
	Label                     string    `json:"label,omitempty"`
	LockIdentity              bool      `json:"lock_identity,omitempty"`
	ManageApiAccessTokens     bool      `json:"manage_api_access_tokens,omitempty"`
	ManageAppSdkApplications  bool      `json:"manage_app_sdk_applications,omitempty"`
	ManageCategories          bool      `json:"manage_categories,omitempty"`
	ManageChat                bool      `json:"manage_chat,omitempty"`
	ManageCustomFields        bool      `json:"manage_custom_fields,omitempty"`
	ManageCustomNotifications bool      `json:"manage_custom_notifications,omitempty"`
	ManageEmailsTemplates     bool      `json:"manage_emails_templates,omitempty"`
	ManageFolders             bool      `json:"manage_folders,omitempty"`
	ManageIce                 bool      `json:"manage_ice,omitempty"`
	ManageIdentities          bool      `json:"manage_identities,omitempty"`
	ManageMessaging           bool      `json:"manage_messaging,omitempty"`
	ManageOwnNotifications    bool      `json:"manage_own_notifications,omitempty"`
	ManageReplyAssistant      bool      `json:"manage_reply_assistant,omitempty"`
	ManageRoles               bool      `json:"manage_roles,omitempty"`
	ManageRulesEngineRules    bool      `json:"manage_rules_engine_rules,omitempty"`
	ManageTags                bool      `json:"manage_tags,omitempty"`
	ManageTeams               bool      `json:"manage_teams,omitempty"`
	ManageTopologies          bool      `json:"manage_topologies,omitempty"`
	ManageUsersOfMyTeams      bool      `json:"manage_users_of_my_teams,omitempty"`
	MonitorTasks              bool      `json:"monitor_tasks,omitempty"`
	MonitorTeamTasks          bool      `json:"monitor_team_tasks,omitempty"`
	MuteContent               bool      `json:"mute_content,omitempty"`
	OpenContentThread         bool      `json:"open_content_thread,omitempty"`
	PublishContent            bool      `json:"publish_content,omitempty"`
	ReadCommunity             bool      `json:"read_community,omitempty"`
	ReadContentSource         bool      `json:"read_content_source,omitempty"`
	ReadEvent                 bool      `json:"read_event,omitempty"`
	ReadExport                bool      `json:"read_export,omitempty"`
	ReadIdentity              bool      `json:"read_identity,omitempty"`
	ReadOwnStats              bool      `json:"read_own_stats,omitempty"`
	ReadPresence              bool      `json:"read_presence,omitempty"`
	ReadStats                 bool      `json:"read_stats,omitempty"`
	ReadUser                  bool      `json:"read_user,omitempty"`
	ReceiveTasks              bool      `json:"receive_tasks,omitempty"`
	ReplyWithAssistant        bool      `json:"reply_with_assistant,omitempty"`
	SearchContents            bool      `json:"search_contents,omitempty"`
	SearchEvent               bool      `json:"search_event,omitempty"`
	UpdateCommunity           bool      `json:"update_community,omitempty"`
	UpdateContentSource       bool      `json:"update_content_source,omitempty"`
	UpdateExtension           bool      `json:"update_extension,omitempty"`
	UpdateIdentity            bool      `json:"update_identity,omitempty"`
	UpdateIntervention        bool      `json:"update_intervention,omitempty"`
	UpdateOwnIntervention     bool      `json:"update_own_intervention,omitempty"`
	UpdateSettings            bool      `json:"update_settings,omitempty"`
	UpdateTimeSheet           bool      `json:"update_time_sheet,omitempty"`
	UpdateUser                bool      `json:"update_user,omitempty"`
	UpdatedAt                 time.Time `json:"updated_at,omitempty"`
	UseCobrowsing             bool      `json:"use_cobrowsing,omitempty"`
	UseEmoji                  bool      `json:"use_emoji,omitempty"`
}

type RolesApiService 

type RolesApiService service

func (*RolesApiService) CreateRole 

func (a *RolesApiService) CreateRole(ctx context.Context, label string, localVarOptionals *CreateRoleOpts) (Role, *http.Response, error)

func (*RolesApiService) GetAllRoles 

func (a *RolesApiService) GetAllRoles(ctx context.Context, localVarOptionals *GetAllRolesOpts) (GetAllRolesResponse, *http.Response, error)

func (*RolesApiService) GetRole 

func (a *RolesApiService) GetRole(ctx context.Context, roleId string) (Role, *http.Response, error)

RolesApiService Getting a role from its id This method renders a role from given id. Authorization​: only users that can manage roles.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param roleId

@return Role

func (*RolesApiService) UpdateRole 

func (a *RolesApiService) UpdateRole(ctx context.Context, roleId string, localVarOptionals *UpdateRoleOpts) (Role, *http.Response, error)

type Settings 

type Settings struct {
	ActivityPresenceThreshold    int32     `json:"activity_presence_threshold,omitempty"`
	ActivityTracking             bool      `json:"activity_tracking,omitempty"`
	BeginningOfWeek              string    `json:"beginning_of_week,omitempty"`
	BrowserNotificationsDisabled bool      `json:"browser_notifications_disabled,omitempty"`
	ContentLanguages             []string  `json:"content_languages[],omitempty"`
	CreatedAt                    time.Time `json:"created_at,omitempty"`
	DenyIframeIntegration        bool      `json:"deny_iframe_integration,omitempty"`
	DisablePasswordAutocomplete  bool      `json:"disable_password_autocomplete,omitempty"`
	DisplayOnlyUnknownBbcode     bool      `json:"display_only_unknown_bbcode,omitempty"`
	DumpInPreprod                bool      `json:"dump_in_preprod,omitempty"`
	ExpirePasswordAfter          int32     `json:"expire_password_after,omitempty"`
	ExpirePasswordEnabled        bool      `json:"expire_password_enabled,omitempty"`
	FteDuration                  int32     `json:"fte_duration,omitempty"`
	Id                           string    `json:"id,omitempty"`
	IdentityMerge                bool      `json:"identity_merge,omitempty"`
	InterventionClosingPeriod    int32     `json:"intervention_closing_period,omitempty"`
	InterventionDeferRates       []int32   `json:"intervention_defer_rates,omitempty"`
	InterventionDeferThreshold   int32     `json:"intervention_defer_threshold,omitempty"`
	InterventionRates            []int32   `json:"intervention_rates,omitempty"`
	Locale                       string    `json:"locale,omitempty"`
	MultiLang                    bool      `json:"multi_lang,omitempty"`
	Name                         string    `json:"name,omitempty"`
	PasswordArchivableEnabled    bool      `json:"password_archivable_enabled,omitempty"`
	PasswordArchivableSize       int32     `json:"password_archivable_size,omitempty"`
	PasswordMinLength            int32     `json:"password_min_length,omitempty"`
	PasswordNonWord              bool      `json:"password_non_word,omitempty"`
	PasswordNumbers              bool      `json:"password_numbers,omitempty"`
	PasswordRecoveryDisabled     bool      `json:"password_recovery_disabled,omitempty"`
	PushEnabled                  bool      `json:"push_enabled,omitempty"`
	ReplyAsAnyIdentity           bool      `json:"reply_as_any_identity,omitempty"`
	RtlSupport                   bool      `json:"rtl_support,omitempty"`
	SelfApprovalRequired         bool      `json:"self_approval_required,omitempty"`
	SessionTimeout               int32     `json:"session_timeout,omitempty"`
	ShardingKey                  string    `json:"sharding_key,omitempty"`
	Spellchecking                bool      `json:"spellchecking,omitempty"`
	Style                        string    `json:"style,omitempty"`
	ThirdPartyServicesDisabled   bool      `json:"third_party_services_disabled,omitempty"`
	Timezone                     string    `json:"timezone,omitempty"`
	Type                         string    `json:"type,omitempty"`
	UpdatedAt                    time.Time `json:"updated_at,omitempty"`
	UrgentTaskThreshold          int32     `json:"urgent_task_threshold,omitempty"`
	UseTwoLettersAvatars         bool      `json:"use_two_letters_avatars,omitempty"`
}

type SettingsApiService 

type SettingsApiService service

func (*SettingsApiService) GetAllSettings 

func (a *SettingsApiService) GetAllSettings(ctx context.Context) (Settings, *http.Response, error)

SettingsApiService Getting all settings This method renders all settings of your domain. Authorization​: only users that can update settings.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return Settings

func (*SettingsApiService) UpdateSettings 

func (a *SettingsApiService) UpdateSettings(ctx context.Context, localVarOptionals *UpdateSettingsOpts) (Settings, *http.Response, error)

type Source 

type Source struct {
	// Activate/deactivate the source
	Active bool `json:"active,omitempty"`
	// Auto-detect content language (Boolean)
	AutoDetectContentLanguage bool   `json:"auto_detect_content_language,omitempty"`
	ChannelId                 string `json:"channel_id,omitempty"`
	// Color of the icon: Default: 0 Blue: 1 Green: 2 Turquoise: 3 Purple: 4 Yellow: 5 Orange: 6 Red: 7 Asphalt: 8 Grey: 9
	Color       int32  `json:"color,omitempty"`
	CommunityId string `json:"community_id,omitempty"`
	// Automatic archiving of old contents (Boolean)
	ContentArchiving bool `json:"content_archiving,omitempty"`
	// Archive contents older than (seconds)
	ContentArchivingPeriod int64     `json:"content_archiving_period,omitempty"`
	ContentLanguages       []string  `json:"content_languages,omitempty"`
	CreatedAt              time.Time `json:"created_at,omitempty"`
	// Default categories
	DefaultCategoryIds []string `json:"default_category_ids,omitempty"`
	// Default content language
	DefaultContentLanguage string `json:"default_content_language,omitempty"`
	ErrorMessage           string `json:"error_message,omitempty"`
	// Hide from statistics
	HiddenFromStats bool   `json:"hidden_from_stats,omitempty"`
	Id              string `json:"id,omitempty"`
	// Priority boost of messages with intervention
	InterventionMessagesBoost int32 `json:"intervention_messages_boost,omitempty"`
	// Source name
	Name string `json:"name,omitempty"`
	// SLA expired strategy (\"max\", \"half\" or \"base\")
	SlaExpiredStrategy string `json:"sla_expired_strategy,omitempty"`
	// Response time (seconds)
	SlaResponse  int32    `json:"sla_response,omitempty"`
	Status       string   `json:"status,omitempty"`
	TimeSheetIds []string `json:"time_sheet_ids,omitempty"`
	// Priority boost of transferred tasks
	TransferredTasksBoost int32     `json:"transferred_tasks_boost,omitempty"`
	Type                  string    `json:"type,omitempty"`
	UpdatedAt             time.Time `json:"updated_at,omitempty"`
	// Default categories (agent messages)
	UserThreadDefaultCategoryIds []string `json:"user_thread_default_category_ids,omitempty"`
}

type SourcesApiService 

type SourcesApiService service

func (*SourcesApiService) GetAllSources 

func (a *SourcesApiService) GetAllSources(ctx context.Context, localVarOptionals *GetAllSourcesOpts) (GetAllSourcesResponse, *http.Response, error)

func (*SourcesApiService) GetSource 

func (a *SourcesApiService) GetSource(ctx context.Context, sourceId string) (Source, *http.Response, error)

SourcesApiService Getting a source from its id This method renders a source from given id.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sourceId

@return Source

func (*SourcesApiService) UpdateSource 

func (a *SourcesApiService) UpdateSource(ctx context.Context, sourceId string, localVarOptionals *UpdateSourceOpts) (Source, *http.Response, error)

type Tag 

type Tag struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	Id        string    `json:"id"`
	Name      string    `json:"name"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type TagsApiService 

type TagsApiService service

func (*TagsApiService) CreateTag 

func (a *TagsApiService) CreateTag(ctx context.Context, name string) (Tag, *http.Response, error)

TagsApiService Creating a tag This method creates a new tag. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name Tag name (mandatory).

@return Tag

func (*TagsApiService) DeleteTag 

func (a *TagsApiService) DeleteTag(ctx context.Context, tagId string) (Tag, *http.Response, error)

TagsApiService Deleting a tag This method destroys an existing tag. It renders tag itself. It renders a 404 if id is invalid. Authorization​: only users that are able to destroy tags.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tagId

@return Tag

func (*TagsApiService) GetAllTags 

func (a *TagsApiService) GetAllTags(ctx context.Context, localVarOptionals *GetAllTagsOpts) (GetAllTagsResponse, *http.Response, error)

func (*TagsApiService) GetTag 

func (a *TagsApiService) GetTag(ctx context.Context, tagId string) (Tag, *http.Response, error)

TagsApiService Getting a tag from its id This method renders a tag from given id.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tagId

@return Tag

func (*TagsApiService) UpdateTag 

func (a *TagsApiService) UpdateTag(ctx context.Context, tagId string, name string) (Tag, *http.Response, error)

TagsApiService Updating a tag This method updates an existing tag from given attributes and renders it in case of success. Authorization​: only users that are able to update tags.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tagId
  • @param name Tag’s label.

@return Tag

type Task 

type Task struct {
	AcceptedAt     time.Time `json:"accepted_at,omitempty"`
	AgentIds       []string  `json:"agent_ids,omitempty"`
	ChannelId      string    `json:"channel_id,omitempty"`
	CompletedAt    time.Time `json:"completed_at,omitempty"`
	ContentId      string    `json:"content_id,omitempty"`
	CreatedAt      time.Time `json:"created_at,omitempty"`
	ExpireAt       time.Time `json:"expire_at,omitempty"`
	Id             string    `json:"id"`
	InterventionId string    `json:"intervention_id,omitempty"`
	LockedAt       time.Time `json:"locked_at,omitempty"`
	Priority       int32     `json:"priority,omitempty"`
	Step           string    `json:"step,omitempty"`
	ThreadId       string    `json:"thread_id,omitempty"`
	TransferedAt   time.Time `json:"transfered_at,omitempty"`
	UpdatedAt      time.Time `json:"updated_at,omitempty"`
}

type TasksApiService 

type TasksApiService service

func (*TasksApiService) GetAllTasks 

func (a *TasksApiService) GetAllTasks(ctx context.Context, localVarOptionals *GetAllTasksOpts) (GetAllTasksResponse, *http.Response, error)

func (*TasksApiService) GetTask 

func (a *TasksApiService) GetTask(ctx context.Context, taskId string) (Task, *http.Response, error)

TasksApiService Getting a task from its id This method renders a task from given id.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId

@return Task

func (*TasksApiService) MoveTask 

func (a *TasksApiService) MoveTask(ctx context.Context, taskId string, queue string) (Task, *http.Response, error)

TasksApiService Move a task to another queue This method changes a task queue and renders it in case of success. Only accepts “undelivered” and special queue defined in topology (e.g. triage). Authorization​: only users that have the right to monitor the task view.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId
  • @param queue Name of the queue task has to be moved in.

@return Task

func (*TasksApiService) TransferTask 

func (a *TasksApiService) TransferTask(ctx context.Context, taskId string, localVarOptionals *TransferTaskOpts) (Task, *http.Response, error)

type Team 

type Team struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	Id        string    `json:"id"`
	LeaderIds []string  `json:"leader_ids,omitempty"`
	Name      string    `json:"name,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	UserIds   []string  `json:"user_ids,omitempty"`
}

type TeamsApiService 

type TeamsApiService service

func (*TeamsApiService) CreateTeam 

func (a *TeamsApiService) CreateTeam(ctx context.Context, localVarOptionals *CreateTeamOpts) (Team, *http.Response, error)

func (*TeamsApiService) DeleteTeam 

func (a *TeamsApiService) DeleteTeam(ctx context.Context, teamId string, localVarOptionals *DeleteTeamOpts) (Team, *http.Response, error)

func (*TeamsApiService) GetAllTeams 

func (a *TeamsApiService) GetAllTeams(ctx context.Context, localVarOptionals *GetAllTeamsOpts) (GetAllTeamsResponse, *http.Response, error)

func (*TeamsApiService) GetTeam 

func (a *TeamsApiService) GetTeam(ctx context.Context, teamId string) (Team, *http.Response, error)

TeamsApiService Getting a team from its id This method renders a team from given id.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param teamId

@return Team

func (*TeamsApiService) UpdateTeam 

func (a *TeamsApiService) UpdateTeam(ctx context.Context, teamId string, localVarOptionals *UpdateTeamOpts) (Team, *http.Response, error)

type Thread 

type Thread struct {
	CategoryIds        []string               `json:"category_ids,omitempty"`
	Closed             bool                   `json:"closed,omitempty"`
	ContentsCount      int32                  `json:"contents_count,omitempty"`
	CreatedAt          time.Time              `json:"created_at,omitempty"`
	ExtraData          map[string]interface{} `json:"extra_data,omitempty"`
	ForeignId          string                 `json:"foreign_id,omitempty"`
	Id                 string                 `json:"id"`
	InterventionsCount int32                  `json:"interventions_count,omitempty"`
	SourceId           string                 `json:"source_id,omitempty"`
	ThreadCategoryIds  []string               `json:"thread_category_ids,omitempty"`
	Title              string                 `json:"title,omitempty"`
	UpdatedAt          time.Time              `json:"updated_at,omitempty"`
}

type ThreadsApiService 

type ThreadsApiService service

func (*ThreadsApiService) ArchiveThread 

func (a *ThreadsApiService) ArchiveThread(ctx context.Context, threadId string) (Thread, *http.Response, error)

ThreadsApiService Archiving a thread Archives the contents of a thread. If token’s user does not have “read” on thread’s source a 404 HTTP response will be returned. If the thread is already being archived, a 409 HTTP response will be returned. Authorization​: no.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param threadId

@return Thread

func (*ThreadsApiService) CategorizeThread 

func (a *ThreadsApiService) CategorizeThread(ctx context.Context, threadId string, localVarOptionals *CategorizeThreadOpts) (Thread, *http.Response, error)

func (*ThreadsApiService) CloseThread 

func (a *ThreadsApiService) CloseThread(ctx context.Context, threadId string) (Thread, *http.Response, error)

ThreadsApiService Close a thread Thread closure/opening is only available for the following sources: * Emails * Answers * Ideas * Facebook Messenger * Google+ * Lithium * Mobile Messaging Starts a job to close a thread. It returns the thread but as the job is asynchronous, the state of the “close” attribute in the returned object do not is the one when the job started. If token’s user does not have “read” on thread’s source a 404 HTTP response will be returned. Returns a 403 if the thread cannot be closed or if the user does not have the permission to close a thread. Authorization​: no.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param threadId

@return Thread

func (*ThreadsApiService) GetAllThreads 

func (a *ThreadsApiService) GetAllThreads(ctx context.Context, localVarOptionals *GetAllThreadsOpts) (GetAllThreadsResponse, *http.Response, error)

func (*ThreadsApiService) GetThread 

func (a *ThreadsApiService) GetThread(ctx context.Context, threadId string) (Thread, *http.Response, error)

ThreadsApiService Getting a thread from its id This method renders a thread from given id. If token’s user does not have “read” on thread’s source a 404 HTTP response will be returned. Authorization​: no.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param threadId

@return Thread

func (*ThreadsApiService) OpenThread 

func (a *ThreadsApiService) OpenThread(ctx context.Context, threadId string) (Thread, *http.Response, error)

ThreadsApiService Open a thread Thread closure/opening is only available for the following sources: * Emails * Answers * Ideas * Facebook Messenger * Google+ * Lithium * Mobile Messaging Starts a job to open a thread. It returns the thread but as the job is asynchronous, the state of the “close” attribute in the returned object is the one when the job started. If token’s user does not have “read” on thread’s source a 404 HTTP response will be returned. Returns a 403 if the thread cannot be opened or if the user does not have the permission to open a thread. Authorization​: no.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param threadId

@return Thread

type TimeSheet 

type TimeSheet struct {
	Active         bool               `json:"active,omitempty"`
	CreatedAt      time.Time          `json:"created_at,omitempty"`
	FridayHours    string             `json:"friday_hours,omitempty"`
	Holidays       []TimeSheetHoliday `json:"holidays[],omitempty"`
	Id             string             `json:"id"`
	Label          string             `json:"label,omitempty"`
	MondayHours    string             `json:"monday_hours,omitempty"`
	SaturdayHours  string             `json:"saturday_hours,omitempty"`
	SourceIds      []string           `json:"source_ids,omitempty"`
	SundayHours    string             `json:"sunday_hours,omitempty"`
	ThursdayHours  string             `json:"thursday_hours,omitempty"`
	Timezone       string             `json:"timezone,omitempty"`
	TuesdayHours   string             `json:"tuesday_hours,omitempty"`
	UpdatedAt      time.Time          `json:"updated_at,omitempty"`
	WednesdayHours string             `json:"wednesday_hours,omitempty"`
}

type TimeSheetHoliday 

type TimeSheetHoliday struct {
	Date string `json:"date,omitempty"`
	Name string `json:"name,omitempty"`
}

type TimeSheetsApiService 

type TimeSheetsApiService service

func (*TimeSheetsApiService) CreateTimeSheet 

func (a *TimeSheetsApiService) CreateTimeSheet(ctx context.Context, label string, localVarOptionals *CreateTimeSheetOpts) (TimeSheet, *http.Response, error)

func (*TimeSheetsApiService) DeleteTimeSheet 

func (a *TimeSheetsApiService) DeleteTimeSheet(ctx context.Context, timeSheetId string) (TimeSheet, *http.Response, error)

TimeSheetsApiService Deleting a time sheet This method destroys an existing time sheet. It renders time sheet itself. It renders a 404 if id is invalid.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param timeSheetId

@return TimeSheet

func (*TimeSheetsApiService) GetAllTimeSheets 

func (a *TimeSheetsApiService) GetAllTimeSheets(ctx context.Context, localVarOptionals *GetAllTimeSheetsOpts) (GetAllTimeSheetsResponse, *http.Response, error)

func (*TimeSheetsApiService) GetTimeSheet 

func (a *TimeSheetsApiService) GetTimeSheet(ctx context.Context, timeSheetId string) (TimeSheet, *http.Response, error)

TimeSheetsApiService Getting a time sheet from its id This method renders a time sheet from given id. Authorization​: only users that can see time sheets in administration section.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param timeSheetId

@return TimeSheet

func (*TimeSheetsApiService) UpdateTimeSheet 

func (a *TimeSheetsApiService) UpdateTimeSheet(ctx context.Context, timeSheetId string, localVarOptionals *UpdateTimeSheetOpts) (TimeSheet, *http.Response, error)

type Timezone 

type Timezone struct {
	Name      map[string]interface{} `json:"name,omitempty"`
	UtcOffset map[string]interface{} `json:"utc_offset,omitempty"`
}

type TimezonesApiService 

type TimezonesApiService service

func (*TimezonesApiService) GetAllTimezones 

func (a *TimezonesApiService) GetAllTimezones(ctx context.Context) ([]Timezone, *http.Response, error)

TimezonesApiService Getting all timezones This method renders all available timezones.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Timezone

type TransferTaskOpts 

type TransferTaskOpts struct {
	AgentIds    optional.Interface
	Bypass      optional.String
	CategoryIds optional.Interface
	Language    optional.String
	TeamIds     optional.Interface
	Comment     optional.String
}

type UpdateCategoryOpts 

type UpdateCategoryOpts struct {
	Name              optional.String
	ParentId          optional.String
	Color             optional.Int32
	Mandatory         optional.Bool
	Multiple          optional.Bool
	PostQualification optional.Bool
	Unselectable      optional.Bool
	SourceIds         optional.Interface
}

type UpdateChannelOpts 

type UpdateChannelOpts struct {
	Name               optional.String
	SourceIds          optional.Interface
	SoftCapability     optional.Int32
	HardCapability     optional.Int32
	TaskTimeoutSeconds optional.Int32
}

type UpdateCustomFieldOpts 

type UpdateCustomFieldOpts struct {
	Label    optional.String
	Choices  optional.Interface
	Position optional.Int32
}

type UpdateFolderOpts 

type UpdateFolderOpts struct {
	Label               optional.String
	ParentId            optional.String
	Position            optional.Int32
	Query               optional.String
	RenderThreadsCount  optional.Bool
	RoleRestrictionOnly optional.Interface
	TeamRestrictionOnly optional.Interface
}

type UpdateIdentityGroupOpts 

type UpdateIdentityGroupOpts struct {
	Company                         optional.String
	CustomFieldValuesCustomFieldKey optional.String
	Emails                          optional.Interface
	Firstname                       optional.String
	Gender                          optional.String
	HomePhones                      optional.Interface
	Lastname                        optional.String
	MobilePhones                    optional.Interface
	Notes                           optional.String
	TagIds                          optional.Interface
}

type UpdateReplyAssistantEntryOpts 

type UpdateReplyAssistantEntryOpts struct {
	Label        optional.String
	ForeignId    optional.String
	CategoryIds  optional.Interface
	Shortcuts    optional.Interface
	EntryGroupId optional.String
	SourceIds    optional.Interface
}

type UpdateReplyAssistantGroupOpts 

type UpdateReplyAssistantGroupOpts struct {
	Name         optional.String
	EntryIds     optional.Interface
	Autocomplete optional.Bool
	Position     optional.Int32
}

type UpdateReplyAssistantVersionOpts 

type UpdateReplyAssistantVersionOpts struct {
	Body      optional.String
	EntryId   optional.String
	SourceIds optional.Interface
	Format    optional.String
	Language  optional.String
}

type UpdateRoleOpts 

type UpdateRoleOpts struct {
	AccessHelpCenter            optional.Bool
	AccessPreviousMessages      optional.Bool
	AccessPullMode              optional.Bool
	AdminStampAnswer            optional.Bool
	ApproveContent              optional.Bool
	AssignIntervention          optional.Bool
	AuthorBlockContent          optional.Bool
	CloseContentThread          optional.Bool
	CreateAndDestroyExtension   optional.Bool
	CreateCommunity             optional.Bool
	CreateContentSource         optional.Bool
	CreateUser                  optional.Bool
	DelayExportContent          optional.Bool
	DeleteContentThread         optional.Bool
	ImpersonateUser             optional.Bool
	InviteUser                  optional.Bool
	ManageApiAccessTokens       optional.Bool
	ManageAppSdkApplications    optional.Bool
	ManageAutomaticExportsTasks optional.Bool
	ManageCategories            optional.Bool
	ManageChat                  optional.Bool
	ManageCustomFields          optional.Bool
	ManageCustomNotifications   optional.Bool
	ManageEmailsTemplates       optional.Bool
	ManageFolders               optional.Bool
	ManageIce                   optional.Bool
	ManageIdentities            optional.Bool
	ManageOwnNotifications      optional.Bool
	ManageReplyAssistant        optional.Bool
	ManageRoles                 optional.Bool
	ManageRulesEngineRules      optional.Bool
	ManageSurveys               optional.Bool
	ManageTags                  optional.Bool
	ManageTeams                 optional.Bool
	ManageTopologies            optional.Bool
	ManageUsersOfMyTeams        optional.Bool
	MonitorTasks                optional.Bool
	MonitorTeamTasks            optional.Bool
	MuteContent                 optional.Bool
	OpenContentThread           optional.Bool
	PublishContent              optional.Bool
	ReadCommunity               optional.Bool
	ReadContentSource           optional.Bool
	ReadEvent                   optional.Bool
	ReadExport                  optional.Bool
	ReadIdentity                optional.Bool
	ReadOwnStats                optional.Bool
	ReadPresence                optional.Bool
	ReadStats                   optional.Bool
	ReadSurveys                 optional.Bool
	ReadUser                    optional.Bool
	ReceiveTasks                optional.Bool
	ReplyWithAssistant          optional.Bool
	SearchContents              optional.Bool
	SearchEvent                 optional.Bool
	UpdateCommunity             optional.Bool
	UpdateContentSource         optional.Bool
	UpdateExtension             optional.Bool
	UpdateIdentity              optional.Bool
	UpdateIntervention          optional.Bool
	UpdateOwnIntervention       optional.Bool
	UpdateSettings              optional.Bool
	UpdateTimeSheet             optional.Bool
	UpdateUser                  optional.Bool
	UseEmoji                    optional.Bool
}

type UpdateSettingsOpts 

type UpdateSettingsOpts struct {
	ActivityPresenceThreshold   optional.Int32
	ActivityTracking            optional.Bool
	BeginningOfWeek             optional.String
	CategoryTagging             optional.Bool
	ContentLanguages            optional.String
	Dashboard                   optional.Bool
	DenyIframeIntegration       optional.Bool
	DisablePasswordAutocomplete optional.Bool
	ExpirePasswordAfter         optional.Int32
	ExpirePasswordEnabled       optional.Bool
	ExportInSeconds             optional.Bool
	FoldUselessContents         optional.Bool
	FteDuration                 optional.Int32
	IdentityMerge               optional.Bool
	InterventionDeferRates      optional.Interface
	InterventionDeferThreshold  optional.Int32
	InterventionRates           optional.Interface
	Locale                      optional.String
	MultiLang                   optional.Bool
	Name                        optional.String
	PasswordArchivableEnabled   optional.Bool
	PasswordArchivableSize      optional.Int32
	PasswordMinLength           optional.Int32
	PasswordNonWord             optional.Bool
	PasswordNumbers             optional.Bool
	PasswordRecoveryDisabled    optional.Bool
	PushEnabled                 optional.Bool
	ReplyAsAnyIdentity          optional.Bool
	RtlSupport                  optional.Bool
	SelfApprovalRequired        optional.Bool
	SessionTimeout              optional.Int32
	Spellchecking               optional.Bool
	Style                       optional.String
	ThirdPartyServicesDisabled  optional.Bool
	Timezone                    optional.String
	TrackJs                     optional.Bool
	Type_                       optional.String
	UrgentTaskThreshold         optional.Int32
	UseSystemFont               optional.Bool
}

type UpdateSourceOpts 

type UpdateSourceOpts struct {
	Name                         optional.String
	Active                       optional.Bool
	ChannelId                    optional.String
	Color                        optional.Int32
	SlaResponse                  optional.Int32
	SlaExpiredStrategy           optional.String
	InterventionMessagesBoost    optional.Int32
	TransferredTasksBoost        optional.Int32
	HiddenFromStats              optional.Bool
	DefaultCategoryIds           optional.Interface
	UserThreadDefaultCategoryIds optional.Interface
	DefaultContentLanguage       optional.String
	AutoDetectContentLanguage    optional.Bool
	ContentArchiving             optional.Bool
	ContentArchivingPeriod       optional.Int32
}

type UpdateTeamOpts 

type UpdateTeamOpts struct {
	Name      optional.String
	LeaderIds optional.Interface
	UserIds   optional.Interface
}

type UpdateTimeSheetOpts 

type UpdateTimeSheetOpts struct {
	Active         optional.Bool
	Label          optional.String
	SourceIds      optional.Interface
	Holidays       optional.String
	MondayHours    optional.String
	TuesdayHours   optional.String
	WednesdayHours optional.String
	ThursdayHours  optional.String
	FridayHours    optional.String
	SaturdayHours  optional.String
	SundayHours    optional.String
}

type UpdateUserOpts 

type UpdateUserOpts struct {
	CategoryIds     optional.Interface
	Email           optional.String
	Enabled         optional.Bool
	ExternalId      optional.String
	Firstname       optional.String
	Gender          optional.String
	IdentityIds     optional.Interface
	Lastname        optional.String
	Locale          optional.String
	Nickname        optional.String
	Password        optional.String
	RoleId          optional.String
	TeamIds         optional.Interface
	Timezone        optional.String
	SpokenLanguages optional.Interface
}

type UpdateWebhookOpts 

type UpdateWebhookOpts struct {
	Active           optional.Bool
	Label            optional.String
	StagingUse       optional.Bool
	Url              optional.String
	VerifyToken      optional.String
	Secret           optional.String
	RegisteredEvents optional.Interface
}

type User 

type User struct {
	CategoryIds       []string  `json:"category_ids,omitempty"`
	CreatedAt         time.Time `json:"created_at,omitempty"`
	Email             string    `json:"email,omitempty"`
	Enabled           bool      `json:"enabled,omitempty"`
	ExternalId        string    `json:"external_id,omitempty"`
	Firstname         string    `json:"firstname,omitempty"`
	Gender            string    `json:"gender,omitempty"`
	Id                string    `json:"id"`
	IdentityIds       []string  `json:"identity_ids,omitempty"`
	InvitationPending bool      `json:"invitation_pending,omitempty"`
	Lastname          string    `json:"lastname,omitempty"`
	Locale            string    `json:"locale,omitempty"`
	Nickname          string    `json:"nickname,omitempty"`
	RcUserId          string    `json:"rc_user_id,omitempty"`
	RoleId            string    `json:"role_id,omitempty"`
	SpokenLanguages   []string  `json:"spoken_languages,omitempty"`
	TeamIds           []string  `json:"team_ids,omitempty"`
	Timezone          string    `json:"timezone,omitempty"`
	UpdatedAt         time.Time `json:"updated_at,omitempty"`
}

type UsersApiService 

type UsersApiService service

func (*UsersApiService) CreateUser 

func (a *UsersApiService) CreateUser(ctx context.Context, email string, firstname string, lastname string, password string, roleId string, localVarOptionals *CreateUserOpts) (User, *http.Response, error)

func (*UsersApiService) DeleteUser 

func (a *UsersApiService) DeleteUser(ctx context.Context, userId string) (User, *http.Response, error)

UsersApiService Deleting a user This method deletes the given user. In case of success it renders the deleted user, otherwise, it renders an error (422 HTTP code). Authorization​: only users that can update users. The user affiliated to the token must have at least all the permissions of the other user. If the user affiliated to the token has the manage_users_of_my_teams permission, the deleted user will need to belong to at least one of the teams he’s the leader of.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId

@return User

func (*UsersApiService) GetAllUsers 

func (a *UsersApiService) GetAllUsers(ctx context.Context, localVarOptionals *GetAllUsersOpts) (GetAllUsersResponse, *http.Response, error)

func (*UsersApiService) GetUser 

func (a *UsersApiService) GetUser(ctx context.Context, userId string) (User, *http.Response, error)

UsersApiService Getting a user from its id This method renders a user from given id.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param userId

@return User

func (*UsersApiService) InviteUser 

func (a *UsersApiService) InviteUser(ctx context.Context, email string, firstname string, lastname string, roleId string, localVarOptionals *InviteUserOpts) (User, *http.Response, error)

func (*UsersApiService) UpdateUser 

func (a *UsersApiService) UpdateUser(ctx context.Context, userId string, localVarOptionals *UpdateUserOpts) (User, *http.Response, error)

type Webhook 

type Webhook struct {
	Active           bool               `json:"active,omitempty"`
	ApiAccessToken   WebhookAccessToken `json:"api_access_token,omitempty"`
	Id               string             `json:"id"`
	RegisteredEvents []string           `json:"registered_events,omitempty"`
	StagingUse       bool               `json:"staging_use,omitempty"`
	Url              string             `json:"url,omitempty"`
	VerifyToken      string             `json:"verify_token,omitempty"`
}

type WebhookAccessToken 

type WebhookAccessToken struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	Id        string    `json:"id"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type WebhooksApiService 

type WebhooksApiService service

func (*WebhooksApiService) CreateWebhook 

func (a *WebhooksApiService) CreateWebhook(ctx context.Context, accessToken string, label string, url_ string, registeredEvents []string, localVarOptionals *CreateWebhookOpts) (Webhook, *http.Response, error)

func (*WebhooksApiService) DeleteWebhook 

func (a *WebhooksApiService) DeleteWebhook(ctx context.Context, webhookId string, accessToken string) (Webhook, *http.Response, error)

WebhooksApiService Deleting a webhook This method destroys an existing webhook. It renders webhook itself. It renders a 404 if id is invalid. Authorization​: All users having the manage_api_access_tokens permission or all users having an api access token belonging to the webhook you’re deleting.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookId
  • @param accessToken Access token.

@return Webhook

func (*WebhooksApiService) GetAllWebhooks 

func (a *WebhooksApiService) GetAllWebhooks(ctx context.Context, accessToken string, localVarOptionals *GetAllWebhooksOpts) (GetAllWebhooksResponse, *http.Response, error)

func (*WebhooksApiService) GetWebhook 

func (a *WebhooksApiService) GetWebhook(ctx context.Context, webhookId string, accessToken string) (Webhook, *http.Response, error)

WebhooksApiService Getting a webhook from its id This method renders a webhook from given id. Authorization​: users having manage_api_access_tokens permission can see any webhook / users don’t having the `manage_api_access_tokens` permission can see only the webhook in case the webhook is associated to an access token created by them.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookId
  • @param accessToken Access token.

@return Webhook

func (*WebhooksApiService) UpdateWebhook 

func (a *WebhooksApiService) UpdateWebhook(ctx context.Context, webhookId string, accessToken string, localVarOptionals *UpdateWebhookOpts) (Webhook, *http.Response, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.