crisp

package
v3.8.1+incompatible Latest Latest
Warning

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

Go to latest
Published: Oct 26, 2020 License: BSD-3-Clause Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CheckResponse

func CheckResponse(response *http.Response) error

CheckResponse checks response for errors

func Stringify

func Stringify(instance interface{}) string

Stringify creates a string representation for given interface instance

Types

type BucketService added in v1.12.0

type BucketService service

BucketService service

func (*BucketService) GenerateBucketURL added in v1.12.0

func (service *BucketService) GenerateBucketURL(bucketData BucketURLRequest) (*Response, error)

GenerateBucketURL generates a bucket URL.

type BucketURLRequest added in v1.12.0

type BucketURLRequest struct {
	Namespace  string               `json:"namespace,omitempty"`
	From       string               `json:"from,omitempty"`
	Identifier string               `json:"identifier,omitempty"`
	ID         string               `json:"id,omitempty"`
	File       BucketURLRequestFile `json:"file,omitempty"`
}

BucketURLRequest mapping

type BucketURLRequestFile added in v1.12.0

type BucketURLRequestFile struct {
	Name string `json:"name,omitempty"`
	Type string `json:"type,omitempty"`
}

BucketURLRequestFile mapping

type Client

type Client struct {
	BaseURL   *url.URL
	UserAgent string

	Bucket  *BucketService
	Media   *MediaService
	Plugin  *PluginService
	Website *WebsiteService

	Events *EventsService
	// contains filtered or unexported fields
}

Client maps an API client

func New added in v1.1.0

func New() *Client

New returns a new API client

func NewWithConfig added in v1.1.0

func NewWithConfig(config ClientConfig) *Client

NewWithConfig returns a new API client

func (*Client) Authenticate

func (client *Client) Authenticate(username string, password string)

Authenticate saves authentication parameters for user (default)

func (*Client) AuthenticateTier added in v1.1.1

func (client *Client) AuthenticateTier(tier string, username string, password string)

AuthenticateTier saves authentication parameters for tier

func (*Client) Do

func (client *Client) Do(req *http.Request, v interface{}) (*Response, error)

Do sends an API request

func (*Client) NewRequest

func (client *Client) NewRequest(method, urlStr string, body interface{}) (*http.Request, error)

NewRequest creates an API request

type ClientConfig added in v1.1.0

type ClientConfig struct {
	HTTPClient          *http.Client
	RestEndpointURL     string
	RealtimeEndpointURL string
}

ClientConfig mapping

type Conversation

type Conversation struct {
	SessionID    *string                    `json:"session_id,omitempty"`
	WebsiteID    *string                    `json:"website_id,omitempty"`
	PeopleID     *string                    `json:"people_id,omitempty"`
	State        *string                    `json:"state,omitempty"`
	Status       *uint8                     `json:"status,omitempty"`
	IsVerified   *bool                      `json:"is_verified,omitempty"`
	IsBlocked    *bool                      `json:"is_blocked,omitempty"`
	Availability *string                    `json:"availability,omitempty"`
	Active       *ConversationActive        `json:"active,omitempty"`
	LastMessage  *string                    `json:"last_message,omitempty"`
	Participants *[]ConversationParticipant `json:"participants,omitempty"`
	Mentions     *[]string                  `json:"mentions,omitempty"`
	Compose      *ConversationCompose       `json:"compose,omitempty"`
	Unread       *ConversationUnread        `json:"unread,omitempty"`
	Assigned     *ConversationAssigned      `json:"assigned,omitempty"`
	Meta         *ConversationMeta          `json:"meta,omitempty"`
	CreatedAt    *uint64                    `json:"created_at,omitempty"`
	UpdatedAt    *uint64                    `json:"updated_at,omitempty"`
}

Conversation mapping

func (Conversation) String

func (instance Conversation) String() string

String returns the string representation of Conversation

type ConversationActive

type ConversationActive struct {
	Now  *bool   `json:"now,omitempty"`
	Last *uint64 `json:"last,omitempty"`
}

ConversationActive mapping

type ConversationAllMessageNewOriginal

type ConversationAllMessageNewOriginal struct {
	Type    string `json:"type,omitempty"`
	Content string `json:"content,omitempty"`
}

ConversationAllMessageNewOriginal mapping

type ConversationAllMessageNewUser added in v1.2.3

type ConversationAllMessageNewUser struct {
	Type     string `json:"type,omitempty"`
	Nickname string `json:"nickname,omitempty"`
	Avatar   string `json:"avatar,omitempty"`
}

ConversationAllMessageNewUser mapping

type ConversationAnimationMessageNew added in v1.16.0

type ConversationAnimationMessageNew struct {
	Type        string                                 `json:"type,omitempty"`
	From        string                                 `json:"from,omitempty"`
	Origin      string                                 `json:"origin,omitempty"`
	Content     ConversationAnimationMessageNewContent `json:"content,omitempty"`
	Mentions    []string                               `json:"mentions,omitempty"`
	Fingerprint int                                    `json:"fingerprint,omitempty"`
	User        ConversationAllMessageNewUser          `json:"user,omitempty"`
	Original    *ConversationAllMessageNewOriginal     `json:"original,omitempty"`
	Translated  *bool                                  `json:"translated,omitempty"`
}

ConversationAnimationMessageNew mapping

type ConversationAnimationMessageNewContent added in v1.16.0

type ConversationAnimationMessageNewContent struct {
	URL  string `json:"url,omitempty"`
	Type string `json:"type,omitempty"`
}

ConversationAnimationMessageNewContent mapping

type ConversationAnimationMessageUpdate

type ConversationAnimationMessageUpdate struct {
	Content ConversationAnimationMessageNewContent `json:"content,omitempty"`
}

ConversationAnimationMessageUpdate mapping

type ConversationAssigned

type ConversationAssigned struct {
	UserID *string `json:"user_id,omitempty"`
}

ConversationAssigned mapping

type ConversationAudioMessageNew

type ConversationAudioMessageNew struct {
	Type        string                             `json:"type,omitempty"`
	From        string                             `json:"from,omitempty"`
	Origin      string                             `json:"origin,omitempty"`
	Content     ConversationAudioMessageNewContent `json:"content,omitempty"`
	Mentions    []string                           `json:"mentions,omitempty"`
	Fingerprint int                                `json:"fingerprint,omitempty"`
	User        ConversationAllMessageNewUser      `json:"user,omitempty"`
	Original    *ConversationAllMessageNewOriginal `json:"original,omitempty"`
	Translated  *bool                              `json:"translated,omitempty"`
}

ConversationAudioMessageNew mapping

type ConversationAudioMessageNewContent

type ConversationAudioMessageNewContent struct {
	URL      string `json:"url,omitempty"`
	Type     string `json:"type,omitempty"`
	Duration uint16 `json:"duration,omitempty"`
}

ConversationAudioMessageNewContent mapping

type ConversationAudioMessageUpdate

type ConversationAudioMessageUpdate struct {
	Content ConversationAudioMessageNewContent `json:"content,omitempty"`
}

ConversationAudioMessageUpdate mapping

type ConversationBlock added in v1.6.0

type ConversationBlock struct {
	Blocked *bool `json:"blocked,omitempty"`
}

ConversationBlock mapping

func (ConversationBlock) String added in v1.6.0

func (instance ConversationBlock) String() string

String returns the string representation of ConversationBlock

type ConversationBlockData added in v1.6.0

type ConversationBlockData struct {
	Data *ConversationBlock `json:"data,omitempty"`
}

ConversationBlockData mapping

type ConversationBlockUpdate

type ConversationBlockUpdate struct {
	Blocked *bool `json:"blocked,omitempty"`
}

ConversationBlockUpdate mapping

type ConversationBrowsing added in v1.23.0

type ConversationBrowsing struct {
	BrowsingID    *string `json:"browsing_id,omitempty"`
	BrowsingToken *string `json:"browsing_token,omitempty"`
	Useragent     *string `json:"useragent,omitempty"`
}

ConversationBrowsing mapping

func (ConversationBrowsing) String

func (instance ConversationBrowsing) String() string

String returns the string representation of ConversationBrowsing

type ConversationBrowsingAction added in v1.23.0

type ConversationBrowsingAction struct {
	Action *string `json:"action,omitempty"`
}

ConversationBrowsingAction mapping

type ConversationBrowsingAssist

type ConversationBrowsingAssist struct {
	Action *string                           `json:"action,omitempty"`
	Mouse  *ConversationBrowsingAssistMouse  `json:"mouse,omitempty"`
	Click  *ConversationBrowsingAssistClick  `json:"click,omitempty"`
	Scroll *ConversationBrowsingAssistScroll `json:"scroll,omitempty"`
}

ConversationBrowsingAssist mapping

type ConversationBrowsingAssistClick

type ConversationBrowsingAssistClick struct {
	X *uint16 `json:"x,omitempty"`
	Y *uint16 `json:"y,omitempty"`
}

ConversationBrowsingAssistClick mapping

type ConversationBrowsingAssistMouse

type ConversationBrowsingAssistMouse struct {
	X *uint16 `json:"x,omitempty"`
	Y *uint16 `json:"y,omitempty"`
}

ConversationBrowsingAssistMouse mapping

type ConversationBrowsingAssistScroll

type ConversationBrowsingAssistScroll struct {
	X *uint16 `json:"x,omitempty"`
	Y *uint16 `json:"y,omitempty"`
}

ConversationBrowsingAssistScroll mapping

type ConversationBrowsingData added in v1.23.0

type ConversationBrowsingData struct {
	Data *[]ConversationBrowsing `json:"data,omitempty"`
}

ConversationBrowsingData mapping

type ConversationBrowsingDebug

type ConversationBrowsingDebug struct {
	Action  *string `json:"action,omitempty"`
	Execute *string `json:"execute,omitempty"`
}

ConversationBrowsingDebug mapping

type ConversationCall

type ConversationCall struct {
	CallID *string `json:"call_id,omitempty"`
}

ConversationCall mapping

func (ConversationCall) String

func (instance ConversationCall) String() string

String returns the string representation of ConversationCall

type ConversationCallData

type ConversationCallData struct {
	Data *ConversationCall `json:"data,omitempty"`
}

ConversationCallData mapping

type ConversationCallPayload

type ConversationCallPayload struct {
	Mode string `json:"mode,omitempty"`
}

ConversationCallPayload mapping

type ConversationCallSignalingPayload

type ConversationCallSignalingPayload struct {
	Type    string      `json:"type,omitempty"`
	Payload interface{} `json:"payload,omitempty"`
}

ConversationCallSignalingPayload mapping

type ConversationCompose

type ConversationCompose struct {
	Operator *ConversationComposeAtom `json:"operator,omitempty"`
	Visitor  *ConversationComposeAtom `json:"visitor,omitempty"`
}

ConversationCompose mapping

type ConversationComposeAtom

type ConversationComposeAtom struct {
	Type      *string                      `json:"type,omitempty"`
	Excerpt   *string                      `json:"excerpt,omitempty"`
	Timestamp *uint64                      `json:"timestamp,omitempty"`
	User      *ConversationComposeAtomUser `json:"user,omitempty"`
}

ConversationComposeAtom mapping

type ConversationComposeAtomUser

type ConversationComposeAtomUser struct {
	UserID   *string `json:"user_id,omitempty"`
	Nickname *string `json:"nickname,omitempty"`
	Avatar   *string `json:"avatar,omitempty"`
}

ConversationComposeAtomUser mapping

type ConversationComposeMessageNew added in v1.2.0

type ConversationComposeMessageNew struct {
	Type    string `json:"type,omitempty"`
	From    string `json:"from,omitempty"`
	Excerpt string `json:"excerpt,omitempty"`
	Stealth *bool  `json:"stealth,omitempty"`
}

ConversationComposeMessageNew mapping

type ConversationData

type ConversationData struct {
	Data *Conversation `json:"data,omitempty"`
}

ConversationData mapping

type ConversationDeliveredMessageMark

type ConversationDeliveredMessageMark ConversationReadMessageMark

ConversationDeliveredMessageMark mapping

type ConversationEvent

type ConversationEvent struct {
	Text      *string      `json:"text,omitempty"`
	Data      *interface{} `json:"data,omitempty"`
	Color     *string      `json:"color,omitempty"`
	Timestamp *uint64      `json:"timestamp,omitempty"`
}

ConversationEvent mapping

type ConversationEventMessageNew

type ConversationEventMessageNew struct {
	Type        string                             `json:"type,omitempty"`
	From        string                             `json:"from,omitempty"`
	Origin      string                             `json:"origin,omitempty"`
	Content     ConversationEventMessageNewContent `json:"content,omitempty"`
	Mentions    []string                           `json:"mentions,omitempty"`
	Fingerprint int                                `json:"fingerprint,omitempty"`
	User        ConversationAllMessageNewUser      `json:"user,omitempty"`
	Original    *ConversationAllMessageNewOriginal `json:"original,omitempty"`
	Translated  *bool                              `json:"translated,omitempty"`
}

ConversationEventMessageNew mapping

type ConversationEventMessageNewContent

type ConversationEventMessageNewContent struct {
	Namespace string `json:"namespace,omitempty"`
}

ConversationEventMessageNewContent mapping

type ConversationEventMessageUpdate

type ConversationEventMessageUpdate struct {
	Content ConversationEventMessageNewContent `json:"content,omitempty"`
}

ConversationEventMessageUpdate mapping

type ConversationEventsData

type ConversationEventsData struct {
	Data *[]ConversationEvent `json:"data,omitempty"`
}

ConversationEventsData mapping

type ConversationFieldMessageNew

type ConversationFieldMessageNew struct {
	Type        string                             `json:"type,omitempty"`
	From        string                             `json:"from,omitempty"`
	Origin      string                             `json:"origin,omitempty"`
	Content     ConversationFieldMessageNewContent `json:"content,omitempty"`
	Mentions    []string                           `json:"mentions,omitempty"`
	Fingerprint int                                `json:"fingerprint,omitempty"`
	User        ConversationAllMessageNewUser      `json:"user,omitempty"`
	Original    *ConversationAllMessageNewOriginal `json:"original,omitempty"`
	Translated  *bool                              `json:"translated,omitempty"`
}

ConversationFieldMessageNew mapping

type ConversationFieldMessageNewContent

type ConversationFieldMessageNewContent struct {
	ID      string `json:"id,omitempty"`
	Text    string `json:"text,omitempty"`
	Explain string `json:"explain,omitempty"`
	Value   string `json:"value,omitempty"`
}

ConversationFieldMessageNewContent mapping

type ConversationFieldMessageUpdate

type ConversationFieldMessageUpdate struct {
	Content ConversationFieldMessageNewContent `json:"content,omitempty"`
}

ConversationFieldMessageUpdate mapping

type ConversationFileMessageNew

type ConversationFileMessageNew struct {
	Type        string                             `json:"type,omitempty"`
	From        string                             `json:"from,omitempty"`
	Origin      string                             `json:"origin,omitempty"`
	Content     ConversationFileMessageNewContent  `json:"content,omitempty"`
	Mentions    []string                           `json:"mentions,omitempty"`
	Fingerprint int                                `json:"fingerprint,omitempty"`
	User        ConversationAllMessageNewUser      `json:"user,omitempty"`
	Original    *ConversationAllMessageNewOriginal `json:"original,omitempty"`
	Translated  *bool                              `json:"translated,omitempty"`
}

ConversationFileMessageNew mapping

type ConversationFileMessageNewContent

type ConversationFileMessageNewContent struct {
	Name string `json:"name,omitempty"`
	URL  string `json:"url,omitempty"`
	Type string `json:"type,omitempty"`
}

ConversationFileMessageNewContent mapping

type ConversationFileMessageUpdate

type ConversationFileMessageUpdate struct {
	Content ConversationFileMessageNewContent `json:"content,omitempty"`
}

ConversationFileMessageUpdate mapping

type ConversationListData

type ConversationListData struct {
	Data *[]Conversation `json:"data,omitempty"`
}

ConversationListData mapping

type ConversationMessage

type ConversationMessage struct {
	SessionID   *string                       `json:"session_id,omitempty"`
	WebsiteID   *string                       `json:"website_id,omitempty"`
	Type        *string                       `json:"type,omitempty"`
	From        *string                       `json:"from,omitempty"`
	Origin      *string                       `json:"origin,omitempty"`
	Content     *interface{}                  `json:"content,omitempty"`
	Preview     *[]ConversationMessagePreview `json:"preview,omitempty"`
	Mentions    *[]string                     `json:"mentions,omitempty"`
	Read        *string                       `json:"read,omitempty"`
	Delivered   *string                       `json:"delivered,omitempty"`
	Edited      *bool                         `json:"edited,omitempty"`
	Translated  *bool                         `json:"translated,omitempty"`
	Fingerprint *int                          `json:"fingerprint,omitempty"`
	Timestamp   *uint64                       `json:"timestamp,omitempty"`
	User        *ConversationMessageUser      `json:"user,omitempty"`
	Original    *ConversationMessageOriginal  `json:"original,omitempty"`
}

ConversationMessage mapping

func (ConversationMessage) String added in v1.6.0

func (instance ConversationMessage) String() string

String returns the string representation of ConversationMessage

type ConversationMessageAnimationContent added in v1.16.0

type ConversationMessageAnimationContent struct {
	URL  *string `json:"url"`
	Type *string `json:"type"`
}

ConversationMessageAnimationContent mapping

type ConversationMessageAudioContent

type ConversationMessageAudioContent struct {
	URL      *string `json:"url"`
	Type     *string `json:"type"`
	Duration *uint16 `json:"duration"`
}

ConversationMessageAudioContent mapping

type ConversationMessageData

type ConversationMessageData struct {
	Data *ConversationMessage `json:"data,omitempty"`
}

ConversationMessageData mapping

type ConversationMessageDispatched

type ConversationMessageDispatched struct {
	Fingerprint *int `json:"fingerprint,omitempty"`
}

ConversationMessageDispatched mapping

type ConversationMessageDispatchedData

type ConversationMessageDispatchedData struct {
	Data *ConversationMessageDispatched `json:"data,omitempty"`
}

ConversationMessageDispatchedData mapping

type ConversationMessageEventContent

type ConversationMessageEventContent struct {
	Namespace *string `json:"namespace"`
	Text      *string `json:"text,omitempty"`
}

ConversationMessageEventContent mapping

type ConversationMessageFieldContent

type ConversationMessageFieldContent struct {
	ID      *string `json:"id"`
	Text    *string `json:"text"`
	Explain *string `json:"explain"`
	Value   *string `json:"value"`
}

ConversationMessageFieldContent mapping

type ConversationMessageFileContent added in v1.6.2

type ConversationMessageFileContent struct {
	Name *string `json:"name"`
	URL  *string `json:"url"`
	Type *string `json:"type"`
}

ConversationMessageFileContent mapping

type ConversationMessageNoteContent added in v1.20.1

type ConversationMessageNoteContent string

ConversationMessageNoteContent mapping

type ConversationMessageOriginal

type ConversationMessageOriginal struct {
	OriginalID *string `json:"original_id,omitempty"`
}

ConversationMessageOriginal mapping

type ConversationMessagePickerContent

type ConversationMessagePickerContent struct {
	ID      *string                                   `json:"id"`
	Text    *string                                   `json:"text"`
	Choices *[]ConversationMessagePickerContentChoice `json:"choices"`
}

ConversationMessagePickerContent mapping

type ConversationMessagePickerContentChoice

type ConversationMessagePickerContentChoice struct {
	Value    *string `json:"value"`
	Label    *string `json:"label"`
	Selected *bool   `json:"selected"`
}

ConversationMessagePickerContentChoice mapping

type ConversationMessagePreview

type ConversationMessagePreview struct {
	URL     *string                                `json:"url,omitempty"`
	Website *string                                `json:"website,omitempty"`
	Title   *string                                `json:"title,omitempty"`
	Preview *ConversationMessagePreviewInformation `json:"preview,omitempty"`
	Stamped *bool                                  `json:"stamped,omitempty"`
}

ConversationMessagePreview mapping

type ConversationMessagePreviewInformation

type ConversationMessagePreviewInformation struct {
	Excerpt *string `json:"excerpt,omitempty"`
	Image   *string `json:"image,omitempty"`
	Embed   *string `json:"embed,omitempty"`
}

ConversationMessagePreviewInformation mapping

type ConversationMessageTextContent added in v1.6.2

type ConversationMessageTextContent string

ConversationMessageTextContent mapping

type ConversationMessageUser

type ConversationMessageUser struct {
	Type     *string `json:"type,omitempty"`
	UserID   *string `json:"user_id,omitempty"`
	Nickname *string `json:"nickname,omitempty"`
	Avatar   *string `json:"avatar,omitempty"`
}

ConversationMessageUser mapping

type ConversationMessagesData added in v1.6.0

type ConversationMessagesData struct {
	Data *[]ConversationMessage `json:"data,omitempty"`
}

ConversationMessagesData mapping

type ConversationMeta

type ConversationMeta struct {
	Nickname *string                 `json:"nickname,omitempty"`
	Email    *string                 `json:"email,omitempty"`
	Phone    *string                 `json:"phone,omitempty"`
	Address  *string                 `json:"address,omitempty"`
	IP       *string                 `json:"ip,omitempty"`
	Data     *interface{}            `json:"data,omitempty"`
	Avatar   *string                 `json:"avatar,omitempty"`
	Device   *ConversationMetaDevice `json:"device,omitempty"`
	Segments *[]string               `json:"segments,omitempty"`
}

ConversationMeta mapping

func (ConversationMeta) String added in v1.6.1

func (instance ConversationMeta) String() string

String returns the string representation of ConversationMeta

type ConversationMetaData added in v1.6.1

type ConversationMetaData struct {
	Data *ConversationMeta `json:"data,omitempty"`
}

ConversationMetaData mapping

type ConversationMetaDevice added in v1.21.0

type ConversationMetaDevice struct {
	Capabilities *[]string                          `json:"capabilities,omitempty"`
	Geolocation  *ConversationMetaDeviceGeolocation `json:"geolocation,omitempty"`
	System       *ConversationMetaDeviceSystem      `json:"system,omitempty"`
	Timezone     *int16                             `json:"timezone,omitempty"`
	Locales      *[]string                          `json:"locales,omitempty"`
}

ConversationMetaDevice mapping

type ConversationMetaDeviceGeolocation added in v1.21.0

type ConversationMetaDeviceGeolocation struct {
	Coordinates *ConversationMetaDeviceGeolocationCoordinates `json:"coordinates,omitempty"`
	City        *string                                       `json:"city,omitempty"`
	Region      *string                                       `json:"region,omitempty"`
	Country     *string                                       `json:"country,omitempty"`
}

ConversationMetaDeviceGeolocation mapping

type ConversationMetaDeviceGeolocationCoordinates added in v1.21.0

type ConversationMetaDeviceGeolocationCoordinates struct {
	Latitude  *float32 `json:"latitude,omitempty"`
	Longitude *float32 `json:"longitude,omitempty"`
}

ConversationMetaDeviceGeolocationCoordinates mapping

type ConversationMetaDeviceSystem added in v1.21.0

type ConversationMetaDeviceSystem struct {
	OS        *ConversationMetaDeviceSystemOS      `json:"os,omitempty"`
	Engine    *ConversationMetaDeviceSystemEngine  `json:"engine,omitempty"`
	Browser   *ConversationMetaDeviceSystemBrowser `json:"browser,omitempty"`
	Useragent *string                              `json:"useragent,omitempty"`
}

ConversationMetaDeviceSystem mapping

type ConversationMetaDeviceSystemBrowser added in v1.21.0

type ConversationMetaDeviceSystemBrowser struct {
	Major   *string `json:"major,omitempty"`
	Version *string `json:"version,omitempty"`
	Name    *string `json:"name,omitempty"`
}

ConversationMetaDeviceSystemBrowser mapping

type ConversationMetaDeviceSystemEngine added in v1.21.0

type ConversationMetaDeviceSystemEngine struct {
	Version *string `json:"version,omitempty"`
	Name    *string `json:"name,omitempty"`
}

ConversationMetaDeviceSystemEngine mapping

type ConversationMetaDeviceSystemOS added in v1.21.0

type ConversationMetaDeviceSystemOS struct {
	Version *string `json:"version,omitempty"`
	Name    *string `json:"name,omitempty"`
}

ConversationMetaDeviceSystemOS mapping

type ConversationMetaUpdate

type ConversationMetaUpdate struct {
	Nickname string                        `json:"nickname,omitempty"`
	Email    string                        `json:"email,omitempty"`
	Avatar   string                        `json:"avatar,omitempty"`
	IP       string                        `json:"ip,omitempty"`
	Phone    string                        `json:"phone,omitempty"`
	Address  string                        `json:"address,omitempty"`
	Segments []string                      `json:"segments,omitempty"`
	Data     interface{}                   `json:"data,omitempty"`
	Device   *ConversationMetaUpdateDevice `json:"device,omitempty"`
}

ConversationMetaUpdate mapping

type ConversationMetaUpdateDevice

type ConversationMetaUpdateDevice struct {
	Capabilities []string                                 `json:"capabilities,omitempty"`
	Geolocation  *ConversationMetaUpdateDeviceGeolocation `json:"geolocation,omitempty"`
	System       *ConversationMetaUpdateDeviceSystem      `json:"system,omitempty"`
	Timezone     int16                                    `json:"timezone,omitempty"`
	Locales      []string                                 `json:"locales,omitempty"`
}

ConversationMetaUpdateDevice mapping

type ConversationMetaUpdateDeviceGeolocation

type ConversationMetaUpdateDeviceGeolocation struct {
	Coordinates ConversationMetaUpdateDeviceGeolocationCoordinates `json:"coordinates,omitempty"`
	City        string                                             `json:"city,omitempty"`
	Region      string                                             `json:"region,omitempty"`
	Country     string                                             `json:"country,omitempty"`
}

ConversationMetaUpdateDeviceGeolocation mapping

type ConversationMetaUpdateDeviceGeolocationCoordinates

type ConversationMetaUpdateDeviceGeolocationCoordinates struct {
	Latitude  float32 `json:"latitude,omitempty"`
	Longitude float32 `json:"longitude,omitempty"`
}

ConversationMetaUpdateDeviceGeolocationCoordinates mapping

type ConversationMetaUpdateDeviceSystem

type ConversationMetaUpdateDeviceSystem struct {
	OS        ConversationMetaUpdateDeviceSystemOS      `json:"os,omitempty"`
	Engine    ConversationMetaUpdateDeviceSystemEngine  `json:"engine,omitempty"`
	Browser   ConversationMetaUpdateDeviceSystemBrowser `json:"browser,omitempty"`
	Useragent string                                    `json:"useragent,omitempty"`
}

ConversationMetaUpdateDeviceSystem mapping

type ConversationMetaUpdateDeviceSystemBrowser

type ConversationMetaUpdateDeviceSystemBrowser struct {
	Major   string `json:"major,omitempty"`
	Version string `json:"version,omitempty"`
	Name    string `json:"name,omitempty"`
}

ConversationMetaUpdateDeviceSystemBrowser mapping

type ConversationMetaUpdateDeviceSystemEngine

type ConversationMetaUpdateDeviceSystemEngine struct {
	Version string `json:"version,omitempty"`
	Name    string `json:"name,omitempty"`
}

ConversationMetaUpdateDeviceSystemEngine mapping

type ConversationMetaUpdateDeviceSystemOS

type ConversationMetaUpdateDeviceSystemOS struct {
	Version string `json:"version,omitempty"`
	Name    string `json:"name,omitempty"`
}

ConversationMetaUpdateDeviceSystemOS mapping

type ConversationNew

type ConversationNew struct {
	SessionID *string `json:"session_id,omitempty"`
}

ConversationNew mapping

func (ConversationNew) String

func (instance ConversationNew) String() string

String returns the string representation of ConversationNew

type ConversationNewData

type ConversationNewData struct {
	Data *ConversationNew `json:"data,omitempty"`
}

ConversationNewData mapping

type ConversationNoteMessageNew added in v1.20.1

type ConversationNoteMessageNew ConversationTextMessageNew

ConversationNoteMessageNew mapping

type ConversationNoteMessageUpdate

type ConversationNoteMessageUpdate ConversationTextMessageUpdate

ConversationNoteMessageUpdate mapping

type ConversationOpenUpdate added in v1.11.0

type ConversationOpenUpdate struct {
	Opened *bool `json:"blocked,omitempty"`
}

ConversationOpenUpdate mapping

type ConversationOriginal

type ConversationOriginal struct {
	WebsiteID  *string `json:"website_id,omitempty"`
	SessionID  *string `json:"session_id,omitempty"`
	OriginalID *string `json:"original_id,omitempty"`
	Type       *string `json:"type,omitempty"`
	Content    *string `json:"content,omitempty"`
	Timestamp  *uint64 `json:"timestamp,omitempty"`
}

ConversationOriginal mapping

func (ConversationOriginal) String

func (instance ConversationOriginal) String() string

String returns the string representation of ConversationOriginal

type ConversationOriginalData

type ConversationOriginalData struct {
	Data *ConversationOriginal `json:"data,omitempty"`
}

ConversationOriginalData mapping

type ConversationPage

type ConversationPage struct {
	PageTitle    *string `json:"page_title,omitempty"`
	PageURL      *string `json:"page_url,omitempty"`
	PageReferrer *string `json:"page_referrer,omitempty"`
	Timestamp    *uint64 `json:"timestamp,omitempty"`
}

ConversationPage mapping

type ConversationPagesData

type ConversationPagesData struct {
	Data *[]ConversationPage `json:"data,omitempty"`
}

ConversationPagesData mapping

type ConversationParticipant

type ConversationParticipant struct {
	Type   *string `json:"type,omitempty"`
	Target *string `json:"target,omitempty"`
}

ConversationParticipant mapping

type ConversationParticipants

type ConversationParticipants struct {
	Participants *[]ConversationParticipant `json:"participants,omitempty"`
}

ConversationParticipants mapping

func (ConversationParticipants) String

func (instance ConversationParticipants) String() string

String returns the string representation of ConversationParticipants

type ConversationParticipantsData

type ConversationParticipantsData struct {
	Data *ConversationParticipants `json:"data,omitempty"`
}

ConversationParticipantsData mapping

type ConversationParticipantsSave

type ConversationParticipantsSave struct {
	Participants *[]ConversationParticipant `json:"participants,omitempty"`
}

ConversationParticipantsSave mapping

type ConversationPickerMessageNew

type ConversationPickerMessageNew struct {
	Type        string                              `json:"type,omitempty"`
	From        string                              `json:"from,omitempty"`
	Origin      string                              `json:"origin,omitempty"`
	Content     ConversationPickerMessageNewContent `json:"content,omitempty"`
	Mentions    []string                            `json:"mentions,omitempty"`
	Fingerprint int                                 `json:"fingerprint,omitempty"`
	User        ConversationAllMessageNewUser       `json:"user,omitempty"`
	Original    *ConversationAllMessageNewOriginal  `json:"original,omitempty"`
	Translated  *bool                               `json:"translated,omitempty"`
}

ConversationPickerMessageNew mapping

type ConversationPickerMessageNewContent

type ConversationPickerMessageNewContent struct {
	ID      string                                      `json:"id,omitempty"`
	Text    string                                      `json:"text,omitempty"`
	Choices []ConversationPickerMessageNewContentChoice `json:"choices,omitempty"`
}

ConversationPickerMessageNewContent mapping

type ConversationPickerMessageNewContentChoice

type ConversationPickerMessageNewContentChoice struct {
	Value    string `json:"value,omitempty"`
	Label    string `json:"label,omitempty"`
	Selected bool   `json:"selected"`
}

ConversationPickerMessageNewContentChoice mapping

type ConversationPickerMessageUpdate

type ConversationPickerMessageUpdate struct {
	Content ConversationPickerMessageNewContent `json:"content,omitempty"`
}

ConversationPickerMessageUpdate mapping

type ConversationReadMessageMark added in v1.2.2

type ConversationReadMessageMark struct {
	From         string `json:"from,omitempty"`
	Origin       string `json:"origin,omitempty"`
	Fingerprints []int  `json:"fingerprints,omitempty"`
}

ConversationReadMessageMark mapping

type ConversationReminderPayload

type ConversationReminderPayload struct {
	Date string `json:"date,omitempty"`
	Note string `json:"note,omitempty"`
}

ConversationReminderPayload mapping

type ConversationRoutingAssign

type ConversationRoutingAssign struct {
	Assigned *ConversationRoutingAssignAssigned `json:"assigned,omitempty"`
}

ConversationRoutingAssign mapping

func (ConversationRoutingAssign) String

func (instance ConversationRoutingAssign) String() string

String returns the string representation of ConversationRoutingAssign

type ConversationRoutingAssignAssigned

type ConversationRoutingAssignAssigned struct {
	UserID *string `json:"user_id,omitempty"`
}

ConversationRoutingAssignAssigned mapping

type ConversationRoutingAssignData

type ConversationRoutingAssignData struct {
	Data *ConversationRoutingAssign `json:"data,omitempty"`
}

ConversationRoutingAssignData mapping

type ConversationRoutingAssignUpdate

type ConversationRoutingAssignUpdate struct {
	Assigned *ConversationRoutingAssignUpdateAssigned `json:"assigned,omitempty"`
}

ConversationRoutingAssignUpdate mapping

type ConversationRoutingAssignUpdateAssigned

type ConversationRoutingAssignUpdateAssigned struct {
	UserID string `json:"user_id,omitempty"`
}

ConversationRoutingAssignUpdateAssigned mapping

type ConversationState added in v1.6.0

type ConversationState struct {
	State *string `json:"state,omitempty"`
}

ConversationState mapping

func (ConversationState) String added in v1.6.0

func (instance ConversationState) String() string

String returns the string representation of ConversationState

type ConversationStateData added in v1.6.0

type ConversationStateData struct {
	Data *ConversationState `json:"data,omitempty"`
}

ConversationStateData mapping

type ConversationStateUpdate

type ConversationStateUpdate struct {
	State *string `json:"state,omitempty"`
}

ConversationStateUpdate mapping

type ConversationSuggestedData

type ConversationSuggestedData struct {
	Key   *string `json:"key,omitempty"`
	Count *int32  `json:"count,omitempty"`
}

ConversationSuggestedData mapping

func (ConversationSuggestedData) String

func (instance ConversationSuggestedData) String() string

String returns the string representation of ConversationSuggestedData

type ConversationSuggestedDataData

type ConversationSuggestedDataData struct {
	Data *[]ConversationSuggestedData `json:"data,omitempty"`
}

ConversationSuggestedDataData mapping

type ConversationSuggestedSegment

type ConversationSuggestedSegment struct {
	Segment *string `json:"segment,omitempty"`
	Count   *int32  `json:"count,omitempty"`
}

ConversationSuggestedSegment mapping

func (ConversationSuggestedSegment) String

func (instance ConversationSuggestedSegment) String() string

String returns the string representation of ConversationSuggestedSegment

type ConversationSuggestedSegmentData

type ConversationSuggestedSegmentData struct {
	Data *[]ConversationSuggestedSegment `json:"data,omitempty"`
}

ConversationSuggestedSegmentData mapping

type ConversationTextMessageNew

type ConversationTextMessageNew struct {
	Type        string                             `json:"type,omitempty"`
	From        string                             `json:"from,omitempty"`
	Origin      string                             `json:"origin,omitempty"`
	Content     string                             `json:"content,omitempty"`
	Mentions    []string                           `json:"mentions,omitempty"`
	Fingerprint int                                `json:"fingerprint,omitempty"`
	User        ConversationAllMessageNewUser      `json:"user,omitempty"`
	Original    *ConversationAllMessageNewOriginal `json:"original,omitempty"`
	Translated  *bool                              `json:"translated,omitempty"`
}

ConversationTextMessageNew mapping

type ConversationTextMessageUpdate

type ConversationTextMessageUpdate struct {
	Content string `json:"content,omitempty"`
}

ConversationTextMessageUpdate mapping

type ConversationTranscriptRequest added in v1.20.2

type ConversationTranscriptRequest struct {
	To    *string `json:"to,omitempty"`
	Email *string `json:"email,omitempty"`
}

ConversationTranscriptRequest mapping

type ConversationUnread

type ConversationUnread struct {
	Operator *uint16 `json:"operator,omitempty"`
	Visitor  *uint16 `json:"visitor,omitempty"`
}

ConversationUnread mapping

type EventsBrowsingGeneric

type EventsBrowsingGeneric struct {
	EventsSessionGeneric
	BrowsingID *string `json:"browsing_id"`
}

EventsBrowsingGeneric maps a generic browsing

type EventsBrowsingRequestInitiated added in v1.23.0

type EventsBrowsingRequestInitiated struct {
	EventsGeneric
	EventsBrowsingGeneric
	BrowsingToken *string `json:"browsing_token"`
}

EventsBrowsingRequestInitiated maps browsing:request:initiated

func (EventsBrowsingRequestInitiated) String

String returns the string representation of EventsBrowsingRequestInitiated

type EventsBrowsingRequestRejected added in v1.23.1

type EventsBrowsingRequestRejected struct {
	EventsGeneric
	EventsSessionGeneric
}

EventsBrowsingRequestRejected maps browsing:request:rejected

func (EventsBrowsingRequestRejected) String

String returns the string representation of EventsBrowsingRequestRejected

type EventsCallGeneric

type EventsCallGeneric struct {
	EventsSessionGeneric
	CallID *string `json:"call_id"`
}

EventsCallGeneric maps a generic call

type EventsCallRequestInitiated

type EventsCallRequestInitiated struct {
	EventsGeneric
	EventsCallGeneric
}

EventsCallRequestInitiated maps call:request:initiated

func (EventsCallRequestInitiated) String

func (evt EventsCallRequestInitiated) String() string

String returns the string representation of EventsCallRequestInitiated

type EventsCallRequestRejected

type EventsCallRequestRejected struct {
	EventsGeneric
	EventsCallGeneric
}

EventsCallRequestRejected maps call:request:rejected

func (EventsCallRequestRejected) String

func (evt EventsCallRequestRejected) String() string

String returns the string representation of EventsCallRequestRejected

type EventsCampaignDispatched added in v1.31.3

type EventsCampaignDispatched struct {
	EventsGeneric
	EventsCampaignGeneric
}

EventsCampaignDispatched maps campaign:dispatched

func (EventsCampaignDispatched) String added in v1.31.3

func (evt EventsCampaignDispatched) String() string

String returns the string representation of EventsCampaignDispatched

type EventsCampaignGeneric

type EventsCampaignGeneric struct {
	EventsWebsiteGeneric
	CampaignID *string `json:"campaign_id"`
}

EventsCampaignGeneric maps a generic campaign

type EventsCampaignProgress added in v1.31.3

type EventsCampaignProgress struct {
	EventsGeneric
	EventsCampaignGeneric
	Progress *uint8 `json:"progress"`
}

EventsCampaignProgress maps campaign:progress

func (EventsCampaignProgress) String added in v1.31.3

func (evt EventsCampaignProgress) String() string

String returns the string representation of EventsCampaignProgress

type EventsCampaignRunning added in v1.31.4

type EventsCampaignRunning struct {
	EventsGeneric
	EventsCampaignGeneric
	Running *bool `json:"running"`
}

EventsCampaignRunning maps campaign:running

func (EventsCampaignRunning) String added in v1.31.4

func (evt EventsCampaignRunning) String() string

String returns the string representation of EventsCampaignRunning

type EventsGeneric

type EventsGeneric struct {
	RoutingIDs *[]string `json:"routing_ids,omitempty"`
}

EventsGeneric maps a generic event

type EventsImportGeneric

type EventsImportGeneric struct {
	ImportID *string `json:"import_id"`
}

EventsImportGeneric maps a generic import

type EventsPeopleBindSession added in v1.28.3

type EventsPeopleBindSession struct {
	EventsGeneric
	EventsPeopleGeneric
	EventsSessionGenericUnbound
}

EventsPeopleBindSession maps people:bind:session

func (EventsPeopleBindSession) String added in v1.28.5

func (evt EventsPeopleBindSession) String() string

String returns the string representation of EventsPeopleBindSession

type EventsPeopleGeneric

type EventsPeopleGeneric struct {
	EventsWebsiteGeneric
	PeopleID *string `json:"people_id"`
}

EventsPeopleGeneric maps a generic people

type EventsPeopleImportDone

type EventsPeopleImportDone struct {
	EventsGeneric
	EventsImportGeneric
	Error *bool `json:"error"`
}

EventsPeopleImportDone maps people:import:done

func (EventsPeopleImportDone) String

func (evt EventsPeopleImportDone) String() string

String returns the string representation of EventsPeopleImportDone

type EventsPeopleImportProgress

type EventsPeopleImportProgress struct {
	EventsGeneric
	EventsImportGeneric
	Progress *uint8                           `json:"progress"`
	Count    *EventsPeopleImportProgressCount `json:"count"`
}

EventsPeopleImportProgress maps people:import:progress

func (EventsPeopleImportProgress) String

func (evt EventsPeopleImportProgress) String() string

String returns the string representation of EventsPeopleImportProgress

type EventsPeopleImportProgressCount

type EventsPeopleImportProgressCount struct {
	Total     *uint32 `json:"total"`
	Remaining *uint32 `json:"remaining"`
}

EventsPeopleImportProgressCount maps people:import:progress/count

type EventsPeopleSyncProfile added in v1.28.5

type EventsPeopleSyncProfile struct {
	EventsGeneric
	EventsPeopleGeneric
	EventsSessionGenericUnbound
	Identity *PeopleProfileCard `json:"identity"`
}

EventsPeopleSyncProfile maps people:sync:profile

func (EventsPeopleSyncProfile) String added in v1.28.5

func (evt EventsPeopleSyncProfile) String() string

String returns the string representation of EventsPeopleSyncProfile

type EventsPluginGeneric

type EventsPluginGeneric struct {
	PluginID *string `json:"plugin_id"`
}

EventsPluginGeneric maps a generic plugin

type EventsReceiveAnimationMessage added in v1.16.0

type EventsReceiveAnimationMessage struct {
	EventsGeneric
	EventsReceiveGenericMessage
	Content *EventsReceiveAnimationMessageContent `json:"content"`
}

EventsReceiveAnimationMessage maps message:{send,received} (animation type)

func (EventsReceiveAnimationMessage) String added in v1.16.0

String returns the string representation of EventsReceiveAnimationMessage

type EventsReceiveAnimationMessageContent added in v1.16.0

type EventsReceiveAnimationMessageContent struct {
	URL  string `json:"url"`
	Type string `json:"type"`
}

EventsReceiveAnimationMessageContent maps message:{send,received}/content (animation type)

type EventsReceiveAudioMessage

type EventsReceiveAudioMessage struct {
	EventsGeneric
	EventsReceiveGenericMessage
	Content *EventsReceiveAudioMessageContent `json:"content"`
}

EventsReceiveAudioMessage maps message:{send,received} (audio type)

func (EventsReceiveAudioMessage) String

func (evt EventsReceiveAudioMessage) String() string

String returns the string representation of EventsReceiveAudioMessage

type EventsReceiveAudioMessageContent

type EventsReceiveAudioMessageContent struct {
	URL      string `json:"url"`
	Type     string `json:"type"`
	Duration uint16 `json:"duration"`
}

EventsReceiveAudioMessageContent maps message:{send,received}/content (audio type)

type EventsReceiveAuthenticationUnauthorized added in v1.1.0

type EventsReceiveAuthenticationUnauthorized struct {
	Message *string `json:"message"`
}

EventsReceiveAuthenticationUnauthorized maps unauthorized

type EventsReceiveBucketURLAvatarGenerated added in v1.1.0

type EventsReceiveBucketURLAvatarGenerated EventsReceiveBucketURLUploadGenerated

EventsReceiveBucketURLAvatarGenerated maps bucket:url:avatar:generated

func (EventsReceiveBucketURLAvatarGenerated) String added in v1.1.0

String returns the string representation of EventsReceiveBucketURLAvatarGenerated

type EventsReceiveBucketURLCampaignGenerated

type EventsReceiveBucketURLCampaignGenerated EventsReceiveBucketURLUploadGenerated

EventsReceiveBucketURLCampaignGenerated maps bucket:url:campaign:generated

func (EventsReceiveBucketURLCampaignGenerated) String

String returns the string representation of EventsReceiveBucketURLCampaignGenerated

type EventsReceiveBucketURLHelpdeskGenerated

type EventsReceiveBucketURLHelpdeskGenerated EventsReceiveBucketURLUploadGenerated

EventsReceiveBucketURLHelpdeskGenerated maps bucket:url:helpdesk:generated

func (EventsReceiveBucketURLHelpdeskGenerated) String

String returns the string representation of EventsReceiveBucketURLHelpdeskGenerated

type EventsReceiveBucketURLProcessingGenerated

type EventsReceiveBucketURLProcessingGenerated EventsReceiveBucketURLUploadGenerated

EventsReceiveBucketURLProcessingGenerated maps bucket:url:processing:generated

func (EventsReceiveBucketURLProcessingGenerated) String

String returns the string representation of EventsReceiveBucketURLProcessingGenerated

type EventsReceiveBucketURLStatusGenerated

type EventsReceiveBucketURLStatusGenerated EventsReceiveBucketURLUploadGenerated

EventsReceiveBucketURLStatusGenerated maps bucket:url:status:generated

func (EventsReceiveBucketURLStatusGenerated) String

String returns the string representation of EventsReceiveBucketURLStatusGenerated

type EventsReceiveBucketURLUploadGenerated added in v1.1.0

type EventsReceiveBucketURLUploadGenerated struct {
	EventsGeneric
	From       *string                                      `json:"from"`
	ID         *string                                      `json:"id"`
	Identifier *string                                      `json:"identifier"`
	Policy     *EventsReceiveBucketURLUploadGeneratedPolicy `json:"policy"`
	Type       *string                                      `json:"type"`
	URL        *EventsReceiveBucketURLUploadGeneratedURL    `json:"url"`
}

EventsReceiveBucketURLUploadGenerated maps bucket:url:upload:generated

func (EventsReceiveBucketURLUploadGenerated) String added in v1.1.0

String returns the string representation of EventsReceiveBucketURLUploadGenerated

type EventsReceiveBucketURLUploadGeneratedPolicy added in v1.1.0

type EventsReceiveBucketURLUploadGeneratedPolicy struct {
	SizeLimit *uint64 `json:"size_limit"`
}

EventsReceiveBucketURLUploadGeneratedPolicy maps bucket:url:upload:generated/policy

type EventsReceiveBucketURLUploadGeneratedURL added in v1.1.0

type EventsReceiveBucketURLUploadGeneratedURL struct {
	Resource *string `json:"resource"`
	Signed   *string `json:"signed"`
}

EventsReceiveBucketURLUploadGeneratedURL maps bucket:url:upload:generated/url

type EventsReceiveBucketURLWebsiteGenerated

type EventsReceiveBucketURLWebsiteGenerated EventsReceiveBucketURLUploadGenerated

EventsReceiveBucketURLWebsiteGenerated maps bucket:url:website:generated

func (EventsReceiveBucketURLWebsiteGenerated) String

String returns the string representation of EventsReceiveBucketURLWebsiteGenerated

type EventsReceiveCommonMessageOriginal

type EventsReceiveCommonMessageOriginal struct {
	OriginalID *string `json:"original_id"`
}

EventsReceiveCommonMessageOriginal maps a message original

type EventsReceiveCommonMessageUser added in v1.3.0

type EventsReceiveCommonMessageUser struct {
	Type     *string `json:"type"`
	UserID   *string `json:"user_id"`
	Nickname *string `json:"nickname"`
	Avatar   *string `json:"avatar"`
}

EventsReceiveCommonMessageUser maps a message user

type EventsReceiveEmailSubscribe

type EventsReceiveEmailSubscribe struct {
	EventsGeneric
	EventsWebsiteGeneric
	Email      *string `json:"email"`
	Subscribed *bool   `json:"subscribed"`
}

EventsReceiveEmailSubscribe maps email:subscribe

func (EventsReceiveEmailSubscribe) String

func (evt EventsReceiveEmailSubscribe) String() string

String returns the string representation of EventsReceiveEmailSubscribe

type EventsReceiveEmailTrackView

type EventsReceiveEmailTrackView struct {
	EventsGeneric
	EventsWebsiteGeneric
	Type       *string `json:"type"`
	Identifier *string `json:"identifier"`
	Mode       *string `json:"mode"`
}

EventsReceiveEmailTrackView maps email:track:view

func (EventsReceiveEmailTrackView) String

func (evt EventsReceiveEmailTrackView) String() string

String returns the string representation of EventsReceiveEmailTrackView

type EventsReceiveEventMessage

type EventsReceiveEventMessage struct {
	EventsGeneric
	EventsReceiveGenericMessage
	Content *EventsReceiveEventMessageContent `json:"content"`
}

EventsReceiveEventMessage maps message:{send,received} (event type)

func (EventsReceiveEventMessage) String

func (evt EventsReceiveEventMessage) String() string

String returns the string representation of EventsReceiveEventMessage

type EventsReceiveEventMessageContent

type EventsReceiveEventMessageContent struct {
	Namespace string  `json:"namespace"`
	Text      *string `json:"text,omitempty"`
}

EventsReceiveEventMessageContent maps message:{send,received}/content (event type)

type EventsReceiveFieldMessage

type EventsReceiveFieldMessage struct {
	EventsGeneric
	EventsReceiveGenericMessage
	Content *EventsReceiveFieldMessageContent `json:"content"`
}

EventsReceiveFieldMessage maps message:{send,received} (field type)

func (EventsReceiveFieldMessage) String

func (evt EventsReceiveFieldMessage) String() string

String returns the string representation of EventsReceiveFieldMessage

type EventsReceiveFieldMessageContent

type EventsReceiveFieldMessageContent struct {
	ID      string `json:"id"`
	Text    string `json:"text"`
	Explain string `json:"explain"`
	Value   string `json:"value"`
}

EventsReceiveFieldMessageContent maps message:{send,received}/content (field type)

type EventsReceiveFileMessage added in v1.3.0

type EventsReceiveFileMessage struct {
	EventsGeneric
	EventsReceiveGenericMessage
	Content *EventsReceiveFileMessageContent `json:"content"`
}

EventsReceiveFileMessage maps message:{send,received} (file type)

func (EventsReceiveFileMessage) String added in v1.3.0

func (evt EventsReceiveFileMessage) String() string

String returns the string representation of EventsReceiveFileMessage

type EventsReceiveFileMessageContent added in v1.3.0

type EventsReceiveFileMessageContent struct {
	Name string `json:"name"`
	URL  string `json:"url"`
	Type string `json:"type"`
}

EventsReceiveFileMessageContent maps message:{send,received}/content (file type)

type EventsReceiveGenericMessage

type EventsReceiveGenericMessage struct {
	EventsReceiveGenericMessageType
	EventsSessionGeneric
	From        *string                             `json:"from"`
	Origin      *string                             `json:"origin"`
	Mentions    *[]string                           `json:"mentions"`
	Stamped     *bool                               `json:"stamped"`
	Timestamp   *uint64                             `json:"timestamp"`
	Fingerprint *int                                `json:"fingerprint"`
	User        *EventsReceiveCommonMessageUser     `json:"user"`
	Original    *EventsReceiveCommonMessageOriginal `json:"original"`
	Edited      *bool                               `json:"edited,omitempty"`
	Translated  *bool                               `json:"translated,omitempty"`
}

EventsReceiveGenericMessage maps a generic message

type EventsReceiveGenericMessageType added in v1.3.0

type EventsReceiveGenericMessageType struct {
	Type *string `json:"type"`
}

EventsReceiveGenericMessageType receive a generic message type

type EventsReceiveMediaAnimationListed added in v1.18.0

type EventsReceiveMediaAnimationListed struct {
	EventsGeneric
	ID      *int                                       `json:"id"`
	Results *[]EventsReceiveMediaAnimationListedResult `json:"results"`
}

EventsReceiveMediaAnimationListed maps media:animation:listed

func (EventsReceiveMediaAnimationListed) String added in v1.18.0

String returns the string representation of EventsReceiveMediaAnimationListed

type EventsReceiveMediaAnimationListedResult added in v1.18.0

type EventsReceiveMediaAnimationListedResult struct {
	Type *string `json:"type"`
	URL  *string `json:"url"`
}

EventsReceiveMediaAnimationListedResult maps media:animation:listed/results

type EventsReceiveMessageAcknowledge added in v1.3.0

type EventsReceiveMessageAcknowledge struct {
	EventsGeneric
	EventsSessionGeneric
	Origin       *string `json:"origin"`
	Fingerprints *[]int  `json:"fingerprints"`
}

EventsReceiveMessageAcknowledge maps message:acknowledge:*

func (EventsReceiveMessageAcknowledge) String added in v1.3.0

String returns the string representation of EventsReceiveMessageAcknowledge

type EventsReceiveMessageComposeReceive added in v1.1.0

type EventsReceiveMessageComposeReceive struct {
	EventsGeneric
	EventsSessionGeneric
	Type      *string                                 `json:"type"`
	Excerpt   *string                                 `json:"excerpt"`
	Timestamp *uint64                                 `json:"timestamp"`
	User      *EventsReceiveMessageComposeReceiveUser `json:"user"`
}

EventsReceiveMessageComposeReceive maps message:compose:receive

func (EventsReceiveMessageComposeReceive) String added in v1.1.0

String returns the string representation of EventsReceiveMessageComposeReceive

type EventsReceiveMessageComposeReceiveUser

type EventsReceiveMessageComposeReceiveUser struct {
	UserID   *string `json:"user_id"`
	Nickname *string `json:"nickname"`
	Avatar   *string `json:"avatar"`
}

EventsReceiveMessageComposeReceiveUser maps message:compose:receive/user

type EventsReceiveMessageComposeSend added in v1.1.0

type EventsReceiveMessageComposeSend struct {
	EventsGeneric
	EventsSessionGeneric
	Type      *string `json:"type"`
	Excerpt   *string `json:"excerpt"`
	Timestamp *uint64 `json:"timestamp"`
}

EventsReceiveMessageComposeSend maps message:compose:send

func (EventsReceiveMessageComposeSend) String added in v1.1.0

String returns the string representation of EventsReceiveMessageComposeSend

type EventsReceiveMessageNotify

type EventsReceiveMessageNotify struct {
	EventsGeneric
	EventsSessionGeneric
}

EventsReceiveMessageNotify maps message:notify:*

func (EventsReceiveMessageNotify) String

func (evt EventsReceiveMessageNotify) String() string

String returns the string representation of EventsReceiveMessageNotify

type EventsReceiveMessageUpdated

type EventsReceiveMessageUpdated struct {
	EventsGeneric
	EventsSessionGeneric
	Fingerprint *int         `json:"fingerprint"`
	Content     *interface{} `json:"content"`
}

EventsReceiveMessageUpdated maps message:updated

func (EventsReceiveMessageUpdated) String

func (evt EventsReceiveMessageUpdated) String() string

String returns the string representation of EventsReceiveMessageUpdated

type EventsReceiveNoteMessage added in v1.20.1

type EventsReceiveNoteMessage EventsReceiveTextMessage

EventsReceiveNoteMessage maps message:{send,received} (note type)

func (EventsReceiveNoteMessage) String added in v1.20.1

func (evt EventsReceiveNoteMessage) String() string

String returns the string representation of EventsReceiveNoteMessage

type EventsReceivePeopleProfileCreated

type EventsReceivePeopleProfileCreated struct {
	EventsGeneric
	EventsPeopleGeneric
	Email *string `json:"email"`
}

EventsReceivePeopleProfileCreated maps people:profile:created

func (EventsReceivePeopleProfileCreated) String

String returns the string representation of EventsReceivePeopleProfileCreated

type EventsReceivePeopleProfileRemoved

type EventsReceivePeopleProfileRemoved EventsReceivePeopleProfileCreated

EventsReceivePeopleProfileRemoved maps people:profile:removed

func (EventsReceivePeopleProfileRemoved) String

String returns the string representation of EventsReceivePeopleProfileRemoved

type EventsReceivePeopleProfileUpdated

type EventsReceivePeopleProfileUpdated struct {
	EventsGeneric
	EventsPeopleGeneric
	Email  *string            `json:"email"`
	Update *PeopleProfileCard `json:"update"`
}

EventsReceivePeopleProfileUpdated maps people:profile:updated

func (EventsReceivePeopleProfileUpdated) String

String returns the string representation of EventsReceivePeopleProfileUpdated

type EventsReceivePickerMessage

type EventsReceivePickerMessage struct {
	EventsGeneric
	EventsReceiveGenericMessage
	Content *EventsReceivePickerMessageContent `json:"content"`
}

EventsReceivePickerMessage maps message:{send,received} (picker type)

func (EventsReceivePickerMessage) String

func (evt EventsReceivePickerMessage) String() string

String returns the string representation of EventsReceivePickerMessage

type EventsReceivePickerMessageContent

type EventsReceivePickerMessageContent struct {
	ID      string                                     `json:"id"`
	Text    string                                     `json:"text"`
	Choices *[]EventsReceivePickerMessageContentChoice `json:"choices"`
}

EventsReceivePickerMessageContent maps message:{send,received}/content (picker type)

type EventsReceivePickerMessageContentChoice

type EventsReceivePickerMessageContentChoice struct {
	Value    string `json:"value"`
	Label    string `json:"label"`
	Selected bool   `json:"selected"`
}

EventsReceivePickerMessageContentChoice maps message:{send,received}/content/choices (picker type)

type EventsReceivePluginChannel

type EventsReceivePluginChannel struct {
	EventsGeneric
	EventsWebsiteGeneric
	EventsPluginGeneric
	Namespace  *string      `json:"namespace"`
	Identifier *string      `json:"identifier,omitempty"`
	Payload    *interface{} `json:"payload"`
}

EventsReceivePluginChannel maps plugin:channel

func (EventsReceivePluginChannel) String

func (evt EventsReceivePluginChannel) String() string

String returns the string representation of EventsReceivePluginChannel

type EventsReceivePluginEvent

type EventsReceivePluginEvent struct {
	EventsGeneric
	EventsWebsiteGeneric
	EventsPluginGeneric
	URN  *string      `json:"urn"`
	Name *string      `json:"name"`
	Data *interface{} `json:"data"`
}

EventsReceivePluginEvent maps plugin:event

func (EventsReceivePluginEvent) String

func (evt EventsReceivePluginEvent) String() string

String returns the string representation of EventsReceivePluginEvent

type EventsReceivePluginSettingsSaved

type EventsReceivePluginSettingsSaved struct {
	EventsGeneric
	EventsWebsiteGeneric
	EventsPluginGeneric
	Settings *interface{} `json:"settings"`
}

EventsReceivePluginSettingsSaved maps plugin:settings:saved

func (EventsReceivePluginSettingsSaved) String

String returns the string representation of EventsReceivePluginSettingsSaved

type EventsReceiveSessionRemoved added in v1.1.0

type EventsReceiveSessionRemoved struct {
	EventsGeneric
	EventsSessionGeneric
}

EventsReceiveSessionRemoved maps session:removed

func (EventsReceiveSessionRemoved) String added in v1.1.0

func (evt EventsReceiveSessionRemoved) String() string

String returns the string representation of EventsReceiveSessionRemoved

type EventsReceiveSessionRequestInitiated added in v1.1.0

type EventsReceiveSessionRequestInitiated struct {
	EventsGeneric
	EventsSessionGeneric
}

EventsReceiveSessionRequestInitiated maps session:request:initiated

func (EventsReceiveSessionRequestInitiated) String added in v1.1.0

String returns the string representation of EventsReceiveSessionRequestInitiated

type EventsReceiveSessionSetAddress added in v1.22.4

type EventsReceiveSessionSetAddress struct {
	EventsGeneric
	EventsSessionGeneric
	Address *string `json:"address"`
}

EventsReceiveSessionSetAddress maps session:set_address

type EventsReceiveSessionSetAvatar added in v1.1.0

type EventsReceiveSessionSetAvatar struct {
	EventsGeneric
	EventsSessionGeneric
	Avatar *string `json:"avatar"`
}

EventsReceiveSessionSetAvatar maps session:set_avatar

func (EventsReceiveSessionSetAvatar) String added in v1.1.0

String returns the string representation of EventsReceiveSessionSetAvatar

type EventsReceiveSessionSetBlock added in v1.1.0

type EventsReceiveSessionSetBlock struct {
	EventsGeneric
	EventsSessionGeneric
	IsBlocked *bool `json:"is_blocked"`
}

EventsReceiveSessionSetBlock maps session:set_block

func (EventsReceiveSessionSetBlock) String added in v1.1.0

func (evt EventsReceiveSessionSetBlock) String() string

String returns the string representation of EventsReceiveSessionSetBlock

type EventsReceiveSessionSetClosed added in v1.1.0

type EventsReceiveSessionSetClosed struct {
	EventsGeneric
	EventsSessionGeneric
	Operator *EventsReceiveSessionSetOpenStateOperator `json:"operator"`
}

EventsReceiveSessionSetClosed maps session:set_closed

func (EventsReceiveSessionSetClosed) String added in v1.1.0

String returns the string representation of EventsReceiveSessionSetClosed

type EventsReceiveSessionSetData added in v1.9.0

type EventsReceiveSessionSetData struct {
	EventsGeneric
	EventsSessionGeneric
	Data *interface{} `json:"data"`
}

EventsReceiveSessionSetData maps session:set_data

func (EventsReceiveSessionSetData) String added in v1.9.0

func (evt EventsReceiveSessionSetData) String() string

String returns the string representation of EventsReceiveSessionSetData

type EventsReceiveSessionSetEmail added in v1.1.0

type EventsReceiveSessionSetEmail struct {
	EventsGeneric
	EventsSessionGeneric
	Email *string `json:"email"`
}

EventsReceiveSessionSetEmail maps session:set_email

func (EventsReceiveSessionSetEmail) String added in v1.1.0

func (evt EventsReceiveSessionSetEmail) String() string

String returns the string representation of EventsReceiveSessionSetEmail

type EventsReceiveSessionSetMentions

type EventsReceiveSessionSetMentions struct {
	EventsGeneric
	EventsSessionGeneric
	Mentions *[]string `json:"mentions"`
}

EventsReceiveSessionSetMentions maps session:set_mentions

func (EventsReceiveSessionSetMentions) String

String returns the string representation of EventsReceiveSessionSetMentions

type EventsReceiveSessionSetNickname added in v1.1.0

type EventsReceiveSessionSetNickname struct {
	EventsGeneric
	EventsSessionGeneric
	Nickname *string `json:"nickname"`
}

EventsReceiveSessionSetNickname maps session:set_nickname

func (EventsReceiveSessionSetNickname) String added in v1.1.0

String returns the string representation of EventsReceiveSessionSetNickname

type EventsReceiveSessionSetOpenStateOperator added in v1.1.0

type EventsReceiveSessionSetOpenStateOperator struct {
	EventsUserGeneric
}

EventsReceiveSessionSetOpenStateOperator maps session:set_{opened,closed}/operator

type EventsReceiveSessionSetOpened added in v1.1.0

type EventsReceiveSessionSetOpened struct {
	EventsGeneric
	EventsSessionGeneric
	Operator *EventsReceiveSessionSetOpenStateOperator `json:"operator"`
}

EventsReceiveSessionSetOpened maps session:set_opened

func (EventsReceiveSessionSetOpened) String added in v1.1.0

String returns the string representation of EventsReceiveSessionSetOpened

type EventsReceiveSessionSetParticipants

type EventsReceiveSessionSetParticipants struct {
	EventsGeneric
	EventsSessionGeneric
	Participants *[]EventsReceiveSessionSetParticipantsOne `json:"participants"`
}

EventsReceiveSessionSetParticipants maps session:set_participants

func (EventsReceiveSessionSetParticipants) String

String returns the string representation of EventsReceiveSessionSetParticipants

type EventsReceiveSessionSetParticipantsOne

type EventsReceiveSessionSetParticipantsOne struct {
	Type   *string `json:"type"`
	Target *string `json:"target"`
}

EventsReceiveSessionSetParticipantsOne maps session:set_participants/participants

type EventsReceiveSessionSetPhone added in v1.22.4

type EventsReceiveSessionSetPhone struct {
	EventsGeneric
	EventsSessionGeneric
	Phone *string `json:"phone"`
}

EventsReceiveSessionSetPhone maps session:set_phone

type EventsReceiveSessionSetRouting

type EventsReceiveSessionSetRouting struct {
	EventsGeneric
	EventsSessionGeneric
	RoutingID *string `json:"routing_id"`
}

EventsReceiveSessionSetRouting maps session:set_routing

func (EventsReceiveSessionSetRouting) String

String returns the string representation of EventsReceiveSessionSetRouting

type EventsReceiveSessionSetSegments added in v1.20.0

type EventsReceiveSessionSetSegments struct {
	EventsGeneric
	EventsSessionGeneric
	Segments *[]string `json:"segments"`
}

EventsReceiveSessionSetSegments maps session:set_segments

func (EventsReceiveSessionSetSegments) String added in v1.20.0

String returns the string representation of EventsReceiveSessionSetSegments

type EventsReceiveSessionSetState added in v1.1.0

type EventsReceiveSessionSetState struct {
	EventsGeneric
	EventsSessionGeneric
	State *string `json:"state"`
}

EventsReceiveSessionSetState maps session:set_state

func (EventsReceiveSessionSetState) String added in v1.1.0

func (evt EventsReceiveSessionSetState) String() string

String returns the string representation of EventsReceiveSessionSetState

type EventsReceiveSessionSyncCapabilities

type EventsReceiveSessionSyncCapabilities struct {
	EventsGeneric
	EventsSessionGeneric
	Capabilities *EventsReceiveSessionSyncCapabilitiesData `json:"capabilities"`
}

EventsReceiveSessionSyncCapabilities maps session:sync:capabilities

func (EventsReceiveSessionSyncCapabilities) String

String returns the string representation of EventsReceiveSessionSyncCapabilities

type EventsReceiveSessionSyncCapabilitiesData

type EventsReceiveSessionSyncCapabilitiesData struct {
	Capabilities *[]string `json:"capabilities,omitempty"`
}

EventsReceiveSessionSyncCapabilitiesData maps session:sync:capabilities/capabilities

type EventsReceiveSessionSyncEvents

type EventsReceiveSessionSyncEvents struct {
	EventsGeneric
	EventsSessionGeneric
	Events *[]EventsReceiveSessionSyncEventsOne `json:"events"`
}

EventsReceiveSessionSyncEvents maps session:sync:events

func (EventsReceiveSessionSyncEvents) String

String returns the string representation of EventsReceiveSessionSyncEvents

type EventsReceiveSessionSyncEventsOne

type EventsReceiveSessionSyncEventsOne struct {
	Text      *string      `json:"text"`
	Data      *interface{} `json:"data,omitempty"`
	Color     *string      `json:"color,omitempty"`
	Timestamp *uint64      `json:"timestamp"`
}

EventsReceiveSessionSyncEventsOne maps session:sync:events/events

type EventsReceiveSessionSyncGeolocation added in v1.1.0

type EventsReceiveSessionSyncGeolocation struct {
	EventsGeneric
	EventsSessionGeneric
	Geolocation *EventsReceiveSessionSyncGeolocationData `json:"geolocation"`
}

EventsReceiveSessionSyncGeolocation maps session:sync:geolocation

func (EventsReceiveSessionSyncGeolocation) String added in v1.1.0

String returns the string representation of EventsReceiveSessionSyncGeolocation

type EventsReceiveSessionSyncGeolocationData added in v1.1.0

type EventsReceiveSessionSyncGeolocationData struct {
	Coordinates *EventsReceiveSessionSyncGeolocationDataCoordinates `json:"coordinates,omitempty"`
	City        *string                                             `json:"city,omitempty"`
	Region      *string                                             `json:"region,omitempty"`
	Country     *string                                             `json:"country,omitempty"`
}

EventsReceiveSessionSyncGeolocationData maps session:sync:geolocation/geolocation

type EventsReceiveSessionSyncGeolocationDataCoordinates added in v1.15.0

type EventsReceiveSessionSyncGeolocationDataCoordinates struct {
	Latitude  *float32 `json:"latitude,omitempty"`
	Longitude *float32 `json:"longitude,omitempty"`
}

EventsReceiveSessionSyncGeolocationDataCoordinates maps session:sync:geolocation/geolocation/coordinates

type EventsReceiveSessionSyncLocales added in v1.22.0

type EventsReceiveSessionSyncLocales struct {
	EventsGeneric
	EventsSessionGeneric
	Locales *EventsReceiveSessionSyncLocalesData `json:"locales"`
}

EventsReceiveSessionSyncLocales maps session:sync:locales

func (EventsReceiveSessionSyncLocales) String added in v1.22.0

String returns the string representation of EventsReceiveSessionSyncLocales

type EventsReceiveSessionSyncLocalesData added in v1.22.0

type EventsReceiveSessionSyncLocalesData struct {
	Locales *[]string `json:"locales,omitempty"`
}

EventsReceiveSessionSyncLocalesData maps session:sync:locales/locales

type EventsReceiveSessionSyncNetwork added in v1.13.3

type EventsReceiveSessionSyncNetwork struct {
	EventsGeneric
	EventsSessionGeneric
	Network *EventsReceiveSessionSyncNetworkData `json:"network"`
}

EventsReceiveSessionSyncNetwork maps session:sync:network

func (EventsReceiveSessionSyncNetwork) String added in v1.13.3

String returns the string representation of EventsReceiveSessionSyncNetwork

type EventsReceiveSessionSyncNetworkData added in v1.13.3

type EventsReceiveSessionSyncNetworkData struct {
	IP *string `json:"ip,omitempty"`
}

EventsReceiveSessionSyncNetworkData maps session:sync:network/network

type EventsReceiveSessionSyncPages added in v1.1.0

type EventsReceiveSessionSyncPages struct {
	EventsGeneric
	EventsSessionGeneric
	Pages *[]EventsReceiveSessionSyncPagesOne `json:"pages"`
}

EventsReceiveSessionSyncPages maps session:sync:pages

func (EventsReceiveSessionSyncPages) String added in v1.1.0

String returns the string representation of EventsReceiveSessionSyncPages

type EventsReceiveSessionSyncPagesOne added in v1.1.0

type EventsReceiveSessionSyncPagesOne struct {
	PageTitle    *string `json:"page_title"`
	PageURL      *string `json:"page_url"`
	PageReferrer *string `json:"page_referrer"`
	Timestamp    *uint64 `json:"timestamp"`
}

EventsReceiveSessionSyncPagesOne maps session:sync:pages/pages

type EventsReceiveSessionSyncRating

type EventsReceiveSessionSyncRating struct {
	EventsGeneric
	EventsSessionGeneric
	Rating *EventsReceiveSessionSyncRatingData `json:"rating"`
}

EventsReceiveSessionSyncRating maps session:sync:rating

func (EventsReceiveSessionSyncRating) String

String returns the string representation of EventsReceiveSessionSyncRating

type EventsReceiveSessionSyncRatingData

type EventsReceiveSessionSyncRatingData struct {
	Stars   uint8   `json:"stars"`
	Comment *string `json:"comment"`
}

EventsReceiveSessionSyncRatingData maps session:sync:rating/rating

type EventsReceiveSessionSyncSystem added in v1.1.0

type EventsReceiveSessionSyncSystem struct {
	EventsGeneric
	EventsSessionGeneric
	System *EventsReceiveSessionSyncSystemData `json:"system"`
}

EventsReceiveSessionSyncSystem maps session:sync:system

func (EventsReceiveSessionSyncSystem) String added in v1.1.0

String returns the string representation of EventsReceiveSessionSyncSystem

type EventsReceiveSessionSyncSystemData added in v1.1.0

type EventsReceiveSessionSyncSystemData struct {
	OS        *EventsReceiveSessionSyncSystemDataOS      `json:"os,omitempty"`
	Engine    *EventsReceiveSessionSyncSystemDataEngine  `json:"engine,omitempty"`
	Browser   *EventsReceiveSessionSyncSystemDataBrowser `json:"browser,omitempty"`
	Useragent *string                                    `json:"useragent,omitempty"`
}

EventsReceiveSessionSyncSystemData maps session:sync:system/system

type EventsReceiveSessionSyncSystemDataBrowser added in v1.1.0

type EventsReceiveSessionSyncSystemDataBrowser struct {
	Major   *string `json:"major,omitempty"`
	Version *string `json:"version,omitempty"`
	Name    *string `json:"name,omitempty"`
}

EventsReceiveSessionSyncSystemDataBrowser maps session:sync:system/system/browser

type EventsReceiveSessionSyncSystemDataEngine added in v1.1.0

type EventsReceiveSessionSyncSystemDataEngine struct {
	Version *string `json:"version,omitempty"`
	Name    *string `json:"name,omitempty"`
}

EventsReceiveSessionSyncSystemDataEngine maps session:sync:system/system/engine

type EventsReceiveSessionSyncSystemDataOS added in v1.1.0

type EventsReceiveSessionSyncSystemDataOS struct {
	Version *string `json:"version,omitempty"`
	Name    *string `json:"name,omitempty"`
}

EventsReceiveSessionSyncSystemDataOS maps session:sync:system/system/os

type EventsReceiveSessionSyncTimezone added in v1.22.0

type EventsReceiveSessionSyncTimezone struct {
	EventsGeneric
	EventsSessionGeneric
	Timezone *EventsReceiveSessionSyncTimezoneData `json:"timezone"`
}

EventsReceiveSessionSyncTimezone maps session:sync:timezone

func (EventsReceiveSessionSyncTimezone) String added in v1.22.0

String returns the string representation of EventsReceiveSessionSyncTimezone

type EventsReceiveSessionSyncTimezoneData added in v1.22.0

type EventsReceiveSessionSyncTimezoneData struct {
	Offset *int16 `json:"offset,omitempty"`
}

EventsReceiveSessionSyncTimezoneData maps session:sync:timezone/timezone

type EventsReceiveSessionUpdateAvailability added in v1.1.0

type EventsReceiveSessionUpdateAvailability struct {
	EventsGeneric
	EventsSessionGeneric
	Availability *string `json:"availability"`
}

EventsReceiveSessionUpdateAvailability maps session:update_availability

func (EventsReceiveSessionUpdateAvailability) String added in v1.1.0

String returns the string representation of EventsReceiveSessionUpdateAvailability

type EventsReceiveSessionUpdateVerify

type EventsReceiveSessionUpdateVerify struct {
	EventsGeneric
	EventsSessionGeneric
	IsVerified *bool `json:"is_verified"`
}

EventsReceiveSessionUpdateVerify maps session:update_verify

func (EventsReceiveSessionUpdateVerify) String

String returns the string representation of EventsReceiveSessionUpdateVerify

type EventsReceiveTextMessage added in v1.3.0

type EventsReceiveTextMessage struct {
	EventsGeneric
	EventsReceiveGenericMessage
	Content *string `json:"content"`
}

EventsReceiveTextMessage maps message:{send,received} (text type)

func (EventsReceiveTextMessage) String added in v1.3.0

func (evt EventsReceiveTextMessage) String() string

String returns the string representation of EventsReceiveTextMessage

type EventsReceiveWebsiteUpdateOperatorsAvailability

type EventsReceiveWebsiteUpdateOperatorsAvailability struct {
	EventsGeneric
	EventsWebsiteGeneric
	EventsUserGeneric
	Availability *EventsReceiveWebsiteUpdateOperatorsAvailabilityItself `json:"availability"`
}

EventsReceiveWebsiteUpdateOperatorsAvailability maps website:update_operators_availability

func (EventsReceiveWebsiteUpdateOperatorsAvailability) String

String returns the string representation of EventsReceiveWebsiteUpdateOperatorsAvailability

type EventsReceiveWebsiteUpdateOperatorsAvailabilityItself

type EventsReceiveWebsiteUpdateOperatorsAvailabilityItself struct {
	Type *string `json:"type"`
}

EventsReceiveWebsiteUpdateOperatorsAvailabilityItself maps website:update_operators_availability/availability

type EventsReceiveWebsiteUpdateVisitorsCount

type EventsReceiveWebsiteUpdateVisitorsCount struct {
	EventsGeneric
	EventsWebsiteGeneric
	VisitorsCount *uint32 `json:"visitors_count"`
}

EventsReceiveWebsiteUpdateVisitorsCount maps website:update_visitors_count

func (EventsReceiveWebsiteUpdateVisitorsCount) String

String returns the string representation of EventsReceiveWebsiteUpdateVisitorsCount

type EventsReceiveWebsiteUsersAvailable

type EventsReceiveWebsiteUsersAvailable struct {
	EventsGeneric
	EventsWebsiteGeneric
	Available *bool `json:"available"`
}

EventsReceiveWebsiteUsersAvailable maps website:users:available

func (EventsReceiveWebsiteUsersAvailable) String

String returns the string representation of EventsReceiveWebsiteUsersAvailable

type EventsRegister added in v1.1.0

type EventsRegister struct {
	Handlers map[string]*caller
}

EventsRegister stores event handlers

func (*EventsRegister) BindEvents added in v1.1.0

func (register *EventsRegister) BindEvents(so *gosocketio.Client)

BindEvents listens for recognized incoming events

func (*EventsRegister) On added in v1.1.0

func (register *EventsRegister) On(eventName string, handler interface{}) error

On registers an event handler on event name

type EventsSendAuthentication

type EventsSendAuthentication struct {
	Tier     string   `json:"tier"`
	Username string   `json:"username"`
	Password string   `json:"password"`
	Events   []string `json:"events"`
}

EventsSendAuthentication sends authentication

type EventsSendBind

type EventsSendBind struct {
	Events []string `json:"events"`
}

EventsSendBind sends bind

type EventsService added in v1.1.0

type EventsService service

EventsService service

func (*EventsService) Bind added in v1.4.1

func (service *EventsService) Bind(events []string)

Bind emits a socket bind event which associates the socket to its channels (with allowed events)

func (*EventsService) BindPop added in v1.29.0

func (service *EventsService) BindPop(events []string)

BindPop emits a socket bind pop event which removes allowed events from socket

func (*EventsService) BindPush added in v1.29.0

func (service *EventsService) BindPush(events []string)

BindPush emits a socket bind push event which adds allowed events to socket

func (*EventsService) Listen added in v1.1.0

func (service *EventsService) Listen(events []string, handleConnected func(*EventsRegister), handleDisconnected func(), handleError func())

Listen starts listening for incoming realtime events.

func (*EventsService) Rebind added in v1.29.0

func (service *EventsService) Rebind()

Rebind emits an empty socket bind event which associates the socket to its channels (without modifying allowed events)

type EventsSessionGeneric

type EventsSessionGeneric struct {
	EventsWebsiteGeneric
	EventsSessionGenericUnbound
}

EventsSessionGeneric maps a generic session

type EventsSessionGenericUnbound

type EventsSessionGenericUnbound struct {
	SessionID *string `json:"session_id"`
}

EventsSessionGenericUnbound maps a generic session (unbound from website)

type EventsStatusHealthChanged

type EventsStatusHealthChanged struct {
	EventsGeneric
	EventsWebsiteGeneric
	Health *string                          `json:"health"`
	Nodes  *[]EventsStatusHealthChangedNode `json:"nodes"`
}

EventsStatusHealthChanged maps status:health:changed

type EventsStatusHealthChangedNode

type EventsStatusHealthChangedNode struct {
	Label   *string `json:"label,omitempty"`
	Replica *string `json:"replica,omitempty"`
}

EventsStatusHealthChangedNode maps status:health:changed/nodes

type EventsUserGeneric

type EventsUserGeneric struct {
	UserID *string `json:"user_id"`
}

EventsUserGeneric maps a generic user

type EventsWebsiteGeneric

type EventsWebsiteGeneric struct {
	WebsiteID *string `json:"website_id"`
}

EventsWebsiteGeneric maps a generic website

type MediaService added in v1.18.0

type MediaService service

MediaService service

type PeopleConversationsData

type PeopleConversationsData struct {
	Data []string `json:"data,omitempty"`
}

PeopleConversationsData mapping

type PeopleData

type PeopleData struct {
	Data *interface{} `json:"data,omitempty"`
}

PeopleData mapping

func (PeopleData) String

func (instance PeopleData) String() string

String returns the string representation of PeopleData

type PeopleDataData

type PeopleDataData struct {
	Data *PeopleData `json:"data,omitempty"`
}

PeopleDataData mapping

type PeopleEvent

type PeopleEvent struct {
	Text      *string      `json:"text,omitempty"`
	Data      *interface{} `json:"data,omitempty"`
	Color     *string      `json:"color,omitempty"`
	Timestamp *uint64      `json:"timestamp,omitempty"`
}

PeopleEvent mapping

func (PeopleEvent) String

func (instance PeopleEvent) String() string

String returns the string representation of PeopleEvent

type PeopleEventAdd

type PeopleEventAdd struct {
	Text  string      `json:"text,omitempty"`
	Data  interface{} `json:"data,omitempty"`
	Color string      `json:"color,omitempty"`
}

PeopleEventAdd mapping

type PeopleEventsData

type PeopleEventsData struct {
	Data *[]PeopleEvent `json:"data,omitempty"`
}

PeopleEventsData mapping

type PeopleFilter

type PeopleFilter struct {
	Model     string   `json:"model,omitempty"`
	Criterion string   `json:"criterion,omitempty"`
	Operator  string   `json:"operator,omitempty"`
	Query     []string `json:"query,omitempty"`
}

PeopleFilter mapping

type PeopleProfile added in v1.27.0

type PeopleProfile struct {
	PeopleProfileCard
	PeopleID *string `json:"people_id,omitempty"`
}

PeopleProfile mapping

func (PeopleProfile) String added in v1.27.0

func (instance PeopleProfile) String() string

String returns the string representation of PeopleProfile

type PeopleProfileCard added in v1.27.0

type PeopleProfileCard struct {
	Email     *string                   `json:"email,omitempty"`
	Person    *PeopleProfileCardPerson  `json:"person,omitempty"`
	Company   *PeopleProfileCardCompany `json:"company,omitempty"`
	Segments  *[]string                 `json:"segments,omitempty"`
	Notepad   *string                   `json:"notepad,omitempty"`
	Active    *PeopleProfileCardActive  `json:"active,omitempty"`
	Score     *uint8                    `json:"score,omitempty"`
	CreatedAt *uint64                   `json:"created_at,omitempty"`
	UpdatedAt *uint64                   `json:"updated_at,omitempty"`
}

PeopleProfileCard mapping

type PeopleProfileCardActive

type PeopleProfileCardActive struct {
	Now  *bool   `json:"now,omitempty"`
	Last *uint64 `json:"last,omitempty"`
}

PeopleProfileCardActive mapping

type PeopleProfileCardCompany added in v1.27.0

type PeopleProfileCardCompany struct {
	Name        *string                          `json:"name,omitempty"`
	LegalName   *string                          `json:"legal_name,omitempty"`
	Domain      *string                          `json:"domain,omitempty"`
	URL         *string                          `json:"url,omitempty"`
	Description *string                          `json:"description,omitempty"`
	Timezone    *int16                           `json:"timezone,omitempty"`
	Phones      *[]string                        `json:"phones,omitempty"`
	Emails      *[]string                        `json:"emails,omitempty"`
	Geolocation *PeopleProfileCardGeolocation    `json:"geolocation,omitempty"`
	Metrics     *PeopleProfileCardCompanyMetrics `json:"metrics,omitempty"`
	Tags        *[]string                        `json:"tags,omitempty"`
}

PeopleProfileCardCompany mapping

type PeopleProfileCardCompanyMetrics added in v1.27.0

type PeopleProfileCardCompanyMetrics struct {
	Employees *uint32 `json:"employees,omitempty"`
	MarketCap *uint32 `json:"market_cap,omitempty"`
	Raised    *uint32 `json:"raised,omitempty"`
	ARR       *uint32 `json:"arr,omitempty"`
}

PeopleProfileCardCompanyMetrics mapping

type PeopleProfileCardGeolocation added in v1.28.4

type PeopleProfileCardGeolocation struct {
	Country     *string                                  `json:"country,omitempty"`
	Region      *string                                  `json:"region,omitempty"`
	City        *string                                  `json:"city,omitempty"`
	Coordinates *PeopleProfileCardGeolocationCoordinates `json:"coordinates,omitempty"`
}

PeopleProfileCardGeolocation mapping

type PeopleProfileCardGeolocationCoordinates added in v1.28.4

type PeopleProfileCardGeolocationCoordinates struct {
	Latitude  *float32 `json:"latitude,omitempty"`
	Longitude *float32 `json:"longitude,omitempty"`
}

PeopleProfileCardGeolocationCoordinates mapping

type PeopleProfileCardPerson added in v1.27.0

type PeopleProfileCardPerson struct {
	Nickname    *string                            `json:"nickname,omitempty"`
	Avatar      *string                            `json:"avatar,omitempty"`
	Gender      *string                            `json:"gender,omitempty"`
	Phone       *string                            `json:"phone,omitempty"`
	Address     *string                            `json:"address,omitempty"`
	Description *string                            `json:"description,omitempty"`
	Website     *string                            `json:"website,omitempty"`
	Timezone    *int16                             `json:"timezone,omitempty"`
	Profiles    *[]PeopleProfileCardPersonProfile  `json:"profiles,omitempty"`
	Employment  *PeopleProfileCardPersonEmployment `json:"employment,omitempty"`
	Geolocation *PeopleProfileCardGeolocation      `json:"geolocation,omitempty"`
	Locales     *[]string                          `json:"locales,omitempty"`
}

PeopleProfileCardPerson mapping

type PeopleProfileCardPersonEmployment added in v1.27.0

type PeopleProfileCardPersonEmployment struct {
	Name      *string `json:"name,omitempty"`
	Domain    *string `json:"domain,omitempty"`
	Title     *string `json:"title,omitempty"`
	Role      *string `json:"role,omitempty"`
	Seniority *string `json:"seniority,omitempty"`
}

PeopleProfileCardPersonEmployment mapping

type PeopleProfileCardPersonProfile added in v1.27.0

type PeopleProfileCardPersonProfile struct {
	Type   *string `json:"type,omitempty"`
	Handle *string `json:"handle,omitempty"`
}

PeopleProfileCardPersonProfile mapping

type PeopleProfileData added in v1.27.0

type PeopleProfileData struct {
	Data *PeopleProfile `json:"data,omitempty"`
}

PeopleProfileData mapping

type PeopleProfileImport

type PeopleProfileImport struct {
	ImportID *string `json:"import_id,omitempty"`
}

PeopleProfileImport mapping

func (PeopleProfileImport) String

func (instance PeopleProfileImport) String() string

String returns the string representation of PeopleProfileImport

type PeopleProfileImportData

type PeopleProfileImportData struct {
	Data *PeopleProfileImport `json:"data,omitempty"`
}

PeopleProfileImportData mapping

type PeopleProfileImportSetup

type PeopleProfileImportSetup struct {
	URL     string                             `json:"url,omitempty"`
	Mapping *[]PeopleProfileImportSetupMapping `json:"mapping,omitempty"`
	Options *PeopleProfileImportSetupOptions   `json:"options,omitempty"`
}

PeopleProfileImportSetup mapping

type PeopleProfileImportSetupMapping

type PeopleProfileImportSetupMapping struct {
	Column uint8  `json:"column,omitempty"`
	Field  string `json:"field,omitempty"`
}

PeopleProfileImportSetupMapping mapping

type PeopleProfileImportSetupOptions

type PeopleProfileImportSetupOptions struct {
	ColumnSeparator string `json:"column_separator,omitempty"`
	SkipHeader      bool   `json:"skip_header,omitempty"`
}

PeopleProfileImportSetupOptions mapping

type PeopleProfileListData added in v1.27.0

type PeopleProfileListData struct {
	Data *[]PeopleProfile `json:"data,omitempty"`
}

PeopleProfileListData mapping

type PeopleProfileUpdateCard

type PeopleProfileUpdateCard struct {
	Email    string                    `json:"email,omitempty"`
	Person   *PeopleProfileCardPerson  `json:"person,omitempty"`
	Company  *PeopleProfileCardCompany `json:"company,omitempty"`
	Segments []string                  `json:"segments,omitempty"`
	Notepad  string                    `json:"notepad,omitempty"`
}

PeopleProfileUpdateCard mapping

type PeopleStatistics added in v1.27.0

type PeopleStatistics struct {
	Total *uint64 `json:"total,omitempty"`
}

PeopleStatistics mapping

func (PeopleStatistics) String added in v1.27.0

func (instance PeopleStatistics) String() string

String returns the string representation of PeopleStatistics

type PeopleStatisticsData added in v1.27.0

type PeopleStatisticsData struct {
	Data *PeopleStatistics `json:"data,omitempty"`
}

PeopleStatisticsData mapping

type PeopleSubscription

type PeopleSubscription struct {
	Email *bool `json:"email,omitempty"`
}

PeopleSubscription mapping

func (PeopleSubscription) String

func (instance PeopleSubscription) String() string

String returns the string representation of PeopleSubscription

type PeopleSubscriptionData

type PeopleSubscriptionData struct {
	Data *PeopleSubscription `json:"data,omitempty"`
}

PeopleSubscriptionData mapping

type PeopleSubscriptionUpdate

type PeopleSubscriptionUpdate struct {
	Email bool `json:"email,omitempty"`
}

PeopleSubscriptionUpdate mapping

type PeopleSuggestedData

type PeopleSuggestedData struct {
	Key   *string `json:"key,omitempty"`
	Count *int32  `json:"count,omitempty"`
}

PeopleSuggestedData mapping

func (PeopleSuggestedData) String

func (instance PeopleSuggestedData) String() string

String returns the string representation of PeopleSuggestedData

type PeopleSuggestedDataData

type PeopleSuggestedDataData struct {
	Data *[]PeopleSuggestedData `json:"data,omitempty"`
}

PeopleSuggestedDataData mapping

type PeopleSuggestedSegment

type PeopleSuggestedSegment struct {
	Segment *string `json:"segment,omitempty"`
	Count   *int32  `json:"count,omitempty"`
}

PeopleSuggestedSegment mapping

func (PeopleSuggestedSegment) String

func (instance PeopleSuggestedSegment) String() string

String returns the string representation of PeopleSuggestedSegment

type PeopleSuggestedSegmentData

type PeopleSuggestedSegmentData struct {
	Data *[]PeopleSuggestedSegment `json:"data,omitempty"`
}

PeopleSuggestedSegmentData mapping

type PluginConnectAccount added in v1.4.3

type PluginConnectAccount struct {
	PluginID *string `json:"plugin_id,omitempty"`
}

PluginConnectAccount mapping

func (PluginConnectAccount) String added in v1.4.3

func (instance PluginConnectAccount) String() string

String returns the string representation of PluginConnectAccount

type PluginConnectAccountData added in v1.4.3

type PluginConnectAccountData struct {
	Data *PluginConnectAccount `json:"data,omitempty"`
}

PluginConnectAccountData mapping

type PluginConnectAllWebsites added in v1.1.5

type PluginConnectAllWebsites struct {
	WebsiteID *string      `json:"website_id,omitempty"`
	Token     *string      `json:"token,omitempty"`
	Settings  *interface{} `json:"settings,omitempty"`
}

PluginConnectAllWebsites mapping

func (PluginConnectAllWebsites) String added in v1.1.5

func (instance PluginConnectAllWebsites) String() string

String returns the string representation of PluginConnectAllWebsites

type PluginConnectAllWebsitesData added in v1.1.5

type PluginConnectAllWebsitesData struct {
	Data *[]PluginConnectAllWebsites `json:"data,omitempty"`
}

PluginConnectAllWebsitesData mapping

type PluginConnectWebsitesSince added in v1.1.5

type PluginConnectWebsitesSince struct {
	WebsiteID  *string      `json:"website_id,omitempty"`
	Token      *string      `json:"token,omitempty"`
	Settings   *interface{} `json:"settings,omitempty"`
	Difference *string      `json:"difference,omitempty"`
}

PluginConnectWebsitesSince mapping

func (PluginConnectWebsitesSince) String added in v1.1.5

func (instance PluginConnectWebsitesSince) String() string

String returns the string representation of PluginConnectWebsitesSince

type PluginConnectWebsitesSinceData added in v1.1.5

type PluginConnectWebsitesSinceData struct {
	Data *[]PluginConnectWebsitesSince `json:"data,omitempty"`
}

PluginConnectWebsitesSinceData mapping

type PluginService

type PluginService service

PluginService service

func (*PluginService) CheckConnectSessionValidity added in v1.1.2

func (service *PluginService) CheckConnectSessionValidity() (*Response, error)

CheckConnectSessionValidity checks whether the connected plugin session is valid or not.

func (*PluginService) ClearBlockedVisitorsInRule

func (service *PluginService) ClearBlockedVisitorsInRule(websiteID string, rule string) (*Response, error)

ClearBlockedVisitorsInRule clears all blocked visitors in rule list on website.

func (*PluginService) DispatchPluginEvent

func (service *PluginService) DispatchPluginEvent(websiteID string, pluginID string, payload PluginSubscriptionEventDispatch) (*Response, error)

DispatchPluginEvent dispatches a generic data event for plugin.

func (*PluginService) ForwardPluginPayloadToChannel

func (service *PluginService) ForwardPluginPayloadToChannel(websiteID string, pluginID string, payload PluginSubscriptionChannelForward) (*Response, error)

ForwardPluginPayloadToChannel forwards generic payload given generic namespace to plugin channel.

func (*PluginService) GetConnectAccount added in v1.4.4

func (service *PluginService) GetConnectAccount() (*PluginConnectAccount, *Response, error)

GetConnectAccount resolves the current plugin account information.

func (*PluginService) GetSubscriptionDetails

func (service *PluginService) GetSubscriptionDetails(websiteID string, pluginID string) (*PluginSubscription, *Response, error)

GetSubscriptionDetails resolves details on a given subscription.

func (*PluginService) GetSubscriptionSettings

func (service *PluginService) GetSubscriptionSettings(websiteID string, pluginID string) (*PluginSubscriptionSettings, *Response, error)

GetSubscriptionSettings resolves plugin subscription settings. Used to read plugin configuration on a given website.

func (*PluginService) ListAllActiveSubscriptions

func (service *PluginService) ListAllActiveSubscriptions() (*[]PluginSubscription, *Response, error)

ListAllActiveSubscriptions lists all active plugin subscriptions on all websites, linked to payment methods owned by the user, or from websites the user is member of.

func (*PluginService) ListAllConnectWebsites added in v1.1.5

func (service *PluginService) ListAllConnectWebsites(pageNumber uint, filterConfigured bool) (*[]PluginConnectAllWebsites, *Response, error)

ListAllConnectWebsites lists all websites linked to connected plugin.

func (*PluginService) ListConnectWebsitesSince added in v1.1.5

func (service *PluginService) ListConnectWebsitesSince(dateSince time.Time, filterConfigured bool) (*[]PluginConnectWebsitesSince, *Response, error)

ListConnectWebsitesSince lists the websites linked or unlinked or updated for connected plugin, since given date.

func (*PluginService) ListSubscriptionsForWebsite

func (service *PluginService) ListSubscriptionsForWebsite(websiteID string) (*[]PluginSubscription, *Response, error)

ListSubscriptionsForWebsite lists plugin subscriptions for given website.

func (*PluginService) SaveSubscriptionSettings

func (service *PluginService) SaveSubscriptionSettings(websiteID string, pluginID string, settings interface{}) (*Response, error)

SaveSubscriptionSettings saves plugin subscription settings (overwrites existing settings). Used to configure a given plugin on a given website.

func (*PluginService) SubscribeWebsiteToPlugin

func (service *PluginService) SubscribeWebsiteToPlugin(websiteID string, pluginID string) (*Response, error)

SubscribeWebsiteToPlugin subscribes a given website to a given plugin.

func (*PluginService) UnsubscribePluginFromWebsite

func (service *PluginService) UnsubscribePluginFromWebsite(websiteID string, pluginID string) (*Response, error)

UnsubscribePluginFromWebsite unsubscribes a given plugin from a given website.

func (*PluginService) UpdateSubscriptionSettings added in v1.23.4

func (service *PluginService) UpdateSubscriptionSettings(websiteID string, pluginID string, settings interface{}) (*Response, error)

UpdateSubscriptionSettings updates plugin subscription settings (merges with existing settings). Used to configure a given plugin on a given website.

type PluginSubscription

type PluginSubscription struct {
	ID           *string                   `json:"id,omitempty"`
	URN          *string                   `json:"urn,omitempty"`
	Type         *string                   `json:"type,omitempty"`
	Category     *string                   `json:"category,omitempty"`
	Name         *string                   `json:"name,omitempty"`
	Description  *string                   `json:"description,omitempty"`
	Price        *uint16                   `json:"price,omitempty"`
	Plans        *[]PluginSubscriptionPlan `json:"plans,omitempty"`
	Icon         *string                   `json:"icon,omitempty"`
	Banner       *string                   `json:"banner,omitempty"`
	WebsiteURL   *string                   `json:"website_url,omitempty"`
	ContactURL   *string                   `json:"contact_url,omitempty"`
	TermsURL     *string                   `json:"terms_url,omitempty"`
	PrivacyURL   *string                   `json:"privacy_url,omitempty"`
	HelpURL      *string                   `json:"help_url,omitempty"`
	VideoURL     *string                   `json:"video_url,omitempty"`
	Configurable *bool                     `json:"configurable,omitempty"`
	Since        *string                   `json:"since,omitempty"`
	Active       *bool                     `json:"active,omitempty"`
	WebsiteID    *string                   `json:"website_id,omitempty"`
	CardID       *string                   `json:"card_id,omitempty"`
}

PluginSubscription mapping

func (PluginSubscription) String

func (instance PluginSubscription) String() string

String returns the string representation of PluginSubscription

type PluginSubscriptionChannelForward

type PluginSubscriptionChannelForward struct {
	Namespace  *string      `json:"namespace,omitempty"`
	Identifier *string      `json:"identifier,omitempty"`
	Payload    *interface{} `json:"payload,omitempty"`
}

PluginSubscriptionChannelForward mapping

type PluginSubscriptionCreate

type PluginSubscriptionCreate struct {
	PluginID *string `json:"plugin_id,omitempty"`
}

PluginSubscriptionCreate mapping

type PluginSubscriptionData

type PluginSubscriptionData struct {
	Data *PluginSubscription `json:"data,omitempty"`
}

PluginSubscriptionData mapping

type PluginSubscriptionEventDispatch

type PluginSubscriptionEventDispatch struct {
	Name *string      `json:"name,omitempty"`
	Data *interface{} `json:"data,omitempty"`
}

PluginSubscriptionEventDispatch mapping

type PluginSubscriptionListData

type PluginSubscriptionListData struct {
	Data *[]PluginSubscription `json:"data,omitempty"`
}

PluginSubscriptionListData mapping

type PluginSubscriptionPlan

type PluginSubscriptionPlan struct {
	ID    *string `json:"id,omitempty"`
	Name  *string `json:"name,omitempty"`
	Price *uint16 `json:"price,omitempty"`
}

PluginSubscriptionPlan mapping

type PluginSubscriptionSettings

type PluginSubscriptionSettings struct {
	PluginID        *string      `json:"plugin_id,omitempty"`
	WebsiteID       *string      `json:"website_id,omitempty"`
	Token           *string      `json:"token,omitempty"`
	Schema          *interface{} `json:"schema,omitempty"`
	Settings        *interface{} `json:"settings,omitempty"`
	SettingsFormURL *string      `json:"settings_form_url,omitempty"`
	CallbackURL     *string      `json:"callback_url,omitempty"`
}

PluginSubscriptionSettings mapping

func (PluginSubscriptionSettings) String

func (instance PluginSubscriptionSettings) String() string

String returns the string representation of PluginSubscriptionSettings

type PluginSubscriptionSettingsData

type PluginSubscriptionSettingsData struct {
	Data *PluginSubscriptionSettings `json:"data,omitempty"`
}

PluginSubscriptionSettingsData mapping

type Response

type Response struct {
	*http.Response
}

Response maps an API HTTP response

type Website

type Website struct {
	WebsiteID *string `json:"website_id,omitempty"`
	Name      *string `json:"name,omitempty"`
	Domain    *string `json:"domain,omitempty"`
}

Website mapping

func (Website) String

func (instance Website) String() string

String returns the string representation of Website

type WebsiteAnalyticsClassifier

type WebsiteAnalyticsClassifier struct {
	Classifier *string `json:"classifier,omitempty"`
	Aggregated *uint32 `json:"aggregated,omitempty"`
}

WebsiteAnalyticsClassifier mapping

type WebsiteAnalyticsClassifierData

type WebsiteAnalyticsClassifierData struct {
	Data *[]WebsiteAnalyticsClassifier `json:"data,omitempty"`
}

WebsiteAnalyticsClassifierData mapping

type WebsiteAnalyticsFilter

type WebsiteAnalyticsFilter struct {
	Primary    *string `json:"primary,omitempty"`
	Secondary  *string `json:"secondary,omitempty"`
	Tertiary   *string `json:"tertiary,omitempty"`
	Aggregated *uint32 `json:"aggregated,omitempty"`
}

WebsiteAnalyticsFilter mapping

func (WebsiteAnalyticsFilter) String

func (instance WebsiteAnalyticsFilter) String() string

String returns the string representation of WebsiteAnalyticsFilter

type WebsiteAnalyticsFilterData

type WebsiteAnalyticsFilterData struct {
	Data *[]WebsiteAnalyticsFilter `json:"data,omitempty"`
}

WebsiteAnalyticsFilterData mapping

type WebsiteAnalyticsPoints

type WebsiteAnalyticsPoints struct {
	Pipeline *WebsiteAnalyticsPointsPipeline `json:"pipeline,omitempty"`
	Points   *[]WebsiteAnalyticsPointsPoint  `json:"points,omitempty"`
}

WebsiteAnalyticsPoints mapping

func (WebsiteAnalyticsPoints) String

func (instance WebsiteAnalyticsPoints) String() string

String returns the string representation of WebsiteAnalyticsPoints

type WebsiteAnalyticsPointsData

type WebsiteAnalyticsPointsData struct {
	Data *WebsiteAnalyticsPoints `json:"data,omitempty"`
}

WebsiteAnalyticsPointsData mapping

type WebsiteAnalyticsPointsPipeline

type WebsiteAnalyticsPointsPipeline struct {
	Aggregator *string `json:"aggregator,omitempty"`
}

WebsiteAnalyticsPointsPipeline mapping

type WebsiteAnalyticsPointsPoint

type WebsiteAnalyticsPointsPoint struct {
	Value *uint32                          `json:"value,omitempty"`
	Hits  *uint64                          `json:"hits,omitempty"`
	Date  *WebsiteAnalyticsPointsPointDate `json:"date,omitempty"`
}

WebsiteAnalyticsPointsPoint mapping

type WebsiteAnalyticsPointsPointDate

type WebsiteAnalyticsPointsPointDate struct {
	From *uint64 `json:"from,omitempty"`
	To   *uint64 `json:"to,omitempty"`
}

WebsiteAnalyticsPointsPointDate mapping

type WebsiteAvailabilityOperator

type WebsiteAvailabilityOperator struct {
	UserID *string                          `json:"user_id,omitempty"`
	Type   *string                          `json:"type,omitempty"`
	Time   *WebsiteAvailabilityOperatorTime `json:"time,omitempty"`
}

WebsiteAvailabilityOperator mapping

func (WebsiteAvailabilityOperator) String

func (instance WebsiteAvailabilityOperator) String() string

String returns the string representation of WebsiteAvailabilityOperator

type WebsiteAvailabilityOperatorTime

type WebsiteAvailabilityOperatorTime struct {
	For   *uint32 `json:"for,omitempty"`
	Since *uint64 `json:"since,omitempty"`
}

WebsiteAvailabilityOperatorTime mapping

type WebsiteAvailabilityOperatorsData

type WebsiteAvailabilityOperatorsData struct {
	Data *[]WebsiteAvailabilityOperator `json:"data,omitempty"`
}

WebsiteAvailabilityOperatorsData mapping

type WebsiteAvailabilityStatus

type WebsiteAvailabilityStatus struct {
	Status *string `json:"status,omitempty"`
	Since  *uint64 `json:"since,omitempty"`
}

WebsiteAvailabilityStatus mapping

func (WebsiteAvailabilityStatus) String

func (instance WebsiteAvailabilityStatus) String() string

String returns the string representation of WebsiteAvailabilityStatus

type WebsiteAvailabilityStatusData

type WebsiteAvailabilityStatusData struct {
	Data *WebsiteAvailabilityStatus `json:"data,omitempty"`
}

WebsiteAvailabilityStatusData mapping

type WebsiteBatchConversationsOperation

type WebsiteBatchConversationsOperation struct {
	Sessions *[]string `json:"sessions,omitempty"`
}

WebsiteBatchConversationsOperation mapping

type WebsiteBatchPeopleOperation

type WebsiteBatchPeopleOperation struct {
	People *WebsiteBatchPeopleOperationInner `json:"people,omitempty"`
}

WebsiteBatchPeopleOperation mapping

type WebsiteBatchPeopleOperationInner

type WebsiteBatchPeopleOperationInner struct {
	Profiles *[]string                               `json:"profiles,omitempty"`
	Search   *WebsiteBatchPeopleOperationInnerSearch `json:"search,omitempty"`
}

WebsiteBatchPeopleOperationInner mapping

type WebsiteBatchPeopleOperationInnerSearch

type WebsiteBatchPeopleOperationInnerSearch struct {
	Filter   []WebsiteFilter `json:"filter,omitempty"`
	Operator string          `json:"operator,omitempty"`
}

WebsiteBatchPeopleOperationInnerSearch mapping

type WebsiteCampaignExcerpt added in v1.31.0

type WebsiteCampaignExcerpt struct {
	CampaignID   *string `json:"campaign_id,omitempty"`
	Type         *string `json:"type,omitempty"`
	Format       *string `json:"format,omitempty"`
	Name         *string `json:"name,omitempty"`
	Ready        *bool   `json:"ready,omitempty"`
	Dispatched   *bool   `json:"dispatched,omitempty"`
	Running      *bool   `json:"running,omitempty"`
	Progress     *uint8  `json:"progress,omitempty"`
	Targets      *uint32 `json:"targets,omitempty"`
	Reached      *uint32 `json:"reached,omitempty"`
	CreatedAt    *uint64 `json:"created_at,omitempty"`
	UpdatedAt    *uint64 `json:"updated_at,omitempty"`
	DispatchedAt *uint64 `json:"dispatched_at,omitempty"`
}

WebsiteCampaignExcerpt mapping

func (WebsiteCampaignExcerpt) String added in v1.31.0

func (instance WebsiteCampaignExcerpt) String() string

String returns the string representation of WebsiteCampaignExcerpt

type WebsiteCampaignExcerptsData added in v1.31.0

type WebsiteCampaignExcerptsData struct {
	Data *[]WebsiteCampaignExcerpt `json:"data,omitempty"`
}

WebsiteCampaignExcerptsData mapping

type WebsiteCampaignItem added in v1.31.0

type WebsiteCampaignItem struct {
	WebsiteCampaignExcerpt
	Sender     *WebsiteCampaignItemSender     `json:"sender,omitempty"`
	Recipients *WebsiteCampaignItemRecipients `json:"recipients,omitempty"`
	Flow       *WebsiteCampaignItemFlow       `json:"flow,omitempty"`
	Message    *string                        `json:"message,omitempty"`
	Options    *WebsiteCampaignItemOptions    `json:"options,omitempty"`
	Statistics *WebsiteCampaignItemStatistics `json:"statistics,omitempty"`
}

WebsiteCampaignItem mapping

func (WebsiteCampaignItem) String added in v1.31.0

func (instance WebsiteCampaignItem) String() string

String returns the string representation of WebsiteCampaignItem

type WebsiteCampaignItemData added in v1.31.0

type WebsiteCampaignItemData struct {
	Data *WebsiteCampaignItem `json:"data,omitempty"`
}

WebsiteCampaignItemData mapping

type WebsiteCampaignItemFlow

type WebsiteCampaignItemFlow struct {
	LaunchEvent  *string          `json:"launch_event,omitempty"`
	AssertFilter *[]WebsiteFilter `json:"assert_filter,omitempty"`
	AssertDelay  *uint16          `json:"assert_delay,omitempty"`
	DeliverOnce  *bool            `json:"deliver_once,omitempty"`
	DeliverDelay *uint16          `json:"deliver_delay,omitempty"`
}

WebsiteCampaignItemFlow mapping

type WebsiteCampaignItemOptions added in v1.31.0

type WebsiteCampaignItemOptions struct {
	DeliverToChatbox *bool `json:"deliver_to_chatbox,omitempty"`
	DeliverToEmail   *bool `json:"deliver_to_email,omitempty"`
	Tracking         *bool `json:"tracking,omitempty"`
}

WebsiteCampaignItemOptions mapping

type WebsiteCampaignItemRecipients added in v1.31.0

type WebsiteCampaignItemRecipients struct {
	Type     *string          `json:"type,omitempty"`
	Segments *[]string        `json:"segments,omitempty"`
	People   *[]string        `json:"people,omitempty"`
	Filter   *[]WebsiteFilter `json:"filter,omitempty"`
}

WebsiteCampaignItemRecipients mapping

type WebsiteCampaignItemSender added in v1.31.0

type WebsiteCampaignItemSender struct {
	UserID *string `json:"user_id,omitempty"`
}

WebsiteCampaignItemSender mapping

type WebsiteCampaignItemStatistics

type WebsiteCampaignItemStatistics struct {
	Opened  *uint64 `json:"opened,omitempty"`
	Clicked *uint64 `json:"clicked,omitempty"`
}

WebsiteCampaignItemStatistics mapping

type WebsiteCampaignNew added in v1.31.0

type WebsiteCampaignNew struct {
	CampaignID *string `json:"campaign_id,omitempty"`
}

WebsiteCampaignNew mapping

func (WebsiteCampaignNew) String added in v1.31.0

func (instance WebsiteCampaignNew) String() string

String returns the string representation of WebsiteCampaignNew

type WebsiteCampaignNewData added in v1.31.0

type WebsiteCampaignNewData struct {
	Data *WebsiteCampaignNew `json:"data,omitempty"`
}

WebsiteCampaignNewData mapping

type WebsiteCampaignNewItem added in v1.31.0

type WebsiteCampaignNewItem struct {
	Type string `json:"type"`
	Name string `json:"name"`
}

WebsiteCampaignNewItem mapping

type WebsiteCampaignStatistic

type WebsiteCampaignStatistic struct {
	Profile   *WebsiteCampaignStatisticProfile `json:"profile,omitempty"`
	Data      *interface{}                     `json:"data,omitempty"`
	CreatedAt *uint64                          `json:"created_at,omitempty"`
	UpdatedAt *uint64                          `json:"updated_at,omitempty"`
}

WebsiteCampaignStatistic mapping

func (WebsiteCampaignStatistic) String

func (instance WebsiteCampaignStatistic) String() string

String returns the string representation of WebsiteCampaignStatistic

type WebsiteCampaignStatisticProfile

type WebsiteCampaignStatisticProfile struct {
	PeopleID *string                                `json:"people_id,omitempty"`
	Email    *string                                `json:"email,omitempty"`
	Person   *WebsiteCampaignStatisticProfilePerson `json:"person,omitempty"`
}

WebsiteCampaignStatisticProfile mapping

type WebsiteCampaignStatisticProfilePerson

type WebsiteCampaignStatisticProfilePerson struct {
	Nickname    *string                                           `json:"nickname,omitempty"`
	Avatar      *string                                           `json:"avatar,omitempty"`
	Geolocation *WebsiteCampaignStatisticProfilePersonGeolocation `json:"geolocation,omitempty"`
}

WebsiteCampaignStatisticProfilePerson mapping

type WebsiteCampaignStatisticProfilePersonGeolocation

type WebsiteCampaignStatisticProfilePersonGeolocation struct {
	Country     *string                                                      `json:"country,omitempty"`
	Region      *string                                                      `json:"region,omitempty"`
	City        *string                                                      `json:"city,omitempty"`
	Coordinates *WebsiteCampaignStatisticProfilePersonGeolocationCoordinates `json:"coordinates,omitempty"`
}

WebsiteCampaignStatisticProfilePersonGeolocation mapping

type WebsiteCampaignStatisticProfilePersonGeolocationCoordinates

type WebsiteCampaignStatisticProfilePersonGeolocationCoordinates struct {
	Latitude  *float32 `json:"latitude,omitempty"`
	Longitude *float32 `json:"longitude,omitempty"`
}

WebsiteCampaignStatisticProfilePersonGeolocationCoordinates mapping

type WebsiteCampaignStatisticsData

type WebsiteCampaignStatisticsData struct {
	Data *[]WebsiteCampaignStatistic `json:"data,omitempty"`
}

WebsiteCampaignStatisticsData mapping

type WebsiteCampaignTemplateExcerpt

type WebsiteCampaignTemplateExcerpt struct {
	TemplateID *string `json:"template_id,omitempty"`
	Name       *string `json:"name,omitempty"`
	Format     *string `json:"format,omitempty"`
	CreatedAt  *uint64 `json:"created_at,omitempty"`
	UpdatedAt  *uint64 `json:"updated_at,omitempty"`
}

WebsiteCampaignTemplateExcerpt mapping

func (WebsiteCampaignTemplateExcerpt) String

func (instance WebsiteCampaignTemplateExcerpt) String() string

String returns the string representation of WebsiteCampaignTemplateExcerpt

type WebsiteCampaignTemplateExcerptsData

type WebsiteCampaignTemplateExcerptsData struct {
	Data *[]WebsiteCampaignTemplateExcerpt `json:"data,omitempty"`
}

WebsiteCampaignTemplateExcerptsData mapping

type WebsiteCampaignTemplateItem

type WebsiteCampaignTemplateItem struct {
	WebsiteCampaignTemplateExcerpt
	Content *string `json:"content,omitempty"`
}

WebsiteCampaignTemplateItem mapping

func (WebsiteCampaignTemplateItem) String

func (instance WebsiteCampaignTemplateItem) String() string

String returns the string representation of WebsiteCampaignTemplateItem

type WebsiteCampaignTemplateItemData

type WebsiteCampaignTemplateItemData struct {
	Data *WebsiteCampaignTemplateItem `json:"data,omitempty"`
}

WebsiteCampaignTemplateItemData mapping

type WebsiteCampaignTemplateNew

type WebsiteCampaignTemplateNew struct {
	TemplateID *string `json:"template_id,omitempty"`
}

WebsiteCampaignTemplateNew mapping

func (WebsiteCampaignTemplateNew) String

func (instance WebsiteCampaignTemplateNew) String() string

String returns the string representation of WebsiteCampaignTemplateNew

type WebsiteCampaignTemplateNewData

type WebsiteCampaignTemplateNewData struct {
	Data *WebsiteCampaignTemplateNew `json:"data,omitempty"`
}

WebsiteCampaignTemplateNewData mapping

type WebsiteCampaignTemplateNewItem

type WebsiteCampaignTemplateNewItem struct {
	Format string `json:"format"`
	Name   string `json:"name"`
}

WebsiteCampaignTemplateNewItem mapping

type WebsiteCreate

type WebsiteCreate struct {
	Name   string `json:"name,omitempty"`
	Domain string `json:"domain,omitempty"`
}

WebsiteCreate mapping

type WebsiteData

type WebsiteData struct {
	Data *Website `json:"data,omitempty"`
}

WebsiteData mapping

type WebsiteFilter

type WebsiteFilter struct {
	Model     *string        `json:"model,omitempty"`
	Criterion *string        `json:"criterion,omitempty"`
	Operator  *string        `json:"operator,omitempty"`
	Query     *[]interface{} `json:"query,omitempty"`
}

WebsiteFilter mapping

type WebsiteOperator

type WebsiteOperator struct {
	UserID       *string `json:"user_id,omitempty"`
	Email        *string `json:"email,omitempty"`
	Avatar       *string `json:"avatar,omitempty"`
	FirstName    *string `json:"first_name,omitempty"`
	LastName     *string `json:"last_name,omitempty"`
	Role         *string `json:"role,omitempty"`
	Title        *string `json:"title,omitempty"`
	Availability *string `json:"availability,omitempty"`
	HasToken     *bool   `json:"has_token,omitempty"`
}

WebsiteOperator mapping

func (WebsiteOperator) String

func (instance WebsiteOperator) String() string

String returns the string representation of WebsiteOperator

type WebsiteOperatorData

type WebsiteOperatorData struct {
	Data *WebsiteOperator `json:"data,omitempty"`
}

WebsiteOperatorData mapping

type WebsiteOperatorEdit

type WebsiteOperatorEdit struct {
	Role  *string `json:"role,omitempty"`
	Title *string `json:"title,omitempty"`
}

WebsiteOperatorEdit mapping

type WebsiteOperatorEmail

type WebsiteOperatorEmail struct {
	Recipient *string                     `json:"recipient,omitempty"`
	UserID    *string                     `json:"user_id,omitempty"`
	Subject   *string                     `json:"subject,omitempty"`
	Message   *string                     `json:"message,omitempty"`
	Target    *WebsiteOperatorEmailTarget `json:"target,omitempty"`
}

WebsiteOperatorEmail mapping

type WebsiteOperatorEmailTarget

type WebsiteOperatorEmailTarget struct {
	Label *string `json:"label,omitempty"`
	URL   *string `json:"url,omitempty"`
}

WebsiteOperatorEmailTarget mapping

type WebsiteOperatorInvite

type WebsiteOperatorInvite struct {
	Email  *string `json:"email,omitempty"`
	Role   *string `json:"role,omitempty"`
	Verify *string `json:"verify,omitempty"`
}

WebsiteOperatorInvite mapping

type WebsiteOperatorListData

type WebsiteOperatorListData struct {
	Data *[]WebsiteOperatorListOne `json:"data,omitempty"`
}

WebsiteOperatorListData mapping

type WebsiteOperatorListOne

type WebsiteOperatorListOne struct {
	Type    *string          `json:"type,omitempty"`
	Details *WebsiteOperator `json:"details,omitempty"`
}

WebsiteOperatorListOne mapping

func (WebsiteOperatorListOne) String

func (instance WebsiteOperatorListOne) String() string

String returns the string representation of WebsiteOperatorListOne

type WebsiteOperatorsLastActiveListData

type WebsiteOperatorsLastActiveListData struct {
	Data *[]WebsiteOperatorsLastActiveListOne `json:"data,omitempty"`
}

WebsiteOperatorsLastActiveListData mapping

type WebsiteOperatorsLastActiveListOne

type WebsiteOperatorsLastActiveListOne struct {
	UserID    *string `json:"user_id,omitempty"`
	Avatar    *string `json:"avatar,omitempty"`
	Nickname  *string `json:"nickname,omitempty"`
	Timestamp *uint64 `json:"timestamp,omitempty"`
}

WebsiteOperatorsLastActiveListOne mapping

type WebsiteRemove

type WebsiteRemove struct {
	Verify *string `json:"verify,omitempty"`
}

WebsiteRemove mapping

type WebsiteService

type WebsiteService service

WebsiteService service

func (*WebsiteService) AbortOngoingCallSessionForConversation

func (service *WebsiteService) AbortOngoingCallSessionForConversation(websiteID string, sessionID string, callID string) (*Response, error)

AbortOngoingCallSessionForConversation aborts the ongoing audio/video call session for conversation.

func (*WebsiteService) AcquireAnalyticsPoints

func (service *WebsiteService) AcquireAnalyticsPoints(websiteID string, pointType string, pointMetric string, dateFrom time.Time, dateTo time.Time, dateSplit string, classifier string, filterPrimary string, filterSecondary string, filterTertiary string) (*WebsiteAnalyticsPoints, *Response, error)

AcquireAnalyticsPoints acquires analytics points for given type and metric in website.

func (*WebsiteService) AddNewPeopleProfile added in v1.27.0

func (service *WebsiteService) AddNewPeopleProfile(websiteID string, peopleProfile PeopleProfileUpdateCard) (*Response, error)

AddNewPeopleProfile adds a new people profile.

func (*WebsiteService) AddPeopleEvent

func (service *WebsiteService) AddPeopleEvent(websiteID string, peopleID string, peopleEvent PeopleEventAdd) (*Response, error)

AddPeopleEvent stacks an event for people.

func (*WebsiteService) AssignConversationRouting

func (service *WebsiteService) AssignConversationRouting(websiteID string, sessionID string, assign ConversationRoutingAssignUpdate) (*Response, error)

AssignConversationRouting assigns conversation routing to an operator, or unassign.

func (*WebsiteService) AssistExistingBrowsingSession

func (service *WebsiteService) AssistExistingBrowsingSession(websiteID string, sessionID string, browsingID string, assist ConversationBrowsingAssist) (*Response, error)

AssistExistingBrowsingSession assists an existing browsing session.

func (*WebsiteService) BatchReadConversations

func (service *WebsiteService) BatchReadConversations(websiteID string, sessions []string) (*Response, error)

BatchReadConversations marks given (or all) items as read in website (conversation variant).

func (*WebsiteService) BatchRemoveConversations

func (service *WebsiteService) BatchRemoveConversations(websiteID string, sessions []string) (*Response, error)

BatchRemoveConversations removes given items in website (conversation variant).

func (*WebsiteService) BatchRemovePeople

func (service *WebsiteService) BatchRemovePeople(websiteID string, people WebsiteBatchPeopleOperationInner) (*Response, error)

BatchRemovePeople removes given items in website (people variant).

func (*WebsiteService) BatchResolveConversations

func (service *WebsiteService) BatchResolveConversations(websiteID string, sessions []string) (*Response, error)

BatchResolveConversations resolves given (or all) items in website (conversation variant).

func (*WebsiteService) BlockIncomingMessagesForConversation

func (service *WebsiteService) BlockIncomingMessagesForConversation(websiteID string, sessionID string, blocked bool) (*Response, error)

BlockIncomingMessagesForConversation blocks further incoming messages from a conversation.

func (*WebsiteService) ChangeConversationState

func (service *WebsiteService) ChangeConversationState(websiteID string, sessionID string, state string) (*Response, error)

ChangeConversationState updates conversation state.

func (*WebsiteService) ChangeOperatorMembership

func (service *WebsiteService) ChangeOperatorMembership(websiteID string, userID string, role string, title *string) (*Response, error)

ChangeOperatorMembership changes the membership of an existing operator.

func (*WebsiteService) CheckCampaignExists added in v1.31.0

func (service *WebsiteService) CheckCampaignExists(websiteID string, campaignID string) (*Response, error)

CheckCampaignExists checks if given campaign exists.

func (*WebsiteService) CheckCampaignTemplateExists

func (service *WebsiteService) CheckCampaignTemplateExists(websiteID string, templateID string) (*Response, error)

CheckCampaignTemplateExists checks if given campaign template exists.

func (*WebsiteService) CheckConversationExists

func (service *WebsiteService) CheckConversationExists(websiteID string, sessionID string) (*Response, error)

CheckConversationExists checks if given conversation session identifier exists.

func (*WebsiteService) CheckPeopleProfileExists added in v1.27.0

func (service *WebsiteService) CheckPeopleProfileExists(websiteID string, peopleID string) (*Response, error)

CheckPeopleProfileExists checks if given people profile exists.

func (*WebsiteService) CheckWebsiteExists

func (service *WebsiteService) CheckWebsiteExists(domain string) (*Response, error)

CheckWebsiteExists checks if given website exists (by domain).

func (*WebsiteService) ComposeMessageInConversation added in v1.2.0

func (service *WebsiteService) ComposeMessageInConversation(websiteID string, sessionID string, compose ConversationComposeMessageNew) (*Response, error)

ComposeMessageInConversation starts or stop composing a message in an existing conversation.

func (*WebsiteService) CountBlockedVisitors

func (service *WebsiteService) CountBlockedVisitors(websiteID string) (*[]WebsiteVisitorsBlocked, *Response, error)

CountBlockedVisitors counts all blocked visitors on website, by rule list.

func (*WebsiteService) CountBlockedVisitorsInRule

func (service *WebsiteService) CountBlockedVisitorsInRule(websiteID string, rule string) (*WebsiteVisitorsBlocked, *Response, error)

CountBlockedVisitorsInRule counts all blocked visitors in rule list on website.

func (*WebsiteService) CountVisitors added in v1.11.0

func (service *WebsiteService) CountVisitors(websiteID string) (*WebsiteVisitorCount, *Response, error)

CountVisitors counts visitors currently on website.

func (*WebsiteService) CreateNewCampaign added in v1.31.0

func (service *WebsiteService) CreateNewCampaign(websiteID string, campaignType string, campaignName string) (*WebsiteCampaignNew, *Response, error)

CreateNewCampaign creates a new campaign.

func (*WebsiteService) CreateNewCampaignTemplate

func (service *WebsiteService) CreateNewCampaignTemplate(websiteID string, templateFormat string, templateName string) (*WebsiteCampaignTemplateNew, *Response, error)

CreateNewCampaignTemplate creates a new campaign template.

func (*WebsiteService) CreateNewConversation

func (service *WebsiteService) CreateNewConversation(websiteID string) (*ConversationNew, *Response, error)

CreateNewConversation creates a new conversation.

func (*WebsiteService) CreateWebsite

func (service *WebsiteService) CreateWebsite(websiteData WebsiteCreate) (*Website, *Response, error)

CreateWebsite creates a new website.

func (*WebsiteService) DebugExistingBrowsingSession

func (service *WebsiteService) DebugExistingBrowsingSession(websiteID string, sessionID string, browsingID string, debug ConversationBrowsingDebug) (*Response, error)

DebugExistingBrowsingSession debugs an existing browsing session.

func (*WebsiteService) DeleteWebsite

func (service *WebsiteService) DeleteWebsite(websiteID string, verify string) (*Response, error)

DeleteWebsite deletes an existing website.

func (*WebsiteService) DispatchCampaign added in v1.31.6

func (service *WebsiteService) DispatchCampaign(websiteID string, campaignID string) (*Response, error)

DispatchCampaign dispatches a ready campaign.

func (*WebsiteService) ExportPeopleProfiles

func (service *WebsiteService) ExportPeopleProfiles(websiteID string) (*Response, error)

ExportPeopleProfiles exports people profiles.

func (*WebsiteService) FilterCampaigns added in v1.31.0

func (service *WebsiteService) FilterCampaigns(websiteID string, pageNumber uint, searchName string, filterTypeOneShot bool, filterTypeAutomated bool, filterStatusNotConfigured bool, filterStatusReady bool, filterStatusPaused bool, filterStatusSending bool, filterStatusDone bool) (*[]WebsiteCampaignExcerpt, *Response, error)

FilterCampaigns lists campaigns for website (filter variant).

func (*WebsiteService) FlushLastActiveWebsiteOperators

func (service *WebsiteService) FlushLastActiveWebsiteOperators(websiteID string) (*Response, error)

FlushLastActiveWebsiteOperators flushes the list of last active website operators.

func (*WebsiteService) GetBlockStatusForConversation added in v1.6.1

func (service *WebsiteService) GetBlockStatusForConversation(websiteID string, sessionID string) (*ConversationBlock, *Response, error)

GetBlockStatusForConversation resolves conversation block status.

func (*WebsiteService) GetCampaign added in v1.31.0

func (service *WebsiteService) GetCampaign(websiteID string, campaignID string) (*WebsiteCampaignItem, *Response, error)

GetCampaign resolves campaign information.

func (*WebsiteService) GetCampaignTemplate

func (service *WebsiteService) GetCampaignTemplate(websiteID string, templateID string) (*WebsiteCampaignTemplateItem, *Response, error)

GetCampaignTemplate resolves campaign template information.

func (*WebsiteService) GetConversation

func (service *WebsiteService) GetConversation(websiteID string, sessionID string) (*Conversation, *Response, error)

GetConversation resolves conversation information and messages.

func (*WebsiteService) GetConversationMetas added in v1.6.0

func (service *WebsiteService) GetConversationMetas(websiteID string, sessionID string) (*ConversationMeta, *Response, error)

GetConversationMetas resolves conversation meta information.

func (*WebsiteService) GetConversationParticipants

func (service *WebsiteService) GetConversationParticipants(websiteID string, sessionID string) (*ConversationParticipants, *Response, error)

GetConversationParticipants resolves conversation participants.

func (*WebsiteService) GetConversationRoutingAssign

func (service *WebsiteService) GetConversationRoutingAssign(websiteID string, sessionID string) (*ConversationRoutingAssign, *Response, error)

GetConversationRoutingAssign resolves assigned operator for conversation routing.

func (*WebsiteService) GetConversationState added in v1.6.0

func (service *WebsiteService) GetConversationState(websiteID string, sessionID string) (*ConversationState, *Response, error)

GetConversationState resolves conversation state.

func (*WebsiteService) GetMessageInConversation

func (service *WebsiteService) GetMessageInConversation(websiteID string, sessionID string, fingerprint int) (*ConversationMessage, *Response, error)

GetMessageInConversation resolves an existing message in an existing conversation.

func (*WebsiteService) GetMessagesInConversationBefore added in v1.24.0

func (service *WebsiteService) GetMessagesInConversationBefore(websiteID string, sessionID string, timestampBefore uint32) (*[]ConversationMessage, *Response, error)

GetMessagesInConversationBefore resolves messages in an existing conversation (before variant).

func (*WebsiteService) GetMessagesInConversationLast added in v1.24.0

func (service *WebsiteService) GetMessagesInConversationLast(websiteID string, sessionID string) (*[]ConversationMessage, *Response, error)

GetMessagesInConversationLast resolves messages in an existing conversation (last variant).

func (*WebsiteService) GetOngoingCallSessionForConversation

func (service *WebsiteService) GetOngoingCallSessionForConversation(websiteID string, sessionID string) (*ConversationCall, *Response, error)

GetOngoingCallSessionForConversation gets the ongoing audio/video call session for conversation.

func (*WebsiteService) GetOriginalMessageInConversation

func (service *WebsiteService) GetOriginalMessageInConversation(websiteID string, sessionID string, originalID string) (*ConversationOriginal, *Response, error)

GetOriginalMessageInConversation resolves conversation original message.

func (*WebsiteService) GetPeopleData

func (service *WebsiteService) GetPeopleData(websiteID string, peopleID string) (*PeopleData, *Response, error)

GetPeopleData gets stored data for people.

func (*WebsiteService) GetPeopleProfile added in v1.27.0

func (service *WebsiteService) GetPeopleProfile(websiteID string, peopleID string) (*PeopleProfile, *Response, error)

GetPeopleProfile resolves people profile.

func (*WebsiteService) GetPeopleStatistics added in v1.27.0

func (service *WebsiteService) GetPeopleStatistics(websiteID string) (*PeopleStatistics, *Response, error)

GetPeopleStatistics resolves statistics on people in website.

func (*WebsiteService) GetPeopleSubscriptionStatus

func (service *WebsiteService) GetPeopleSubscriptionStatus(websiteID string, peopleID string) (*PeopleSubscription, *Response, error)

GetPeopleSubscriptionStatus resolves subscription status for people.

func (*WebsiteService) GetSessionIdentifierFromToken

func (service *WebsiteService) GetSessionIdentifierFromToken(websiteID string, tokenID string) (*WebsiteVisitorsToken, *Response, error)

GetSessionIdentifierFromToken transforms a token to a session identifier, if any session is bound to the token.

func (*WebsiteService) GetWebsite

func (service *WebsiteService) GetWebsite(websiteID string) (*Website, *Response, error)

GetWebsite resolves an existing website information.

func (*WebsiteService) GetWebsiteAvailabilityStatus

func (service *WebsiteService) GetWebsiteAvailabilityStatus(websiteID string) (*WebsiteAvailabilityStatus, *Response, error)

GetWebsiteAvailabilityStatus resolves the website availability status. This tells whether the chatbox is seen as online or away by visitors.

func (*WebsiteService) GetWebsiteOperator

func (service *WebsiteService) GetWebsiteOperator(websiteID string, userID string) (*WebsiteOperator, *Response, error)

GetWebsiteOperator resolves a given website operator.

func (*WebsiteService) GetWebsiteSettings

func (service *WebsiteService) GetWebsiteSettings(websiteID string) (*WebsiteSettings, *Response, error)

GetWebsiteSettings resolves the current settings for a website.

func (*WebsiteService) ImportPeopleProfiles

func (service *WebsiteService) ImportPeopleProfiles(websiteID string, profileImportSetup PeopleProfileImportSetup) (*PeopleProfileImport, *Response, error)

ImportPeopleProfiles imports people profiles.

func (*WebsiteService) InitiateBrowsingSessionForConversation

func (service *WebsiteService) InitiateBrowsingSessionForConversation(websiteID string, sessionID string) (*Response, error)

InitiateBrowsingSessionForConversation initiates browsing session for conversation.

func (*WebsiteService) InitiateConversationWithExistingSession

func (service *WebsiteService) InitiateConversationWithExistingSession(websiteID string, sessionID string) (*Response, error)

InitiateConversationWithExistingSession initiates a conversation from an existing session.

func (*WebsiteService) InitiateNewCallSessionForConversation

func (service *WebsiteService) InitiateNewCallSessionForConversation(websiteID string, sessionID string, mode string) (*ConversationCall, *Response, error)

InitiateNewCallSessionForConversation initiates a new audio/video call session for conversation.

func (*WebsiteService) InviteWebsiteOperator

func (service *WebsiteService) InviteWebsiteOperator(websiteID string, email string, role string, verify string) (*Response, error)

InviteWebsiteOperator invites an email to join website as operator.

func (*WebsiteService) ListAnalyticsClassifiers

func (service *WebsiteService) ListAnalyticsClassifiers(websiteID string, pageNumber uint, pointType string, pointMetric string, dateFrom time.Time, dateTo time.Time) (*[]WebsiteAnalyticsClassifier, *Response, error)

ListAnalyticsClassifiers acquires available analytics classifiers in website.

func (*WebsiteService) ListAnalyticsFilters

func (service *WebsiteService) ListAnalyticsFilters(websiteID string, pageNumber uint, pointType string, pointMetric string, dateFrom time.Time, dateTo time.Time) (*[]WebsiteAnalyticsFilter, *Response, error)

ListAnalyticsFilters acquires available analytics filters in website.

func (*WebsiteService) ListAnimationMedias added in v1.18.0

func (service *WebsiteService) ListAnimationMedias(pageNumber uint, listID int, searchQuery string) (*Response, error)

ListAnimationMedias lists animation medias.

func (*WebsiteService) ListBrowsingSessionsForConversation added in v1.23.0

func (service *WebsiteService) ListBrowsingSessionsForConversation(websiteID string, sessionID string) (*[]ConversationBrowsing, *Response, error)

ListBrowsingSessionsForConversation lists available browsing sessions for conversation.

func (*WebsiteService) ListCampaignStatistics

func (service *WebsiteService) ListCampaignStatistics(websiteID string, campaignID string, action string, pageNumber uint) (*[]WebsiteCampaignStatistic, *Response, error)

ListCampaignStatistics lists campaigns statistics on action for website.

func (*WebsiteService) ListCampaignTemplates

func (service *WebsiteService) ListCampaignTemplates(websiteID string, pageNumber uint) (*[]WebsiteCampaignTemplateExcerpt, *Response, error)

ListCampaignTemplates lists campaign templates for website.

func (*WebsiteService) ListCampaigns added in v1.31.0

func (service *WebsiteService) ListCampaigns(websiteID string, pageNumber uint) (*[]WebsiteCampaignExcerpt, *Response, error)

ListCampaigns lists campaigns for website.

func (*WebsiteService) ListConversationEvents

func (service *WebsiteService) ListConversationEvents(websiteID string, sessionID string, pageNumber uint) (*[]ConversationEvent, *Response, error)

ListConversationEvents lists stacked events in conversation.

func (*WebsiteService) ListConversationPages

func (service *WebsiteService) ListConversationPages(websiteID string, sessionID string, pageNumber uint) (*[]ConversationPage, *Response, error)

ListConversationPages lists browsed pages in conversation.

func (*WebsiteService) ListConversations

func (service *WebsiteService) ListConversations(websiteID string, pageNumber uint) (*[]Conversation, *Response, error)

ListConversations lists conversations for website.

func (*WebsiteService) ListLastActiveWebsiteOperators

func (service *WebsiteService) ListLastActiveWebsiteOperators(websiteID string) (*[]WebsiteOperatorsLastActiveListOne, *Response, error)

ListLastActiveWebsiteOperators lists last active website operators.

func (*WebsiteService) ListPeopleConversations

func (service *WebsiteService) ListPeopleConversations(websiteID string, peopleID string, pageNumber uint) ([]string, *Response, error)

ListPeopleConversations lists conversations linked to people.

func (*WebsiteService) ListPeopleEvents

func (service *WebsiteService) ListPeopleEvents(websiteID string, peopleID string, pageNumber uint) (*[]PeopleEvent, *Response, error)

ListPeopleEvents lists stacked events for people.

func (*WebsiteService) ListPeopleProfiles added in v1.27.0

func (service *WebsiteService) ListPeopleProfiles(websiteID string, pageNumber uint, searchField string, searchOrder string, searchOperator string, searchFilter []PeopleFilter, searchText string) (*[]PeopleProfile, *Response, error)

ListPeopleProfiles lists people profiles for website.

func (*WebsiteService) ListSuggestedConversationDataKeys

func (service *WebsiteService) ListSuggestedConversationDataKeys(websiteID string, pageNumber uint) (*[]ConversationSuggestedData, *Response, error)

ListSuggestedConversationDataKeys lists suggested conversation data keys for website.

func (*WebsiteService) ListSuggestedConversationSegments

func (service *WebsiteService) ListSuggestedConversationSegments(websiteID string, pageNumber uint) (*[]ConversationSuggestedSegment, *Response, error)

ListSuggestedConversationSegments lists suggested conversation segments for website.

func (*WebsiteService) ListSuggestedPeopleDataKeys

func (service *WebsiteService) ListSuggestedPeopleDataKeys(websiteID string, pageNumber uint) (*[]PeopleSuggestedData, *Response, error)

ListSuggestedPeopleDataKeys lists suggested data keys for people.

func (*WebsiteService) ListSuggestedPeopleSegments

func (service *WebsiteService) ListSuggestedPeopleSegments(websiteID string, pageNumber uint) (*[]PeopleSuggestedSegment, *Response, error)

ListSuggestedPeopleSegments lists suggested segments for people.

func (*WebsiteService) ListVisitors

func (service *WebsiteService) ListVisitors(websiteID string, pageNumber uint) (*[]WebsiteVisitor, *Response, error)

ListVisitors lists visitors currently on website.

func (*WebsiteService) ListWebsiteOperatorAvailabilities

func (service *WebsiteService) ListWebsiteOperatorAvailabilities(websiteID string) (*[]WebsiteAvailabilityOperator, *Response, error)

ListWebsiteOperatorAvailabilities lists the availabilities for website operators. This maps the availability of each operator in the website.

func (*WebsiteService) ListWebsiteOperators

func (service *WebsiteService) ListWebsiteOperators(websiteID string) (*[]WebsiteOperatorListOne, *Response, error)

ListWebsiteOperators lists all operator members of website.

func (*WebsiteService) MarkMessagesDeliveredInConversation

func (service *WebsiteService) MarkMessagesDeliveredInConversation(websiteID string, sessionID string, delivered ConversationDeliveredMessageMark) (*Response, error)

MarkMessagesDeliveredInConversation marks messages as delivered in conversation. Either using given message fingerprints, or all messages.

func (*WebsiteService) MarkMessagesReadInConversation added in v1.2.2

func (service *WebsiteService) MarkMessagesReadInConversation(websiteID string, sessionID string, read ConversationReadMessageMark) (*Response, error)

MarkMessagesReadInConversation marks messages as read in conversation. Either using given message fingerprints, or all messages.

func (*WebsiteService) PauseCampaign added in v1.31.0

func (service *WebsiteService) PauseCampaign(websiteID string, campaignID string) (*Response, error)

PauseCampaign pauses a dispatched campaign.

func (*WebsiteService) PinpointVisitorsOnMapArea

func (service *WebsiteService) PinpointVisitorsOnMapArea(websiteID string, centerLongitude float32, centerLatitude float32, centerRadius uint) (*[]WebsiteVisitorsMapPoint, *Response, error)

PinpointVisitorsOnMapArea maps visitors in a geographical area, given a geographical center and a map radius (area variant).

func (*WebsiteService) PinpointVisitorsOnMapWide

func (service *WebsiteService) PinpointVisitorsOnMapWide(websiteID string) (*[]WebsiteVisitorsMapPoint, *Response, error)

PinpointVisitorsOnMapWide maps visitors in a geographical area, given a geographical center and a map radius (wide variant).

func (*WebsiteService) RemoveCampaign added in v1.31.0

func (service *WebsiteService) RemoveCampaign(websiteID string, campaignID string) (*Response, error)

RemoveCampaign removes a campaign in website.

func (*WebsiteService) RemoveCampaignTemplate

func (service *WebsiteService) RemoveCampaignTemplate(websiteID string, templateID string) (*Response, error)

RemoveCampaignTemplate removes a campaign template in website.

func (*WebsiteService) RemoveConversation

func (service *WebsiteService) RemoveConversation(websiteID string, sessionID string) (*Response, error)

RemoveConversation removes a conversation in website.

func (*WebsiteService) RemovePeopleProfile added in v1.27.0

func (service *WebsiteService) RemovePeopleProfile(websiteID string, peopleID string) (*Response, error)

RemovePeopleProfile removes people profile in website.

func (*WebsiteService) RequestChatboxBindingPurgeForConversation

func (service *WebsiteService) RequestChatboxBindingPurgeForConversation(websiteID string, sessionID string) (*Response, error)

RequestChatboxBindingPurgeForConversation requests a chatbox binding purge for conversation.

func (*WebsiteService) RequestEmailTranscriptForConversation added in v1.20.2

func (service *WebsiteService) RequestEmailTranscriptForConversation(websiteID string, sessionID string, to string, email string) (*Response, error)

RequestEmailTranscriptForConversation requests an email transcript for a conversation.

func (*WebsiteService) ResumeCampaign added in v1.31.1

func (service *WebsiteService) ResumeCampaign(websiteID string, campaignID string) (*Response, error)

ResumeCampaign resumes a dispatched campaign.

func (*WebsiteService) SaveCampaign added in v1.31.0

func (service *WebsiteService) SaveCampaign(websiteID string, campaignID string, websiteCampaignItem WebsiteCampaignItem) (*Response, error)

SaveCampaign saves a campaign in website, and overwrite previous campaign information.

func (*WebsiteService) SaveCampaignTemplate

func (service *WebsiteService) SaveCampaignTemplate(websiteID string, templateID string, websiteCampaignTemplateItem WebsiteCampaignTemplateItem) (*Response, error)

SaveCampaignTemplate saves a campaign template in website, and overwrite previous template information.

func (*WebsiteService) SaveConversationParticipants

func (service *WebsiteService) SaveConversationParticipants(websiteID string, sessionID string, participants ConversationParticipantsSave) (*Response, error)

SaveConversationParticipants saves conversation participants.

func (*WebsiteService) SavePeopleData

func (service *WebsiteService) SavePeopleData(websiteID string, peopleID string, peopleData interface{}) (*Response, error)

SavePeopleData saves stored data for people.

func (*WebsiteService) SavePeopleProfile added in v1.27.0

func (service *WebsiteService) SavePeopleProfile(websiteID string, peopleID string, peopleProfile PeopleProfileUpdateCard) (*Response, error)

SavePeopleProfile saves people profile, and overwrite all previous information.

func (*WebsiteService) ScheduleReminderForConversation

func (service *WebsiteService) ScheduleReminderForConversation(websiteID string, sessionID string, date string, note string) (*Response, error)

ScheduleReminderForConversation schedules a reminder in the future for conversation.

func (*WebsiteService) SearchConversations

func (service *WebsiteService) SearchConversations(websiteID string, pageNumber uint, searchQuery string, searchType string) (*[]Conversation, *Response, error)

SearchConversations searches conversations for website.

func (*WebsiteService) SendActionToExistingBrowsingSession added in v1.23.0

func (service *WebsiteService) SendActionToExistingBrowsingSession(websiteID string, sessionID string, browsingID string, action string) (*Response, error)

SendActionToExistingBrowsingSession sends an action to an existing browsing session.

func (*WebsiteService) SendAnimationMessageInConversation added in v1.16.0

func (service *WebsiteService) SendAnimationMessageInConversation(websiteID string, sessionID string, message ConversationAnimationMessageNew) (*ConversationMessageDispatched, *Response, error)

SendAnimationMessageInConversation sends a message in an existing conversation (animation variant).

func (*WebsiteService) SendAudioMessageInConversation

func (service *WebsiteService) SendAudioMessageInConversation(websiteID string, sessionID string, message ConversationAudioMessageNew) (*ConversationMessageDispatched, *Response, error)

SendAudioMessageInConversation sends a message in an existing conversation (audio variant).

func (*WebsiteService) SendEmailToWebsiteOperators

func (service *WebsiteService) SendEmailToWebsiteOperators(websiteID string, email WebsiteOperatorEmail) (*Response, error)

SendEmailToWebsiteOperators sends an email to target website operators.

func (*WebsiteService) SendEventMessageInConversation

func (service *WebsiteService) SendEventMessageInConversation(websiteID string, sessionID string, message ConversationEventMessageNew) (*ConversationMessageDispatched, *Response, error)

SendEventMessageInConversation sends a message in an existing conversation (event variant).

func (*WebsiteService) SendFieldMessageInConversation

func (service *WebsiteService) SendFieldMessageInConversation(websiteID string, sessionID string, message ConversationFieldMessageNew) (*ConversationMessageDispatched, *Response, error)

SendFieldMessageInConversation sends a message in an existing conversation (field variant).

func (*WebsiteService) SendFileMessageInConversation

func (service *WebsiteService) SendFileMessageInConversation(websiteID string, sessionID string, message ConversationFileMessageNew) (*ConversationMessageDispatched, *Response, error)

SendFileMessageInConversation sends a message in an existing conversation (file variant).

func (*WebsiteService) SendNoteMessageInConversation added in v1.20.1

func (service *WebsiteService) SendNoteMessageInConversation(websiteID string, sessionID string, message ConversationNoteMessageNew) (*ConversationMessageDispatched, *Response, error)

SendNoteMessageInConversation sends a message in an existing conversation (note variant).

func (*WebsiteService) SendPickerMessageInConversation

func (service *WebsiteService) SendPickerMessageInConversation(websiteID string, sessionID string, message ConversationPickerMessageNew) (*ConversationMessageDispatched, *Response, error)

SendPickerMessageInConversation sends a message in an existing conversation (picker variant).

func (*WebsiteService) SendTextMessageInConversation

func (service *WebsiteService) SendTextMessageInConversation(websiteID string, sessionID string, message ConversationTextMessageNew) (*ConversationMessageDispatched, *Response, error)

SendTextMessageInConversation sends a message in an existing conversation (text variant).

func (*WebsiteService) TestCampaign

func (service *WebsiteService) TestCampaign(websiteID string, campaignID string) (*Response, error)

TestCampaign tests a ready campaign.

func (*WebsiteService) TransmitSignalingOnOngoingCallSession

func (service *WebsiteService) TransmitSignalingOnOngoingCallSession(websiteID string, sessionID string, callID string, payload ConversationCallSignalingPayload) (*Response, error)

TransmitSignalingOnOngoingCallSession transmits a signaling payload for the ongoing audio/video call session for conversation.

func (*WebsiteService) UnlinkOperatorFromWebsite

func (service *WebsiteService) UnlinkOperatorFromWebsite(websiteID string, userID string) (*Response, error)

UnlinkOperatorFromWebsite unlinks given operator from website. Note that the last operator in the website cannot be unlinked.

func (*WebsiteService) UpdateAnimationMessageInConversation

func (service *WebsiteService) UpdateAnimationMessageInConversation(websiteID string, sessionID string, fingerprint int, content ConversationAnimationMessageNewContent) (*Response, error)

UpdateAnimationMessageInConversation edits an existing message in an existing conversation (animation variant).

func (*WebsiteService) UpdateAudioMessageInConversation

func (service *WebsiteService) UpdateAudioMessageInConversation(websiteID string, sessionID string, fingerprint int, content ConversationAudioMessageNewContent) (*Response, error)

UpdateAudioMessageInConversation edits an existing message in an existing conversation (audio variant).

func (*WebsiteService) UpdateCampaign added in v1.31.0

func (service *WebsiteService) UpdateCampaign(websiteID string, campaignID string, websiteCampaignItem WebsiteCampaignItem) (*Response, error)

UpdateCampaign updates a campaign in website, and save only changed fields.

func (*WebsiteService) UpdateCampaignTemplate

func (service *WebsiteService) UpdateCampaignTemplate(websiteID string, templateID string, websiteCampaignTemplateItem WebsiteCampaignTemplateItem) (*Response, error)

UpdateCampaignTemplate updates a campaign template in website, and save only changed fields.

func (*WebsiteService) UpdateConversationMetas

func (service *WebsiteService) UpdateConversationMetas(websiteID string, sessionID string, metas ConversationMetaUpdate) (*Response, error)

UpdateConversationMetas updates conversation meta information.

func (*WebsiteService) UpdateConversationOpenState added in v1.11.0

func (service *WebsiteService) UpdateConversationOpenState(websiteID string, sessionID string, opened bool) (*Response, error)

UpdateConversationOpenState updates conversation open state for authenticated operator user.

func (*WebsiteService) UpdateEventMessageInConversation

func (service *WebsiteService) UpdateEventMessageInConversation(websiteID string, sessionID string, fingerprint int, content ConversationEventMessageNewContent) (*Response, error)

UpdateEventMessageInConversation edits an existing message in an existing conversation (event variant).

func (*WebsiteService) UpdateFieldMessageInConversation

func (service *WebsiteService) UpdateFieldMessageInConversation(websiteID string, sessionID string, fingerprint int, content ConversationFieldMessageNewContent) (*Response, error)

UpdateFieldMessageInConversation edits an existing message in an existing conversation (field variant).

func (*WebsiteService) UpdateFileMessageInConversation

func (service *WebsiteService) UpdateFileMessageInConversation(websiteID string, sessionID string, fingerprint int, content ConversationFileMessageNewContent) (*Response, error)

UpdateFileMessageInConversation edits an existing message in an existing conversation (file variant).

func (*WebsiteService) UpdateNoteMessageInConversation

func (service *WebsiteService) UpdateNoteMessageInConversation(websiteID string, sessionID string, fingerprint int, content string) (*Response, error)

UpdateNoteMessageInConversation edits an existing message in an existing conversation (note variant).

func (*WebsiteService) UpdatePeopleProfile added in v1.27.0

func (service *WebsiteService) UpdatePeopleProfile(websiteID string, peopleID string, peopleProfile PeopleProfileUpdateCard) (*Response, error)

UpdatePeopleProfile updates people profile, and save only changed fields on the previous profile revision.

func (*WebsiteService) UpdatePeopleSubscriptionStatus

func (service *WebsiteService) UpdatePeopleSubscriptionStatus(websiteID string, peopleID string, peopleSubscription PeopleSubscriptionUpdate) (*Response, error)

UpdatePeopleSubscriptionStatus updates current subscription status for people.

func (*WebsiteService) UpdatePickerMessageInConversation

func (service *WebsiteService) UpdatePickerMessageInConversation(websiteID string, sessionID string, fingerprint int, content ConversationPickerMessageNewContent) (*Response, error)

UpdatePickerMessageInConversation edits an existing message in an existing conversation (picker variant).

func (*WebsiteService) UpdateTextMessageInConversation

func (service *WebsiteService) UpdateTextMessageInConversation(websiteID string, sessionID string, fingerprint int, content string) (*Response, error)

UpdateTextMessageInConversation edits an existing message in an existing conversation (text variant).

func (*WebsiteService) UpdateWebsiteSettings

func (service *WebsiteService) UpdateWebsiteSettings(websiteID string, settings WebsiteSettingsUpdate) (*Response, error)

UpdateWebsiteSettings updates the current settings for a website.

type WebsiteSettings

type WebsiteSettings struct {
	WebsiteID *string                 `json:"website_id,omitempty"`
	Name      *string                 `json:"name,omitempty"`
	Domain    *string                 `json:"domain,omitempty"`
	Contact   *WebsiteSettingsContact `json:"contact,omitempty"`
	Inbox     *WebsiteSettingsInbox   `json:"inbox,omitempty"`
	Emails    *WebsiteSettingsEmails  `json:"emails,omitempty"`
	Chatbox   *WebsiteSettingsChatbox `json:"chatbox,omitempty"`
}

WebsiteSettings mapping

func (WebsiteSettings) String

func (instance WebsiteSettings) String() string

String returns the string representation of WebsiteSettings

type WebsiteSettingsChatbox

type WebsiteSettingsChatbox struct {
	Tile                *string   `json:"tile,omitempty"`
	WaitGame            *bool     `json:"wait_game,omitempty"`
	LastOperatorFace    *bool     `json:"last_operator_face,omitempty"`
	OngoingOperatorFace *bool     `json:"ongoing_operator_face,omitempty"`
	ActivityMetrics     *bool     `json:"activity_metrics,omitempty"`
	OperatorPrivacy     *bool     `json:"operator_privacy,omitempty"`
	AvailabilityTooltip *bool     `json:"availability_tooltip,omitempty"`
	HideVacation        *bool     `json:"hide_vacation,omitempty"`
	HideOnAway          *bool     `json:"hide_on_away,omitempty"`
	HideOnMobile        *bool     `json:"hide_on_mobile,omitempty"`
	PositionReverse     *bool     `json:"position_reverse,omitempty"`
	EmailVisitors       *bool     `json:"email_visitors,omitempty"`
	PhoneVisitors       *bool     `json:"phone_visitors,omitempty"`
	ForceIdentify       *bool     `json:"force_identify,omitempty"`
	IgnorePrivacy       *bool     `json:"ignore_privacy,omitempty"`
	VisitorCompose      *bool     `json:"visitor_compose,omitempty"`
	FileTransfer        *bool     `json:"file_transfer,omitempty"`
	HelpdeskLink        *bool     `json:"helpdesk_link,omitempty"`
	StatusHealthDead    *bool     `json:"status_health_dead,omitempty"`
	CheckDomain         *bool     `json:"check_domain,omitempty"`
	ColorTheme          *string   `json:"color_theme,omitempty"`
	TextTheme           *string   `json:"text_theme,omitempty"`
	WelcomeMessage      *string   `json:"welcome_message,omitempty"`
	Locale              *string   `json:"locale,omitempty"`
	AllowedPages        *[]string `json:"allowed_pages,omitempty"`
	BlockedPages        *[]string `json:"blocked_pages,omitempty"`
	BlockedCountries    *[]string `json:"blocked_countries,omitempty"`
	BlockedLocales      *[]string `json:"blocked_locales,omitempty"`
}

WebsiteSettingsChatbox mapping

type WebsiteSettingsContact

type WebsiteSettingsContact struct {
	Email     *string `json:"email,omitempty"`
	Phone     *string `json:"phone,omitempty"`
	Messenger *string `json:"messenger,omitempty"`
	Telegram  *string `json:"telegram,omitempty"`
	Twitter   *string `json:"twitter,omitempty"`
}

WebsiteSettingsContact mapping

type WebsiteSettingsData

type WebsiteSettingsData struct {
	Data *WebsiteSettings `json:"data,omitempty"`
}

WebsiteSettingsData mapping

type WebsiteSettingsEmails

type WebsiteSettingsEmails struct {
	Rating     *bool `json:"rating,omitempty"`
	Transcript *bool `json:"transcript,omitempty"`
	Enrich     *bool `json:"enrich,omitempty"`
	JunkFilter *bool `json:"junk_filter,omitempty"`
}

WebsiteSettingsEmails mapping

type WebsiteSettingsInbox

type WebsiteSettingsInbox struct {
	LockRemoval        *bool `json:"lock_removal,omitempty"`
	ForceOperatorToken *bool `json:"force_operator_token,omitempty"`
}

WebsiteSettingsInbox mapping

type WebsiteSettingsUpdate

type WebsiteSettingsUpdate struct {
	WebsiteID string                        `json:"website_id,omitempty"`
	Name      string                        `json:"name,omitempty"`
	Domain    string                        `json:"domain,omitempty"`
	Contact   *WebsiteSettingsUpdateContact `json:"contact,omitempty"`
	Inbox     *WebsiteSettingsUpdateInbox   `json:"inbox,omitempty"`
	Emails    *WebsiteSettingsUpdateEmails  `json:"emails,omitempty"`
	Chatbox   *WebsiteSettingsUpdateChatbox `json:"chatbox,omitempty"`
}

WebsiteSettingsUpdate mapping

type WebsiteSettingsUpdateChatbox

type WebsiteSettingsUpdateChatbox struct {
	Tile                string    `json:"tile,omitempty"`
	WaitGame            bool      `json:"wait_game,omitempty"`
	LastOperatorFace    bool      `json:"last_operator_face,omitempty"`
	OngoingOperatorFace bool      `json:"ongoing_operator_face,omitempty"`
	ActivityMetrics     bool      `json:"activity_metrics,omitempty"`
	OperatorPrivacy     bool      `json:"operator_privacy,omitempty"`
	AvailabilityTooltip bool      `json:"availability_tooltip,omitempty"`
	HideVacation        bool      `json:"hide_vacation,omitempty"`
	HideOnAway          bool      `json:"hide_on_away,omitempty"`
	HideOnMobile        bool      `json:"hide_on_mobile,omitempty"`
	PositionReverse     bool      `json:"position_reverse,omitempty"`
	EmailVisitors       bool      `json:"email_visitors,omitempty"`
	PhoneVisitors       bool      `json:"phone_visitors,omitempty"`
	ForceIdentify       bool      `json:"force_identify,omitempty"`
	IgnorePrivacy       bool      `json:"ignore_privacy,omitempty"`
	VisitorCompose      bool      `json:"visitor_compose,omitempty"`
	FileTransfer        bool      `json:"file_transfer,omitempty"`
	HelpdeskLink        bool      `json:"helpdesk_link,omitempty"`
	StatusHealthDead    bool      `json:"status_health_dead,omitempty"`
	CheckDomain         bool      `json:"check_domain,omitempty"`
	ColorTheme          string    `json:"color_theme,omitempty"`
	TextTheme           string    `json:"text_theme,omitempty"`
	WelcomeMessage      string    `json:"welcome_message,omitempty"`
	Locale              string    `json:"locale,omitempty"`
	AllowedPages        *[]string `json:"allowed_pages,omitempty"`
	BlockedPages        *[]string `json:"blocked_pages,omitempty"`
	BlockedCountries    *[]string `json:"blocked_countries,omitempty"`
	BlockedLocales      *[]string `json:"blocked_locales,omitempty"`
	BlockedIPs          *[]string `json:"blocked_ips,omitempty"`
}

WebsiteSettingsUpdateChatbox mapping

type WebsiteSettingsUpdateContact

type WebsiteSettingsUpdateContact struct {
	Email     string `json:"email,omitempty"`
	Phone     string `json:"phone,omitempty"`
	Messenger string `json:"messenger,omitempty"`
	Telegram  string `json:"telegram,omitempty"`
	Twitter   string `json:"twitter,omitempty"`
}

WebsiteSettingsUpdateContact mapping

type WebsiteSettingsUpdateEmails

type WebsiteSettingsUpdateEmails struct {
	Rating     bool `json:"rating,omitempty"`
	Transcript bool `json:"transcript,omitempty"`
	Enrich     bool `json:"enrich,omitempty"`
	JunkFilter bool `json:"junk_filter,omitempty"`
}

WebsiteSettingsUpdateEmails mapping

type WebsiteSettingsUpdateInbox

type WebsiteSettingsUpdateInbox struct {
	LockRemoval        bool `json:"lock_removal,omitempty"`
	ForceOperatorToken bool `json:"force_operator_token,omitempty"`
}

WebsiteSettingsUpdateInbox mapping

type WebsiteVisitor

type WebsiteVisitor struct {
	SessionID    *string                    `json:"session_id,omitempty"`
	Nickname     *string                    `json:"nickname,omitempty"`
	Email        *string                    `json:"email,omitempty"`
	Avatar       *string                    `json:"avatar,omitempty"`
	Useragent    *string                    `json:"useragent,omitempty"`
	Initiated    *bool                      `json:"initiated,omitempty"`
	Active       *bool                      `json:"active,omitempty"`
	LastPage     *WebsiteVisitorLastPage    `json:"last_page,omitempty"`
	Geolocation  *WebsiteVisitorGeolocation `json:"geolocation,omitempty"`
	Timezone     *int16                     `json:"timezone,omitempty"`
	Capabilities *[]string                  `json:"capabilities,omitempty"`
	Locales      *[]string                  `json:"locales,omitempty"`
}

WebsiteVisitor mapping

func (WebsiteVisitor) String

func (instance WebsiteVisitor) String() string

String returns the string representation of WebsiteVisitor

type WebsiteVisitorCount added in v1.11.0

type WebsiteVisitorCount struct {
	Count   *uint32 `json:"count,omitempty"`
	Active  *uint32 `json:"active,omitempty"`
	Limited *bool   `json:"limited,omitempty"`
}

WebsiteVisitorCount mapping

func (WebsiteVisitorCount) String added in v1.11.0

func (instance WebsiteVisitorCount) String() string

String returns the string representation of WebsiteVisitorCount

type WebsiteVisitorCountData added in v1.11.0

type WebsiteVisitorCountData struct {
	Data *WebsiteVisitorCount `json:"data,omitempty"`
}

WebsiteVisitorCountData mapping

type WebsiteVisitorGeolocation

type WebsiteVisitorGeolocation struct {
	Coordinates *WebsiteVisitorGeolocationCoordinates `json:"coordinates,omitempty"`
	City        *string                               `json:"city,omitempty"`
	Region      *string                               `json:"region,omitempty"`
	Country     *string                               `json:"country,omitempty"`
}

WebsiteVisitorGeolocation mapping

type WebsiteVisitorGeolocationCoordinates

type WebsiteVisitorGeolocationCoordinates struct {
	Latitude  *float32 `json:"latitude,omitempty"`
	Longitude *float32 `json:"longitude,omitempty"`
}

WebsiteVisitorGeolocationCoordinates mapping

type WebsiteVisitorLastPage

type WebsiteVisitorLastPage struct {
	PageTitle *string `json:"page_title,omitempty"`
	PageURL   *string `json:"page_url,omitempty"`
}

WebsiteVisitorLastPage mapping

type WebsiteVisitorListData

type WebsiteVisitorListData struct {
	Data *[]WebsiteVisitor `json:"data,omitempty"`
}

WebsiteVisitorListData mapping

type WebsiteVisitorsBlocked

type WebsiteVisitorsBlocked struct {
	Rule    *[]string `json:"rule,omitempty"`
	Blocked *uint32   `json:"blocked,omitempty"`
}

WebsiteVisitorsBlocked mapping

func (WebsiteVisitorsBlocked) String

func (instance WebsiteVisitorsBlocked) String() string

String returns the string representation of WebsiteVisitorsBlocked

type WebsiteVisitorsBlockedAllData

type WebsiteVisitorsBlockedAllData struct {
	Data *[]WebsiteVisitorsBlocked `json:"data,omitempty"`
}

WebsiteVisitorsBlockedAllData mapping

type WebsiteVisitorsBlockedRuleData

type WebsiteVisitorsBlockedRuleData struct {
	Data *WebsiteVisitorsBlocked `json:"data,omitempty"`
}

WebsiteVisitorsBlockedRuleData mapping

type WebsiteVisitorsMapPoint

type WebsiteVisitorsMapPoint struct {
	Visitors    *WebsiteVisitorsMapPointVisitors    `json:"visitors"`
	Geolocation *WebsiteVisitorsMapPointGeolocation `json:"geolocation"`
}

WebsiteVisitorsMapPoint mapping

func (WebsiteVisitorsMapPoint) String

func (instance WebsiteVisitorsMapPoint) String() string

String returns the string representation of WebsiteVisitorsMapPoint

type WebsiteVisitorsMapPointGeolocation

type WebsiteVisitorsMapPointGeolocation struct {
	Coordinates *WebsiteVisitorsMapPointGeolocationCoordinates `json:"coordinates,omitempty"`
	City        *string                                        `json:"city,omitempty"`
	Region      *string                                        `json:"region,omitempty"`
	Country     *string                                        `json:"country,omitempty"`
}

WebsiteVisitorsMapPointGeolocation mapping

type WebsiteVisitorsMapPointGeolocationCoordinates

type WebsiteVisitorsMapPointGeolocationCoordinates struct {
	Latitude  *float32 `json:"latitude,omitempty"`
	Longitude *float32 `json:"longitude,omitempty"`
}

WebsiteVisitorsMapPointGeolocationCoordinates mapping

type WebsiteVisitorsMapPointVisitors

type WebsiteVisitorsMapPointVisitors struct {
	Count     *uint32                                   `json:"count,omitempty"`
	Threshold *uint32                                   `json:"threshold,omitempty"`
	Sessions  *[]WebsiteVisitorsMapPointVisitorsSession `json:"sessions,omitempty"`
}

WebsiteVisitorsMapPointVisitors mapping

type WebsiteVisitorsMapPointVisitorsSession

type WebsiteVisitorsMapPointVisitorsSession struct {
	SessionID    *string                 `json:"session_id,omitempty"`
	Nickname     *string                 `json:"nickname,omitempty"`
	Email        *string                 `json:"email,omitempty"`
	Avatar       *string                 `json:"avatar,omitempty"`
	Initiated    *bool                   `json:"initiated,omitempty"`
	Active       *bool                   `json:"active,omitempty"`
	LastPage     *WebsiteVisitorLastPage `json:"last_page,omitempty"`
	Timezone     *int16                  `json:"timezone,omitempty"`
	Capabilities *[]string               `json:"capabilities,omitempty"`
	Locales      *[]string               `json:"locales,omitempty"`
}

WebsiteVisitorsMapPointVisitorsSession mapping

type WebsiteVisitorsMapPointsData

type WebsiteVisitorsMapPointsData struct {
	Data *[]WebsiteVisitorsMapPoint `json:"data,omitempty"`
}

WebsiteVisitorsMapPointsData mapping

type WebsiteVisitorsToken

type WebsiteVisitorsToken struct {
	SessionID *string `json:"session_id,omitempty"`
}

WebsiteVisitorsToken mapping

func (WebsiteVisitorsToken) String

func (instance WebsiteVisitorsToken) String() string

String returns the string representation of WebsiteVisitorsToken

type WebsiteVisitorsTokenData

type WebsiteVisitorsTokenData struct {
	Data *WebsiteVisitorsToken `json:"data,omitempty"`
}

WebsiteVisitorsTokenData mapping

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL