platformclientv2

package
v33.0.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Feb 19, 2021 License: MIT Imports: 14 Imported by: 1

Documentation

Overview

Example (AuthorizeDefaultConfiguration)
// Use the default config instance and retrieve settings from env vars
config := GetDefaultConfiguration()
config.BasePath = "https://api." + os.Getenv("PURECLOUD_ENVIRONMENT") // e.g. PURECLOUD_ENVIRONMENT=mypurecloud.com
clientID := os.Getenv("PURECLOUD_CLIENT_ID")
clientSecret := os.Getenv("PURECLOUD_CLIENT_SECRET")

// Authorize the configuration
err := config.AuthorizeClientCredentials(clientID, clientSecret)
if err != nil {
	panic(err)
}

// Create an API instance using the default config
usersAPI := NewUsersApi()
fmt.Printf("Users API type: %v", reflect.TypeOf(usersAPI).String())
Example (AuthorizeNewConfiguration)
// Create a new config instance and retrieve settings from env vars
config := NewConfiguration()
config.BasePath = "https://api." + os.Getenv("PURECLOUD_ENVIRONMENT") // e.g. PURECLOUD_ENVIRONMENT=mypurecloud.com
clientID := os.Getenv("PURECLOUD_CLIENT_ID")
clientSecret := os.Getenv("PURECLOUD_CLIENT_SECRET")

// Authorize the configuration
err := config.AuthorizeClientCredentials(clientID, clientSecret)
if err != nil {
	panic(err)
}

// Create an API instance using the config instance
usersAPI := NewUsersApiWithConfig(config)
fmt.Printf("Users API type: %v", reflect.TypeOf(usersAPI).String())

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool

func Bool(v bool) *bool

Bool is an easy way to get a pointer

func Int32

func Int32(v int) *int32

Int32 is an easy way to get a pointer

func String

func String(v string) *string

String is an easy way to get a pointer

Types

type APIClient

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

APIClient provides functions for making API requests

func NewAPIClient

func NewAPIClient(c *Configuration) APIClient

NewAPIClient creates a new API client

func (*APIClient) CallAPI

func (c *APIClient) CallAPI(path string, method string,
	postBody interface{},
	headerParams map[string]string,
	queryParams map[string]string,
	formParams url.Values,
	fileName string,
	fileBytes []byte) (*APIResponse, error)

CallAPI invokes an API endpoint

func (*APIClient) ParameterToString

func (c *APIClient) ParameterToString(obj interface{}, collectionFormat string) string

ParameterToString joins a parameter in the desired format

func (*APIClient) SelectHeaderAccept

func (c *APIClient) SelectHeaderAccept(accepts []string) string

SelectHeaderAccept selects the header accept

func (*APIClient) SelectHeaderContentType

func (c *APIClient) SelectHeaderContentType(contentTypes []string) string

SelectHeaderContentType selects the header content type

type APIError

type APIError struct {
	Status            int                    `json:"status,omitempty"`
	Message           string                 `json:"message,omitempty"`
	MessageWithParams map[string]interface{} `json:"messageWithParams,omitempty"`
	Code              string                 `json:"code,omitempty"`
	ContextID         string                 `json:"contextId,omitempty"`
	Details           []string               `json:"details,omitempty"`
}

APIError is the standard error body from the API

func (*APIError) String

func (r *APIError) String() string

String returns the JSON serialized object

type APIResponse

type APIResponse struct {
	Response      *http.Response      `json:"-"`
	HasBody       bool                `json:"hasBody,omitempty"`
	RawBody       []byte              `json:"rawBody,omitempty"`
	IsSuccess     bool                `json:"isSuccess,omitempty"`
	StatusCode    int                 `json:"statusCode,omitempty"`
	Status        string              `json:"status,omitempty"`
	Error         *APIError           `json:"error,omitempty"`
	ErrorMessage  string              `json:"errorMessage,omitempty"`
	CorrelationID string              `json:"correlationId,omitempty"`
	Header        map[string][]string `json:"header,omitempty"`
}

APIResponse is a friendly interface for a response from the API

func NewAPIResponse

func NewAPIResponse(r *http.Response, body []byte) (*APIResponse, error)

NewAPIResponse creates an APIResponse from a http Response

func (*APIResponse) SetError

func (r *APIResponse) SetError(err *APIError)

SetError returns the JSON serialized object

func (*APIResponse) String

func (r *APIResponse) String() string

String returns the JSON serialized object

type Action

type Action struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// IntegrationId - The ID of the integration for which this action is associated
	IntegrationId *string `json:"integrationId,omitempty"`

	// Category - Category of Action
	Category *string `json:"category,omitempty"`

	// Contract - Action contract
	Contract *Actioncontract `json:"contract,omitempty"`

	// Version - Version of this action
	Version *int `json:"version,omitempty"`

	// Secure - Indication of whether or not the action is designed to accept sensitive data
	Secure *bool `json:"secure,omitempty"`

	// Config - Configuration to support request and response processing
	Config *Actionconfig `json:"config,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Action

func (*Action) String

func (o *Action) String() string

String returns a JSON representation of the model

type Actionconfig

type Actionconfig struct {
	// Request - Configuration of outbound request.
	Request *Requestconfig `json:"request,omitempty"`

	// Response - Configuration of response processing.
	Response *Responseconfig `json:"response,omitempty"`
}

Actionconfig - Defines components of the Action Config.

func (*Actionconfig) String

func (o *Actionconfig) String() string

String returns a JSON representation of the model

type Actioncontract

type Actioncontract struct {
	// Output - The output to expect when executing this action.
	Output *Actionoutput `json:"output,omitempty"`

	// Input - The input required when executing this action.
	Input *Actioninput `json:"input,omitempty"`
}

Actioncontract - This resource contains all of the schemas needed to define the inputs and outputs, of a single Action.

func (*Actioncontract) String

func (o *Actioncontract) String() string

String returns a JSON representation of the model

type Actioncontractinput

type Actioncontractinput struct {
	// Input - Execution input contract
	Input *Postinputcontract `json:"input,omitempty"`

	// Output - Execution output contract
	Output *Postoutputcontract `json:"output,omitempty"`
}

Actioncontractinput - Contract definition.

func (*Actioncontractinput) String

func (o *Actioncontractinput) String() string

String returns a JSON representation of the model

type Actionentitylisting

type Actionentitylisting struct {
	// Entities
	Entities *[]Action `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Actionentitylisting

func (*Actionentitylisting) String

func (o *Actionentitylisting) String() string

String returns a JSON representation of the model

type Actioninput

type Actioninput struct {
	// InputSchema - JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. If the 'flatten' query parameter is omitted or false, this field will be returned. Either inputSchema or inputSchemaFlattened will be returned, not both.
	InputSchema *Jsonschemadocument `json:"inputSchema,omitempty"`

	// InputSchemaFlattened - JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either inputSchema or inputSchemaFlattened will be returned, not both.
	InputSchemaFlattened *Jsonschemadocument `json:"inputSchemaFlattened,omitempty"`

	// InputSchemaUri - The URI of the input schema
	InputSchemaUri *string `json:"inputSchemaUri,omitempty"`
}

Actioninput - Input requirements of Action.

func (*Actioninput) String

func (o *Actioninput) String() string

String returns a JSON representation of the model

type Actionmap

type Actionmap struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Version - The version of the action map.
	Version *int `json:"version,omitempty"`

	// IsActive - Whether the action map is active.
	IsActive *bool `json:"isActive,omitempty"`

	// DisplayName - Display name of the action map.
	DisplayName *string `json:"displayName,omitempty"`

	// TriggerWithSegments - Trigger action map if any segment in the list is assigned to a given customer.
	TriggerWithSegments *[]string `json:"triggerWithSegments,omitempty"`

	// TriggerWithEventConditions - List of event conditions that must be satisfied to trigger the action map.
	TriggerWithEventConditions *[]Eventcondition `json:"triggerWithEventConditions,omitempty"`

	// TriggerWithOutcomeProbabilityConditions - Probability conditions for outcomes that must be satisfied to trigger the action map.
	TriggerWithOutcomeProbabilityConditions *[]Outcomeprobabilitycondition `json:"triggerWithOutcomeProbabilityConditions,omitempty"`

	// PageUrlConditions - URL conditions that a page must match for web actions to be displayable.
	PageUrlConditions *[]Urlcondition `json:"pageUrlConditions,omitempty"`

	// Activation - Type of activation.
	Activation *Activation `json:"activation,omitempty"`

	// Weight - Weight of the action map with higher number denoting higher weight.
	Weight *int `json:"weight,omitempty"`

	// Action - The action that will be executed if this action map is triggered.
	Action *Actionmapaction `json:"action,omitempty"`

	// ActionMapScheduleGroups - The action map's associated schedule groups.
	ActionMapScheduleGroups *Actionmapschedulegroups `json:"actionMapScheduleGroups,omitempty"`

	// IgnoreFrequencyCap - Override organization-level frequency cap and always offer web engagements from this action map.
	IgnoreFrequencyCap *bool `json:"ignoreFrequencyCap,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// CreatedDate - Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CreatedDate *time.Time `json:"createdDate,omitempty"`

	// ModifiedDate - Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ModifiedDate *time.Time `json:"modifiedDate,omitempty"`

	// StartDate - Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndDate *time.Time `json:"endDate,omitempty"`
}

Actionmap

func (*Actionmap) String

func (o *Actionmap) String() string

String returns a JSON representation of the model

type Actionmapaction

type Actionmapaction struct {
	// ActionTemplate - Action template associated with the action map.
	ActionTemplate *Actionmapactiontemplate `json:"actionTemplate,omitempty"`

	// MediaType - Media type of action.
	MediaType *string `json:"mediaType,omitempty"`

	// ArchitectFlowFields - Architect Flow Id and input contract.
	ArchitectFlowFields *Architectflowfields `json:"architectFlowFields,omitempty"`
}

Actionmapaction

func (*Actionmapaction) String

func (o *Actionmapaction) String() string

String returns a JSON representation of the model

type Actionmapactiontemplate

type Actionmapactiontemplate struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Actionmapactiontemplate

func (*Actionmapactiontemplate) String

func (o *Actionmapactiontemplate) String() string

String returns a JSON representation of the model

type Actionmaplisting

type Actionmaplisting struct {
	// Entities
	Entities *[]Actionmap `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Actionmaplisting

func (*Actionmaplisting) String

func (o *Actionmaplisting) String() string

String returns a JSON representation of the model

type Actionmapschedulegroup

type Actionmapschedulegroup struct {
	// Id - The ID of the action maps's associated schedule group.
	Id *string `json:"id,omitempty"`
}

Actionmapschedulegroup

func (*Actionmapschedulegroup) String

func (o *Actionmapschedulegroup) String() string

String returns a JSON representation of the model

type Actionmapschedulegroups

type Actionmapschedulegroups struct {
	// ActionMapScheduleGroup - The actions map's associated schedule group.
	ActionMapScheduleGroup *Actionmapschedulegroup `json:"actionMapScheduleGroup,omitempty"`

	// EmergencyActionMapScheduleGroup - The action map's associated emergency schedule group.
	EmergencyActionMapScheduleGroup *Actionmapschedulegroup `json:"emergencyActionMapScheduleGroup,omitempty"`
}

Actionmapschedulegroups

func (*Actionmapschedulegroups) String

func (o *Actionmapschedulegroups) String() string

String returns a JSON representation of the model

type Actionoutput

type Actionoutput struct {
	// SuccessSchema - JSON schema that defines the transformed, successful result that will be sent back to the caller. If the 'flatten' query parameter is omitted or false, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both.
	SuccessSchema *Jsonschemadocument `json:"successSchema,omitempty"`

	// SuccessSchemaUri - URI to retrieve success schema
	SuccessSchemaUri *string `json:"successSchemaUri,omitempty"`

	// ErrorSchema - JSON schema that defines the body of response when request is not successful. If the 'flatten' query parameter is omitted or false, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both.
	ErrorSchema *Jsonschemadocument `json:"errorSchema,omitempty"`

	// ErrorSchemaUri - URI to retrieve error schema
	ErrorSchemaUri *string `json:"errorSchemaUri,omitempty"`

	// SuccessSchemaFlattened - JSON schema that defines the transformed, successful result that will be sent back to the caller. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both.
	SuccessSchemaFlattened *Jsonschemadocument `json:"successSchemaFlattened,omitempty"`

	// ErrorSchemaFlattened - JSON schema that defines the body of response when request is not successful. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both.
	ErrorSchemaFlattened *map[string]interface{} `json:"errorSchemaFlattened,omitempty"`
}

Actionoutput - Output definition of Action.

func (*Actionoutput) String

func (o *Actionoutput) String() string

String returns a JSON representation of the model

type Actionproperties

type Actionproperties struct {
	// WebchatPrompt - Prompt message shown to user, used for webchat type action.
	WebchatPrompt *string `json:"webchatPrompt,omitempty"`

	// WebchatTitleText - Title shown to the user, used for webchat type action.
	WebchatTitleText *string `json:"webchatTitleText,omitempty"`

	// WebchatAcceptText - Accept button text shown to user, used for webchat type action.
	WebchatAcceptText *string `json:"webchatAcceptText,omitempty"`

	// WebchatDeclineText - Decline button text shown to user, used for webchat type action.
	WebchatDeclineText *string `json:"webchatDeclineText,omitempty"`

	// WebchatSurvey - Survey provided to the user, used for webchat type action.
	WebchatSurvey *Actionsurvey `json:"webchatSurvey,omitempty"`
}

Actionproperties

func (*Actionproperties) String

func (o *Actionproperties) String() string

String returns a JSON representation of the model

type Actions

type Actions struct {
	// SkillsToRemove
	SkillsToRemove *[]Skillstoremove `json:"skillsToRemove,omitempty"`
}

Actions

func (*Actions) String

func (o *Actions) String() string

String returns a JSON representation of the model

type Actionsurvey

type Actionsurvey struct {
	// Questions - Questions shown to the user.
	Questions *[]Journeysurveyquestion `json:"questions,omitempty"`
}

Actionsurvey

func (*Actionsurvey) String

func (o *Actionsurvey) String() string

String returns a JSON representation of the model

type Actiontarget

type Actiontarget struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// UserData - Additional user data associated with the target in key/value format.
	UserData *[]Keyvalue `json:"userData,omitempty"`

	// SupportedMediaTypes - Supported media types of the target.
	SupportedMediaTypes *[]string `json:"supportedMediaTypes,omitempty"`

	// State - Indicates the state of the target.
	State *string `json:"state,omitempty"`

	// Description - Description of the target.
	Description *string `json:"description,omitempty"`

	// ServiceLevel - Service Level of the action target. Chat offers for the target will be throttled with the aim of achieving this service level.
	ServiceLevel *Servicelevel `json:"serviceLevel,omitempty"`

	// ShortAbandonThreshold - Indicates the non-default short abandon threshold
	ShortAbandonThreshold *int `json:"shortAbandonThreshold,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// CreatedDate - The date the target was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CreatedDate *time.Time `json:"createdDate,omitempty"`

	// ModifiedDate - The date the target was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ModifiedDate *time.Time `json:"modifiedDate,omitempty"`
}

Actiontarget

func (*Actiontarget) String

func (o *Actiontarget) String() string

String returns a JSON representation of the model

type Actiontargetlisting

type Actiontargetlisting struct {
	// Entities
	Entities *[]Actiontarget `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Actiontargetlisting

func (*Actiontargetlisting) String

func (o *Actiontargetlisting) String() string

String returns a JSON representation of the model

type Actiontemplate

type Actiontemplate struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - Name of the action template.
	Name *string `json:"name,omitempty"`

	// Description - Description of the action template's functionality.
	Description *string `json:"description,omitempty"`

	// MediaType - Media type of action described by the action template.
	MediaType *string `json:"mediaType,omitempty"`

	// State - Whether the action template is currently active, inactive or deleted.
	State *string `json:"state,omitempty"`

	// ContentOffer - Properties used to configure an action of type content offer
	ContentOffer *Contentoffer `json:"contentOffer,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// CreatedDate - Date when action template was created in ISO-8601 format.
	CreatedDate *time.Time `json:"createdDate,omitempty"`

	// ModifiedDate - Date when action template was last modified in ISO-8601 format.
	ModifiedDate *time.Time `json:"modifiedDate,omitempty"`
}

Actiontemplate

func (*Actiontemplate) String

func (o *Actiontemplate) String() string

String returns a JSON representation of the model

type Actiontemplatelisting

type Actiontemplatelisting struct {
	// Entities
	Entities *[]Actiontemplate `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Actiontemplatelisting

func (*Actiontemplatelisting) String

func (o *Actiontemplatelisting) String() string

String returns a JSON representation of the model

type Activation

type Activation struct {
	// VarType - Type of activation.
	VarType *string `json:"type,omitempty"`

	// DelayInSeconds - Activation delay time amount.
	DelayInSeconds *int `json:"delayInSeconds,omitempty"`
}

Activation

func (*Activation) String

func (o *Activation) String() string

String returns a JSON representation of the model

type Activealertcount

type Activealertcount struct {
	// Count - The count of active alerts for a user.
	Count *int `json:"count,omitempty"`
}

Activealertcount

func (*Activealertcount) String

func (o *Activealertcount) String() string

String returns a JSON representation of the model

type Activitycode

type Activitycode struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// Name - The name of the activity code. Default activity codes will be created with an empty name
	Name *string `json:"name,omitempty"`

	// IsActive - Whether this activity code is active or has been deleted
	IsActive *bool `json:"isActive,omitempty"`

	// IsDefault - Whether this is a default activity code
	IsDefault *bool `json:"isDefault,omitempty"`

	// Category - The activity code's category.
	Category *string `json:"category,omitempty"`

	// LengthInMinutes - The default length of the activity in minutes
	LengthInMinutes *int `json:"lengthInMinutes,omitempty"`

	// CountsAsPaidTime - Whether an agent is paid while performing this activity
	CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"`

	// CountsAsWorkTime - Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints
	CountsAsWorkTime *bool `json:"countsAsWorkTime,omitempty"`

	// AgentTimeOffSelectable - Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off.
	AgentTimeOffSelectable *bool `json:"agentTimeOffSelectable,omitempty"`

	// Metadata - Version metadata for the associated management unit's list of activity codes
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Activitycode - Activity code data

func (*Activitycode) String

func (o *Activitycode) String() string

String returns a JSON representation of the model

type Activitycodecontainer

type Activitycodecontainer struct {
	// ActivityCodes - Map of activity code id to activity code
	ActivityCodes *map[string]Activitycode `json:"activityCodes,omitempty"`

	// Metadata - Version metadata for the associated management unit's list of activity codes
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Activitycodecontainer - Container for a map of ActivityCodeId to ActivityCode

func (*Activitycodecontainer) String

func (o *Activitycodecontainer) String() string

String returns a JSON representation of the model

type Acwsettings

type Acwsettings struct {
	// WrapupPrompt - This field controls how the UI prompts the agent for a wrapup.
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// TimeoutMs - The amount of time the agent can stay in ACW (Min: 1 sec, Max: 1 day).  Can only be used when ACW is MANDATORY_TIMEOUT or MANDATORY_FORCED_TIMEOUT.
	TimeoutMs *int `json:"timeoutMs,omitempty"`
}

Acwsettings

func (*Acwsettings) String

func (o *Acwsettings) String() string

String returns a JSON representation of the model

type Addconversationrequest

type Addconversationrequest struct {
	// ConversationId - The id of the conversation to add
	ConversationId *string `json:"conversationId,omitempty"`
}

Addconversationrequest - Update coaching appointment request

func (*Addconversationrequest) String

func (o *Addconversationrequest) String() string

String returns a JSON representation of the model

type Addconversationresponse

type Addconversationresponse struct {
	// Conversation - The conversation reference
	Conversation *Conversationreference `json:"conversation,omitempty"`

	// Appointment - The appointment reference
	Appointment *Coachingappointmentreference `json:"appointment,omitempty"`
}

Addconversationresponse

func (*Addconversationresponse) String

func (o *Addconversationresponse) String() string

String returns a JSON representation of the model

type Additionalmessage

type Additionalmessage struct {
	// TextBody - The body of the text message.
	TextBody *string `json:"textBody,omitempty"`

	// MediaIds - The media ids associated with the text message.
	MediaIds *[]string `json:"mediaIds,omitempty"`

	// StickerIds - The sticker ids associated with the text message.
	StickerIds *[]string `json:"stickerIds,omitempty"`

	// MessagingTemplate - The messaging template use to send a predefined canned response with the message
	MessagingTemplate *Messagingtemplaterequest `json:"messagingTemplate,omitempty"`
}

Additionalmessage

func (*Additionalmessage) String

func (o *Additionalmessage) String() string

String returns a JSON representation of the model

type Address

type Address struct {
	// Name - This will be nameRaw if present, or a locality lookup of the address field otherwise.
	Name *string `json:"name,omitempty"`

	// NameRaw - The name as close to the bits on the wire as possible.
	NameRaw *string `json:"nameRaw,omitempty"`

	// AddressNormalized - The normalized address. This field is acquired from the Address Normalization Table.  The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table.
	AddressNormalized *string `json:"addressNormalized,omitempty"`

	// AddressRaw - The address as close to the bits on the wire as possible.
	AddressRaw *string `json:"addressRaw,omitempty"`

	// AddressDisplayable - The displayable address. This field is acquired from the Address Normalization Table.  The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table.
	AddressDisplayable *string `json:"addressDisplayable,omitempty"`
}

Address

func (*Address) String

func (o *Address) String() string

String returns a JSON representation of the model

type Addressableentityref

type Addressableentityref struct {
	// Id
	Id *string `json:"id,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`
}

Addressableentityref

func (*Addressableentityref) String

func (o *Addressableentityref) String() string

String returns a JSON representation of the model

type Addressablelicensedefinition

type Addressablelicensedefinition struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Addressablelicensedefinition

func (*Addressablelicensedefinition) String

String returns a JSON representation of the model

type Addshifttraderequest

type Addshifttraderequest struct {
	// ScheduleId - The ID of the schedule to which the initiating and receiving shifts belong
	ScheduleId *string `json:"scheduleId,omitempty"`

	// InitiatingShiftId - The ID of the shift that the initiating user wants to give up
	InitiatingShiftId *string `json:"initiatingShiftId,omitempty"`

	// ReceivingUserId - The ID of the user to whom to send the request (for use in direct trade requests)
	ReceivingUserId *string `json:"receivingUserId,omitempty"`

	// Expiration - When this shift trade request should expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Expiration *time.Time `json:"expiration,omitempty"`

	// AcceptableIntervals
	AcceptableIntervals *[]string `json:"acceptableIntervals,omitempty"`
}

Addshifttraderequest

func (*Addshifttraderequest) String

func (o *Addshifttraderequest) String() string

String returns a JSON representation of the model

type Addworkplanrotationagentrequest

type Addworkplanrotationagentrequest struct {
	// UserId - The ID of an agent in this work plan rotation
	UserId *string `json:"userId,omitempty"`

	// DateRange - The date range to which this agent is effective in the work plan rotation
	DateRange *Daterangewithoptionalend `json:"dateRange,omitempty"`

	// Position - Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0
	Position *int `json:"position,omitempty"`
}

Addworkplanrotationagentrequest

func (*Addworkplanrotationagentrequest) String

String returns a JSON representation of the model

type Addworkplanrotationrequest

type Addworkplanrotationrequest struct {
	// Name - Name of this work plan rotation
	Name *string `json:"name,omitempty"`

	// DateRange - The date range to which this work plan rotation applies
	DateRange *Daterangewithoptionalend `json:"dateRange,omitempty"`

	// Agents - Agents in this work plan rotation
	Agents *[]Addworkplanrotationagentrequest `json:"agents,omitempty"`

	// Pattern - Pattern with list of work plan IDs that rotate on a weekly basis
	Pattern *Workplanpatternrequest `json:"pattern,omitempty"`
}

Addworkplanrotationrequest

func (*Addworkplanrotationrequest) String

func (o *Addworkplanrotationrequest) String() string

String returns a JSON representation of the model

type Adfs

type Adfs struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Disabled
	Disabled *bool `json:"disabled,omitempty"`

	// IssuerURI
	IssuerURI *string `json:"issuerURI,omitempty"`

	// SsoTargetURI
	SsoTargetURI *string `json:"ssoTargetURI,omitempty"`

	// Certificate
	Certificate *string `json:"certificate,omitempty"`

	// Certificates
	Certificates *[]string `json:"certificates,omitempty"`

	// RelyingPartyIdentifier
	RelyingPartyIdentifier *string `json:"relyingPartyIdentifier,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Adfs

func (*Adfs) String

func (o *Adfs) String() string

String returns a JSON representation of the model

type Adherencesettings

type Adherencesettings struct {
	// SevereAlertThresholdMinutes - The threshold in minutes where an alert will be triggered when an agent is considered severely out of adherence
	SevereAlertThresholdMinutes *int `json:"severeAlertThresholdMinutes,omitempty"`

	// AdherenceTargetPercent - Target adherence percentage
	AdherenceTargetPercent *int `json:"adherenceTargetPercent,omitempty"`

	// AdherenceExceptionThresholdSeconds - The threshold in seconds for which agents should not be penalized for being momentarily out of adherence
	AdherenceExceptionThresholdSeconds *int `json:"adherenceExceptionThresholdSeconds,omitempty"`

	// NonOnQueueActivitiesEquivalent - Whether to treat all non-on-queue activities as equivalent for adherence purposes
	NonOnQueueActivitiesEquivalent *bool `json:"nonOnQueueActivitiesEquivalent,omitempty"`

	// TrackOnQueueActivity - Whether to track on-queue activities
	TrackOnQueueActivity *bool `json:"trackOnQueueActivity,omitempty"`

	// IgnoredActivityCategories - Activity categories that should be ignored for adherence purposes
	IgnoredActivityCategories *Ignoredactivitycategories `json:"ignoredActivityCategories,omitempty"`
}

Adherencesettings - Schedule Adherence Configuration

func (*Adherencesettings) String

func (o *Adherencesettings) String() string

String returns a JSON representation of the model

type Adhocrecordingtopicconversationdata

type Adhocrecordingtopicconversationdata struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Adhocrecordingtopicconversationdata

func (*Adhocrecordingtopicconversationdata) String

String returns a JSON representation of the model

type Adhocrecordingtopiclockdata

type Adhocrecordingtopiclockdata struct {
	// LockedBy
	LockedBy *Adhocrecordingtopicuserdata `json:"lockedBy,omitempty"`

	// DateCreated
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateExpires
	DateExpires *time.Time `json:"dateExpires,omitempty"`
}

Adhocrecordingtopiclockdata

func (*Adhocrecordingtopiclockdata) String

func (o *Adhocrecordingtopiclockdata) String() string

String returns a JSON representation of the model

type Adhocrecordingtopicrecordingdatav2

type Adhocrecordingtopicrecordingdatav2 struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// DateCreated
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateModified
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Workspace
	Workspace *Adhocrecordingtopicworkspacedata `json:"workspace,omitempty"`

	// CreatedBy
	CreatedBy *Adhocrecordingtopicuserdata `json:"createdBy,omitempty"`

	// ContentType
	ContentType *string `json:"contentType,omitempty"`

	// ContentLength
	ContentLength *int `json:"contentLength,omitempty"`

	// Filename
	Filename *string `json:"filename,omitempty"`

	// ChangeNumber
	ChangeNumber *int `json:"changeNumber,omitempty"`

	// DateUploaded
	DateUploaded *time.Time `json:"dateUploaded,omitempty"`

	// UploadedBy
	UploadedBy *Adhocrecordingtopicuserdata `json:"uploadedBy,omitempty"`

	// LockInfo
	LockInfo *Adhocrecordingtopiclockdata `json:"lockInfo,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// DurationMillieconds
	DurationMillieconds *int `json:"durationMillieconds,omitempty"`

	// Conversation
	Conversation *Adhocrecordingtopicconversationdata `json:"conversation,omitempty"`

	// Read
	Read *bool `json:"read,omitempty"`
}

Adhocrecordingtopicrecordingdatav2

func (*Adhocrecordingtopicrecordingdatav2) String

String returns a JSON representation of the model

type Adhocrecordingtopicuserdata

type Adhocrecordingtopicuserdata struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Adhocrecordingtopicuserdata

func (*Adhocrecordingtopicuserdata) String

func (o *Adhocrecordingtopicuserdata) String() string

String returns a JSON representation of the model

type Adhocrecordingtopicworkspacedata

type Adhocrecordingtopicworkspacedata struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Adhocrecordingtopicworkspacedata

func (*Adhocrecordingtopicworkspacedata) String

String returns a JSON representation of the model

type Adjacents

type Adjacents struct {
	// Superiors
	Superiors *[]User `json:"superiors,omitempty"`

	// Siblings
	Siblings *[]User `json:"siblings,omitempty"`

	// DirectReports
	DirectReports *[]User `json:"directReports,omitempty"`
}

Adjacents

func (*Adjacents) String

func (o *Adjacents) String() string

String returns a JSON representation of the model

type Admintimeoffrequestpatch

type Admintimeoffrequestpatch struct {
	// Status - The status of this time off request
	Status *string `json:"status,omitempty"`

	// ActivityCodeId - The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category
	ActivityCodeId *string `json:"activityCodeId,omitempty"`

	// Notes - Notes about the time off request
	Notes *string `json:"notes,omitempty"`

	// FullDayManagementUnitDates - A set of dates in yyyy-MM-dd format.  Should be interpreted in the management unit's configured time zone.
	FullDayManagementUnitDates *[]string `json:"fullDayManagementUnitDates,omitempty"`

	// PartialDayStartDateTimes - A set of start date-times in ISO-8601 format for partial day requests.
	PartialDayStartDateTimes *[]time.Time `json:"partialDayStartDateTimes,omitempty"`

	// DailyDurationMinutes - The daily duration of this time off request in minutes
	DailyDurationMinutes *int `json:"dailyDurationMinutes,omitempty"`

	// Metadata - Version metadata for the time off request
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Admintimeoffrequestpatch

func (*Admintimeoffrequestpatch) String

func (o *Admintimeoffrequestpatch) String() string

String returns a JSON representation of the model

type Aftercallwork

type Aftercallwork struct {
	// StartTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartTime *time.Time `json:"startTime,omitempty"`

	// EndTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndTime *time.Time `json:"endTime,omitempty"`

	// State
	State *string `json:"state,omitempty"`
}

Aftercallwork

func (*Aftercallwork) String

func (o *Aftercallwork) String() string

String returns a JSON representation of the model

type Agent

type Agent struct {
	// Stage - The current stage for this agent
	Stage *string `json:"stage,omitempty"`
}

Agent

func (*Agent) String

func (o *Agent) String() string

String returns a JSON representation of the model

type Agentactivity

type Agentactivity struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Agent
	Agent *User `json:"agent,omitempty"`

	// NumEvaluations
	NumEvaluations *int `json:"numEvaluations,omitempty"`

	// AverageEvaluationScore
	AverageEvaluationScore *int `json:"averageEvaluationScore,omitempty"`

	// NumCriticalEvaluations
	NumCriticalEvaluations *int `json:"numCriticalEvaluations,omitempty"`

	// AverageCriticalScore
	AverageCriticalScore *float32 `json:"averageCriticalScore,omitempty"`

	// HighestEvaluationScore
	HighestEvaluationScore *float32 `json:"highestEvaluationScore,omitempty"`

	// LowestEvaluationScore
	LowestEvaluationScore *float32 `json:"lowestEvaluationScore,omitempty"`

	// HighestCriticalScore
	HighestCriticalScore *float32 `json:"highestCriticalScore,omitempty"`

	// LowestCriticalScore
	LowestCriticalScore *float32 `json:"lowestCriticalScore,omitempty"`

	// AgentEvaluatorActivityList
	AgentEvaluatorActivityList *[]Agentevaluatoractivity `json:"agentEvaluatorActivityList,omitempty"`

	// NumEvaluationsWithoutViewPermission
	NumEvaluationsWithoutViewPermission *int `json:"numEvaluationsWithoutViewPermission,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Agentactivity

func (*Agentactivity) String

func (o *Agentactivity) String() string

String returns a JSON representation of the model

type Agentactivitychangedtopicagentactivity

type Agentactivitychangedtopicagentactivity struct {
	// Id
	Id *string `json:"id,omitempty"`

	// RoutingStatus
	RoutingStatus *Agentactivitychangedtopicroutingstatus `json:"routingStatus,omitempty"`

	// Presence
	Presence *Agentactivitychangedtopicpresence `json:"presence,omitempty"`

	// OutOfOffice
	OutOfOffice *Agentactivitychangedtopicoutofoffice `json:"outOfOffice,omitempty"`

	// ActiveQueueIds
	ActiveQueueIds *[]string `json:"activeQueueIds,omitempty"`

	// DateActiveQueuesChanged
	DateActiveQueuesChanged *time.Time `json:"dateActiveQueuesChanged,omitempty"`
}

Agentactivitychangedtopicagentactivity

func (*Agentactivitychangedtopicagentactivity) String

String returns a JSON representation of the model

type Agentactivitychangedtopicorganizationpresence

type Agentactivitychangedtopicorganizationpresence struct {
	// Id
	Id *string `json:"id,omitempty"`

	// SystemPresence
	SystemPresence *string `json:"systemPresence,omitempty"`
}

Agentactivitychangedtopicorganizationpresence

func (*Agentactivitychangedtopicorganizationpresence) String

String returns a JSON representation of the model

type Agentactivitychangedtopicoutofoffice

type Agentactivitychangedtopicoutofoffice struct {
	// Active
	Active *bool `json:"active,omitempty"`

	// ModifiedDate
	ModifiedDate *time.Time `json:"modifiedDate,omitempty"`
}

Agentactivitychangedtopicoutofoffice

func (*Agentactivitychangedtopicoutofoffice) String

String returns a JSON representation of the model

type Agentactivitychangedtopicpresence

type Agentactivitychangedtopicpresence struct {
	// PresenceDefinition
	PresenceDefinition *Agentactivitychangedtopicorganizationpresence `json:"presenceDefinition,omitempty"`

	// PresenceMessage
	PresenceMessage *string `json:"presenceMessage,omitempty"`

	// ModifiedDate
	ModifiedDate *time.Time `json:"modifiedDate,omitempty"`
}

Agentactivitychangedtopicpresence

func (*Agentactivitychangedtopicpresence) String

String returns a JSON representation of the model

type Agentactivitychangedtopicroutingstatus

type Agentactivitychangedtopicroutingstatus struct {
	// Status
	Status *string `json:"status,omitempty"`

	// StartTime
	StartTime *time.Time `json:"startTime,omitempty"`
}

Agentactivitychangedtopicroutingstatus

func (*Agentactivitychangedtopicroutingstatus) String

String returns a JSON representation of the model

type Agentactivityentitylisting

type Agentactivityentitylisting struct {
	// Entities
	Entities *[]Agentactivity `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Agentactivityentitylisting

func (*Agentactivityentitylisting) String

func (o *Agentactivityentitylisting) String() string

String returns a JSON representation of the model

type Agentevaluatoractivity

type Agentevaluatoractivity struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Agent
	Agent *User `json:"agent,omitempty"`

	// Evaluator
	Evaluator *User `json:"evaluator,omitempty"`

	// NumEvaluations
	NumEvaluations *int `json:"numEvaluations,omitempty"`

	// AverageEvaluationScore
	AverageEvaluationScore *int `json:"averageEvaluationScore,omitempty"`

	// NumEvaluationsWithoutViewPermission
	NumEvaluationsWithoutViewPermission *int `json:"numEvaluationsWithoutViewPermission,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Agentevaluatoractivity

func (*Agentevaluatoractivity) String

func (o *Agentevaluatoractivity) String() string

String returns a JSON representation of the model

type Agenttimeoffrequestpatch

type Agenttimeoffrequestpatch struct {
	// MarkedAsRead - Whether this request has been read by the agent
	MarkedAsRead *bool `json:"markedAsRead,omitempty"`

	// Status - The status of this time off request. Can only be canceled if the requested date has not already passed
	Status *string `json:"status,omitempty"`

	// Notes - Notes about the time off request. Can only be edited while the request is still pending
	Notes *string `json:"notes,omitempty"`
}

Agenttimeoffrequestpatch

func (*Agenttimeoffrequestpatch) String

func (o *Agenttimeoffrequestpatch) String() string

String returns a JSON representation of the model

type Aggregatemetricdata

type Aggregatemetricdata struct {
	// Metric
	Metric *string `json:"metric,omitempty"`

	// Qualifier
	Qualifier *string `json:"qualifier,omitempty"`

	// Stats
	Stats *Statisticalsummary `json:"stats,omitempty"`
}

Aggregatemetricdata

func (*Aggregatemetricdata) String

func (o *Aggregatemetricdata) String() string

String returns a JSON representation of the model

type Aggregateviewdata

type Aggregateviewdata struct {
	// Name
	Name *string `json:"name,omitempty"`

	// Stats
	Stats *Statisticalsummary `json:"stats,omitempty"`
}

Aggregateviewdata

func (*Aggregateviewdata) String

func (o *Aggregateviewdata) String() string

String returns a JSON representation of the model

type Aggregationrange

type Aggregationrange struct {
	// Gte - Greater than or equal to
	Gte *float32 `json:"gte,omitempty"`

	// Lt - Less than
	Lt *float32 `json:"lt,omitempty"`
}

Aggregationrange

func (*Aggregationrange) String

func (o *Aggregationrange) String() string

String returns a JSON representation of the model

type Aggregationresult

type Aggregationresult struct {
	// VarType
	VarType *string `json:"type,omitempty"`

	// Dimension - For termFrequency aggregations
	Dimension *string `json:"dimension,omitempty"`

	// Metric - For numericRange aggregations
	Metric *string `json:"metric,omitempty"`

	// Count
	Count *int `json:"count,omitempty"`

	// Results
	Results *[]Aggregationresultentry `json:"results,omitempty"`
}

Aggregationresult

func (*Aggregationresult) String

func (o *Aggregationresult) String() string

String returns a JSON representation of the model

type Aggregationresultentry

type Aggregationresultentry struct {
	// Count
	Count *int `json:"count,omitempty"`

	// Value - For termFrequency aggregations
	Value *string `json:"value,omitempty"`

	// Gte - For numericRange aggregations
	Gte *float32 `json:"gte,omitempty"`

	// Lt - For numericRange aggregations
	Lt *float32 `json:"lt,omitempty"`
}

Aggregationresultentry

func (*Aggregationresultentry) String

func (o *Aggregationresultentry) String() string

String returns a JSON representation of the model

type AlertingApi

type AlertingApi struct {
	Configuration *Configuration
}

AlertingApi provides functions for API endpoints

func NewAlertingApi

func NewAlertingApi() *AlertingApi

NewAlertingApi creates an API instance using the default configuration

func NewAlertingApiWithConfig

func NewAlertingApiWithConfig(config *Configuration) *AlertingApi

NewAlertingApiWithConfig creates an API instance using the provided configuration

func (AlertingApi) DeleteAlertingInteractionstatsAlert

func (a AlertingApi) DeleteAlertingInteractionstatsAlert(alertId string) (*APIResponse, error)

DeleteAlertingInteractionstatsAlert invokes DELETE /api/v2/alerting/interactionstats/alerts/{alertId}

Delete an interaction stats alert

func (AlertingApi) DeleteAlertingInteractionstatsRule

func (a AlertingApi) DeleteAlertingInteractionstatsRule(ruleId string) (*APIResponse, error)

DeleteAlertingInteractionstatsRule invokes DELETE /api/v2/alerting/interactionstats/rules/{ruleId}

Delete an interaction stats rule.

func (AlertingApi) GetAlertingAlertsActive

func (a AlertingApi) GetAlertingAlertsActive() (*Activealertcount, *APIResponse, error)

GetAlertingAlertsActive invokes GET /api/v2/alerting/alerts/active

Gets active alert count for a user.

func (AlertingApi) GetAlertingInteractionstatsAlert

func (a AlertingApi) GetAlertingInteractionstatsAlert(alertId string, expand []string) (*Interactionstatsalert, *APIResponse, error)

GetAlertingInteractionstatsAlert invokes GET /api/v2/alerting/interactionstats/alerts/{alertId}

Get an interaction stats alert

func (AlertingApi) GetAlertingInteractionstatsAlerts

func (a AlertingApi) GetAlertingInteractionstatsAlerts(expand []string) (*Interactionstatsalertcontainer, *APIResponse, error)

GetAlertingInteractionstatsAlerts invokes GET /api/v2/alerting/interactionstats/alerts

Get interaction stats alert list.

func (AlertingApi) GetAlertingInteractionstatsAlertsUnread

func (a AlertingApi) GetAlertingInteractionstatsAlertsUnread() (*Unreadmetric, *APIResponse, error)

GetAlertingInteractionstatsAlertsUnread invokes GET /api/v2/alerting/interactionstats/alerts/unread

Gets user unread count of interaction stats alerts.

func (AlertingApi) GetAlertingInteractionstatsRule

func (a AlertingApi) GetAlertingInteractionstatsRule(ruleId string, expand []string) (*Interactionstatsrule, *APIResponse, error)

GetAlertingInteractionstatsRule invokes GET /api/v2/alerting/interactionstats/rules/{ruleId}

Get an interaction stats rule.

func (AlertingApi) GetAlertingInteractionstatsRules

func (a AlertingApi) GetAlertingInteractionstatsRules(expand []string) (*Interactionstatsrulecontainer, *APIResponse, error)

GetAlertingInteractionstatsRules invokes GET /api/v2/alerting/interactionstats/rules

Get an interaction stats rule list.

func (AlertingApi) PostAlertingInteractionstatsRules

func (a AlertingApi) PostAlertingInteractionstatsRules(body Interactionstatsrule, expand []string) (*Interactionstatsrule, *APIResponse, error)

PostAlertingInteractionstatsRules invokes POST /api/v2/alerting/interactionstats/rules

Create an interaction stats rule.

func (AlertingApi) PutAlertingInteractionstatsAlert

func (a AlertingApi) PutAlertingInteractionstatsAlert(alertId string, body Unreadstatus, expand []string) (*Unreadstatus, *APIResponse, error)

PutAlertingInteractionstatsAlert invokes PUT /api/v2/alerting/interactionstats/alerts/{alertId}

Update an interaction stats alert read status

func (AlertingApi) PutAlertingInteractionstatsRule

func (a AlertingApi) PutAlertingInteractionstatsRule(ruleId string, body Interactionstatsrule, expand []string) (*Interactionstatsrule, *APIResponse, error)

PutAlertingInteractionstatsRule invokes PUT /api/v2/alerting/interactionstats/rules/{ruleId}

Update an interaction stats rule

type Amazonlexrequest

type Amazonlexrequest struct {
	// RequestAttributes - AttributeName/AttributeValue pairs of User Defined Request Attributes to be sent to the amazon bot See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs
	RequestAttributes *map[string]string `json:"requestAttributes,omitempty"`

	// SessionAttributes - AttributeName/AttributeValue pairs of Session Attributes to be sent to the amazon bot. See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs
	SessionAttributes *map[string]string `json:"sessionAttributes,omitempty"`
}

Amazonlexrequest

func (*Amazonlexrequest) String

func (o *Amazonlexrequest) String() string

String returns a JSON representation of the model

type AnalyticsApi

type AnalyticsApi struct {
	Configuration *Configuration
}

AnalyticsApi provides functions for API endpoints

func NewAnalyticsApi

func NewAnalyticsApi() *AnalyticsApi

NewAnalyticsApi creates an API instance using the default configuration

func NewAnalyticsApiWithConfig

func NewAnalyticsApiWithConfig(config *Configuration) *AnalyticsApi

NewAnalyticsApiWithConfig creates an API instance using the provided configuration

func (AnalyticsApi) DeleteAnalyticsConversationsDetailsJob

func (a AnalyticsApi) DeleteAnalyticsConversationsDetailsJob(jobId string) (*APIResponse, error)

DeleteAnalyticsConversationsDetailsJob invokes DELETE /api/v2/analytics/conversations/details/jobs/{jobId}

Delete/cancel an async request

func (AnalyticsApi) DeleteAnalyticsReportingSchedule

func (a AnalyticsApi) DeleteAnalyticsReportingSchedule(scheduleId string) (*APIResponse, error)

DeleteAnalyticsReportingSchedule invokes DELETE /api/v2/analytics/reporting/schedules/{scheduleId}

Delete a scheduled report job.

func (AnalyticsApi) DeleteAnalyticsUsersDetailsJob

func (a AnalyticsApi) DeleteAnalyticsUsersDetailsJob(jobId string) (*APIResponse, error)

DeleteAnalyticsUsersDetailsJob invokes DELETE /api/v2/analytics/users/details/jobs/{jobId}

Delete/cancel an async request

func (AnalyticsApi) GetAnalyticsConversationDetails

func (a AnalyticsApi) GetAnalyticsConversationDetails(conversationId string) (*Analyticsconversationwithoutattributes, *APIResponse, error)

GetAnalyticsConversationDetails invokes GET /api/v2/analytics/conversations/{conversationId}/details

Get a conversation by id

func (AnalyticsApi) GetAnalyticsConversationsDetails

func (a AnalyticsApi) GetAnalyticsConversationsDetails(id []string) (*Analyticsconversationwithoutattributesmultigetresponse, *APIResponse, error)

GetAnalyticsConversationsDetails invokes GET /api/v2/analytics/conversations/details

Gets multiple conversations by id

func (AnalyticsApi) GetAnalyticsConversationsDetailsJob

func (a AnalyticsApi) GetAnalyticsConversationsDetailsJob(jobId string) (*Asyncquerystatus, *APIResponse, error)

GetAnalyticsConversationsDetailsJob invokes GET /api/v2/analytics/conversations/details/jobs/{jobId}

Get status for async query for conversation details

func (AnalyticsApi) GetAnalyticsConversationsDetailsJobResults

func (a AnalyticsApi) GetAnalyticsConversationsDetailsJobResults(jobId string, cursor string, pageSize int) (*Analyticsconversationasyncqueryresponse, *APIResponse, error)

GetAnalyticsConversationsDetailsJobResults invokes GET /api/v2/analytics/conversations/details/jobs/{jobId}/results

Fetch a page of results for an async query

func (AnalyticsApi) GetAnalyticsConversationsDetailsJobsAvailability

func (a AnalyticsApi) GetAnalyticsConversationsDetailsJobsAvailability() (*Dataavailabilityresponse, *APIResponse, error)

GetAnalyticsConversationsDetailsJobsAvailability invokes GET /api/v2/analytics/conversations/details/jobs/availability

Lookup the datalake availability date and time

func (AnalyticsApi) GetAnalyticsReportingExports

func (a AnalyticsApi) GetAnalyticsReportingExports(pageNumber int, pageSize int) (*Reportingexportjoblisting, *APIResponse, error)

GetAnalyticsReportingExports invokes GET /api/v2/analytics/reporting/exports

Get all view export requests for a user

func (AnalyticsApi) GetAnalyticsReportingExportsMetadata

func (a AnalyticsApi) GetAnalyticsReportingExportsMetadata() (*Reportingexportmetadatajoblisting, *APIResponse, error)

GetAnalyticsReportingExportsMetadata invokes GET /api/v2/analytics/reporting/exports/metadata

Get all export metadata

func (AnalyticsApi) GetAnalyticsReportingMetadata

func (a AnalyticsApi) GetAnalyticsReportingMetadata(pageNumber int, pageSize int, locale string) (*Reportmetadataentitylisting, *APIResponse, error)

GetAnalyticsReportingMetadata invokes GET /api/v2/analytics/reporting/metadata

Get list of reporting metadata.

func (AnalyticsApi) GetAnalyticsReportingReportIdMetadata

func (a AnalyticsApi) GetAnalyticsReportingReportIdMetadata(reportId string, locale string) (*Reportmetadata, *APIResponse, error)

GetAnalyticsReportingReportIdMetadata invokes GET /api/v2/analytics/reporting/{reportId}/metadata

Get a reporting metadata.

func (AnalyticsApi) GetAnalyticsReportingReportformats

func (a AnalyticsApi) GetAnalyticsReportingReportformats() ([]string, *APIResponse, error)

GetAnalyticsReportingReportformats invokes GET /api/v2/analytics/reporting/reportformats

Get a list of report formats

Get a list of report formats.

func (AnalyticsApi) GetAnalyticsReportingSchedule

func (a AnalyticsApi) GetAnalyticsReportingSchedule(scheduleId string) (*Reportschedule, *APIResponse, error)

GetAnalyticsReportingSchedule invokes GET /api/v2/analytics/reporting/schedules/{scheduleId}

Get a scheduled report job.

func (AnalyticsApi) GetAnalyticsReportingScheduleHistory

func (a AnalyticsApi) GetAnalyticsReportingScheduleHistory(scheduleId string, pageNumber int, pageSize int) (*Reportrunentryentitydomainlisting, *APIResponse, error)

GetAnalyticsReportingScheduleHistory invokes GET /api/v2/analytics/reporting/schedules/{scheduleId}/history

Get list of completed scheduled report jobs.

func (AnalyticsApi) GetAnalyticsReportingScheduleHistoryLatest

func (a AnalyticsApi) GetAnalyticsReportingScheduleHistoryLatest(scheduleId string) (*Reportrunentry, *APIResponse, error)

GetAnalyticsReportingScheduleHistoryLatest invokes GET /api/v2/analytics/reporting/schedules/{scheduleId}/history/latest

Get most recently completed scheduled report job.

func (AnalyticsApi) GetAnalyticsReportingScheduleHistoryRunId

func (a AnalyticsApi) GetAnalyticsReportingScheduleHistoryRunId(runId string, scheduleId string) (*Reportrunentry, *APIResponse, error)

GetAnalyticsReportingScheduleHistoryRunId invokes GET /api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}

A completed scheduled report job

A completed scheduled report job.

func (AnalyticsApi) GetAnalyticsReportingSchedules

func (a AnalyticsApi) GetAnalyticsReportingSchedules(pageNumber int, pageSize int) (*Reportscheduleentitylisting, *APIResponse, error)

GetAnalyticsReportingSchedules invokes GET /api/v2/analytics/reporting/schedules

Get a list of scheduled report jobs

Get a list of scheduled report jobs.

func (AnalyticsApi) GetAnalyticsReportingTimeperiods

func (a AnalyticsApi) GetAnalyticsReportingTimeperiods() ([]string, *APIResponse, error)

GetAnalyticsReportingTimeperiods invokes GET /api/v2/analytics/reporting/timeperiods

Get a list of report time periods.

func (AnalyticsApi) GetAnalyticsUsersDetailsJob

func (a AnalyticsApi) GetAnalyticsUsersDetailsJob(jobId string) (*Asyncquerystatus, *APIResponse, error)

GetAnalyticsUsersDetailsJob invokes GET /api/v2/analytics/users/details/jobs/{jobId}

Get status for async query for user details

func (AnalyticsApi) GetAnalyticsUsersDetailsJobResults

func (a AnalyticsApi) GetAnalyticsUsersDetailsJobResults(jobId string, cursor string, pageSize int) (*Analyticsuserdetailsasyncqueryresponse, *APIResponse, error)

GetAnalyticsUsersDetailsJobResults invokes GET /api/v2/analytics/users/details/jobs/{jobId}/results

Fetch a page of results for an async query

func (AnalyticsApi) GetAnalyticsUsersDetailsJobsAvailability

func (a AnalyticsApi) GetAnalyticsUsersDetailsJobsAvailability() (*Dataavailabilityresponse, *APIResponse, error)

GetAnalyticsUsersDetailsJobsAvailability invokes GET /api/v2/analytics/users/details/jobs/availability

Lookup the datalake availability date and time

func (AnalyticsApi) PostAnalyticsConversationDetailsProperties

func (a AnalyticsApi) PostAnalyticsConversationDetailsProperties(conversationId string, body Propertyindexrequest) (*Propertyindexrequest, *APIResponse, error)

PostAnalyticsConversationDetailsProperties invokes POST /api/v2/analytics/conversations/{conversationId}/details/properties

Index conversation properties

func (AnalyticsApi) PostAnalyticsConversationsAggregatesQuery

func (a AnalyticsApi) PostAnalyticsConversationsAggregatesQuery(body Conversationaggregationquery) (*Conversationaggregatequeryresponse, *APIResponse, error)

PostAnalyticsConversationsAggregatesQuery invokes POST /api/v2/analytics/conversations/aggregates/query

Query for conversation aggregates

func (AnalyticsApi) PostAnalyticsConversationsDetailsJobs

func (a AnalyticsApi) PostAnalyticsConversationsDetailsJobs(body Asyncconversationquery) (*Asyncqueryresponse, *APIResponse, error)

PostAnalyticsConversationsDetailsJobs invokes POST /api/v2/analytics/conversations/details/jobs

Query for conversation details asynchronously

func (AnalyticsApi) PostAnalyticsConversationsDetailsQuery

func (a AnalyticsApi) PostAnalyticsConversationsDetailsQuery(body Conversationquery) (*Analyticsconversationqueryresponse, *APIResponse, error)

PostAnalyticsConversationsDetailsQuery invokes POST /api/v2/analytics/conversations/details/query

Query for conversation details

func (AnalyticsApi) PostAnalyticsConversationsTranscriptsQuery

PostAnalyticsConversationsTranscriptsQuery invokes POST /api/v2/analytics/conversations/transcripts/query

Search resources.

func (AnalyticsApi) PostAnalyticsEvaluationsAggregatesQuery

func (a AnalyticsApi) PostAnalyticsEvaluationsAggregatesQuery(body Evaluationaggregationquery) (*Evaluationaggregatequeryresponse, *APIResponse, error)

PostAnalyticsEvaluationsAggregatesQuery invokes POST /api/v2/analytics/evaluations/aggregates/query

Query for evaluation aggregates

func (AnalyticsApi) PostAnalyticsFlowsAggregatesQuery

func (a AnalyticsApi) PostAnalyticsFlowsAggregatesQuery(body Flowaggregationquery) (*Flowaggregatequeryresponse, *APIResponse, error)

PostAnalyticsFlowsAggregatesQuery invokes POST /api/v2/analytics/flows/aggregates/query

Query for flow aggregates

func (AnalyticsApi) PostAnalyticsFlowsObservationsQuery

func (a AnalyticsApi) PostAnalyticsFlowsObservationsQuery(body Flowobservationquery) (*Flowobservationqueryresponse, *APIResponse, error)

PostAnalyticsFlowsObservationsQuery invokes POST /api/v2/analytics/flows/observations/query

Query for flow observations

func (AnalyticsApi) PostAnalyticsJourneysAggregatesQuery

func (a AnalyticsApi) PostAnalyticsJourneysAggregatesQuery(body Journeyaggregationquery) (*Journeyaggregatequeryresponse, *APIResponse, error)

PostAnalyticsJourneysAggregatesQuery invokes POST /api/v2/analytics/journeys/aggregates/query

Query for journey aggregates

func (AnalyticsApi) PostAnalyticsQueuesObservationsQuery

func (a AnalyticsApi) PostAnalyticsQueuesObservationsQuery(body Queueobservationquery) (*Queueobservationqueryresponse, *APIResponse, error)

PostAnalyticsQueuesObservationsQuery invokes POST /api/v2/analytics/queues/observations/query

Query for queue observations

func (AnalyticsApi) PostAnalyticsReportingExports

func (a AnalyticsApi) PostAnalyticsReportingExports(body Reportingexportjobrequest) (*Reportingexportjobresponse, *APIResponse, error)

PostAnalyticsReportingExports invokes POST /api/v2/analytics/reporting/exports

Generate a view export request

This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead

func (AnalyticsApi) PostAnalyticsReportingScheduleRunreport

func (a AnalyticsApi) PostAnalyticsReportingScheduleRunreport(scheduleId string) (*Runnowresponse, *APIResponse, error)

PostAnalyticsReportingScheduleRunreport invokes POST /api/v2/analytics/reporting/schedules/{scheduleId}/runreport

Place a scheduled report immediately into the reporting queue

func (AnalyticsApi) PostAnalyticsReportingSchedules

func (a AnalyticsApi) PostAnalyticsReportingSchedules(body Reportschedule) (*Reportschedule, *APIResponse, error)

PostAnalyticsReportingSchedules invokes POST /api/v2/analytics/reporting/schedules

Create a scheduled report job

Create a scheduled report job.

func (AnalyticsApi) PostAnalyticsSurveysAggregatesQuery

func (a AnalyticsApi) PostAnalyticsSurveysAggregatesQuery(body Surveyaggregationquery) (*Surveyaggregatequeryresponse, *APIResponse, error)

PostAnalyticsSurveysAggregatesQuery invokes POST /api/v2/analytics/surveys/aggregates/query

Query for survey aggregates

func (AnalyticsApi) PostAnalyticsTranscriptsAggregatesQuery

func (a AnalyticsApi) PostAnalyticsTranscriptsAggregatesQuery(body Transcriptaggregationquery) (*Transcriptaggregatequeryresponse, *APIResponse, error)

PostAnalyticsTranscriptsAggregatesQuery invokes POST /api/v2/analytics/transcripts/aggregates/query

Query for transcript aggregates

func (AnalyticsApi) PostAnalyticsUsersAggregatesQuery

func (a AnalyticsApi) PostAnalyticsUsersAggregatesQuery(body Useraggregationquery) (*Useraggregatequeryresponse, *APIResponse, error)

PostAnalyticsUsersAggregatesQuery invokes POST /api/v2/analytics/users/aggregates/query

Query for user aggregates

func (AnalyticsApi) PostAnalyticsUsersDetailsJobs

func (a AnalyticsApi) PostAnalyticsUsersDetailsJobs(body Asyncuserdetailsquery) (*Asyncqueryresponse, *APIResponse, error)

PostAnalyticsUsersDetailsJobs invokes POST /api/v2/analytics/users/details/jobs

Query for user details asynchronously

func (AnalyticsApi) PostAnalyticsUsersDetailsQuery

func (a AnalyticsApi) PostAnalyticsUsersDetailsQuery(body Userdetailsquery) (*Analyticsuserdetailsqueryresponse, *APIResponse, error)

PostAnalyticsUsersDetailsQuery invokes POST /api/v2/analytics/users/details/query

Query for user details

func (AnalyticsApi) PostAnalyticsUsersObservationsQuery

func (a AnalyticsApi) PostAnalyticsUsersObservationsQuery(body Userobservationquery) (*Userobservationqueryresponse, *APIResponse, error)

PostAnalyticsUsersObservationsQuery invokes POST /api/v2/analytics/users/observations/query

Query for user observations

func (AnalyticsApi) PutAnalyticsReportingSchedule

func (a AnalyticsApi) PutAnalyticsReportingSchedule(scheduleId string, body Reportschedule) (*Reportschedule, *APIResponse, error)

PutAnalyticsReportingSchedule invokes PUT /api/v2/analytics/reporting/schedules/{scheduleId}

Update a scheduled report job.

type Analyticsconversation

type Analyticsconversation struct {
	// ConversationId - Unique identifier for the conversation
	ConversationId *string `json:"conversationId,omitempty"`

	// ConversationStart - Date/time the conversation started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConversationStart *time.Time `json:"conversationStart,omitempty"`

	// ConversationEnd - Date/time the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConversationEnd *time.Time `json:"conversationEnd,omitempty"`

	// MediaStatsMinConversationMos - The lowest estimated average MOS among all the audio streams belonging to this conversation
	MediaStatsMinConversationMos *float64 `json:"mediaStatsMinConversationMos,omitempty"`

	// MediaStatsMinConversationRFactor - The lowest R-factor value among all of the audio streams belonging to this conversation
	MediaStatsMinConversationRFactor *float64 `json:"mediaStatsMinConversationRFactor,omitempty"`

	// OriginatingDirection - The original direction of the conversation
	OriginatingDirection *string `json:"originatingDirection,omitempty"`

	// Evaluations - Evaluations tied to this conversation
	Evaluations *[]Analyticsevaluation `json:"evaluations,omitempty"`

	// Surveys - Surveys tied to this conversation
	Surveys *[]Analyticssurvey `json:"surveys,omitempty"`

	// Resolutions - Resolutions tied to this conversation
	Resolutions *[]Analyticsresolution `json:"resolutions,omitempty"`

	// DivisionIds - Identifiers of divisions associated with this conversation
	DivisionIds *[]string `json:"divisionIds,omitempty"`

	// Participants - Participants in the conversation
	Participants *[]Analyticsparticipant `json:"participants,omitempty"`
}

Analyticsconversation

func (*Analyticsconversation) String

func (o *Analyticsconversation) String() string

String returns a JSON representation of the model

type Analyticsconversationasyncqueryresponse

type Analyticsconversationasyncqueryresponse struct {
	// Cursor - Optional cursor to indicate where to resume the results
	Cursor *string `json:"cursor,omitempty"`

	// DataAvailabilityDate - Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DataAvailabilityDate *time.Time `json:"dataAvailabilityDate,omitempty"`

	// Conversations
	Conversations *[]Analyticsconversation `json:"conversations,omitempty"`
}

Analyticsconversationasyncqueryresponse

func (*Analyticsconversationasyncqueryresponse) String

String returns a JSON representation of the model

type Analyticsconversationqueryresponse

type Analyticsconversationqueryresponse struct {
	// Aggregations
	Aggregations *[]Aggregationresult `json:"aggregations,omitempty"`

	// Conversations
	Conversations *[]Analyticsconversationwithoutattributes `json:"conversations,omitempty"`
}

Analyticsconversationqueryresponse

func (*Analyticsconversationqueryresponse) String

String returns a JSON representation of the model

type Analyticsconversationsegment

type Analyticsconversationsegment struct {
	// SegmentStart - The timestamp when this segment began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	SegmentStart *time.Time `json:"segmentStart,omitempty"`

	// SegmentEnd - The timestamp when this segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	SegmentEnd *time.Time `json:"segmentEnd,omitempty"`

	// QueueId - Queue identifier
	QueueId *string `json:"queueId,omitempty"`

	// WrapUpCode - Wrapup Code id
	WrapUpCode *string `json:"wrapUpCode,omitempty"`

	// WrapUpNote - Note entered by an agent during after-call work
	WrapUpNote *string `json:"wrapUpNote,omitempty"`

	// WrapUpTags
	WrapUpTags *[]string `json:"wrapUpTags,omitempty"`

	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// DisconnectType - A description of the event that disconnected the segment
	DisconnectType *string `json:"disconnectType,omitempty"`

	// SegmentType - The activity taking place for the participant in the segment
	SegmentType *string `json:"segmentType,omitempty"`

	// RequestedRoutingUserIds
	RequestedRoutingUserIds *[]string `json:"requestedRoutingUserIds,omitempty"`

	// RequestedRoutingSkillIds
	RequestedRoutingSkillIds *[]string `json:"requestedRoutingSkillIds,omitempty"`

	// RequestedLanguageId - A unique identifier for the language requested for an interaction.
	RequestedLanguageId *string `json:"requestedLanguageId,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Analyticsscoredagent `json:"scoredAgents,omitempty"`

	// Properties
	Properties *[]Analyticsproperty `json:"properties,omitempty"`

	// SourceConversationId
	SourceConversationId *string `json:"sourceConversationId,omitempty"`

	// DestinationConversationId
	DestinationConversationId *string `json:"destinationConversationId,omitempty"`

	// SourceSessionId
	SourceSessionId *string `json:"sourceSessionId,omitempty"`

	// DestinationSessionId
	DestinationSessionId *string `json:"destinationSessionId,omitempty"`

	// SipResponseCodes
	SipResponseCodes *[]int `json:"sipResponseCodes,omitempty"`

	// Q850ResponseCodes
	Q850ResponseCodes *[]int `json:"q850ResponseCodes,omitempty"`

	// Conference - Indicates whether the segment was a conference
	Conference *bool `json:"conference,omitempty"`

	// GroupId
	GroupId *string `json:"groupId,omitempty"`

	// Subject
	Subject *string `json:"subject,omitempty"`

	// AudioMuted
	AudioMuted *bool `json:"audioMuted,omitempty"`

	// VideoMuted
	VideoMuted *bool `json:"videoMuted,omitempty"`
}

Analyticsconversationsegment

func (*Analyticsconversationsegment) String

String returns a JSON representation of the model

type Analyticsconversationwithoutattributes

type Analyticsconversationwithoutattributes struct {
	// ConversationId - Unique identifier for the conversation
	ConversationId *string `json:"conversationId,omitempty"`

	// ConversationStart - Date/time the conversation started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConversationStart *time.Time `json:"conversationStart,omitempty"`

	// ConversationEnd - Date/time the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConversationEnd *time.Time `json:"conversationEnd,omitempty"`

	// MediaStatsMinConversationMos - The lowest estimated average MOS among all the audio streams belonging to this conversation
	MediaStatsMinConversationMos *float64 `json:"mediaStatsMinConversationMos,omitempty"`

	// MediaStatsMinConversationRFactor - The lowest R-factor value among all of the audio streams belonging to this conversation
	MediaStatsMinConversationRFactor *float64 `json:"mediaStatsMinConversationRFactor,omitempty"`

	// OriginatingDirection - The original direction of the conversation
	OriginatingDirection *string `json:"originatingDirection,omitempty"`

	// Evaluations - Evaluations tied to this conversation
	Evaluations *[]Analyticsevaluation `json:"evaluations,omitempty"`

	// Surveys - Surveys tied to this conversation
	Surveys *[]Analyticssurvey `json:"surveys,omitempty"`

	// Resolutions - Resolutions tied to this conversation
	Resolutions *[]Analyticsresolution `json:"resolutions,omitempty"`

	// DivisionIds - Identifiers of divisions associated with this conversation
	DivisionIds *[]string `json:"divisionIds,omitempty"`

	// Participants - Participants in the conversation
	Participants *[]Analyticsparticipantwithoutattributes `json:"participants,omitempty"`
}

Analyticsconversationwithoutattributes

func (*Analyticsconversationwithoutattributes) String

String returns a JSON representation of the model

type Analyticsconversationwithoutattributesmultigetresponse

type Analyticsconversationwithoutattributesmultigetresponse struct {
	// Conversations
	Conversations *[]Analyticsconversationwithoutattributes `json:"conversations,omitempty"`
}

Analyticsconversationwithoutattributesmultigetresponse

func (*Analyticsconversationwithoutattributesmultigetresponse) String

String returns a JSON representation of the model

type Analyticsevaluation

type Analyticsevaluation struct {
	// EvaluationId - Unique identifier for the evaluation
	EvaluationId *string `json:"evaluationId,omitempty"`

	// EvaluatorId - A unique identifier of the PureCloud user who evaluated the interaction
	EvaluatorId *string `json:"evaluatorId,omitempty"`

	// UserId - Unique identifier for the user being evaluated
	UserId *string `json:"userId,omitempty"`

	// EventTime - Specifies when an evaluation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EventTime *time.Time `json:"eventTime,omitempty"`

	// QueueId - Unique identifier for the queue the conversation was on
	QueueId *string `json:"queueId,omitempty"`

	// FormId - Unique identifier for the form used to evaluate the conversation/agent
	FormId *string `json:"formId,omitempty"`

	// ContextId - A unique identifier for an evaluation form, regardless of version
	ContextId *string `json:"contextId,omitempty"`

	// FormName - Name of the evaluation form
	FormName *string `json:"formName,omitempty"`

	// CalibrationId - The calibration id used for the purpose of training evaluators
	CalibrationId *string `json:"calibrationId,omitempty"`

	// Rescored - Whether this evaluation has ever been rescored
	Rescored *bool `json:"rescored,omitempty"`

	// Deleted - Whether this evaluation has been deleted
	Deleted *bool `json:"deleted,omitempty"`

	// OTotalScore
	OTotalScore *int `json:"oTotalScore,omitempty"`

	// OTotalCriticalScore
	OTotalCriticalScore *int `json:"oTotalCriticalScore,omitempty"`
}

Analyticsevaluation

func (*Analyticsevaluation) String

func (o *Analyticsevaluation) String() string

String returns a JSON representation of the model

type Analyticsflow

type Analyticsflow struct {
	// FlowId - The unique identifier of this flow
	FlowId *string `json:"flowId,omitempty"`

	// FlowName - The name of this flow
	FlowName *string `json:"flowName,omitempty"`

	// FlowVersion - The version of this flow
	FlowVersion *string `json:"flowVersion,omitempty"`

	// FlowType - The type of this flow
	FlowType *string `json:"flowType,omitempty"`

	// ExitReason - The exit reason for this flow, e.g. DISCONNECT
	ExitReason *string `json:"exitReason,omitempty"`

	// EntryReason - The particular entry reason for this flow, e.g. an address, userId, or flowId
	EntryReason *string `json:"entryReason,omitempty"`

	// EntryType - The entry type for this flow
	EntryType *string `json:"entryType,omitempty"`

	// TransferType - The type of transfer for flows that ended with a transfer
	TransferType *string `json:"transferType,omitempty"`

	// TransferTargetName - The name of a transfer target
	TransferTargetName *string `json:"transferTargetName,omitempty"`

	// TransferTargetAddress - The address of a transfer target
	TransferTargetAddress *string `json:"transferTargetAddress,omitempty"`

	// IssuedCallback - Flag indicating whether the flow issued a callback
	IssuedCallback *bool `json:"issuedCallback,omitempty"`

	// StartingLanguage - Flow starting language, e.g. en-us
	StartingLanguage *string `json:"startingLanguage,omitempty"`

	// EndingLanguage - Flow ending language, e.g. en-us
	EndingLanguage *string `json:"endingLanguage,omitempty"`

	// Outcomes - Flow outcomes
	Outcomes *[]Analyticsflowoutcome `json:"outcomes,omitempty"`
}

Analyticsflow

func (*Analyticsflow) String

func (o *Analyticsflow) String() string

String returns a JSON representation of the model

type Analyticsflowoutcome

type Analyticsflowoutcome struct {
	// FlowOutcomeId - Unique identifiers of a flow outcome
	FlowOutcomeId *string `json:"flowOutcomeId,omitempty"`

	// FlowOutcomeValue - Flow outcome value, e.g. SUCCESS
	FlowOutcomeValue *string `json:"flowOutcomeValue,omitempty"`

	// FlowOutcome - Colon-separated combinations of unique flow outcome identifier and value
	FlowOutcome *string `json:"flowOutcome,omitempty"`

	// FlowOutcomeStartTimestamp - Date/time the outcome started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	FlowOutcomeStartTimestamp *time.Time `json:"flowOutcomeStartTimestamp,omitempty"`

	// FlowOutcomeEndTimestamp - Date/time the outcome ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	FlowOutcomeEndTimestamp *time.Time `json:"flowOutcomeEndTimestamp,omitempty"`
}

Analyticsflowoutcome

func (*Analyticsflowoutcome) String

func (o *Analyticsflowoutcome) String() string

String returns a JSON representation of the model

type Analyticsmediaendpointstat

type Analyticsmediaendpointstat struct {
	// Codecs - The MIME types of the audio encodings used by the audio streams belonging to this endpoint
	Codecs *[]string `json:"codecs,omitempty"`

	// MinMos - The lowest estimated average MOS among all the audio streams belonging to this endpoint
	MinMos *float64 `json:"minMos,omitempty"`

	// MinRFactor - The lowest R-factor value among all of the audio streams belonging to this endpoint
	MinRFactor *float64 `json:"minRFactor,omitempty"`

	// MaxLatencyMs - The maximum latency experienced by any audio stream belonging to this endpoint, in milliseconds
	MaxLatencyMs *int `json:"maxLatencyMs,omitempty"`

	// ReceivedPackets - The total number of packets received for all audio streams belonging to this endpoint (includes invalid, duplicate, and discarded packets)
	ReceivedPackets *int `json:"receivedPackets,omitempty"`

	// InvalidPackets - The total number of malformed or not RTP packets, unknown payload type, or discarded probation packets for all audio streams belonging to this endpoint
	InvalidPackets *int `json:"invalidPackets,omitempty"`

	// DiscardedPackets - The total number of packets received too late or too early, jitter queue overrun or underrun, for all audio streams belonging to this endpoint
	DiscardedPackets *int `json:"discardedPackets,omitempty"`

	// DuplicatePackets - The total number of packets received with the same sequence number as another one recently received (window of 64 packets), for all audio streams belonging to this endpoint
	DuplicatePackets *int `json:"duplicatePackets,omitempty"`

	// OverrunPackets - The total number of packets for which there was no room in the jitter queue when it was received, for all audio streams belonging to this endpoint (also counted in discarded)
	OverrunPackets *int `json:"overrunPackets,omitempty"`

	// UnderrunPackets - The total number of packets received after their timestamp/seqnum has been played out, for all audio streams belonging to this endpoint (also counted in discarded)
	UnderrunPackets *int `json:"underrunPackets,omitempty"`
}

Analyticsmediaendpointstat

func (*Analyticsmediaendpointstat) String

func (o *Analyticsmediaendpointstat) String() string

String returns a JSON representation of the model

type Analyticsparticipant

type Analyticsparticipant struct {
	// ParticipantId - Unique identifier for the participant
	ParticipantId *string `json:"participantId,omitempty"`

	// ParticipantName - A human readable name identifying the participant
	ParticipantName *string `json:"participantName,omitempty"`

	// UserId - If a user, then this will be the unique identifier for the user
	UserId *string `json:"userId,omitempty"`

	// Purpose - The participant's purpose
	Purpose *string `json:"purpose,omitempty"`

	// ExternalContactId - External Contact Identifier
	ExternalContactId *string `json:"externalContactId,omitempty"`

	// ExternalOrganizationId - External Organization Identifier
	ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"`

	// FlaggedReason - Reason for which participant flagged conversation
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// TeamId - The team id the user is a member of
	TeamId *string `json:"teamId,omitempty"`

	// Sessions - List of sessions associated to this participant
	Sessions *[]Analyticssession `json:"sessions,omitempty"`

	// Attributes - List of attributes associated to this participant
	Attributes *map[string]string `json:"attributes,omitempty"`
}

Analyticsparticipant

func (*Analyticsparticipant) String

func (o *Analyticsparticipant) String() string

String returns a JSON representation of the model

type Analyticsparticipantwithoutattributes

type Analyticsparticipantwithoutattributes struct {
	// ParticipantId - Unique identifier for the participant
	ParticipantId *string `json:"participantId,omitempty"`

	// ParticipantName - A human readable name identifying the participant
	ParticipantName *string `json:"participantName,omitempty"`

	// UserId - If a user, then this will be the unique identifier for the user
	UserId *string `json:"userId,omitempty"`

	// Purpose - The participant's purpose
	Purpose *string `json:"purpose,omitempty"`

	// ExternalContactId - External Contact Identifier
	ExternalContactId *string `json:"externalContactId,omitempty"`

	// ExternalOrganizationId - External Organization Identifier
	ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"`

	// FlaggedReason - Reason for which participant flagged conversation
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// TeamId - The team id the user is a member of
	TeamId *string `json:"teamId,omitempty"`

	// Sessions - List of sessions associated to this participant
	Sessions *[]Analyticssession `json:"sessions,omitempty"`
}

Analyticsparticipantwithoutattributes

func (*Analyticsparticipantwithoutattributes) String

String returns a JSON representation of the model

type Analyticsproperty

type Analyticsproperty struct {
	// PropertyType - Indicates what the data type is (e.g. integer vs string) and therefore how to evaluate what would constitute a match
	PropertyType *string `json:"propertyType,omitempty"`

	// Property - User-defined rather than intrinsic system-observed values. These are tagged onto segments by other components within PureCloud or by API users directly.  This is the name of the user-defined property.
	Property *string `json:"property,omitempty"`

	// Value - What property value to match against
	Value *string `json:"value,omitempty"`
}

Analyticsproperty

func (*Analyticsproperty) String

func (o *Analyticsproperty) String() string

String returns a JSON representation of the model

type Analyticsproposedagent

type Analyticsproposedagent struct {
	// ProposedAgentId - Unique identifier of an agent that was proposed by predictive routing
	ProposedAgentId *string `json:"proposedAgentId,omitempty"`

	// AgentRank - Proposed agent rank for this conversation from predictive routing (lower is better)
	AgentRank *int `json:"agentRank,omitempty"`
}

Analyticsproposedagent

func (*Analyticsproposedagent) String

func (o *Analyticsproposedagent) String() string

String returns a JSON representation of the model

type Analyticsqueryaggregation

type Analyticsqueryaggregation struct {
	// VarType - Optional type, can usually be inferred
	VarType *string `json:"type,omitempty"`

	// Dimension - For use with termFrequency aggregations
	Dimension *string `json:"dimension,omitempty"`

	// Metric - For use with numericRange aggregations
	Metric *string `json:"metric,omitempty"`

	// Size - For use with termFrequency aggregations
	Size *int `json:"size,omitempty"`

	// Ranges - For use with numericRange aggregations
	Ranges *[]Aggregationrange `json:"ranges,omitempty"`
}

Analyticsqueryaggregation

func (*Analyticsqueryaggregation) String

func (o *Analyticsqueryaggregation) String() string

String returns a JSON representation of the model

type Analyticsresolution

type Analyticsresolution struct {
	// QueueId - The ID of the last queue on which the conversation was handled.
	QueueId *string `json:"queueId,omitempty"`

	// UserId - The ID of the last user who handled the conversation.
	UserId *string `json:"userId,omitempty"`

	// GetnNextContactAvoided - The number of interactions for which next contact was avoided.
	GetnNextContactAvoided *int `json:"getnNextContactAvoided,omitempty"`
}

Analyticsresolution

func (*Analyticsresolution) String

func (o *Analyticsresolution) String() string

String returns a JSON representation of the model

type Analyticsroutingstatusrecord

type Analyticsroutingstatusrecord struct {
	// StartTime - The start time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartTime *time.Time `json:"startTime,omitempty"`

	// EndTime - The end time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndTime *time.Time `json:"endTime,omitempty"`

	// RoutingStatus - The user's ACD routing status
	RoutingStatus *string `json:"routingStatus,omitempty"`
}

Analyticsroutingstatusrecord

func (*Analyticsroutingstatusrecord) String

String returns a JSON representation of the model

type Analyticsscoredagent

type Analyticsscoredagent struct {
	// ScoredAgentId - Unique identifier of an agent that was scored for this conversation
	ScoredAgentId *string `json:"scoredAgentId,omitempty"`

	// AgentScore - Assigned agent score for this conversation (0 - 100, higher being better)
	AgentScore *int `json:"agentScore,omitempty"`
}

Analyticsscoredagent

func (*Analyticsscoredagent) String

func (o *Analyticsscoredagent) String() string

String returns a JSON representation of the model

type Analyticssession

type Analyticssession struct {
	// MediaType - The session media type
	MediaType *string `json:"mediaType,omitempty"`

	// SessionId - The unique identifier of this session
	SessionId *string `json:"sessionId,omitempty"`

	// AddressOther
	AddressOther *string `json:"addressOther,omitempty"`

	// AddressSelf
	AddressSelf *string `json:"addressSelf,omitempty"`

	// AddressFrom
	AddressFrom *string `json:"addressFrom,omitempty"`

	// AddressTo
	AddressTo *string `json:"addressTo,omitempty"`

	// MessageType - Message type for messaging services such as sms
	MessageType *string `json:"messageType,omitempty"`

	// Ani - Automatic Number Identification (caller's number)
	Ani *string `json:"ani,omitempty"`

	// Direction - Direction
	Direction *string `json:"direction,omitempty"`

	// Dnis - Dialed number identification service (number dialed by the calling party)
	Dnis *string `json:"dnis,omitempty"`

	// SessionDnis - Dialed number for the current session; this can be different from dnis, e.g. if the call was transferred
	SessionDnis *string `json:"sessionDnis,omitempty"`

	// OutboundCampaignId - (Dialer) Unique identifier of the outbound campaign
	OutboundCampaignId *string `json:"outboundCampaignId,omitempty"`

	// OutboundContactId - (Dialer) Unique identifier of the contact
	OutboundContactId *string `json:"outboundContactId,omitempty"`

	// OutboundContactListId - (Dialer) Unique identifier of the contact list that this contact belongs to
	OutboundContactListId *string `json:"outboundContactListId,omitempty"`

	// DispositionAnalyzer - (Dialer) Unique identifier of the contact list that this contact belongs to
	DispositionAnalyzer *string `json:"dispositionAnalyzer,omitempty"`

	// DispositionName - (Dialer) Result of the analysis
	DispositionName *string `json:"dispositionName,omitempty"`

	// EdgeId - Unique identifier of the edge device
	EdgeId *string `json:"edgeId,omitempty"`

	// RemoteNameDisplayable
	RemoteNameDisplayable *string `json:"remoteNameDisplayable,omitempty"`

	// RoomId - Unique identifier for the room
	RoomId *string `json:"roomId,omitempty"`

	// MonitoredSessionId - The sessionID being monitored
	MonitoredSessionId *string `json:"monitoredSessionId,omitempty"`

	// MonitoredParticipantId
	MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"`

	// CallbackUserName - The name of the user requesting a call back
	CallbackUserName *string `json:"callbackUserName,omitempty"`

	// CallbackNumbers - List of numbers to callback
	CallbackNumbers *[]string `json:"callbackNumbers,omitempty"`

	// CallbackScheduledTime - Scheduled callback date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"`

	// ScriptId - A unique identifier for a script
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId - A unique identifier for a peer
	PeerId *string `json:"peerId,omitempty"`

	// SkipEnabled - (Dialer) Whether the agent can skip the dialer contact
	SkipEnabled *bool `json:"skipEnabled,omitempty"`

	// TimeoutSeconds - The number of seconds before PureCloud begins the call for a call back. 0 disables automatic calling
	TimeoutSeconds *int `json:"timeoutSeconds,omitempty"`

	// CobrowseRole - Describe side of the cobrowse (sharer or viewer)
	CobrowseRole *string `json:"cobrowseRole,omitempty"`

	// CobrowseRoomId - A unique identifier for a PureCloud Cobrowse room.
	CobrowseRoomId *string `json:"cobrowseRoomId,omitempty"`

	// MediaBridgeId
	MediaBridgeId *string `json:"mediaBridgeId,omitempty"`

	// ScreenShareAddressSelf - Direct ScreenShare address
	ScreenShareAddressSelf *string `json:"screenShareAddressSelf,omitempty"`

	// SharingScreen - Flag determining if screenShare is started or not (true/false)
	SharingScreen *bool `json:"sharingScreen,omitempty"`

	// ScreenShareRoomId - A unique identifier for a PureCloud ScreenShare room.
	ScreenShareRoomId *string `json:"screenShareRoomId,omitempty"`

	// VideoRoomId - A unique identifier for a PureCloud video room.
	VideoRoomId *string `json:"videoRoomId,omitempty"`

	// VideoAddressSelf - Direct Video address
	VideoAddressSelf *string `json:"videoAddressSelf,omitempty"`

	// Segments - List of segments for this session
	Segments *[]Analyticsconversationsegment `json:"segments,omitempty"`

	// Metrics - List of metrics for this session
	Metrics *[]Analyticssessionmetric `json:"metrics,omitempty"`

	// Flow - IVR flow execution associated with this session
	Flow *Analyticsflow `json:"flow,omitempty"`

	// MediaEndpointStats - Media endpoint stats associated with this session
	MediaEndpointStats *[]Analyticsmediaendpointstat `json:"mediaEndpointStats,omitempty"`

	// Recording - Flag determining if an audio recording was started or not
	Recording *bool `json:"recording,omitempty"`

	// JourneyCustomerId - ID of the journey customer
	JourneyCustomerId *string `json:"journeyCustomerId,omitempty"`

	// JourneyCustomerIdType - Type of the journey customer ID
	JourneyCustomerIdType *string `json:"journeyCustomerIdType,omitempty"`

	// JourneyCustomerSessionId - ID of the journey customer session
	JourneyCustomerSessionId *string `json:"journeyCustomerSessionId,omitempty"`

	// JourneyCustomerSessionIdType - Type of the journey customer session ID
	JourneyCustomerSessionIdType *string `json:"journeyCustomerSessionIdType,omitempty"`

	// JourneyActionId - Journey action ID
	JourneyActionId *string `json:"journeyActionId,omitempty"`

	// JourneyActionMapId - Journey action map ID
	JourneyActionMapId *string `json:"journeyActionMapId,omitempty"`

	// JourneyActionMapVersion - Journey action map version
	JourneyActionMapVersion *string `json:"journeyActionMapVersion,omitempty"`

	// ProtocolCallId - The original voice protocol call ID, e.g. a SIP call ID
	ProtocolCallId *string `json:"protocolCallId,omitempty"`

	// Provider - The source provider for the communication
	Provider *string `json:"provider,omitempty"`

	// Remote - Name, phone number, or email address of the remote party.
	Remote *string `json:"remote,omitempty"`

	// MediaCount - Count of any media (images, files, etc) included in this session
	MediaCount *int `json:"mediaCount,omitempty"`

	// FlowInType - Type of flow in that occurred, e.g. acd, ivr, etc.
	FlowInType *string `json:"flowInType,omitempty"`

	// FlowOutType - Type of flow out that occurred, e.g. voicemail, callback, or acd
	FlowOutType *string `json:"flowOutType,omitempty"`

	// RequestedRoutings - All routing types for requested/attempted routing methods.
	RequestedRoutings *[]string `json:"requestedRoutings,omitempty"`

	// UsedRouting - Complete routing method
	UsedRouting *string `json:"usedRouting,omitempty"`

	// SelectedAgentId - Selected agent id
	SelectedAgentId *string `json:"selectedAgentId,omitempty"`

	// SelectedAgentRank - Selected agent GPR rank
	SelectedAgentRank *int `json:"selectedAgentRank,omitempty"`

	// AgentAssistantId - Unique identifier of the active virtual agent assistant
	AgentAssistantId *string `json:"agentAssistantId,omitempty"`

	// ProposedAgents - Proposed agents
	ProposedAgents *[]Analyticsproposedagent `json:"proposedAgents,omitempty"`

	// AssignerId - ID of the user that manually assigned a conversation
	AssignerId *string `json:"assignerId,omitempty"`

	// AcwSkipped - Marker for an agent that skipped after call work
	AcwSkipped *bool `json:"acwSkipped,omitempty"`
}

Analyticssession

func (*Analyticssession) String

func (o *Analyticssession) String() string

String returns a JSON representation of the model

type Analyticssessionmetric

type Analyticssessionmetric struct {
	// Name - Unique name of this metric
	Name *string `json:"name,omitempty"`

	// Value - The metric value
	Value *int `json:"value,omitempty"`

	// EmitDate - Metric emission date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EmitDate *time.Time `json:"emitDate,omitempty"`
}

Analyticssessionmetric

func (*Analyticssessionmetric) String

func (o *Analyticssessionmetric) String() string

String returns a JSON representation of the model

type Analyticssurvey

type Analyticssurvey struct {
	// SurveyId - Unique identifier for the survey
	SurveyId *string `json:"surveyId,omitempty"`

	// SurveyFormId - Unique identifier for the survey form
	SurveyFormId *string `json:"surveyFormId,omitempty"`

	// SurveyFormName - Name of the survey form
	SurveyFormName *string `json:"surveyFormName,omitempty"`

	// SurveyFormContextId - Unique identifier for the survey form, regardless of version
	SurveyFormContextId *string `json:"surveyFormContextId,omitempty"`

	// EventTime - Specifies when a survey occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EventTime *time.Time `json:"eventTime,omitempty"`

	// UserId - A unique identifier of the PureCloud user
	UserId *string `json:"userId,omitempty"`

	// QueueId - Unique identifier for the queue the conversation was on
	QueueId *string `json:"queueId,omitempty"`

	// SurveyStatus - Survey status
	SurveyStatus *string `json:"surveyStatus,omitempty"`

	// SurveyPromoterScore - Promoter score of the survey
	SurveyPromoterScore *int `json:"surveyPromoterScore,omitempty"`

	// SurveyCompletedDate - Completion date/time of the survey. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	SurveyCompletedDate *time.Time `json:"surveyCompletedDate,omitempty"`

	// OSurveyTotalScore
	OSurveyTotalScore *int `json:"oSurveyTotalScore,omitempty"`
}

Analyticssurvey

func (*Analyticssurvey) String

func (o *Analyticssurvey) String() string

String returns a JSON representation of the model

type Analyticsuserdetail

type Analyticsuserdetail struct {
	// UserId - The identifier for the user
	UserId *string `json:"userId,omitempty"`

	// PrimaryPresence - The presence records for the user
	PrimaryPresence *[]Analyticsuserpresencerecord `json:"primaryPresence,omitempty"`

	// RoutingStatus - The ACD routing status records for the user
	RoutingStatus *[]Analyticsroutingstatusrecord `json:"routingStatus,omitempty"`
}

Analyticsuserdetail

func (*Analyticsuserdetail) String

func (o *Analyticsuserdetail) String() string

String returns a JSON representation of the model

type Analyticsuserdetailsasyncqueryresponse

type Analyticsuserdetailsasyncqueryresponse struct {
	// UserDetails
	UserDetails *[]Analyticsuserdetail `json:"userDetails,omitempty"`

	// Cursor - Optional cursor to indicate where to resume the results
	Cursor *string `json:"cursor,omitempty"`

	// DataAvailabilityDate - Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DataAvailabilityDate *time.Time `json:"dataAvailabilityDate,omitempty"`
}

Analyticsuserdetailsasyncqueryresponse

func (*Analyticsuserdetailsasyncqueryresponse) String

String returns a JSON representation of the model

type Analyticsuserdetailsqueryresponse

type Analyticsuserdetailsqueryresponse struct {
	// UserDetails
	UserDetails *[]Analyticsuserdetail `json:"userDetails,omitempty"`

	// Aggregations
	Aggregations *[]Aggregationresult `json:"aggregations,omitempty"`
}

Analyticsuserdetailsqueryresponse

func (*Analyticsuserdetailsqueryresponse) String

String returns a JSON representation of the model

type Analyticsuserpresencerecord

type Analyticsuserpresencerecord struct {
	// StartTime - The start time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartTime *time.Time `json:"startTime,omitempty"`

	// EndTime - The end time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndTime *time.Time `json:"endTime,omitempty"`

	// SystemPresence - The user's system presence
	SystemPresence *string `json:"systemPresence,omitempty"`

	// OrganizationPresenceId - The identifier for the user's organization presence
	OrganizationPresenceId *string `json:"organizationPresenceId,omitempty"`
}

Analyticsuserpresencerecord

func (*Analyticsuserpresencerecord) String

func (o *Analyticsuserpresencerecord) String() string

String returns a JSON representation of the model

type Annotation

type Annotation struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// Location - Offset of annotation in milliseconds.
	Location *int `json:"location,omitempty"`

	// DurationMs - Duration of annotation in milliseconds.
	DurationMs *int `json:"durationMs,omitempty"`

	// AbsoluteLocation - Offset of annotation (milliseconds) from start of recording.
	AbsoluteLocation *int `json:"absoluteLocation,omitempty"`

	// AbsoluteDurationMs - Duration of annotation (milliseconds).
	AbsoluteDurationMs *int `json:"absoluteDurationMs,omitempty"`

	// RecordingLocation - Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts
	RecordingLocation *int `json:"recordingLocation,omitempty"`

	// RecordingDurationMs - Duration of annotation (milliseconds), adjusted for any recording cuts.
	RecordingDurationMs *int `json:"recordingDurationMs,omitempty"`

	// User - User that created this annotation (if any).
	User *User `json:"user,omitempty"`

	// Description - Text of annotation.
	Description *string `json:"description,omitempty"`

	// KeywordName - The word or phrase which is being looked for with speech recognition.
	KeywordName *string `json:"keywordName,omitempty"`

	// Confidence - Actual confidence that this is an accurate match.
	Confidence *float32 `json:"confidence,omitempty"`

	// KeywordSetId - A unique identifier for the keyword set to which this spotted keyword belongs.
	KeywordSetId *string `json:"keywordSetId,omitempty"`

	// KeywordSetName - The keyword set to which this spotted keyword belongs.
	KeywordSetName *string `json:"keywordSetName,omitempty"`

	// Utterance - The phonetic spellings for the phrase and alternate spellings.
	Utterance *string `json:"utterance,omitempty"`

	// TimeBegin - Beginning time offset of the keyword spot match.
	TimeBegin *string `json:"timeBegin,omitempty"`

	// TimeEnd - Ending time offset of the keyword spot match.
	TimeEnd *string `json:"timeEnd,omitempty"`

	// KeywordConfidenceThreshold - Configured sensitivity threshold that can be increased to lower false positives or decreased to reduce false negatives.
	KeywordConfidenceThreshold *string `json:"keywordConfidenceThreshold,omitempty"`

	// AgentScoreModifier - A modifier to the evaluation score when the phrase is spotted in the agent channel.
	AgentScoreModifier *string `json:"agentScoreModifier,omitempty"`

	// CustomerScoreModifier - A modifier to the evaluation score when the phrase is spotted in the customer channel.
	CustomerScoreModifier *string `json:"customerScoreModifier,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Annotation

func (*Annotation) String

func (o *Annotation) String() string

String returns a JSON representation of the model

type Answeroption

type Answeroption struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Text
	Text *string `json:"text,omitempty"`

	// Value
	Value *int `json:"value,omitempty"`
}

Answeroption

func (*Answeroption) String

func (o *Answeroption) String() string

String returns a JSON representation of the model

type Apiusagequery

type Apiusagequery struct {
	// Interval - Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
	Interval *string `json:"interval,omitempty"`

	// Granularity - Date granularity of the results
	Granularity *string `json:"granularity,omitempty"`

	// GroupBy - Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
	GroupBy *[]string `json:"groupBy,omitempty"`

	// Metrics - Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).
	Metrics *[]string `json:"metrics,omitempty"`
}

Apiusagequery

func (*Apiusagequery) String

func (o *Apiusagequery) String() string

String returns a JSON representation of the model

type Apiusagequeryresult

type Apiusagequeryresult struct {
	// Results - Query results
	Results *[]Apiusagerow `json:"results,omitempty"`

	// QueryStatus - Query status
	QueryStatus *string `json:"queryStatus,omitempty"`
}

Apiusagequeryresult

func (*Apiusagequeryresult) String

func (o *Apiusagequeryresult) String() string

String returns a JSON representation of the model

type Apiusagerow

type Apiusagerow struct {
	// ClientId - Client Id associated with this query result
	ClientId *string `json:"clientId,omitempty"`

	// ClientName - Client Name associated with this query result
	ClientName *string `json:"clientName,omitempty"`

	// OrganizationId - Organization Id associated with this query result
	OrganizationId *string `json:"organizationId,omitempty"`

	// UserId - User Id associated with this query result
	UserId *string `json:"userId,omitempty"`

	// TemplateUri - Template Uri associated with this query result
	TemplateUri *string `json:"templateUri,omitempty"`

	// HttpMethod - HTTP Method associated with this query result
	HttpMethod *string `json:"httpMethod,omitempty"`

	// Status200 - Number of requests resulting in a 2xx HTTP status code
	Status200 *int `json:"status200,omitempty"`

	// Status300 - Number of requests resulting in a 3xx HTTP status code
	Status300 *int `json:"status300,omitempty"`

	// Status400 - Number of requests resulting in a 4xx HTTP status code
	Status400 *int `json:"status400,omitempty"`

	// Status500 - Number of requests resulting in a 5xx HTTP status code
	Status500 *int `json:"status500,omitempty"`

	// Status429 - Number of requests resulting in a 429 HTTP status code, this is a subset of the count returned with status400
	Status429 *int `json:"status429,omitempty"`

	// Requests - Total number of requests
	Requests *int `json:"requests,omitempty"`

	// Date - Date of requests, based on granularity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Date *time.Time `json:"date,omitempty"`
}

Apiusagerow

func (*Apiusagerow) String

func (o *Apiusagerow) String() string

String returns a JSON representation of the model

type ArchitectApi

type ArchitectApi struct {
	Configuration *Configuration
}

ArchitectApi provides functions for API endpoints

func NewArchitectApi

func NewArchitectApi() *ArchitectApi

NewArchitectApi creates an API instance using the default configuration

func NewArchitectApiWithConfig

func NewArchitectApiWithConfig(config *Configuration) *ArchitectApi

NewArchitectApiWithConfig creates an API instance using the provided configuration

func (ArchitectApi) DeleteArchitectEmergencygroup

func (a ArchitectApi) DeleteArchitectEmergencygroup(emergencyGroupId string) (*APIResponse, error)

DeleteArchitectEmergencygroup invokes DELETE /api/v2/architect/emergencygroups/{emergencyGroupId}

Deletes a emergency group by ID

func (ArchitectApi) DeleteArchitectIvr

func (a ArchitectApi) DeleteArchitectIvr(ivrId string) (*APIResponse, error)

DeleteArchitectIvr invokes DELETE /api/v2/architect/ivrs/{ivrId}

Delete an IVR Config.

func (ArchitectApi) DeleteArchitectPrompt

func (a ArchitectApi) DeleteArchitectPrompt(promptId string, allResources bool) (*APIResponse, error)

DeleteArchitectPrompt invokes DELETE /api/v2/architect/prompts/{promptId}

Delete specified user prompt

func (ArchitectApi) DeleteArchitectPromptResource

func (a ArchitectApi) DeleteArchitectPromptResource(promptId string, languageCode string) (*APIResponse, error)

DeleteArchitectPromptResource invokes DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}

Delete specified user prompt resource

func (ArchitectApi) DeleteArchitectPromptResourceAudio

func (a ArchitectApi) DeleteArchitectPromptResourceAudio(promptId string, languageCode string) (*APIResponse, error)

DeleteArchitectPromptResourceAudio invokes DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio

Delete specified user prompt resource audio

func (ArchitectApi) DeleteArchitectPrompts

func (a ArchitectApi) DeleteArchitectPrompts(id []string) (*Operation, *APIResponse, error)

DeleteArchitectPrompts invokes DELETE /api/v2/architect/prompts

Batch-delete a list of prompts

Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId}

func (ArchitectApi) DeleteArchitectSchedule

func (a ArchitectApi) DeleteArchitectSchedule(scheduleId string) (*APIResponse, error)

DeleteArchitectSchedule invokes DELETE /api/v2/architect/schedules/{scheduleId}

Delete a schedule by id

func (ArchitectApi) DeleteArchitectSchedulegroup

func (a ArchitectApi) DeleteArchitectSchedulegroup(scheduleGroupId string) (*APIResponse, error)

DeleteArchitectSchedulegroup invokes DELETE /api/v2/architect/schedulegroups/{scheduleGroupId}

Deletes a schedule group by ID

func (ArchitectApi) DeleteArchitectSystempromptResource

func (a ArchitectApi) DeleteArchitectSystempromptResource(promptId string, languageCode string) (*APIResponse, error)

DeleteArchitectSystempromptResource invokes DELETE /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}

Delete a system prompt resource override.

func (ArchitectApi) DeleteFlow

func (a ArchitectApi) DeleteFlow(flowId string) (*APIResponse, error)

DeleteFlow invokes DELETE /api/v2/flows/{flowId}

Delete flow

func (ArchitectApi) DeleteFlows

func (a ArchitectApi) DeleteFlows(id []string) (*Operation, *APIResponse, error)

DeleteFlows invokes DELETE /api/v2/flows

Batch-delete a list of flows

Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId}

func (ArchitectApi) DeleteFlowsDatatable

func (a ArchitectApi) DeleteFlowsDatatable(datatableId string, force bool) (*APIResponse, error)

DeleteFlowsDatatable invokes DELETE /api/v2/flows/datatables/{datatableId}

deletes a specific datatable by id

Deletes an entire datatable (including the schema and data) with a given datatableId

func (ArchitectApi) DeleteFlowsDatatableRow

func (a ArchitectApi) DeleteFlowsDatatableRow(datatableId string, rowId string) (*APIResponse, error)

DeleteFlowsDatatableRow invokes DELETE /api/v2/flows/datatables/{datatableId}/rows/{rowId}

Delete a row entry

Deletes a row with a given rowId (the value of the key field).

func (ArchitectApi) DeleteFlowsMilestone

func (a ArchitectApi) DeleteFlowsMilestone(milestoneId string) (*Empty, *APIResponse, error)

DeleteFlowsMilestone invokes DELETE /api/v2/flows/milestones/{milestoneId}

Delete a flow milestone.

func (ArchitectApi) GetArchitectDependencytracking

func (a ArchitectApi) GetArchitectDependencytracking(name string, pageNumber int, pageSize int, objectType []string, consumedResources bool, consumingResources bool, consumedResourceType []string, consumingResourceType []string) (*Dependencyobjectentitylisting, *APIResponse, error)

GetArchitectDependencytracking invokes GET /api/v2/architect/dependencytracking

Get Dependency Tracking objects that have a given display name

func (ArchitectApi) GetArchitectDependencytrackingBuild

func (a ArchitectApi) GetArchitectDependencytrackingBuild() (*Dependencystatus, *APIResponse, error)

GetArchitectDependencytrackingBuild invokes GET /api/v2/architect/dependencytracking/build

Get Dependency Tracking build status for an organization

func (ArchitectApi) GetArchitectDependencytrackingConsumedresources

func (a ArchitectApi) GetArchitectDependencytrackingConsumedresources(id string, version string, objectType string, resourceType []string, pageNumber int, pageSize int) (*Consumedresourcesentitylisting, *APIResponse, error)

GetArchitectDependencytrackingConsumedresources invokes GET /api/v2/architect/dependencytracking/consumedresources

Get resources that are consumed by a given Dependency Tracking object

func (ArchitectApi) GetArchitectDependencytrackingConsumingresources

func (a ArchitectApi) GetArchitectDependencytrackingConsumingresources(id string, objectType string, resourceType []string, version string, pageNumber int, pageSize int, flowFilter string) (*Consumingresourcesentitylisting, *APIResponse, error)

GetArchitectDependencytrackingConsumingresources invokes GET /api/v2/architect/dependencytracking/consumingresources

Get resources that consume a given Dependency Tracking object

func (ArchitectApi) GetArchitectDependencytrackingDeletedresourceconsumers

func (a ArchitectApi) GetArchitectDependencytrackingDeletedresourceconsumers(name string, objectType []string, flowFilter string, consumedResources bool, consumedResourceType []string, pageNumber int, pageSize int) (*Dependencyobjectentitylisting, *APIResponse, error)

GetArchitectDependencytrackingDeletedresourceconsumers invokes GET /api/v2/architect/dependencytracking/deletedresourceconsumers

Get Dependency Tracking objects that consume deleted resources

func (ArchitectApi) GetArchitectDependencytrackingObject

func (a ArchitectApi) GetArchitectDependencytrackingObject(id string, version string, objectType string, consumedResources bool, consumingResources bool, consumedResourceType []string, consumingResourceType []string, consumedResourceRequest bool) (*Dependencyobject, *APIResponse, error)

GetArchitectDependencytrackingObject invokes GET /api/v2/architect/dependencytracking/object

Get a Dependency Tracking object

func (ArchitectApi) GetArchitectDependencytrackingType

func (a ArchitectApi) GetArchitectDependencytrackingType(typeId string) (*Dependencytype, *APIResponse, error)

GetArchitectDependencytrackingType invokes GET /api/v2/architect/dependencytracking/types/{typeId}

Get a Dependency Tracking type.

func (ArchitectApi) GetArchitectDependencytrackingTypes

func (a ArchitectApi) GetArchitectDependencytrackingTypes(pageNumber int, pageSize int) (*Dependencytypeentitylisting, *APIResponse, error)

GetArchitectDependencytrackingTypes invokes GET /api/v2/architect/dependencytracking/types

Get Dependency Tracking types.

func (ArchitectApi) GetArchitectDependencytrackingUpdatedresourceconsumers

func (a ArchitectApi) GetArchitectDependencytrackingUpdatedresourceconsumers(name string, objectType []string, consumedResources bool, consumedResourceType []string, pageNumber int, pageSize int) (*Dependencyobjectentitylisting, *APIResponse, error)

GetArchitectDependencytrackingUpdatedresourceconsumers invokes GET /api/v2/architect/dependencytracking/updatedresourceconsumers

Get Dependency Tracking objects that depend on updated resources

func (ArchitectApi) GetArchitectEmergencygroup

func (a ArchitectApi) GetArchitectEmergencygroup(emergencyGroupId string) (*Emergencygroup, *APIResponse, error)

GetArchitectEmergencygroup invokes GET /api/v2/architect/emergencygroups/{emergencyGroupId}

Gets a emergency group by ID

func (ArchitectApi) GetArchitectEmergencygroups

func (a ArchitectApi) GetArchitectEmergencygroups(pageNumber int, pageSize int, sortBy string, sortOrder string, name string) (*Emergencygrouplisting, *APIResponse, error)

GetArchitectEmergencygroups invokes GET /api/v2/architect/emergencygroups

Get a list of emergency groups.

func (ArchitectApi) GetArchitectIvr

func (a ArchitectApi) GetArchitectIvr(ivrId string) (*Ivr, *APIResponse, error)

GetArchitectIvr invokes GET /api/v2/architect/ivrs/{ivrId}

Get an IVR config.

func (ArchitectApi) GetArchitectIvrs

func (a ArchitectApi) GetArchitectIvrs(pageNumber int, pageSize int, sortBy string, sortOrder string, name string) (*Ivrentitylisting, *APIResponse, error)

GetArchitectIvrs invokes GET /api/v2/architect/ivrs

Get IVR configs.

func (ArchitectApi) GetArchitectPrompt

func (a ArchitectApi) GetArchitectPrompt(promptId string) (*Prompt, *APIResponse, error)

GetArchitectPrompt invokes GET /api/v2/architect/prompts/{promptId}

Get specified user prompt

func (ArchitectApi) GetArchitectPromptHistoryHistoryId

func (a ArchitectApi) GetArchitectPromptHistoryHistoryId(promptId string, historyId string, pageNumber int, pageSize int, sortOrder string, sortBy string, action []string) (*Historylisting, *APIResponse, error)

GetArchitectPromptHistoryHistoryId invokes GET /api/v2/architect/prompts/{promptId}/history/{historyId}

Get generated prompt history

func (ArchitectApi) GetArchitectPromptResource

func (a ArchitectApi) GetArchitectPromptResource(promptId string, languageCode string) (*Promptasset, *APIResponse, error)

GetArchitectPromptResource invokes GET /api/v2/architect/prompts/{promptId}/resources/{languageCode}

Get specified user prompt resource

func (ArchitectApi) GetArchitectPromptResources

func (a ArchitectApi) GetArchitectPromptResources(promptId string, pageNumber int, pageSize int) (*Promptassetentitylisting, *APIResponse, error)

GetArchitectPromptResources invokes GET /api/v2/architect/prompts/{promptId}/resources

Get a pageable list of user prompt resources

The returned list is pageable, and query parameters can be used for filtering.

func (ArchitectApi) GetArchitectPrompts

func (a ArchitectApi) GetArchitectPrompts(pageNumber int, pageSize int, name []string, description string, nameOrDescription string, sortBy string, sortOrder string) (*Promptentitylisting, *APIResponse, error)

GetArchitectPrompts invokes GET /api/v2/architect/prompts

Get a pageable list of user prompts

The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.

func (ArchitectApi) GetArchitectSchedule

func (a ArchitectApi) GetArchitectSchedule(scheduleId string) (*Schedule, *APIResponse, error)

GetArchitectSchedule invokes GET /api/v2/architect/schedules/{scheduleId}

Get a schedule by ID

func (ArchitectApi) GetArchitectSchedulegroup

func (a ArchitectApi) GetArchitectSchedulegroup(scheduleGroupId string) (*Schedulegroup, *APIResponse, error)

GetArchitectSchedulegroup invokes GET /api/v2/architect/schedulegroups/{scheduleGroupId}

Gets a schedule group by ID

func (ArchitectApi) GetArchitectSchedulegroups

func (a ArchitectApi) GetArchitectSchedulegroups(pageNumber int, pageSize int, sortBy string, sortOrder string, name string, scheduleIds string) (*Schedulegroupentitylisting, *APIResponse, error)

GetArchitectSchedulegroups invokes GET /api/v2/architect/schedulegroups

Get a list of schedule groups.

func (ArchitectApi) GetArchitectSchedules

func (a ArchitectApi) GetArchitectSchedules(pageNumber int, pageSize int, sortBy string, sortOrder string, name string) (*Scheduleentitylisting, *APIResponse, error)

GetArchitectSchedules invokes GET /api/v2/architect/schedules

Get a list of schedules.

func (ArchitectApi) GetArchitectSystemprompt

func (a ArchitectApi) GetArchitectSystemprompt(promptId string) (*Systemprompt, *APIResponse, error)

GetArchitectSystemprompt invokes GET /api/v2/architect/systemprompts/{promptId}

Get a system prompt

func (ArchitectApi) GetArchitectSystempromptHistoryHistoryId

func (a ArchitectApi) GetArchitectSystempromptHistoryHistoryId(promptId string, historyId string, pageNumber int, pageSize int, sortOrder string, sortBy string, action []string) (*Historylisting, *APIResponse, error)

GetArchitectSystempromptHistoryHistoryId invokes GET /api/v2/architect/systemprompts/{promptId}/history/{historyId}

Get generated prompt history

func (ArchitectApi) GetArchitectSystempromptResource

func (a ArchitectApi) GetArchitectSystempromptResource(promptId string, languageCode string) (*Systempromptasset, *APIResponse, error)

GetArchitectSystempromptResource invokes GET /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}

Get a system prompt resource.

func (ArchitectApi) GetArchitectSystempromptResources

func (a ArchitectApi) GetArchitectSystempromptResources(promptId string, pageNumber int, pageSize int, sortBy string, sortOrder string) (*Systempromptassetentitylisting, *APIResponse, error)

GetArchitectSystempromptResources invokes GET /api/v2/architect/systemprompts/{promptId}/resources

Get system prompt resources.

func (ArchitectApi) GetArchitectSystemprompts

func (a ArchitectApi) GetArchitectSystemprompts(pageNumber int, pageSize int, sortBy string, sortOrder string, name string, description string, nameOrDescription string) (*Systempromptentitylisting, *APIResponse, error)

GetArchitectSystemprompts invokes GET /api/v2/architect/systemprompts

Get System Prompts

func (ArchitectApi) GetFlow

func (a ArchitectApi) GetFlow(flowId string, deleted bool) (*Flow, *APIResponse, error)

GetFlow invokes GET /api/v2/flows/{flowId}

Get flow

func (ArchitectApi) GetFlowHistoryHistoryId

func (a ArchitectApi) GetFlowHistoryHistoryId(flowId string, historyId string, pageNumber int, pageSize int, sortOrder string, sortBy string, action []string) (*Historylisting, *APIResponse, error)

GetFlowHistoryHistoryId invokes GET /api/v2/flows/{flowId}/history/{historyId}

Get generated flow history

func (ArchitectApi) GetFlowLatestconfiguration

func (a ArchitectApi) GetFlowLatestconfiguration(flowId string, deleted bool) (*map[string]interface{}, *APIResponse, error)

GetFlowLatestconfiguration invokes GET /api/v2/flows/{flowId}/latestconfiguration

Get the latest configuration for flow

func (ArchitectApi) GetFlowVersion

func (a ArchitectApi) GetFlowVersion(flowId string, versionId string, deleted string) (*Flowversion, *APIResponse, error)

GetFlowVersion invokes GET /api/v2/flows/{flowId}/versions/{versionId}

Get flow version

func (ArchitectApi) GetFlowVersionConfiguration

func (a ArchitectApi) GetFlowVersionConfiguration(flowId string, versionId string, deleted string) (*map[string]interface{}, *APIResponse, error)

GetFlowVersionConfiguration invokes GET /api/v2/flows/{flowId}/versions/{versionId}/configuration

Create flow version configuration

func (ArchitectApi) GetFlowVersions

func (a ArchitectApi) GetFlowVersions(flowId string, pageNumber int, pageSize int, deleted bool) (*Flowversionentitylisting, *APIResponse, error)

GetFlowVersions invokes GET /api/v2/flows/{flowId}/versions

Get flow version list

func (ArchitectApi) GetFlows

func (a ArchitectApi) GetFlows(varType []string, pageNumber int, pageSize int, sortBy string, sortOrder string, id []string, name string, description string, nameOrDescription string, publishVersionId string, editableBy string, lockedBy string, lockedByClientId string, secure string, deleted bool, includeSchemas bool, publishedAfter string, publishedBefore string, divisionId []string) (*Flowentitylisting, *APIResponse, error)

GetFlows invokes GET /api/v2/flows

Get a pageable list of flows, filtered by query parameters

If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.

func (ArchitectApi) GetFlowsDatatable

func (a ArchitectApi) GetFlowsDatatable(datatableId string, expand string) (*Datatable, *APIResponse, error)

GetFlowsDatatable invokes GET /api/v2/flows/datatables/{datatableId}

Returns a specific datatable by id

Given a datatableId returns the datatable object and schema associated with it.

func (ArchitectApi) GetFlowsDatatableExportJob

func (a ArchitectApi) GetFlowsDatatableExportJob(datatableId string, exportJobId string) (*Datatableexportjob, *APIResponse, error)

GetFlowsDatatableExportJob invokes GET /api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId}

Returns the state information about an export job

Returns the state information about an export job.

func (ArchitectApi) GetFlowsDatatableImportJob

func (a ArchitectApi) GetFlowsDatatableImportJob(datatableId string, importJobId string) (*Datatableimportjob, *APIResponse, error)

GetFlowsDatatableImportJob invokes GET /api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}

Returns the state information about an import job

Returns the state information about an import job.

func (ArchitectApi) GetFlowsDatatableImportJobs

func (a ArchitectApi) GetFlowsDatatableImportJobs(datatableId string, pageNumber int, pageSize int) (*Entitylisting, *APIResponse, error)

GetFlowsDatatableImportJobs invokes GET /api/v2/flows/datatables/{datatableId}/import/jobs

Get all recent import jobs

Get all recent import jobs

func (ArchitectApi) GetFlowsDatatableRow

func (a ArchitectApi) GetFlowsDatatableRow(datatableId string, rowId string, showbrief bool) (*map[string]interface{}, *APIResponse, error)

GetFlowsDatatableRow invokes GET /api/v2/flows/datatables/{datatableId}/rows/{rowId}

Returns a specific row for the datatable

Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.

func (ArchitectApi) GetFlowsDatatableRows

func (a ArchitectApi) GetFlowsDatatableRows(datatableId string, pageNumber int, pageSize int, showbrief bool) (*Datatablerowentitylisting, *APIResponse, error)

GetFlowsDatatableRows invokes GET /api/v2/flows/datatables/{datatableId}/rows

Returns the rows for the datatable with the given id

Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.

func (ArchitectApi) GetFlowsDatatables

func (a ArchitectApi) GetFlowsDatatables(expand string, pageNumber int, pageSize int, sortBy string, sortOrder string) (*Datatablesdomainentitylisting, *APIResponse, error)

GetFlowsDatatables invokes GET /api/v2/flows/datatables

Retrieve a list of datatables for the org

Returns a metadata list of the datatables associated with this org, including datatableId, name and description.

func (ArchitectApi) GetFlowsDivisionviews

func (a ArchitectApi) GetFlowsDivisionviews(varType []string, pageNumber int, pageSize int, sortBy string, sortOrder string, id []string, name string, publishVersionId string, publishedAfter string, publishedBefore string, divisionId []string, includeSchemas bool) (*Flowdivisionviewentitylisting, *APIResponse, error)

GetFlowsDivisionviews invokes GET /api/v2/flows/divisionviews

Get a pageable list of basic flow information objects filterable by query parameters.

This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.

func (ArchitectApi) GetFlowsExecution

func (a ArchitectApi) GetFlowsExecution(flowExecutionId string) (*Flowruntimeexecution, *APIResponse, error)

GetFlowsExecution invokes GET /api/v2/flows/executions/{flowExecutionId}

Get a flow execution's details. Flow execution details are available for several days after the flow is started.

func (ArchitectApi) GetFlowsMilestone

func (a ArchitectApi) GetFlowsMilestone(milestoneId string) (*Flowmilestone, *APIResponse, error)

GetFlowsMilestone invokes GET /api/v2/flows/milestones/{milestoneId}

Get a flow milestone

Returns a specified flow milestone

func (ArchitectApi) GetFlowsMilestones

func (a ArchitectApi) GetFlowsMilestones(pageNumber int, pageSize int, sortBy string, sortOrder string, id []string, name string, description string, nameOrDescription string) (*Flowmilestonelisting, *APIResponse, error)

GetFlowsMilestones invokes GET /api/v2/flows/milestones

Get a pageable list of flow milestones, filtered by query parameters

Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated.

func (ArchitectApi) GetFlowsOutcome

func (a ArchitectApi) GetFlowsOutcome(flowOutcomeId string) (*Flowoutcome, *APIResponse, error)

GetFlowsOutcome invokes GET /api/v2/flows/outcomes/{flowOutcomeId}

Get a flow outcome

Returns a specified flow outcome

func (ArchitectApi) GetFlowsOutcomes

func (a ArchitectApi) GetFlowsOutcomes(pageNumber int, pageSize int, sortBy string, sortOrder string, id []string, name string, description string, nameOrDescription string) (*Flowoutcomelisting, *APIResponse, error)

GetFlowsOutcomes invokes GET /api/v2/flows/outcomes

Get a pageable list of flow outcomes, filtered by query parameters

Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.

func (ArchitectApi) PostArchitectDependencytrackingBuild

func (a ArchitectApi) PostArchitectDependencytrackingBuild() (*APIResponse, error)

PostArchitectDependencytrackingBuild invokes POST /api/v2/architect/dependencytracking/build

Rebuild Dependency Tracking data for an organization

Asynchronous. Notification topic: v2.architect.dependencytracking.build

func (ArchitectApi) PostArchitectEmergencygroups

func (a ArchitectApi) PostArchitectEmergencygroups(body Emergencygroup) (*Emergencygroup, *APIResponse, error)

PostArchitectEmergencygroups invokes POST /api/v2/architect/emergencygroups

Creates a new emergency group

func (ArchitectApi) PostArchitectIvrs

func (a ArchitectApi) PostArchitectIvrs(body Ivr) (*Ivr, *APIResponse, error)

PostArchitectIvrs invokes POST /api/v2/architect/ivrs

Create IVR config.

func (ArchitectApi) PostArchitectPromptHistory

func (a ArchitectApi) PostArchitectPromptHistory(promptId string) (*Operation, *APIResponse, error)

PostArchitectPromptHistory invokes POST /api/v2/architect/prompts/{promptId}/history

Generate prompt history

Asynchronous. Notification topic: v2.architect.prompts.{promptId}

func (ArchitectApi) PostArchitectPromptResources

func (a ArchitectApi) PostArchitectPromptResources(promptId string, body Promptassetcreate) (*Promptasset, *APIResponse, error)

PostArchitectPromptResources invokes POST /api/v2/architect/prompts/{promptId}/resources

Create a new user prompt resource

func (ArchitectApi) PostArchitectPrompts

func (a ArchitectApi) PostArchitectPrompts(body Prompt) (*Prompt, *APIResponse, error)

PostArchitectPrompts invokes POST /api/v2/architect/prompts

Create a new user prompt

func (ArchitectApi) PostArchitectSchedulegroups

func (a ArchitectApi) PostArchitectSchedulegroups(body Schedulegroup) (*Schedulegroup, *APIResponse, error)

PostArchitectSchedulegroups invokes POST /api/v2/architect/schedulegroups

Creates a new schedule group

func (ArchitectApi) PostArchitectSchedules

func (a ArchitectApi) PostArchitectSchedules(body Schedule) (*Schedule, *APIResponse, error)

PostArchitectSchedules invokes POST /api/v2/architect/schedules

Create a new schedule.

func (ArchitectApi) PostArchitectSystempromptHistory

func (a ArchitectApi) PostArchitectSystempromptHistory(promptId string) (*Operation, *APIResponse, error)

PostArchitectSystempromptHistory invokes POST /api/v2/architect/systemprompts/{promptId}/history

Generate system prompt history

Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId}

func (ArchitectApi) PostArchitectSystempromptResources

func (a ArchitectApi) PostArchitectSystempromptResources(promptId string, body Systempromptasset) (*Systempromptasset, *APIResponse, error)

PostArchitectSystempromptResources invokes POST /api/v2/architect/systemprompts/{promptId}/resources

Create system prompt resource override.

func (ArchitectApi) PostFlowVersions

func (a ArchitectApi) PostFlowVersions(flowId string, body map[string]interface{}) (*Flowversion, *APIResponse, error)

PostFlowVersions invokes POST /api/v2/flows/{flowId}/versions

Create flow version

func (ArchitectApi) PostFlows

func (a ArchitectApi) PostFlows(body Flow) (*Flow, *APIResponse, error)

PostFlows invokes POST /api/v2/flows

Create flow

func (ArchitectApi) PostFlowsActionsCheckin

func (a ArchitectApi) PostFlowsActionsCheckin(flow string) (*Operation, *APIResponse, error)

PostFlowsActionsCheckin invokes POST /api/v2/flows/actions/checkin

Check-in flow

Asynchronous. Notification topic: v2.flows.{flowId}

func (ArchitectApi) PostFlowsActionsCheckout

func (a ArchitectApi) PostFlowsActionsCheckout(flow string) (*Flow, *APIResponse, error)

PostFlowsActionsCheckout invokes POST /api/v2/flows/actions/checkout

Check-out flow

func (ArchitectApi) PostFlowsActionsDeactivate

func (a ArchitectApi) PostFlowsActionsDeactivate(flow string) (*Flow, *APIResponse, error)

PostFlowsActionsDeactivate invokes POST /api/v2/flows/actions/deactivate

Deactivate flow

func (ArchitectApi) PostFlowsActionsPublish

func (a ArchitectApi) PostFlowsActionsPublish(flow string, version string) (*Operation, *APIResponse, error)

PostFlowsActionsPublish invokes POST /api/v2/flows/actions/publish

Publish flow

Asynchronous. Notification topic: v2.flows.{flowId}

func (ArchitectApi) PostFlowsActionsRevert

func (a ArchitectApi) PostFlowsActionsRevert(flow string) (*Flow, *APIResponse, error)

PostFlowsActionsRevert invokes POST /api/v2/flows/actions/revert

Revert flow

func (ArchitectApi) PostFlowsActionsUnlock

func (a ArchitectApi) PostFlowsActionsUnlock(flow string) (*Flow, *APIResponse, error)

PostFlowsActionsUnlock invokes POST /api/v2/flows/actions/unlock

Unlock flow

Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action.

func (ArchitectApi) PostFlowsDatatableExportJobs

func (a ArchitectApi) PostFlowsDatatableExportJobs(datatableId string) (*Datatableexportjob, *APIResponse, error)

PostFlowsDatatableExportJobs invokes POST /api/v2/flows/datatables/{datatableId}/export/jobs

Begin an export process for exporting all rows from a datatable

Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response

func (ArchitectApi) PostFlowsDatatableImportJobs

func (a ArchitectApi) PostFlowsDatatableImportJobs(datatableId string, body Datatableimportjob) (*Datatableimportjob, *APIResponse, error)

PostFlowsDatatableImportJobs invokes POST /api/v2/flows/datatables/{datatableId}/import/jobs

Begin an import process for importing rows into a datatable

Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response

func (ArchitectApi) PostFlowsDatatableRows

func (a ArchitectApi) PostFlowsDatatableRows(datatableId string, dataTableRow map[string]interface{}) (*map[string]interface{}, *APIResponse, error)

PostFlowsDatatableRows invokes POST /api/v2/flows/datatables/{datatableId}/rows

Create a new row entry for the datatable.

Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" }

func (ArchitectApi) PostFlowsDatatables

func (a ArchitectApi) PostFlowsDatatables(body Datatable) (*Datatable, *APIResponse, error)

PostFlowsDatatables invokes POST /api/v2/flows/datatables

Create a new datatable with the specified json-schema definition

This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/

func (ArchitectApi) PostFlowsExecutions

func (a ArchitectApi) PostFlowsExecutions(flowLaunchRequest Flowexecutionlaunchrequest) (*Flowexecutionlaunchresponse, *APIResponse, error)

PostFlowsExecutions invokes POST /api/v2/flows/executions

Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.

The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.

func (ArchitectApi) PostFlowsMilestones

func (a ArchitectApi) PostFlowsMilestones(body Flowmilestone) (*Flowmilestone, *APIResponse, error)

PostFlowsMilestones invokes POST /api/v2/flows/milestones

Create a flow milestone

func (ArchitectApi) PostFlowsOutcomes

func (a ArchitectApi) PostFlowsOutcomes(body Flowoutcome) (*Flowoutcome, *APIResponse, error)

PostFlowsOutcomes invokes POST /api/v2/flows/outcomes

Create a flow outcome

Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId}

func (ArchitectApi) PutArchitectEmergencygroup

func (a ArchitectApi) PutArchitectEmergencygroup(emergencyGroupId string, body Emergencygroup) (*Emergencygroup, *APIResponse, error)

PutArchitectEmergencygroup invokes PUT /api/v2/architect/emergencygroups/{emergencyGroupId}

Updates a emergency group by ID

func (ArchitectApi) PutArchitectIvr

func (a ArchitectApi) PutArchitectIvr(ivrId string, body Ivr) (*Ivr, *APIResponse, error)

PutArchitectIvr invokes PUT /api/v2/architect/ivrs/{ivrId}

Update an IVR Config.

func (ArchitectApi) PutArchitectPrompt

func (a ArchitectApi) PutArchitectPrompt(promptId string, body Prompt) (*Prompt, *APIResponse, error)

PutArchitectPrompt invokes PUT /api/v2/architect/prompts/{promptId}

Update specified user prompt

func (ArchitectApi) PutArchitectPromptResource

func (a ArchitectApi) PutArchitectPromptResource(promptId string, languageCode string, body Promptasset) (*Promptasset, *APIResponse, error)

PutArchitectPromptResource invokes PUT /api/v2/architect/prompts/{promptId}/resources/{languageCode}

Update specified user prompt resource

func (ArchitectApi) PutArchitectSchedule

func (a ArchitectApi) PutArchitectSchedule(scheduleId string, body Schedule) (*Schedule, *APIResponse, error)

PutArchitectSchedule invokes PUT /api/v2/architect/schedules/{scheduleId}

Update schedule by ID

func (ArchitectApi) PutArchitectSchedulegroup

func (a ArchitectApi) PutArchitectSchedulegroup(scheduleGroupId string, body Schedulegroup) (*Schedulegroup, *APIResponse, error)

PutArchitectSchedulegroup invokes PUT /api/v2/architect/schedulegroups/{scheduleGroupId}

Updates a schedule group by ID

func (ArchitectApi) PutArchitectSystempromptResource

func (a ArchitectApi) PutArchitectSystempromptResource(promptId string, languageCode string, body Systempromptasset) (*Systempromptasset, *APIResponse, error)

PutArchitectSystempromptResource invokes PUT /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}

Updates a system prompt resource override.

func (ArchitectApi) PutFlow

func (a ArchitectApi) PutFlow(flowId string, body Flow) (*Flow, *APIResponse, error)

PutFlow invokes PUT /api/v2/flows/{flowId}

Update flow

func (ArchitectApi) PutFlowsDatatable

func (a ArchitectApi) PutFlowsDatatable(datatableId string, expand string, body Datatable) (*Datatable, *APIResponse, error)

PutFlowsDatatable invokes PUT /api/v2/flows/datatables/{datatableId}

Updates a specific datatable by id

Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.

func (ArchitectApi) PutFlowsDatatableRow

func (a ArchitectApi) PutFlowsDatatableRow(datatableId string, rowId string, body map[string]interface{}) (*map[string]interface{}, *APIResponse, error)

PutFlowsDatatableRow invokes PUT /api/v2/flows/datatables/{datatableId}/rows/{rowId}

Update a row entry

Updates a row with the given rowId (the value of the key field) to the new values. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" }

func (ArchitectApi) PutFlowsMilestone

func (a ArchitectApi) PutFlowsMilestone(milestoneId string, body Flowmilestone) (*Flowmilestone, *APIResponse, error)

PutFlowsMilestone invokes PUT /api/v2/flows/milestones/{milestoneId}

Updates a flow milestone

func (ArchitectApi) PutFlowsOutcome

func (a ArchitectApi) PutFlowsOutcome(flowOutcomeId string, body Flowoutcome) (*Operation, *APIResponse, error)

PutFlowsOutcome invokes PUT /api/v2/flows/outcomes/{flowOutcomeId}

Updates a flow outcome

Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.{flowoutcomeId}

type Architectdependencytrackingbuildnotificationclient

type Architectdependencytrackingbuildnotificationclient struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Architectdependencytrackingbuildnotificationclient

func (*Architectdependencytrackingbuildnotificationclient) String

String returns a JSON representation of the model

type Architectdependencytrackingbuildnotificationdependencytrackingbuildnotification

type Architectdependencytrackingbuildnotificationdependencytrackingbuildnotification struct {
	// Status
	Status *string `json:"status,omitempty"`

	// User
	User *Architectdependencytrackingbuildnotificationuser `json:"user,omitempty"`

	// Client
	Client *Architectdependencytrackingbuildnotificationclient `json:"client,omitempty"`

	// StartTime
	StartTime *time.Time `json:"startTime,omitempty"`
}

Architectdependencytrackingbuildnotificationdependencytrackingbuildnotification

func (*Architectdependencytrackingbuildnotificationdependencytrackingbuildnotification) String

String returns a JSON representation of the model

type Architectdependencytrackingbuildnotificationhomeorganization

type Architectdependencytrackingbuildnotificationhomeorganization struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ThirdPartyOrgName
	ThirdPartyOrgName *string `json:"thirdPartyOrgName,omitempty"`
}

Architectdependencytrackingbuildnotificationhomeorganization

func (*Architectdependencytrackingbuildnotificationhomeorganization) String

String returns a JSON representation of the model

type Architectdependencytrackingbuildnotificationuser

type Architectdependencytrackingbuildnotificationuser struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// HomeOrg
	HomeOrg *Architectdependencytrackingbuildnotificationhomeorganization `json:"homeOrg,omitempty"`
}

Architectdependencytrackingbuildnotificationuser

func (*Architectdependencytrackingbuildnotificationuser) String

String returns a JSON representation of the model

type Architectflowfields

type Architectflowfields struct {
	// ArchitectFlow - The architect flow.
	ArchitectFlow *Addressableentityref `json:"architectFlow,omitempty"`

	// FlowRequestMappings - Collection of Architect Flow Request Mappings to use.
	FlowRequestMappings *[]Requestmapping `json:"flowRequestMappings,omitempty"`
}

Architectflowfields

func (*Architectflowfields) String

func (o *Architectflowfields) String() string

String returns a JSON representation of the model

type Architectflownotificationarchitectoperation

type Architectflownotificationarchitectoperation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Complete
	Complete *bool `json:"complete,omitempty"`

	// User
	User *Architectflownotificationuser `json:"user,omitempty"`

	// Client
	Client *Architectflownotificationclient `json:"client,omitempty"`

	// ActionName
	ActionName *string `json:"actionName,omitempty"`

	// ActionStatus
	ActionStatus *string `json:"actionStatus,omitempty"`

	// ErrorMessage
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// ErrorMessageParams
	ErrorMessageParams *Architectflownotificationerrormessageparams `json:"errorMessageParams,omitempty"`

	// ErrorDetails
	ErrorDetails *[]Architectflownotificationerrordetail `json:"errorDetails,omitempty"`
}

Architectflownotificationarchitectoperation

func (*Architectflownotificationarchitectoperation) String

String returns a JSON representation of the model

type Architectflownotificationclient

type Architectflownotificationclient struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Architectflownotificationclient

func (*Architectflownotificationclient) String

String returns a JSON representation of the model

type Architectflownotificationerrordetail

type Architectflownotificationerrordetail struct {
	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// FieldName
	FieldName *string `json:"fieldName,omitempty"`
}

Architectflownotificationerrordetail

func (*Architectflownotificationerrordetail) String

String returns a JSON representation of the model

type Architectflownotificationerrormessageparams

type Architectflownotificationerrormessageparams struct {
	// AdditionalProperties
	AdditionalProperties *map[string]string `json:"additionalProperties,omitempty"`
}

Architectflownotificationerrormessageparams

func (*Architectflownotificationerrormessageparams) String

String returns a JSON representation of the model

type Architectflownotificationflownotification

type Architectflownotificationflownotification struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Deleted
	Deleted *bool `json:"deleted,omitempty"`

	// CheckedInVersion
	CheckedInVersion *Architectflownotificationflowversion `json:"checkedInVersion,omitempty"`

	// SavedVersion
	SavedVersion *Architectflownotificationflowversion `json:"savedVersion,omitempty"`

	// PublishedVersion
	PublishedVersion *Architectflownotificationflowversion `json:"publishedVersion,omitempty"`

	// CurrentOperation
	CurrentOperation *Architectflownotificationarchitectoperation `json:"currentOperation,omitempty"`
}

Architectflownotificationflownotification

func (*Architectflownotificationflownotification) String

String returns a JSON representation of the model

type Architectflownotificationflowversion

type Architectflownotificationflowversion struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Architectflownotificationflowversion

func (*Architectflownotificationflowversion) String

String returns a JSON representation of the model

type Architectflownotificationhomeorganization

type Architectflownotificationhomeorganization struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ThirdPartyOrgName
	ThirdPartyOrgName *string `json:"thirdPartyOrgName,omitempty"`
}

Architectflownotificationhomeorganization

func (*Architectflownotificationhomeorganization) String

String returns a JSON representation of the model

type Architectflownotificationuser

type Architectflownotificationuser struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// HomeOrg
	HomeOrg *Architectflownotificationhomeorganization `json:"homeOrg,omitempty"`
}

Architectflownotificationuser

func (*Architectflownotificationuser) String

String returns a JSON representation of the model

type Architectflowoutcomenotificationarchitectoperation

type Architectflowoutcomenotificationarchitectoperation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Complete
	Complete *bool `json:"complete,omitempty"`

	// User
	User *Architectflowoutcomenotificationuser `json:"user,omitempty"`

	// Client
	Client *Architectflowoutcomenotificationclient `json:"client,omitempty"`

	// ActionName
	ActionName *string `json:"actionName,omitempty"`

	// ActionStatus
	ActionStatus *string `json:"actionStatus,omitempty"`

	// ErrorMessage
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// ErrorMessageParams
	ErrorMessageParams *Architectflowoutcomenotificationerrormessageparams `json:"errorMessageParams,omitempty"`

	// ErrorDetails
	ErrorDetails *[]Architectflowoutcomenotificationerrordetail `json:"errorDetails,omitempty"`
}

Architectflowoutcomenotificationarchitectoperation

func (*Architectflowoutcomenotificationarchitectoperation) String

String returns a JSON representation of the model

type Architectflowoutcomenotificationclient

type Architectflowoutcomenotificationclient struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Architectflowoutcomenotificationclient

func (*Architectflowoutcomenotificationclient) String

String returns a JSON representation of the model

type Architectflowoutcomenotificationerrordetail

type Architectflowoutcomenotificationerrordetail struct {
	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// FieldName
	FieldName *string `json:"fieldName,omitempty"`
}

Architectflowoutcomenotificationerrordetail

func (*Architectflowoutcomenotificationerrordetail) String

String returns a JSON representation of the model

type Architectflowoutcomenotificationerrormessageparams

type Architectflowoutcomenotificationerrormessageparams struct {
	// AdditionalProperties
	AdditionalProperties *map[string]string `json:"additionalProperties,omitempty"`
}

Architectflowoutcomenotificationerrormessageparams

func (*Architectflowoutcomenotificationerrormessageparams) String

String returns a JSON representation of the model

type Architectflowoutcomenotificationflowoutcomenotification

type Architectflowoutcomenotificationflowoutcomenotification struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// CurrentOperation
	CurrentOperation *Architectflowoutcomenotificationarchitectoperation `json:"currentOperation,omitempty"`
}

Architectflowoutcomenotificationflowoutcomenotification

func (*Architectflowoutcomenotificationflowoutcomenotification) String

String returns a JSON representation of the model

type Architectflowoutcomenotificationhomeorganization

type Architectflowoutcomenotificationhomeorganization struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ThirdPartyOrgName
	ThirdPartyOrgName *string `json:"thirdPartyOrgName,omitempty"`
}

Architectflowoutcomenotificationhomeorganization

func (*Architectflowoutcomenotificationhomeorganization) String

String returns a JSON representation of the model

type Architectflowoutcomenotificationuser

type Architectflowoutcomenotificationuser struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// HomeOrg
	HomeOrg *Architectflowoutcomenotificationhomeorganization `json:"homeOrg,omitempty"`
}

Architectflowoutcomenotificationuser

func (*Architectflowoutcomenotificationuser) String

String returns a JSON representation of the model

type Architectpromptnotificationarchitectoperation

type Architectpromptnotificationarchitectoperation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Complete
	Complete *bool `json:"complete,omitempty"`

	// User
	User *Architectpromptnotificationuser `json:"user,omitempty"`

	// Client
	Client *Architectpromptnotificationclient `json:"client,omitempty"`

	// ActionName
	ActionName *string `json:"actionName,omitempty"`

	// ActionStatus
	ActionStatus *string `json:"actionStatus,omitempty"`

	// ErrorMessage
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// ErrorMessageParams
	ErrorMessageParams *Architectpromptnotificationerrormessageparams `json:"errorMessageParams,omitempty"`

	// ErrorDetails
	ErrorDetails *[]Architectpromptnotificationerrordetail `json:"errorDetails,omitempty"`
}

Architectpromptnotificationarchitectoperation

func (*Architectpromptnotificationarchitectoperation) String

String returns a JSON representation of the model

type Architectpromptnotificationclient

type Architectpromptnotificationclient struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Architectpromptnotificationclient

func (*Architectpromptnotificationclient) String

String returns a JSON representation of the model

type Architectpromptnotificationerrordetail

type Architectpromptnotificationerrordetail struct {
	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// FieldName
	FieldName *string `json:"fieldName,omitempty"`
}

Architectpromptnotificationerrordetail

func (*Architectpromptnotificationerrordetail) String

String returns a JSON representation of the model

type Architectpromptnotificationerrormessageparams

type Architectpromptnotificationerrormessageparams struct {
	// AdditionalProperties
	AdditionalProperties *map[string]string `json:"additionalProperties,omitempty"`
}

Architectpromptnotificationerrormessageparams

func (*Architectpromptnotificationerrormessageparams) String

String returns a JSON representation of the model

type Architectpromptnotificationhomeorganization

type Architectpromptnotificationhomeorganization struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ThirdPartyOrgName
	ThirdPartyOrgName *string `json:"thirdPartyOrgName,omitempty"`
}

Architectpromptnotificationhomeorganization

func (*Architectpromptnotificationhomeorganization) String

String returns a JSON representation of the model

type Architectpromptnotificationpromptnotification

type Architectpromptnotificationpromptnotification struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// CurrentOperation
	CurrentOperation *Architectpromptnotificationarchitectoperation `json:"currentOperation,omitempty"`
}

Architectpromptnotificationpromptnotification

func (*Architectpromptnotificationpromptnotification) String

String returns a JSON representation of the model

type Architectpromptnotificationuser

type Architectpromptnotificationuser struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// HomeOrg
	HomeOrg *Architectpromptnotificationhomeorganization `json:"homeOrg,omitempty"`
}

Architectpromptnotificationuser

func (*Architectpromptnotificationuser) String

String returns a JSON representation of the model

type Architectpromptresourcenotificationpromptresourcenotification

type Architectpromptresourcenotificationpromptresourcenotification struct {
	// PromptId
	PromptId *string `json:"promptId,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Language
	Language *string `json:"language,omitempty"`

	// MediaUri
	MediaUri *string `json:"mediaUri,omitempty"`

	// UploadStatus
	UploadStatus *string `json:"uploadStatus,omitempty"`

	// DurationSeconds
	DurationSeconds *float32 `json:"durationSeconds,omitempty"`
}

Architectpromptresourcenotificationpromptresourcenotification

func (*Architectpromptresourcenotificationpromptresourcenotification) String

String returns a JSON representation of the model

type Architectsystempromptresourcenotificationsystempromptresourcenotification

type Architectsystempromptresourcenotificationsystempromptresourcenotification struct {
	// PromptId
	PromptId *string `json:"promptId,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Language
	Language *string `json:"language,omitempty"`

	// MediaUri
	MediaUri *string `json:"mediaUri,omitempty"`

	// UploadStatus
	UploadStatus *string `json:"uploadStatus,omitempty"`

	// DurationSeconds
	DurationSeconds *float32 `json:"durationSeconds,omitempty"`
}

Architectsystempromptresourcenotificationsystempromptresourcenotification

func (*Architectsystempromptresourcenotificationsystempromptresourcenotification) String

String returns a JSON representation of the model

type Archiveretention

type Archiveretention struct {
	// Days
	Days *int `json:"days,omitempty"`

	// StorageMedium
	StorageMedium *string `json:"storageMedium,omitempty"`
}

Archiveretention

func (*Archiveretention) String

func (o *Archiveretention) String() string

String returns a JSON representation of the model

type Arraynode

type Arraynode struct {
	// NodeType
	NodeType *string `json:"nodeType,omitempty"`

	// Float
	Float *bool `json:"float,omitempty"`

	// Number
	Number *bool `json:"number,omitempty"`

	// Boolean
	Boolean *bool `json:"boolean,omitempty"`

	// Object
	Object *bool `json:"object,omitempty"`

	// ValueNode
	ValueNode *bool `json:"valueNode,omitempty"`

	// ContainerNode
	ContainerNode *bool `json:"containerNode,omitempty"`

	// FloatingPointNumber
	FloatingPointNumber *bool `json:"floatingPointNumber,omitempty"`

	// Pojo
	Pojo *bool `json:"pojo,omitempty"`

	// IntegralNumber
	IntegralNumber *bool `json:"integralNumber,omitempty"`

	// Short
	Short *bool `json:"short,omitempty"`

	// Int
	Int *bool `json:"int,omitempty"`

	// Long
	Long *bool `json:"long,omitempty"`

	// Double
	Double *bool `json:"double,omitempty"`

	// BigDecimal
	BigDecimal *bool `json:"bigDecimal,omitempty"`

	// BigInteger
	BigInteger *bool `json:"bigInteger,omitempty"`

	// Textual
	Textual *bool `json:"textual,omitempty"`

	// Binary
	Binary *bool `json:"binary,omitempty"`

	// MissingNode
	MissingNode *bool `json:"missingNode,omitempty"`

	// Array
	Array *bool `json:"array,omitempty"`

	// Null
	Null *bool `json:"null,omitempty"`
}

Arraynode

func (*Arraynode) String

func (o *Arraynode) String() string

String returns a JSON representation of the model

type Assignedwrapupcode

type Assignedwrapupcode struct {
	// Code - The user configured wrap up code id.
	Code *string `json:"code,omitempty"`

	// Notes - Text entered by the agent to describe the call or disposition.
	Notes *string `json:"notes,omitempty"`

	// Tags - List of tags selected by the agent to describe the call or disposition.
	Tags *[]string `json:"tags,omitempty"`

	// DurationSeconds - The duration in seconds of the wrap-up segment.
	DurationSeconds *int `json:"durationSeconds,omitempty"`

	// EndTime - The timestamp when the wrap-up segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndTime *time.Time `json:"endTime,omitempty"`
}

Assignedwrapupcode

func (*Assignedwrapupcode) String

func (o *Assignedwrapupcode) String() string

String returns a JSON representation of the model

type Assignmentgroup

type Assignmentgroup struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Assignmentgroup

func (*Assignmentgroup) String

func (o *Assignmentgroup) String() string

String returns a JSON representation of the model

type Asyncconversationquery

type Asyncconversationquery struct {
	// ConversationFilters - Filters that target conversation-level data
	ConversationFilters *[]Conversationdetailqueryfilter `json:"conversationFilters,omitempty"`

	// SegmentFilters - Filters that target individual segments within a conversation
	SegmentFilters *[]Segmentdetailqueryfilter `json:"segmentFilters,omitempty"`

	// EvaluationFilters - Filters that target evaluations
	EvaluationFilters *[]Evaluationdetailqueryfilter `json:"evaluationFilters,omitempty"`

	// MediaEndpointStatFilters - Filters that target mediaEndpointStats
	MediaEndpointStatFilters *[]Mediaendpointstatdetailqueryfilter `json:"mediaEndpointStatFilters,omitempty"`

	// SurveyFilters - Filters that target surveys
	SurveyFilters *[]Surveydetailqueryfilter `json:"surveyFilters,omitempty"`

	// ResolutionFilters - Filters that target resolutions
	ResolutionFilters *[]Resolutiondetailqueryfilter `json:"resolutionFilters,omitempty"`

	// Order - Sort the result set in ascending/descending order. Default is ascending
	Order *string `json:"order,omitempty"`

	// OrderBy - Specify which data element within the result set to use for sorting. The options  to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart
	OrderBy *string `json:"orderBy,omitempty"`

	// Interval - Specifies the date and time range of data being queried. Results will include all conversations that had activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
	Interval *string `json:"interval,omitempty"`

	// Limit - Specify number of results to be returned
	Limit *int `json:"limit,omitempty"`

	// StartOfDayIntervalMatching - Add a filter to only include conversations that started after the beginning of the interval start date (UTC)
	StartOfDayIntervalMatching *bool `json:"startOfDayIntervalMatching,omitempty"`
}

Asyncconversationquery

func (*Asyncconversationquery) String

func (o *Asyncconversationquery) String() string

String returns a JSON representation of the model

type Asyncforecastoperationresult

type Asyncforecastoperationresult struct {
	// Status - The status of the operation
	Status *string `json:"status,omitempty"`

	// OperationId - The ID for the operation
	OperationId *string `json:"operationId,omitempty"`

	// Result - The result of the operation.  Null unless status == Complete
	Result *Bushorttermforecast `json:"result,omitempty"`

	// Progress - Percent progress for the operation
	Progress *int `json:"progress,omitempty"`
}

Asyncforecastoperationresult

func (*Asyncforecastoperationresult) String

String returns a JSON representation of the model

type Asyncintradayresponse

type Asyncintradayresponse struct {
	// Status - The status of the operation
	Status *string `json:"status,omitempty"`

	// OperationId - The ID for the operation
	OperationId *string `json:"operationId,omitempty"`

	// Result - The result of the operation.  Null unless status == Complete
	Result *Buintradayresponse `json:"result,omitempty"`
}

Asyncintradayresponse

func (*Asyncintradayresponse) String

func (o *Asyncintradayresponse) String() string

String returns a JSON representation of the model

type Asyncqueryresponse

type Asyncqueryresponse struct {
	// JobId - Unique identifier for the async query execution. Can be used to check the status of the query and retrieve results.
	JobId *string `json:"jobId,omitempty"`
}

Asyncqueryresponse

func (*Asyncqueryresponse) String

func (o *Asyncqueryresponse) String() string

String returns a JSON representation of the model

type Asyncquerystatus

type Asyncquerystatus struct {
	// State - The current state of the asynchronous query
	State *string `json:"state,omitempty"`

	// ErrorMessage - The error associated with the current query, if the state is FAILED
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// ExpirationDate - The time at which results for this query will expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ExpirationDate *time.Time `json:"expirationDate,omitempty"`

	// SubmissionDate - The time at which the query was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	SubmissionDate *time.Time `json:"submissionDate,omitempty"`

	// CompletionDate - The time at which the query completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CompletionDate *time.Time `json:"completionDate,omitempty"`
}

Asyncquerystatus

func (*Asyncquerystatus) String

func (o *Asyncquerystatus) String() string

String returns a JSON representation of the model

type Asyncuserdetailsquery

type Asyncuserdetailsquery struct {
	// Interval - Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
	Interval *string `json:"interval,omitempty"`

	// UserFilters - Filters that target the users to retrieve data for
	UserFilters *[]Userdetailqueryfilter `json:"userFilters,omitempty"`

	// PresenceFilters - Filters that target system and organization presence-level data
	PresenceFilters *[]Presencedetailqueryfilter `json:"presenceFilters,omitempty"`

	// RoutingStatusFilters - Filters that target agent routing status-level data
	RoutingStatusFilters *[]Routingstatusdetailqueryfilter `json:"routingStatusFilters,omitempty"`

	// Order - Sort the result set in ascending/descending order. Default is ascending
	Order *string `json:"order,omitempty"`

	// Limit - Specify number of results to be returned
	Limit *int `json:"limit,omitempty"`
}

Asyncuserdetailsquery

func (*Asyncuserdetailsquery) String

func (o *Asyncuserdetailsquery) String() string

String returns a JSON representation of the model

type Asyncweekscheduleresponse

type Asyncweekscheduleresponse struct {
	// Result - Week schedule result. The value will be null if the data is sent through notification or if response is large.
	Result *Weekschedule `json:"result,omitempty"`

	// DownloadUrl - The url to fetch the result for large responses. The value is null if result contains the data
	DownloadUrl *string `json:"downloadUrl,omitempty"`

	// Status - The status of the request
	Status *string `json:"status,omitempty"`

	// OperationId - The operation id to watch for on the notification topic if status == Processing
	OperationId *string `json:"operationId,omitempty"`
}

Asyncweekscheduleresponse - Response for query for week schedule for a given week in management unit

func (*Asyncweekscheduleresponse) String

func (o *Asyncweekscheduleresponse) String() string

String returns a JSON representation of the model

type Attachment

type Attachment struct {
	// AttachmentId - The unique identifier for the attachment.
	AttachmentId *string `json:"attachmentId,omitempty"`

	// Name - The name of the attachment.
	Name *string `json:"name,omitempty"`

	// ContentUri - The content uri of the attachment. If set, this is commonly a public api download location.
	ContentUri *string `json:"contentUri,omitempty"`

	// ContentType - The type of file the attachment is.
	ContentType *string `json:"contentType,omitempty"`

	// ContentLength - The length of the attachment file.
	ContentLength *int `json:"contentLength,omitempty"`

	// InlineImage - Whether or not the attachment was attached inline.,
	InlineImage *bool `json:"inlineImage,omitempty"`
}

Attachment

func (*Attachment) String

func (o *Attachment) String() string

String returns a JSON representation of the model

type Attemptlimits

type Attemptlimits struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Version - Required for updates, must match the version number of the most recent update
	Version *int `json:"version,omitempty"`

	// MaxAttemptsPerContact - The maximum number of times a contact can be called within the resetPeriod. Required if maxAttemptsPerNumber is not defined.
	MaxAttemptsPerContact *int `json:"maxAttemptsPerContact,omitempty"`

	// MaxAttemptsPerNumber - The maximum number of times a phone number can be called within the resetPeriod. Required if maxAttemptsPerContact is not defined.
	MaxAttemptsPerNumber *int `json:"maxAttemptsPerNumber,omitempty"`

	// TimeZoneId - If the resetPeriod is TODAY, this specifies the timezone in which TODAY occurs. Required if the resetPeriod is TODAY.
	TimeZoneId *string `json:"timeZoneId,omitempty"`

	// ResetPeriod - After how long the number of attempts will be set back to 0. Defaults to NEVER.
	ResetPeriod *string `json:"resetPeriod,omitempty"`

	// RecallEntries - Configuration for recall attempts.
	RecallEntries *map[string]Recallentry `json:"recallEntries,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Attemptlimits

func (*Attemptlimits) String

func (o *Attemptlimits) String() string

String returns a JSON representation of the model

type Attemptlimitsentitylisting

type Attemptlimitsentitylisting struct {
	// Entities
	Entities *[]Attemptlimits `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Attemptlimitsentitylisting

func (*Attemptlimitsentitylisting) String

func (o *Attemptlimitsentitylisting) String() string

String returns a JSON representation of the model

type Attribute

type Attribute struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The attribute name.
	Name *string `json:"name,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// CreatedBy
	CreatedBy *Domainentityref `json:"createdBy,omitempty"`

	// DateCreated - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// ModifiedBy
	ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"`

	// DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Attribute

func (*Attribute) String

func (o *Attribute) String() string

String returns a JSON representation of the model

type Attributefilteritem

type Attributefilteritem struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Operator
	Operator *string `json:"operator,omitempty"`

	// Values
	Values *[]string `json:"values,omitempty"`
}

Attributefilteritem

func (*Attributefilteritem) String

func (o *Attributefilteritem) String() string

String returns a JSON representation of the model

type Atzmtimeslot

type Atzmtimeslot struct {
	// EarliestCallableTime - The earliest time to dial a contact. Valid format is HH:mm
	EarliestCallableTime *string `json:"earliestCallableTime,omitempty"`

	// LatestCallableTime - The latest time to dial a contact. Valid format is HH:mm
	LatestCallableTime *string `json:"latestCallableTime,omitempty"`
}

Atzmtimeslot

func (*Atzmtimeslot) String

func (o *Atzmtimeslot) String() string

String returns a JSON representation of the model

type Atzmtimeslotwithtimezone

type Atzmtimeslotwithtimezone struct {
	// EarliestCallableTime - The earliest time to dial a contact. Valid format is HH:mm
	EarliestCallableTime *string `json:"earliestCallableTime,omitempty"`

	// LatestCallableTime - The latest time to dial a contact. Valid format is HH:mm
	LatestCallableTime *string `json:"latestCallableTime,omitempty"`

	// TimeZoneId - The time zone to use for contacts that cannot be mapped.
	TimeZoneId *string `json:"timeZoneId,omitempty"`
}

Atzmtimeslotwithtimezone

func (*Atzmtimeslotwithtimezone) String

func (o *Atzmtimeslotwithtimezone) String() string

String returns a JSON representation of the model

type AuditApi

type AuditApi struct {
	Configuration *Configuration
}

AuditApi provides functions for API endpoints

func NewAuditApi

func NewAuditApi() *AuditApi

NewAuditApi creates an API instance using the default configuration

func NewAuditApiWithConfig

func NewAuditApiWithConfig(config *Configuration) *AuditApi

NewAuditApiWithConfig creates an API instance using the provided configuration

func (AuditApi) GetAuditsQueryRealtimeServicemapping

func (a AuditApi) GetAuditsQueryRealtimeServicemapping() (*Auditqueryservicemapping, *APIResponse, error)

GetAuditsQueryRealtimeServicemapping invokes GET /api/v2/audits/query/realtime/servicemapping

Get service mapping information used in realtime audits.

func (AuditApi) GetAuditsQueryServicemapping

func (a AuditApi) GetAuditsQueryServicemapping() (*Auditqueryservicemapping, *APIResponse, error)

GetAuditsQueryServicemapping invokes GET /api/v2/audits/query/servicemapping

Get service mapping information used in audits.

func (AuditApi) GetAuditsQueryTransactionId

func (a AuditApi) GetAuditsQueryTransactionId(transactionId string) (*Auditqueryexecutionstatusresponse, *APIResponse, error)

GetAuditsQueryTransactionId invokes GET /api/v2/audits/query/{transactionId}

Get status of audit query execution

func (AuditApi) GetAuditsQueryTransactionIdResults

func (a AuditApi) GetAuditsQueryTransactionIdResults(transactionId string, cursor string, pageSize int, expand []string) (*Auditqueryexecutionresultsresponse, *APIResponse, error)

GetAuditsQueryTransactionIdResults invokes GET /api/v2/audits/query/{transactionId}/results

Get results of audit query

func (AuditApi) PostAuditsQuery

PostAuditsQuery invokes POST /api/v2/audits/query

Create audit query execution

func (AuditApi) PostAuditsQueryRealtime

func (a AuditApi) PostAuditsQueryRealtime(body Auditrealtimequeryrequest, expand []string) (*Auditrealtimequeryresultsresponse, *APIResponse, error)

PostAuditsQueryRealtime invokes POST /api/v2/audits/query/realtime

This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.

type Auditchange

type Auditchange struct {
	// Property
	Property *string `json:"property,omitempty"`

	// Entity
	Entity *Auditentityreference `json:"entity,omitempty"`

	// OldValues
	OldValues *[]string `json:"oldValues,omitempty"`

	// NewValues
	NewValues *[]string `json:"newValues,omitempty"`
}

Auditchange

func (*Auditchange) String

func (o *Auditchange) String() string

String returns a JSON representation of the model

type Auditentity

type Auditentity struct {
	// VarType - The type of the entity the action of this AuditEntity targeted.
	VarType *string `json:"type,omitempty"`

	// Id - The id of the entity the action of this AuditEntity targeted.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity the action of this AuditEntity targeted.
	Name *string `json:"name,omitempty"`

	// SelfUri - The selfUri for this entity.
	SelfUri *string `json:"selfUri,omitempty"`
}

Auditentity

func (*Auditentity) String

func (o *Auditentity) String() string

String returns a JSON representation of the model

type Auditentityreference

type Auditentityreference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// Action
	Action *string `json:"action,omitempty"`
}

Auditentityreference

func (*Auditentityreference) String

func (o *Auditentityreference) String() string

String returns a JSON representation of the model

type Auditfacet

type Auditfacet struct {
	// Name - The name of the field on which to facet.
	Name *string `json:"name,omitempty"`

	// VarType - The type of the facet, DATE or STRING.
	VarType *string `json:"type,omitempty"`
}

Auditfacet

func (*Auditfacet) String

func (o *Auditfacet) String() string

String returns a JSON representation of the model

type Auditfilter

type Auditfilter struct {
	// Name - The name of the field by which to filter.
	Name *string `json:"name,omitempty"`

	// VarType - The type of the filter, DATE or STRING.
	VarType *string `json:"type,omitempty"`

	// Operator - The operation that the filter performs.
	Operator *string `json:"operator,omitempty"`

	// Values - The values to make the filter comparison against.
	Values *[]string `json:"values,omitempty"`
}

Auditfilter

func (*Auditfilter) String

func (o *Auditfilter) String() string

String returns a JSON representation of the model

type Auditlogmessage

type Auditlogmessage struct {
	// Id - Id of the audit message.
	Id *string `json:"id,omitempty"`

	// UserHomeOrgId - Home Organization Id associated with this audit message.
	UserHomeOrgId *string `json:"userHomeOrgId,omitempty"`

	// User - User associated with this audit message.
	User *Domainentityref `json:"user,omitempty"`

	// Client - Client associated with this audit message.
	Client *Addressableentityref `json:"client,omitempty"`

	// RemoteIp - List of IP addresses of systems that originated or handled the request.
	RemoteIp *[]string `json:"remoteIp,omitempty"`

	// ServiceName - Name of the service that logged this audit message.
	ServiceName *string `json:"serviceName,omitempty"`

	// EventDate - Date and time of when the audit message was logged. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EventDate *time.Time `json:"eventDate,omitempty"`

	// Message - Message describing the event being audited.
	Message *Messageinfo `json:"message,omitempty"`

	// Action - Action that took place.
	Action *string `json:"action,omitempty"`

	// Entity - Entity that was impacted.
	Entity *Domainentityref `json:"entity,omitempty"`

	// EntityType - Type of the entity that was impacted.
	EntityType *string `json:"entityType,omitempty"`

	// PropertyChanges - List of properties that were changed and changes made to those properties.
	PropertyChanges *[]Propertychange `json:"propertyChanges,omitempty"`

	// Context - Additional context for this message.
	Context *map[string]string `json:"context,omitempty"`
}

Auditlogmessage

func (*Auditlogmessage) String

func (o *Auditlogmessage) String() string

String returns a JSON representation of the model

type Auditmessage

type Auditmessage struct {
	// Id - AuditMessage ID.
	Id *string `json:"id,omitempty"`

	// User
	User *Audituser `json:"user,omitempty"`

	// CorrelationId - Correlation ID.
	CorrelationId *string `json:"correlationId,omitempty"`

	// TransactionId - Transaction ID.
	TransactionId *string `json:"transactionId,omitempty"`

	// TransactionInitiator - Whether or not this audit can be considered the initiator of the transaction it is a part of.
	TransactionInitiator *bool `json:"transactionInitiator,omitempty"`

	// Application - The application through which the action of this AuditMessage was initiated.
	Application *string `json:"application,omitempty"`

	// ServiceName - The name of the service which sent this AuditMessage.
	ServiceName *string `json:"serviceName,omitempty"`

	// Level - The level of this audit. USER or SYSTEM.
	Level *string `json:"level,omitempty"`

	// Timestamp - The time at which the action of this AuditMessage was initiated.
	Timestamp *string `json:"timestamp,omitempty"`

	// ReceivedTimestamp - The time at which this AuditMessage was received.
	ReceivedTimestamp *string `json:"receivedTimestamp,omitempty"`

	// Status - The status of the action of this AuditMessage
	Status *string `json:"status,omitempty"`

	// ActionContext - The context of a system-level action
	ActionContext *string `json:"actionContext,omitempty"`

	// Action - A string representing the action that took place
	Action *string `json:"action,omitempty"`

	// Changes - Details about any changes that occurred in this audit
	Changes *[]Change `json:"changes,omitempty"`

	// Entity
	Entity *Auditentity `json:"entity,omitempty"`

	// ServiceContext - The service-specific context associated with this AuditMessage.
	ServiceContext *Servicecontext `json:"serviceContext,omitempty"`
}

Auditmessage

func (*Auditmessage) String

func (o *Auditmessage) String() string

String returns a JSON representation of the model

type Auditqueryentity

type Auditqueryentity struct {
	// Name - Name of the Entity
	Name *string `json:"name,omitempty"`

	// Actions - List of Actions
	Actions *[]string `json:"actions,omitempty"`
}

Auditqueryentity

func (*Auditqueryentity) String

func (o *Auditqueryentity) String() string

String returns a JSON representation of the model

type Auditqueryexecutionresultsresponse

type Auditqueryexecutionresultsresponse struct {
	// Id - Id of the audit query execution request.
	Id *string `json:"id,omitempty"`

	// PageSize - Number of results in a page.
	PageSize *int `json:"pageSize,omitempty"`

	// Cursor - Optional cursor to indicate where to resume the results.
	Cursor *string `json:"cursor,omitempty"`

	// Entities - List of audit messages.
	Entities *[]Auditlogmessage `json:"entities,omitempty"`
}

Auditqueryexecutionresultsresponse

func (*Auditqueryexecutionresultsresponse) String

String returns a JSON representation of the model

type Auditqueryexecutionstatusresponse

type Auditqueryexecutionstatusresponse struct {
	// Id - Id of the audit query execution request.
	Id *string `json:"id,omitempty"`

	// State - Status of the audit query execution request.
	State *string `json:"state,omitempty"`

	// StartDate - Start date and time of the audit query execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartDate *time.Time `json:"startDate,omitempty"`

	// Interval - Interval for the audit query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
	Interval *string `json:"interval,omitempty"`

	// ServiceName - Service name for the audit query.
	ServiceName *string `json:"serviceName,omitempty"`

	// Filters - Filters for the audit query.
	Filters *[]Auditqueryfilter `json:"filters,omitempty"`

	// Sort - Sort parameter for the audit query.
	Sort *[]Auditquerysort `json:"sort,omitempty"`
}

Auditqueryexecutionstatusresponse

func (*Auditqueryexecutionstatusresponse) String

String returns a JSON representation of the model

type Auditqueryfilter

type Auditqueryfilter struct {
	// Property - Name of the property to filter.
	Property *string `json:"property,omitempty"`

	// Value - Value of the property to filter.
	Value *string `json:"value,omitempty"`
}

Auditqueryfilter

func (*Auditqueryfilter) String

func (o *Auditqueryfilter) String() string

String returns a JSON representation of the model

type Auditqueryrequest

type Auditqueryrequest struct {
	// Interval - Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
	Interval *string `json:"interval,omitempty"`

	// ServiceName - Name of the service to query audits for.
	ServiceName *string `json:"serviceName,omitempty"`

	// Filters - Additional filters for the query.
	Filters *[]Auditqueryfilter `json:"filters,omitempty"`

	// Sort - Sort parameter for the query.
	Sort *[]Auditquerysort `json:"sort,omitempty"`
}

Auditqueryrequest

func (*Auditqueryrequest) String

func (o *Auditqueryrequest) String() string

String returns a JSON representation of the model

type Auditqueryresponse

type Auditqueryresponse struct{}

Auditqueryresponse

func (*Auditqueryresponse) String

func (o *Auditqueryresponse) String() string

String returns a JSON representation of the model

type Auditqueryservice

type Auditqueryservice struct {
	// Name - Name of the Service
	Name *string `json:"name,omitempty"`

	// Entities - List of Entities
	Entities *[]Auditqueryentity `json:"entities,omitempty"`
}

Auditqueryservice

func (*Auditqueryservice) String

func (o *Auditqueryservice) String() string

String returns a JSON representation of the model

type Auditqueryservicemapping

type Auditqueryservicemapping struct {
	// Services - List of Services
	Services *[]Auditqueryservice `json:"services,omitempty"`
}

Auditqueryservicemapping

func (*Auditqueryservicemapping) String

func (o *Auditqueryservicemapping) String() string

String returns a JSON representation of the model

type Auditquerysort

type Auditquerysort struct {
	// Name - Name of the property to sort.
	Name *string `json:"name,omitempty"`

	// SortOrder - Sort Order
	SortOrder *string `json:"sortOrder,omitempty"`
}

Auditquerysort

func (*Auditquerysort) String

func (o *Auditquerysort) String() string

String returns a JSON representation of the model

type Auditrealtimequeryrequest

type Auditrealtimequeryrequest struct {
	// Interval - Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
	Interval *string `json:"interval,omitempty"`

	// ServiceName - Name of the service to query audits for.
	ServiceName *string `json:"serviceName,omitempty"`

	// Filters - Additional filters for the query.
	Filters *[]Auditqueryfilter `json:"filters,omitempty"`

	// Sort - Sort parameter for the query.
	Sort *[]Auditquerysort `json:"sort,omitempty"`

	// PageNumber - Page number
	PageNumber *int `json:"pageNumber,omitempty"`

	// PageSize - Page size
	PageSize *int `json:"pageSize,omitempty"`
}

Auditrealtimequeryrequest

func (*Auditrealtimequeryrequest) String

func (o *Auditrealtimequeryrequest) String() string

String returns a JSON representation of the model

type Auditrealtimequeryresultsresponse

type Auditrealtimequeryresultsresponse struct {
	// Entities
	Entities *[]Auditlogmessage `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Auditrealtimequeryresultsresponse

func (*Auditrealtimequeryresultsresponse) String

String returns a JSON representation of the model

type Auditsearchresult

type Auditsearchresult struct {
	// PageNumber - Which page was returned.
	PageNumber *int `json:"pageNumber,omitempty"`

	// PageSize - The number of results in a page.
	PageSize *int `json:"pageSize,omitempty"`

	// Total - The total number of results.
	Total *int `json:"total,omitempty"`

	// PageCount - The number of pages of results.
	PageCount *int `json:"pageCount,omitempty"`

	// FacetInfo
	FacetInfo *[]Facetinfo `json:"facetInfo,omitempty"`

	// AuditMessages
	AuditMessages *[]Auditmessage `json:"auditMessages,omitempty"`
}

Auditsearchresult

func (*Auditsearchresult) String

func (o *Auditsearchresult) String() string

String returns a JSON representation of the model

type Audituser

type Audituser struct {
	// Id - The ID (UUID) of the user who initiated the action of this AuditMessage.
	Id *string `json:"id,omitempty"`

	// Name - The full username of the user who initiated the action of this AuditMessage.
	Name *string `json:"name,omitempty"`

	// Display - The display name of the user who initiated the action of this AuditMessage.
	Display *string `json:"display,omitempty"`
}

Audituser

func (*Audituser) String

func (o *Audituser) String() string

String returns a JSON representation of the model

type AuthErrorResponse

type AuthErrorResponse struct {
	Error            string `json:"error,omitempty"`
	Description      string `json:"description,omitempty"`
	ErrorDescription string `json:"error_description,omitempty"`
}

AuthErrorResponse gives you some intel when authorization goes boom

type AuthResponse

type AuthResponse struct {
	AccessToken  string `json:"access_token,omitempty"`
	RefreshToken string `json:"refresh_token,omitempty"`
	TokenType    string `json:"token_type,omitempty"`
	ExpiresIn    int    `json:"expires_in,omitempty"`
}

AuthResponse contains the access token to use in future requests

type AuthorizationApi

type AuthorizationApi struct {
	Configuration *Configuration
}

AuthorizationApi provides functions for API endpoints

func NewAuthorizationApi

func NewAuthorizationApi() *AuthorizationApi

NewAuthorizationApi creates an API instance using the default configuration

func NewAuthorizationApiWithConfig

func NewAuthorizationApiWithConfig(config *Configuration) *AuthorizationApi

NewAuthorizationApiWithConfig creates an API instance using the provided configuration

func (AuthorizationApi) DeleteAuthorizationDivision

func (a AuthorizationApi) DeleteAuthorizationDivision(divisionId string, force bool) (*APIResponse, error)

DeleteAuthorizationDivision invokes DELETE /api/v2/authorization/divisions/{divisionId}

Delete a division.

func (AuthorizationApi) DeleteAuthorizationRole

func (a AuthorizationApi) DeleteAuthorizationRole(roleId string) (*APIResponse, error)

DeleteAuthorizationRole invokes DELETE /api/v2/authorization/roles/{roleId}

Delete an organization role.

func (AuthorizationApi) DeleteAuthorizationSubjectDivisionRole

func (a AuthorizationApi) DeleteAuthorizationSubjectDivisionRole(subjectId string, divisionId string, roleId string) (*APIResponse, error)

DeleteAuthorizationSubjectDivisionRole invokes DELETE /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}

Delete a grant of a role in a division

func (AuthorizationApi) GetAuthorizationDivision

func (a AuthorizationApi) GetAuthorizationDivision(divisionId string, objectCount bool) (*Authzdivision, *APIResponse, error)

GetAuthorizationDivision invokes GET /api/v2/authorization/divisions/{divisionId}

Returns an authorization division.

func (AuthorizationApi) GetAuthorizationDivisionGrants

func (a AuthorizationApi) GetAuthorizationDivisionGrants(divisionId string, pageNumber int, pageSize int) (*Authzdivisiongrantentitylisting, *APIResponse, error)

GetAuthorizationDivisionGrants invokes GET /api/v2/authorization/divisions/{divisionId}/grants

Gets all grants for a given division.

Returns all grants assigned to a given division. Maximum page size is 500.

func (AuthorizationApi) GetAuthorizationDivisions

func (a AuthorizationApi) GetAuthorizationDivisions(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, objectCount bool, id []string, name string) (*Authzdivisionentitylisting, *APIResponse, error)

GetAuthorizationDivisions invokes GET /api/v2/authorization/divisions

Retrieve a list of all divisions defined for the organization

Request specific divisions by id using a query param \"id\", e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3

func (AuthorizationApi) GetAuthorizationDivisionsHome

func (a AuthorizationApi) GetAuthorizationDivisionsHome() (*Authzdivision, *APIResponse, error)

GetAuthorizationDivisionsHome invokes GET /api/v2/authorization/divisions/home

Retrieve the home division for the organization.

Will not include object counts.

func (AuthorizationApi) GetAuthorizationDivisionsLimit

func (a AuthorizationApi) GetAuthorizationDivisionsLimit() (*int, *APIResponse, error)

GetAuthorizationDivisionsLimit invokes GET /api/v2/authorization/divisions/limit

Returns the maximum allowed number of divisions.

func (AuthorizationApi) GetAuthorizationDivisionspermittedMe

func (a AuthorizationApi) GetAuthorizationDivisionspermittedMe(permission string, name string) ([]Authzdivision, *APIResponse, error)

GetAuthorizationDivisionspermittedMe invokes GET /api/v2/authorization/divisionspermitted/me

Returns which divisions the current user has the given permission in.

This route is deprecated, use authorization/divisionspermitted/paged/me instead.

func (AuthorizationApi) GetAuthorizationDivisionspermittedPagedMe

func (a AuthorizationApi) GetAuthorizationDivisionspermittedPagedMe(permission string, pageNumber int, pageSize int) (*Divspermittedentitylisting, *APIResponse, error)

GetAuthorizationDivisionspermittedPagedMe invokes GET /api/v2/authorization/divisionspermitted/paged/me

Returns which divisions the current user has the given permission in.

func (AuthorizationApi) GetAuthorizationDivisionspermittedPagedSubjectId

func (a AuthorizationApi) GetAuthorizationDivisionspermittedPagedSubjectId(subjectId string, permission string, pageNumber int, pageSize int) (*Divspermittedentitylisting, *APIResponse, error)

GetAuthorizationDivisionspermittedPagedSubjectId invokes GET /api/v2/authorization/divisionspermitted/paged/{subjectId}

Returns which divisions the specified user has the given permission in.

This route is deprecated, use authorization/divisionspermitted/paged/me instead.

func (AuthorizationApi) GetAuthorizationPermissions

func (a AuthorizationApi) GetAuthorizationPermissions(pageSize int, pageNumber int, queryType string, query string) (*Permissioncollectionentitylisting, *APIResponse, error)

GetAuthorizationPermissions invokes GET /api/v2/authorization/permissions

Get all permissions.

Retrieve a list of all permission defined in the system.

func (AuthorizationApi) GetAuthorizationProducts

func (a AuthorizationApi) GetAuthorizationProducts() (*Organizationproductentitylisting, *APIResponse, error)

GetAuthorizationProducts invokes GET /api/v2/authorization/products

Get the list of enabled products

Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.

func (AuthorizationApi) GetAuthorizationRole

func (a AuthorizationApi) GetAuthorizationRole(roleId string, expand []string) (*Domainorganizationrole, *APIResponse, error)

GetAuthorizationRole invokes GET /api/v2/authorization/roles/{roleId}

Get a single organization role.

Get the organization role specified by its ID.

func (AuthorizationApi) GetAuthorizationRoleComparedefaultRightRoleId

func (a AuthorizationApi) GetAuthorizationRoleComparedefaultRightRoleId(leftRoleId string, rightRoleId string) (*Domainorgroledifference, *APIResponse, error)

GetAuthorizationRoleComparedefaultRightRoleId invokes GET /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}

Get an org role to default role comparison

Compares any organization role to a default role id and show differences

func (AuthorizationApi) GetAuthorizationRoleSubjectgrants

func (a AuthorizationApi) GetAuthorizationRoleSubjectgrants(roleId string, pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string) (*Subjectdivisiongrantsentitylisting, *APIResponse, error)

GetAuthorizationRoleSubjectgrants invokes GET /api/v2/authorization/roles/{roleId}/subjectgrants

Get the subjects' granted divisions in the specified role.

Includes the divisions for which the subject has a grant.

func (AuthorizationApi) GetAuthorizationRoleUsers

func (a AuthorizationApi) GetAuthorizationRoleUsers(roleId string, pageSize int, pageNumber int) (*Userentitylisting, *APIResponse, error)

GetAuthorizationRoleUsers invokes GET /api/v2/authorization/roles/{roleId}/users

Get a list of the users in a specified role.

Get an array of the UUIDs of the users in the specified role.

func (AuthorizationApi) GetAuthorizationRoles

func (a AuthorizationApi) GetAuthorizationRoles(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, name string, permission []string, defaultRoleId []string, userCount bool, id []string) (*Organizationroleentitylisting, *APIResponse, error)

GetAuthorizationRoles invokes GET /api/v2/authorization/roles

Retrieve a list of all roles defined for the organization

func (AuthorizationApi) GetAuthorizationSubject

func (a AuthorizationApi) GetAuthorizationSubject(subjectId string) (*Authzsubject, *APIResponse, error)

GetAuthorizationSubject invokes GET /api/v2/authorization/subjects/{subjectId}

Returns a listing of roles and permissions for a user.

func (AuthorizationApi) GetAuthorizationSubjectsMe

func (a AuthorizationApi) GetAuthorizationSubjectsMe() (*Authzsubject, *APIResponse, error)

GetAuthorizationSubjectsMe invokes GET /api/v2/authorization/subjects/me

Returns a listing of roles and permissions for the currently authenticated user.

func (AuthorizationApi) GetAuthorizationSubjectsRolecounts

func (a AuthorizationApi) GetAuthorizationSubjectsRolecounts(id []string) (*map[string]interface{}, *APIResponse, error)

GetAuthorizationSubjectsRolecounts invokes GET /api/v2/authorization/subjects/rolecounts

Get the count of roles granted to a list of subjects

func (AuthorizationApi) GetUserRoles

func (a AuthorizationApi) GetUserRoles(userId string) (*Userauthorization, *APIResponse, error)

GetUserRoles invokes GET /api/v2/users/{userId}/roles

Returns a listing of roles and permissions for a user.

func (AuthorizationApi) PatchAuthorizationRole

func (a AuthorizationApi) PatchAuthorizationRole(roleId string, body Domainorganizationrole) (*Domainorganizationrole, *APIResponse, error)

PatchAuthorizationRole invokes PATCH /api/v2/authorization/roles/{roleId}

Patch Organization Role for needsUpdate Field

Patch Organization Role for needsUpdate Field

func (AuthorizationApi) PostAuthorizationDivisionObject

func (a AuthorizationApi) PostAuthorizationDivisionObject(divisionId string, objectType string, body []string) (*APIResponse, error)

PostAuthorizationDivisionObject invokes POST /api/v2/authorization/divisions/{divisionId}/objects/{objectType}

Assign a list of objects to a division

Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"]

func (AuthorizationApi) PostAuthorizationDivisions

func (a AuthorizationApi) PostAuthorizationDivisions(body Authzdivision) (*Authzdivision, *APIResponse, error)

PostAuthorizationDivisions invokes POST /api/v2/authorization/divisions

Create a division.

func (AuthorizationApi) PostAuthorizationRole

func (a AuthorizationApi) PostAuthorizationRole(roleId string, body Subjectdivisions, subjectType string) (*APIResponse, error)

PostAuthorizationRole invokes POST /api/v2/authorization/roles/{roleId}

Bulk-grant subjects and divisions with an organization role.

func (AuthorizationApi) PostAuthorizationRoleComparedefaultRightRoleId

func (a AuthorizationApi) PostAuthorizationRoleComparedefaultRightRoleId(leftRoleId string, rightRoleId string, body Domainorganizationrole) (*Domainorgroledifference, *APIResponse, error)

PostAuthorizationRoleComparedefaultRightRoleId invokes POST /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}

Get an unsaved org role to default role comparison

Allows users to compare their existing roles in an unsaved state to its default role

func (AuthorizationApi) PostAuthorizationRoles

PostAuthorizationRoles invokes POST /api/v2/authorization/roles

Create an organization role.

func (AuthorizationApi) PostAuthorizationRolesDefault

func (a AuthorizationApi) PostAuthorizationRolesDefault(force bool) (*Organizationroleentitylisting, *APIResponse, error)

PostAuthorizationRolesDefault invokes POST /api/v2/authorization/roles/default

Restores all default roles

This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.

func (AuthorizationApi) PostAuthorizationSubjectBulkadd

func (a AuthorizationApi) PostAuthorizationSubjectBulkadd(subjectId string, body Roledivisiongrants, subjectType string) (*APIResponse, error)

PostAuthorizationSubjectBulkadd invokes POST /api/v2/authorization/subjects/{subjectId}/bulkadd

Bulk-grant roles and divisions to a subject.

func (AuthorizationApi) PostAuthorizationSubjectBulkremove

func (a AuthorizationApi) PostAuthorizationSubjectBulkremove(subjectId string, body Roledivisiongrants) (*APIResponse, error)

PostAuthorizationSubjectBulkremove invokes POST /api/v2/authorization/subjects/{subjectId}/bulkremove

Bulk-remove grants from a subject.

func (AuthorizationApi) PostAuthorizationSubjectDivisionRole

func (a AuthorizationApi) PostAuthorizationSubjectDivisionRole(subjectId string, divisionId string, roleId string, subjectType string) (*APIResponse, error)

PostAuthorizationSubjectDivisionRole invokes POST /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}

Make a grant of a role in a division

func (AuthorizationApi) PutAuthorizationDivision

func (a AuthorizationApi) PutAuthorizationDivision(divisionId string, body Authzdivision) (*Authzdivision, *APIResponse, error)

PutAuthorizationDivision invokes PUT /api/v2/authorization/divisions/{divisionId}

Update a division.

func (AuthorizationApi) PutAuthorizationRole

PutAuthorizationRole invokes PUT /api/v2/authorization/roles/{roleId}

Update an organization role.

Update

func (AuthorizationApi) PutAuthorizationRoleUsersAdd

func (a AuthorizationApi) PutAuthorizationRoleUsersAdd(roleId string, body []string) ([]string, *APIResponse, error)

PutAuthorizationRoleUsersAdd invokes PUT /api/v2/authorization/roles/{roleId}/users/add

Sets the users for the role

func (AuthorizationApi) PutAuthorizationRoleUsersRemove

func (a AuthorizationApi) PutAuthorizationRoleUsersRemove(roleId string, body []string) ([]string, *APIResponse, error)

PutAuthorizationRoleUsersRemove invokes PUT /api/v2/authorization/roles/{roleId}/users/remove

Removes the users from the role

func (AuthorizationApi) PutAuthorizationRolesDefault

func (a AuthorizationApi) PutAuthorizationRolesDefault(body []Domainorganizationrole) (*Organizationroleentitylisting, *APIResponse, error)

PutAuthorizationRolesDefault invokes PUT /api/v2/authorization/roles/default

Restore specified default roles

func (AuthorizationApi) PutUserRoles

func (a AuthorizationApi) PutUserRoles(userId string, body []string) (*Userauthorization, *APIResponse, error)

PutUserRoles invokes PUT /api/v2/users/{userId}/roles

Sets the user's roles

type Authzdivision

type Authzdivision struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Description - A helpful description for the division.
	Description *string `json:"description,omitempty"`

	// HomeDivision - A flag indicating whether this division is the \"Home\" (default) division. Cannot be modified and any supplied value will be ignored on create or update.
	HomeDivision *bool `json:"homeDivision,omitempty"`

	// ObjectCounts - A count of objects in this division, grouped by type.
	ObjectCounts *map[string]int `json:"objectCounts,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Authzdivision

func (*Authzdivision) String

func (o *Authzdivision) String() string

String returns a JSON representation of the model

type Authzdivisionentitylisting

type Authzdivisionentitylisting struct {
	// Entities
	Entities *[]Authzdivision `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Authzdivisionentitylisting

func (*Authzdivisionentitylisting) String

func (o *Authzdivisionentitylisting) String() string

String returns a JSON representation of the model

type Authzdivisiongrantentitylisting

type Authzdivisiongrantentitylisting struct {
	// Entities
	Entities *[]Authzgrant `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Authzdivisiongrantentitylisting

func (*Authzdivisiongrantentitylisting) String

String returns a JSON representation of the model

type Authzgrant

type Authzgrant struct {
	// SubjectId
	SubjectId *string `json:"subjectId,omitempty"`

	// Division
	Division *Authzdivision `json:"division,omitempty"`

	// Role
	Role *Authzgrantrole `json:"role,omitempty"`

	// GrantMadeAt - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	GrantMadeAt *time.Time `json:"grantMadeAt,omitempty"`
}

Authzgrant

func (*Authzgrant) String

func (o *Authzgrant) String() string

String returns a JSON representation of the model

type Authzgrantpolicy

type Authzgrantpolicy struct {
	// Actions
	Actions *[]string `json:"actions,omitempty"`

	// Condition
	Condition *string `json:"condition,omitempty"`

	// Domain
	Domain *string `json:"domain,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`
}

Authzgrantpolicy

func (*Authzgrantpolicy) String

func (o *Authzgrantpolicy) String() string

String returns a JSON representation of the model

type Authzgrantrole

type Authzgrantrole struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Policies
	Policies *[]Authzgrantpolicy `json:"policies,omitempty"`

	// VarDefault
	VarDefault *bool `json:"default,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Authzgrantrole

func (*Authzgrantrole) String

func (o *Authzgrantrole) String() string

String returns a JSON representation of the model

type Authzsubject

type Authzsubject struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Grants
	Grants *[]Authzgrant `json:"grants,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Authzsubject

func (*Authzsubject) String

func (o *Authzsubject) String() string

String returns a JSON representation of the model

type Automatictimezonemappingsettings

type Automatictimezonemappingsettings struct {
	// CallableWindows - The time intervals to use for automatic time zone mapping.
	CallableWindows *[]Callablewindow `json:"callableWindows,omitempty"`
}

Automatictimezonemappingsettings

func (*Automatictimezonemappingsettings) String

String returns a JSON representation of the model

type Availablelanguagelist

type Availablelanguagelist struct {
	// Languages
	Languages *[]string `json:"languages,omitempty"`
}

Availablelanguagelist

func (*Availablelanguagelist) String

func (o *Availablelanguagelist) String() string

String returns a JSON representation of the model

type Availabletopic

type Availabletopic struct {
	// Description
	Description *string `json:"description,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// RequiresPermissions - Permissions required to subscribe to the topic
	RequiresPermissions *[]string `json:"requiresPermissions,omitempty"`

	// RequiresDivisionPermissions - True if the subscribing user must belong to the same division as the topic object ID
	RequiresDivisionPermissions *bool `json:"requiresDivisionPermissions,omitempty"`

	// Enforced - Whether or not the permissions on this topic are enforced
	Enforced *bool `json:"enforced,omitempty"`

	// Visibility - Visibility of this topic (Public or Preview)
	Visibility *string `json:"visibility,omitempty"`

	// Schema
	Schema *map[string]interface{} `json:"schema,omitempty"`

	// RequiresCurrentUser - True if the topic user ID is required to match the subscribing user ID
	RequiresCurrentUser *bool `json:"requiresCurrentUser,omitempty"`

	// RequiresCurrentUserOrPermission - True if permissions are only required when the topic user ID does not match the subscribing user ID
	RequiresCurrentUserOrPermission *bool `json:"requiresCurrentUserOrPermission,omitempty"`

	// Transports - Transports that support events for the topic
	Transports *[]string `json:"transports,omitempty"`

	// PublicApiTemplateUriPaths
	PublicApiTemplateUriPaths *[]string `json:"publicApiTemplateUriPaths,omitempty"`
}

Availabletopic

func (*Availabletopic) String

func (o *Availabletopic) String() string

String returns a JSON representation of the model

type Availabletopicentitylisting

type Availabletopicentitylisting struct {
	// Entities
	Entities *[]Availabletopic `json:"entities,omitempty"`
}

Availabletopicentitylisting

func (*Availabletopicentitylisting) String

func (o *Availabletopicentitylisting) String() string

String returns a JSON representation of the model

type Availabletranslations

type Availabletranslations struct {
	// OrgSpecific
	OrgSpecific *[]string `json:"orgSpecific,omitempty"`

	// Builtin
	Builtin *[]string `json:"builtin,omitempty"`
}

Availabletranslations

func (*Availabletranslations) String

func (o *Availabletranslations) String() string

String returns a JSON representation of the model

type Batchdownloadjobresult

type Batchdownloadjobresult struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ConversationId - Conversation id of the result
	ConversationId *string `json:"conversationId,omitempty"`

	// RecordingId - Recording id of the result
	RecordingId *string `json:"recordingId,omitempty"`

	// ResultUrl - URL of results... HTTP GET from this location to download results for this item
	ResultUrl *string `json:"resultUrl,omitempty"`

	// ContentType - Content type of this result
	ContentType *string `json:"contentType,omitempty"`

	// ErrorMsg - An error message, in case of failed processing will indicate the cause of the failure
	ErrorMsg *string `json:"errorMsg,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Batchdownloadjobresult

func (*Batchdownloadjobresult) String

func (o *Batchdownloadjobresult) String() string

String returns a JSON representation of the model

type Batchdownloadjobstatusresult

type Batchdownloadjobstatusresult struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// JobId - JobId returned when job was initially submitted
	JobId *string `json:"jobId,omitempty"`

	// ExpectedResultCount - Number of results expected when job is completed
	ExpectedResultCount *int `json:"expectedResultCount,omitempty"`

	// ResultCount - Current number of results available
	ResultCount *int `json:"resultCount,omitempty"`

	// ErrorCount - Number of error results produced so far
	ErrorCount *int `json:"errorCount,omitempty"`

	// Results - Current set of results for the job
	Results *[]Batchdownloadjobresult `json:"results,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Batchdownloadjobstatusresult

func (*Batchdownloadjobstatusresult) String

String returns a JSON representation of the model

type Batchdownloadjobsubmission

type Batchdownloadjobsubmission struct {
	// BatchDownloadRequestList - List of up to 100 items requested
	BatchDownloadRequestList *[]Batchdownloadrequest `json:"batchDownloadRequestList,omitempty"`
}

Batchdownloadjobsubmission

func (*Batchdownloadjobsubmission) String

func (o *Batchdownloadjobsubmission) String() string

String returns a JSON representation of the model

type Batchdownloadjobsubmissionresult

type Batchdownloadjobsubmissionresult struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Batchdownloadjobsubmissionresult

func (*Batchdownloadjobsubmissionresult) String

String returns a JSON representation of the model

type Batchdownloadrequest

type Batchdownloadrequest struct {
	// ConversationId - Conversation id requested
	ConversationId *string `json:"conversationId,omitempty"`

	// RecordingId - Recording id requested, optional.  Leave null for all recordings on the conversation
	RecordingId *string `json:"recordingId,omitempty"`
}

Batchdownloadrequest

func (*Batchdownloadrequest) String

func (o *Batchdownloadrequest) String() string

String returns a JSON representation of the model

type BillingApi

type BillingApi struct {
	Configuration *Configuration
}

BillingApi provides functions for API endpoints

func NewBillingApi

func NewBillingApi() *BillingApi

NewBillingApi creates an API instance using the default configuration

func NewBillingApiWithConfig

func NewBillingApiWithConfig(config *Configuration) *BillingApi

NewBillingApiWithConfig creates an API instance using the provided configuration

func (BillingApi) GetBillingReportsBillableusage

func (a BillingApi) GetBillingReportsBillableusage(startDate time.Time, endDate time.Time) (*Billingusagereport, *APIResponse, error)

GetBillingReportsBillableusage invokes GET /api/v2/billing/reports/billableusage

Get a report of the billable license usages

Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.

func (BillingApi) GetBillingTrusteebillingoverviewTrustorOrgId

func (a BillingApi) GetBillingTrusteebillingoverviewTrustorOrgId(trustorOrgId string, billingPeriodIndex int) (*Trusteebillingoverview, *APIResponse, error)

GetBillingTrusteebillingoverviewTrustorOrgId invokes GET /api/v2/billing/trusteebillingoverview/{trustorOrgId}

Get the billing overview for an organization that is managed by a partner.

Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. See the PureCloud API Documentation in the Developer Center for more information about this API: https://developer.mypurecloud.com/api/rest/v2/

type Billingusage

type Billingusage struct {
	// Name - Identifies the billable usage.
	Name *string `json:"name,omitempty"`

	// TotalUsage - The total amount of usage, expressed as a decimal number in string format.
	TotalUsage *string `json:"totalUsage,omitempty"`

	// Resources - The resources for which usage was observed (e.g. license users, devices).
	Resources *[]Billingusageresource `json:"resources,omitempty"`
}

Billingusage

func (*Billingusage) String

func (o *Billingusage) String() string

String returns a JSON representation of the model

type Billingusagereport

type Billingusagereport struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// StartDate - The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndDate *time.Time `json:"endDate,omitempty"`

	// Status - Generation status of report
	Status *string `json:"status,omitempty"`

	// Usages - The usages for the given period.
	Usages *[]Billingusage `json:"usages,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Billingusagereport

func (*Billingusagereport) String

func (o *Billingusagereport) String() string

String returns a JSON representation of the model

type Billingusageresource

type Billingusageresource struct {
	// Name - Identifies the resource (e.g. license user, device).
	Name *string `json:"name,omitempty"`

	// Date - The date that the usage was first observed by the billing subsystem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Date *time.Time `json:"date,omitempty"`
}

Billingusageresource

func (*Billingusageresource) String

func (o *Billingusageresource) String() string

String returns a JSON representation of the model

type Biography

type Biography struct {
	// Biography - Personal detailed description
	Biography *string `json:"biography,omitempty"`

	// Interests
	Interests *[]string `json:"interests,omitempty"`

	// Hobbies
	Hobbies *[]string `json:"hobbies,omitempty"`

	// Spouse
	Spouse *string `json:"spouse,omitempty"`

	// Education - User education details
	Education *[]Education `json:"education,omitempty"`
}

Biography

func (*Biography) String

func (o *Biography) String() string

String returns a JSON representation of the model

type Buabandonrate

type Buabandonrate struct {
	// Include - Whether to include abandon rate in the associated configuration
	Include *bool `json:"include,omitempty"`

	// Percent - Abandon rate percent goal. Required if include == true
	Percent *int `json:"percent,omitempty"`
}

Buabandonrate - Service goal abandon rate configuration

func (*Buabandonrate) String

func (o *Buabandonrate) String() string

String returns a JSON representation of the model

type Buagentscheduleactivity

type Buagentscheduleactivity struct {
	// StartDate - The start date/time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartDate *time.Time `json:"startDate,omitempty"`

	// LengthMinutes - The length of this activity in minutes
	LengthMinutes *int `json:"lengthMinutes,omitempty"`

	// Description - The description of this activity
	Description *string `json:"description,omitempty"`

	// ActivityCodeId - The ID of the activity code associated with this activity
	ActivityCodeId *string `json:"activityCodeId,omitempty"`

	// Paid - Whether this activity is paid
	Paid *bool `json:"paid,omitempty"`

	// TimeOffRequestId - The ID of the time off request associated with this activity, if applicable
	TimeOffRequestId *string `json:"timeOffRequestId,omitempty"`

	// ExternalActivityId - The ID of the external activity associated with this activity, if applicable
	ExternalActivityId *string `json:"externalActivityId,omitempty"`

	// ExternalActivityType - The type of the external activity associated with this activity, if applicable
	ExternalActivityType *string `json:"externalActivityType,omitempty"`
}

Buagentscheduleactivity

func (*Buagentscheduleactivity) String

func (o *Buagentscheduleactivity) String() string

String returns a JSON representation of the model

type Buagentschedulehistorychange

type Buagentschedulehistorychange struct {
	// Metadata - The metadata of the change, including who and when the change was made
	Metadata *Buagentschedulehistorychangemetadata `json:"metadata,omitempty"`

	// Shifts - The list of changed shifts
	Shifts *[]Buagentscheduleshift `json:"shifts,omitempty"`

	// FullDayTimeOffMarkers - The list of changed full day time off markers
	FullDayTimeOffMarkers *[]Bufulldaytimeoffmarker `json:"fullDayTimeOffMarkers,omitempty"`

	// Deletes - The deleted shifts, full day time off markers, or the entire agent schedule
	Deletes *Buagentschedulehistorydeletedchange `json:"deletes,omitempty"`
}

Buagentschedulehistorychange

func (*Buagentschedulehistorychange) String

String returns a JSON representation of the model

type Buagentschedulehistorychangemetadata

type Buagentschedulehistorychangemetadata struct {
	// DateModified - The timestamp of the schedule change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// ModifiedBy - The user that made the schedule change
	ModifiedBy *Userreference `json:"modifiedBy,omitempty"`
}

Buagentschedulehistorychangemetadata

func (*Buagentschedulehistorychangemetadata) String

String returns a JSON representation of the model

type Buagentschedulehistorydeletedchange

type Buagentschedulehistorydeletedchange struct {
	// ShiftIds - The IDs of deleted shifts
	ShiftIds *[]string `json:"shiftIds,omitempty"`

	// FullDayTimeOffMarkerDates - The dates of any deleted full day time off markers
	FullDayTimeOffMarkerDates *[]time.Time `json:"fullDayTimeOffMarkerDates,omitempty"`

	// AgentSchedule - Whether the entire agent schedule was deleted
	AgentSchedule *bool `json:"agentSchedule,omitempty"`
}

Buagentschedulehistorydeletedchange

func (*Buagentschedulehistorydeletedchange) String

String returns a JSON representation of the model

type Buagentschedulehistorydroppedchange

type Buagentschedulehistorydroppedchange struct {
	// Metadata - The metadata of the change, including who and when the change was made
	Metadata *Buagentschedulehistorychangemetadata `json:"metadata,omitempty"`

	// ShiftIds - The IDs of deleted shifts
	ShiftIds *[]string `json:"shiftIds,omitempty"`

	// FullDayTimeOffMarkerDates - The dates of any deleted full day time off markers
	FullDayTimeOffMarkerDates *[]time.Time `json:"fullDayTimeOffMarkerDates,omitempty"`

	// Deletes - The deleted shifts, full day time off markers, or the entire agent schedule
	Deletes *Buagentschedulehistorydeletedchange `json:"deletes,omitempty"`
}

Buagentschedulehistorydroppedchange

func (*Buagentschedulehistorydroppedchange) String

String returns a JSON representation of the model

type Buagentschedulehistoryresponse

type Buagentschedulehistoryresponse struct {
	// PriorPublishedSchedules - The list of previously published schedules
	PriorPublishedSchedules *[]Buschedulereference `json:"priorPublishedSchedules,omitempty"`

	// BasePublishedSchedule - The originally published agent schedules
	BasePublishedSchedule *Buagentschedulehistorychange `json:"basePublishedSchedule,omitempty"`

	// DroppedChanges - The changes dropped from the schedule history. This will happen if the schedule history is too large
	DroppedChanges *[]Buagentschedulehistorydroppedchange `json:"droppedChanges,omitempty"`

	// Changes - The list of changes for the schedule history
	Changes *[]Buagentschedulehistorychange `json:"changes,omitempty"`
}

Buagentschedulehistoryresponse

func (*Buagentschedulehistoryresponse) String

String returns a JSON representation of the model

type Buagentschedulepublishedschedulereference

type Buagentschedulepublishedschedulereference struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// WeekDate - The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	WeekDate *time.Time `json:"weekDate,omitempty"`

	// WeekCount - The number of weeks encompassed by the schedule
	WeekCount *int `json:"weekCount,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Buagentschedulepublishedschedulereference

func (*Buagentschedulepublishedschedulereference) String

String returns a JSON representation of the model

type Buagentschedulequeryresponse

type Buagentschedulequeryresponse struct {
	// User - The user to whom this agent schedule applies
	User *Userreference `json:"user,omitempty"`

	// Shifts - The shift definitions for this agent schedule
	Shifts *[]Buagentscheduleshift `json:"shifts,omitempty"`

	// FullDayTimeOffMarkers - Full day time off markers which apply to this agent schedule
	FullDayTimeOffMarkers *[]Bufulldaytimeoffmarker `json:"fullDayTimeOffMarkers,omitempty"`

	// WorkPlan - The work plan for this user
	WorkPlan *Workplanreference `json:"workPlan,omitempty"`

	// WorkPlansPerWeek - The work plans per week for this user from the work plan rotation. Null values in the list denotes that user is not part of any work plan for that week
	WorkPlansPerWeek *[]Workplanreference `json:"workPlansPerWeek,omitempty"`

	// Metadata - Versioned entity metadata for this agent schedule
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Buagentschedulequeryresponse

func (*Buagentschedulequeryresponse) String

String returns a JSON representation of the model

type Buagentschedulerescheduleresponse

type Buagentschedulerescheduleresponse struct {
	// User - The user to whom this agent schedule applies
	User *Userreference `json:"user,omitempty"`

	// Shifts - The shift definitions for this agent schedule
	Shifts *[]Buagentscheduleshift `json:"shifts,omitempty"`

	// FullDayTimeOffMarkers - Full day time off markers which apply to this agent schedule
	FullDayTimeOffMarkers *[]Bufulldaytimeoffmarker `json:"fullDayTimeOffMarkers,omitempty"`

	// WorkPlan - The work plan for this user
	WorkPlan *Workplanreference `json:"workPlan,omitempty"`

	// WorkPlansPerWeek - The work plans per week for this user from the work plan rotation. Null values in the list denotes that user is not part of any work plan for that week
	WorkPlansPerWeek *[]Workplanreference `json:"workPlansPerWeek,omitempty"`
}

Buagentschedulerescheduleresponse

func (*Buagentschedulerescheduleresponse) String

String returns a JSON representation of the model

type Buagentschedulesearchresponse

type Buagentschedulesearchresponse struct {
	// User - The user to whom this agent schedule applies
	User *Userreference `json:"user,omitempty"`

	// Shifts - The shift definitions for this agent schedule
	Shifts *[]Buagentscheduleshift `json:"shifts,omitempty"`

	// FullDayTimeOffMarkers - Full day time off markers which apply to this agent schedule
	FullDayTimeOffMarkers *[]Bufulldaytimeoffmarker `json:"fullDayTimeOffMarkers,omitempty"`
}

Buagentschedulesearchresponse

func (*Buagentschedulesearchresponse) String

String returns a JSON representation of the model

type Buagentscheduleshift

type Buagentscheduleshift struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// StartDate - The start date of this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartDate *time.Time `json:"startDate,omitempty"`

	// LengthMinutes - The length of this shift in minutes
	LengthMinutes *int `json:"lengthMinutes,omitempty"`

	// Activities - The activities associated with this shift
	Activities *[]Buagentscheduleactivity `json:"activities,omitempty"`

	// ManuallyEdited - Whether this shift was manually edited. This is only set by clients and is used for rescheduling
	ManuallyEdited *bool `json:"manuallyEdited,omitempty"`

	// Schedule - The schedule to which this shift belongs
	Schedule *Buschedulereference `json:"schedule,omitempty"`
}

Buagentscheduleshift

func (*Buagentscheduleshift) String

func (o *Buagentscheduleshift) String() string

String returns a JSON representation of the model

type Buagentschedulesqueryresponse

type Buagentschedulesqueryresponse struct {
	// AgentSchedules - The requested agent schedules
	AgentSchedules *[]Buagentschedulequeryresponse `json:"agentSchedules,omitempty"`

	// BusinessUnitTimeZone - The time zone configured for the business unit to which these schedules apply
	BusinessUnitTimeZone *string `json:"businessUnitTimeZone,omitempty"`
}

Buagentschedulesqueryresponse

func (*Buagentschedulesqueryresponse) String

String returns a JSON representation of the model

type Buagentschedulessearchresponse

type Buagentschedulessearchresponse struct {
	// AgentSchedules - The requested agent schedules
	AgentSchedules *[]Buagentschedulesearchresponse `json:"agentSchedules,omitempty"`

	// BusinessUnitTimeZone - The time zone configured for the business unit to which this schedule applies
	BusinessUnitTimeZone *string `json:"businessUnitTimeZone,omitempty"`

	// PublishedSchedules - References to all published week schedules overlapping the start/end date query parameters
	PublishedSchedules *[]Buagentschedulepublishedschedulereference `json:"publishedSchedules,omitempty"`
}

Buagentschedulessearchresponse

func (*Buagentschedulessearchresponse) String

String returns a JSON representation of the model

type Buagentscheduleupdate

type Buagentscheduleupdate struct {
	// VarType - The type of update
	VarType *string `json:"type,omitempty"`

	// ShiftStartDates - The start date for the affected shifts
	ShiftStartDates *[]time.Time `json:"shiftStartDates,omitempty"`
}

Buagentscheduleupdate

func (*Buagentscheduleupdate) String

func (o *Buagentscheduleupdate) String() string

String returns a JSON representation of the model

type Buasyncagentschedulesqueryresponse

type Buasyncagentschedulesqueryresponse struct {
	// Status - The status of the operation
	Status *string `json:"status,omitempty"`

	// OperationId - The ID for the operation
	OperationId *string `json:"operationId,omitempty"`

	// Result - The result of the operation.  Null unless status == Complete
	Result *Buagentschedulesqueryresponse `json:"result,omitempty"`

	// Progress - Percent progress for the operation
	Progress *int `json:"progress,omitempty"`

	// DownloadUrl - The URL from which to download the result if it is too large to pass directly
	DownloadUrl *string `json:"downloadUrl,omitempty"`
}

Buasyncagentschedulesqueryresponse

func (*Buasyncagentschedulesqueryresponse) String

String returns a JSON representation of the model

type Buasyncagentschedulessearchresponse

type Buasyncagentschedulessearchresponse struct {
	// Status - The status of the operation
	Status *string `json:"status,omitempty"`

	// OperationId - The ID for the operation
	OperationId *string `json:"operationId,omitempty"`

	// Result - The result of the operation.  Null unless status == Complete
	Result *Buagentschedulessearchresponse `json:"result,omitempty"`

	// Progress - Percent progress for the operation
	Progress *int `json:"progress,omitempty"`

	// DownloadUrl - The URL from which to download the result if it is too large to pass directly
	DownloadUrl *string `json:"downloadUrl,omitempty"`
}

Buasyncagentschedulessearchresponse

func (*Buasyncagentschedulessearchresponse) String

String returns a JSON representation of the model

type Buasyncscheduleresponse

type Buasyncscheduleresponse struct {
	// Status - The status of the operation
	Status *string `json:"status,omitempty"`

	// OperationId - The ID for the operation
	OperationId *string `json:"operationId,omitempty"`

	// Result - The result of the operation.  Null unless status == Complete
	Result *Buschedulemetadata `json:"result,omitempty"`
}

Buasyncscheduleresponse

func (*Buasyncscheduleresponse) String

func (o *Buasyncscheduleresponse) String() string

String returns a JSON representation of the model

type Buasyncschedulerunresponse

type Buasyncschedulerunresponse struct {
	// Status - The status of the operation
	Status *string `json:"status,omitempty"`

	// OperationId - The ID for the operation
	OperationId *string `json:"operationId,omitempty"`

	// Result - The result of the operation.  Null unless status == Complete
	Result *Buschedulerun `json:"result,omitempty"`
}

Buasyncschedulerunresponse

func (*Buasyncschedulerunresponse) String

func (o *Buasyncschedulerunresponse) String() string

String returns a JSON representation of the model

type Buaveragespeedofanswer

type Buaveragespeedofanswer struct {
	// Include - Whether to include average speed of answer (ASA) in the associated configuration
	Include *bool `json:"include,omitempty"`

	// Seconds - The target average speed of answer (ASA) in seconds. Required if include == true
	Seconds *int `json:"seconds,omitempty"`
}

Buaveragespeedofanswer - Service goal average speed of answer configuration

func (*Buaveragespeedofanswer) String

func (o *Buaveragespeedofanswer) String() string

String returns a JSON representation of the model

type Bucopyschedulerequest

type Bucopyschedulerequest struct {
	// Description - The description for the new schedule
	Description *string `json:"description,omitempty"`

	// WeekDate - The start weekDate for the new copy of the schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	WeekDate *time.Time `json:"weekDate,omitempty"`
}

Bucopyschedulerequest

func (*Bucopyschedulerequest) String

func (o *Bucopyschedulerequest) String() string

String returns a JSON representation of the model

type Bucreateblankschedulerequest

type Bucreateblankschedulerequest struct {
	// Description - The description for the schedule
	Description *string `json:"description,omitempty"`

	// ShortTermForecast - The forecast to use when generating the schedule.  Note that the forecast must fully encompass the schedule's start week + week count
	ShortTermForecast *Bushorttermforecastreference `json:"shortTermForecast,omitempty"`

	// WeekCount - The number of weeks in the schedule. One extra day is added at the end
	WeekCount *int `json:"weekCount,omitempty"`
}

Bucreateblankschedulerequest

func (*Bucreateblankschedulerequest) String

String returns a JSON representation of the model

type Bucurrentagentschedulesearchresponse

type Bucurrentagentschedulesearchresponse struct {
	// AgentSchedules - The requested agent schedules
	AgentSchedules *[]Buagentschedulesearchresponse `json:"agentSchedules,omitempty"`

	// BusinessUnitTimeZone - The time zone configured for the business unit to which this schedule applies
	BusinessUnitTimeZone *string `json:"businessUnitTimeZone,omitempty"`

	// PublishedSchedules - References to all published week schedules overlapping the start/end date query parameters
	PublishedSchedules *[]Buagentschedulepublishedschedulereference `json:"publishedSchedules,omitempty"`

	// StartDate - The start date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - The end date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndDate *time.Time `json:"endDate,omitempty"`

	// Updates - The list of updates for the schedule. Only used in notifications
	Updates *[]Buagentscheduleupdate `json:"updates,omitempty"`
}

Bucurrentagentschedulesearchresponse

func (*Bucurrentagentschedulesearchresponse) String

String returns a JSON representation of the model

type Buforecastgenerationplanninggroupresult

type Buforecastgenerationplanninggroupresult struct {
	// PlanningGroupId - The ID of the planning group
	PlanningGroupId *string `json:"planningGroupId,omitempty"`

	// MetricResults - The generation results for the associated planning group
	MetricResults *[]Buforecasttimeseriesresult `json:"metricResults,omitempty"`
}

Buforecastgenerationplanninggroupresult

func (*Buforecastgenerationplanninggroupresult) String

String returns a JSON representation of the model

type Buforecastgenerationresult

type Buforecastgenerationresult struct {
	// PlanningGroupResults - Generation results, broken down by planning group
	PlanningGroupResults *[]Buforecastgenerationplanninggroupresult `json:"planningGroupResults,omitempty"`
}

Buforecastgenerationresult

func (*Buforecastgenerationresult) String

func (o *Buforecastgenerationresult) String() string

String returns a JSON representation of the model

type Buforecastmodification

type Buforecastmodification struct {
	// VarType - The type of the modification
	VarType *string `json:"type,omitempty"`

	// StartIntervalIndex - The number of 15 minute intervals past referenceStartDate representing the first interval to which to apply this modification. Must be null if values is populated
	StartIntervalIndex *int `json:"startIntervalIndex,omitempty"`

	// EndIntervalIndex - The number of 15 minute intervals past referenceStartDate representing the last interval to which to apply this modification.  Must be null if values is populated
	EndIntervalIndex *int `json:"endIntervalIndex,omitempty"`

	// Metric - The metric to which this modification applies
	Metric *string `json:"metric,omitempty"`

	// LegacyMetric - The legacy metric to which this modification applies if applicable
	LegacyMetric *string `json:"legacyMetric,omitempty"`

	// Value - The value of the modification.  Must be null if \"values\" is populated
	Value *float64 `json:"value,omitempty"`

	// Values - The list of values to update.  Only applicable for grid-type modifications. Must be null if \"value\" is populated
	Values *[]Wfmforecastmodificationintervaloffsetvalue `json:"values,omitempty"`

	// DisplayGranularity - The client side display granularity of the modification, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
	DisplayGranularity *string `json:"displayGranularity,omitempty"`

	// Granularity - The actual granularity of the modification as stored behind the scenes, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
	Granularity *string `json:"granularity,omitempty"`

	// Enabled - Whether the modification is enabled for the forecast
	Enabled *bool `json:"enabled,omitempty"`

	// PlanningGroupIds - The IDs of the planning groups to which this forecast modification applies.  Leave empty to apply to all
	PlanningGroupIds *[]string `json:"planningGroupIds,omitempty"`
}

Buforecastmodification

func (*Buforecastmodification) String

func (o *Buforecastmodification) String() string

String returns a JSON representation of the model

type Buforecastresult

type Buforecastresult struct {
	// ReferenceStartDate - The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"`

	// PlanningGroups - The forecast data broken up by planning group
	PlanningGroups *[]Forecastplanninggroupdata `json:"planningGroups,omitempty"`

	// WeekNumber - The week number represented by this response
	WeekNumber *int `json:"weekNumber,omitempty"`

	// WeekCount - The number of weeks in this forecast
	WeekCount *int `json:"weekCount,omitempty"`
}

Buforecastresult

func (*Buforecastresult) String

func (o *Buforecastresult) String() string

String returns a JSON representation of the model

type Buforecastresultresponse

type Buforecastresultresponse struct {
	// Result - The result of the operation.  Populated whenever the result is small enough to pass through the api directly
	Result *Buforecastresult `json:"result,omitempty"`

	// DownloadUrl - The download url to fetch the result.  Only populated if the result is too large to pass through the api directly
	DownloadUrl *string `json:"downloadUrl,omitempty"`
}

Buforecastresultresponse

func (*Buforecastresultresponse) String

func (o *Buforecastresultresponse) String() string

String returns a JSON representation of the model

type Buforecasttimeseriesresult

type Buforecasttimeseriesresult struct {
	// Metric - The metric this result applies to
	Metric *string `json:"metric,omitempty"`

	// ForecastingMethod - The forecasting method that was used for this metric
	ForecastingMethod *string `json:"forecastingMethod,omitempty"`
}

Buforecasttimeseriesresult

func (*Buforecasttimeseriesresult) String

func (o *Buforecasttimeseriesresult) String() string

String returns a JSON representation of the model

type Bufulldaytimeoffmarker

type Bufulldaytimeoffmarker struct {
	// BusinessUnitDate - The date of the time off marker, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	BusinessUnitDate *time.Time `json:"businessUnitDate,omitempty"`

	// LengthMinutes - The length of the time off marker in minutes
	LengthMinutes *int `json:"lengthMinutes,omitempty"`

	// Description - The description of the time off marker
	Description *string `json:"description,omitempty"`

	// ActivityCodeId - The ID of the activity code associated with the time off marker
	ActivityCodeId *string `json:"activityCodeId,omitempty"`

	// Paid - Whether the time off marker is paid
	Paid *bool `json:"paid,omitempty"`

	// TimeOffRequestId - The ID of the time off request
	TimeOffRequestId *string `json:"timeOffRequestId,omitempty"`
}

Bufulldaytimeoffmarker

func (*Bufulldaytimeoffmarker) String

func (o *Bufulldaytimeoffmarker) String() string

String returns a JSON representation of the model

type Bugenerateschedulerequest

type Bugenerateschedulerequest struct {
	// Description - The description for the schedule
	Description *string `json:"description,omitempty"`

	// ShortTermForecast - The forecast to use when generating the schedule.  Note that the forecast must fully encompass the schedule's start week + week count
	ShortTermForecast *Bushorttermforecastreference `json:"shortTermForecast,omitempty"`

	// WeekCount - The number of weeks in the schedule. One extra day is added at the end
	WeekCount *int `json:"weekCount,omitempty"`
}

Bugenerateschedulerequest

func (*Bugenerateschedulerequest) String

func (o *Bugenerateschedulerequest) String() string

String returns a JSON representation of the model

type Bugetcurrentagentschedulerequest

type Bugetcurrentagentschedulerequest struct {
	// StartDate - Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndDate *time.Time `json:"endDate,omitempty"`
}

Bugetcurrentagentschedulerequest

func (*Bugetcurrentagentschedulerequest) String

String returns a JSON representation of the model

type Buheadcountforecast

type Buheadcountforecast struct {
	// Entities
	Entities *[]Buplanninggroupheadcountforecast `json:"entities,omitempty"`

	// ReferenceStartDate - Reference start date for the interval values in each forecast entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"`
}

Buheadcountforecast

func (*Buheadcountforecast) String

func (o *Buheadcountforecast) String() string

String returns a JSON representation of the model

type Buheadcountforecastresponse

type Buheadcountforecastresponse struct {
	// Result - The headcount forecast, null when downloadUrl is provided
	Result *Buheadcountforecast `json:"result,omitempty"`

	// DownloadUrl - Download URL.  Null unless the response is too large to pass directly through the api
	DownloadUrl *string `json:"downloadUrl,omitempty"`
}

Buheadcountforecastresponse

func (*Buheadcountforecastresponse) String

func (o *Buheadcountforecastresponse) String() string

String returns a JSON representation of the model

type Buintradaydatagroup

type Buintradaydatagroup struct {
	// MediaType - The media type associated with this intraday group
	MediaType *string `json:"mediaType,omitempty"`

	// ForecastDataSummary - Forecast data summary for this date range
	ForecastDataSummary *Buintradayforecastdata `json:"forecastDataSummary,omitempty"`

	// ForecastDataPerInterval - Forecast data per interval for this date range
	ForecastDataPerInterval *[]Buintradayforecastdata `json:"forecastDataPerInterval,omitempty"`

	// ScheduleDataSummary - Schedule data summary for this date range
	ScheduleDataSummary *Buintradayscheduledata `json:"scheduleDataSummary,omitempty"`

	// ScheduleDataPerInterval - Schedule data per interval for this date range
	ScheduleDataPerInterval *[]Buintradayscheduledata `json:"scheduleDataPerInterval,omitempty"`

	// PerformancePredictionDataSummary - Performance prediction data summary for this date range
	PerformancePredictionDataSummary *Intradayperformancepredictiondata `json:"performancePredictionDataSummary,omitempty"`

	// PerformancePredictionDataPerInterval - Performance prediction data per interval for this date range
	PerformancePredictionDataPerInterval *[]Intradayperformancepredictiondata `json:"performancePredictionDataPerInterval,omitempty"`
}

Buintradaydatagroup

func (*Buintradaydatagroup) String

func (o *Buintradaydatagroup) String() string

String returns a JSON representation of the model

type Buintradayforecastdata

type Buintradayforecastdata struct {
	// Offered - The number of interactions routed into the queues in the selected planning groups for the given media type for an agent to answer
	Offered *float64 `json:"offered,omitempty"`

	// AverageHandleTimeSeconds - The average handle time in seconds an agent spent handling interactions
	AverageHandleTimeSeconds *float64 `json:"averageHandleTimeSeconds,omitempty"`
}

Buintradayforecastdata

func (*Buintradayforecastdata) String

func (o *Buintradayforecastdata) String() string

String returns a JSON representation of the model

type Buintradayresponse

type Buintradayresponse struct {
	// StartDate - The start of the date range for which this data applies.  This is also the start reference point for the intervals represented in the various arrays. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - The end of the date range for which this data applies. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndDate *time.Time `json:"endDate,omitempty"`

	// IntervalLengthMinutes - The aggregation period in minutes, which determines the interval duration of the returned data
	IntervalLengthMinutes *int `json:"intervalLengthMinutes,omitempty"`

	// NoDataReason - If not null, the reason there was no data for the request
	NoDataReason *string `json:"noDataReason,omitempty"`

	// Categories - The categories to which this data corresponds
	Categories *[]string `json:"categories,omitempty"`

	// ShortTermForecast - Short term forecast reference
	ShortTermForecast *Bushorttermforecastreference `json:"shortTermForecast,omitempty"`

	// Schedule - Schedule reference
	Schedule *Buschedulereference `json:"schedule,omitempty"`

	// IntradayDataGroupings - Intraday data grouped by a single media type and set of planning group IDs
	IntradayDataGroupings *[]Buintradaydatagroup `json:"intradayDataGroupings,omitempty"`
}

Buintradayresponse

func (*Buintradayresponse) String

func (o *Buintradayresponse) String() string

String returns a JSON representation of the model

type Buintradayscheduledata

type Buintradayscheduledata struct {
	// OnQueueTimeSeconds - The total on-queue time in seconds for all agents in this group
	OnQueueTimeSeconds *int `json:"onQueueTimeSeconds,omitempty"`
}

Buintradayscheduledata

func (*Buintradayscheduledata) String

func (o *Buintradayscheduledata) String() string

String returns a JSON representation of the model

type Bulkshifttradestateupdaterequest

type Bulkshifttradestateupdaterequest struct {
	// Entities - The shift trades to update
	Entities *[]Bulkupdateshifttradestaterequestitem `json:"entities,omitempty"`
}

Bulkshifttradestateupdaterequest

func (*Bulkshifttradestateupdaterequest) String

String returns a JSON representation of the model

type Bulkupdateshifttradestaterequestitem

type Bulkupdateshifttradestaterequestitem struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// State - The new state to set on the shift trade
	State *string `json:"state,omitempty"`

	// Metadata - Version metadata for the shift trade
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Bulkupdateshifttradestaterequestitem

func (*Bulkupdateshifttradestaterequestitem) String

String returns a JSON representation of the model

type Bulkupdateshifttradestateresponse

type Bulkupdateshifttradestateresponse struct {
	// Status - The status of the operation
	Status *string `json:"status,omitempty"`

	// OperationId - The ID for the operation
	OperationId *string `json:"operationId,omitempty"`

	// Result - The result of the operation.  Null unless status == Complete
	Result *Bulkupdateshifttradestateresult `json:"result,omitempty"`
}

Bulkupdateshifttradestateresponse

func (*Bulkupdateshifttradestateresponse) String

String returns a JSON representation of the model

type Bulkupdateshifttradestateresult

type Bulkupdateshifttradestateresult struct {
	// Entities
	Entities *[]Bulkupdateshifttradestateresultitem `json:"entities,omitempty"`
}

Bulkupdateshifttradestateresult

func (*Bulkupdateshifttradestateresult) String

String returns a JSON representation of the model

type Bulkupdateshifttradestateresultitem

type Bulkupdateshifttradestateresultitem struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// State - The state of the shift trade after the update request is processed
	State *string `json:"state,omitempty"`

	// ReviewedBy - The user who reviewed the request, if applicable
	ReviewedBy *Userreference `json:"reviewedBy,omitempty"`

	// ReviewedDate - The date the request was reviewed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ReviewedDate *time.Time `json:"reviewedDate,omitempty"`

	// FailureReason - The reason the update failed, if applicable
	FailureReason *string `json:"failureReason,omitempty"`

	// Metadata - Version metadata for the shift trade
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Bulkupdateshifttradestateresultitem

func (*Bulkupdateshifttradestateresultitem) String

String returns a JSON representation of the model

type Bullseye

type Bullseye struct {
	// Rings
	Rings *[]Ring `json:"rings,omitempty"`
}

Bullseye

func (*Bullseye) String

func (o *Bullseye) String() string

String returns a JSON representation of the model

type Bumanagementunitschedulesummary

type Bumanagementunitschedulesummary struct {
	// ManagementUnit - The management unit to which this summary applies
	ManagementUnit *Managementunitreference `json:"managementUnit,omitempty"`

	// AgentCount - The number of agents from this management unit that are in the schedule
	AgentCount *int `json:"agentCount,omitempty"`

	// StartDate - The start of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - The end of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndDate *time.Time `json:"endDate,omitempty"`

	// Agents - The agents in the management unit who are part of this schedule, or in schedule change notifications, the agents that were changed. Note this will come back as an empty list unless the appropriate expand query parameter is passed
	Agents *[]Userreference `json:"agents,omitempty"`
}

Bumanagementunitschedulesummary

func (*Bumanagementunitschedulesummary) String

String returns a JSON representation of the model

type Buplanninggroupheadcountforecast

type Buplanninggroupheadcountforecast struct {
	// PlanningGroup - The planning group to which this portion of the headcount forecast applies
	PlanningGroup *Planninggroupreference `json:"planningGroup,omitempty"`

	// RequiredPerInterval - Required headcount per interval, referenced against the reference start date
	RequiredPerInterval *[]float64 `json:"requiredPerInterval,omitempty"`

	// RequiredWithoutShrinkagePerInterval - Required headcount per interval without accounting for shrinkage, referenced against the reference start date
	RequiredWithoutShrinkagePerInterval *[]float64 `json:"requiredWithoutShrinkagePerInterval,omitempty"`
}

Buplanninggroupheadcountforecast

func (*Buplanninggroupheadcountforecast) String

String returns a JSON representation of the model

type Buqueryagentschedulesrequest

type Buqueryagentschedulesrequest struct {
	// ManagementUnitId - The ID of the management unit to query
	ManagementUnitId *string `json:"managementUnitId,omitempty"`

	// UserIds - The IDs of the users to query.  Omit to query all user schedules in the management unit. Note: If teamIds is also specified, only schedules for users in the requested teams will be returned
	UserIds *[]string `json:"userIds,omitempty"`

	// TeamIds - The teamIds to report on. If null or not set, results will be queried for requested users if applicable or otherwise all users in the management unit
	TeamIds *[]string `json:"teamIds,omitempty"`
}

Buqueryagentschedulesrequest

func (*Buqueryagentschedulesrequest) String

String returns a JSON representation of the model

type Burescheduleagentscheduleresult

type Burescheduleagentscheduleresult struct {
	// ManagementUnit - The management unit to which this part of the result applies
	ManagementUnit *Managementunitreference `json:"managementUnit,omitempty"`

	// DownloadResult - The agent schedules.  Result will always come via the downloadUrl; however the schema is included for documentation
	DownloadResult *Murescheduleresultwrapper `json:"downloadResult,omitempty"`

	// DownloadUrl - The download URL from which to fetch the result
	DownloadUrl *string `json:"downloadUrl,omitempty"`
}

Burescheduleagentscheduleresult

func (*Burescheduleagentscheduleresult) String

String returns a JSON representation of the model

type Bureschedulerequest

type Bureschedulerequest struct {
	// StartDate - The start of the range to reschedule.  Defaults to the beginning of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - The end of the range to reschedule.  Defaults the the end of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndDate *time.Time `json:"endDate,omitempty"`

	// AgentIds - The IDs of the agents to consider for rescheduling.  Omit to consider all agents in the specified management units.Agents not in the specified management units will be ignored
	AgentIds *[]string `json:"agentIds,omitempty"`

	// ActivityCodeIds - The IDs of the activity codes to consider for rescheduling.  Omit to consider all activity codes
	ActivityCodeIds *[]string `json:"activityCodeIds,omitempty"`

	// ManagementUnitIds - The IDs of the management units to reschedule
	ManagementUnitIds *[]string `json:"managementUnitIds,omitempty"`

	// DoNotChangeWeeklyPaidTime - Instructs the scheduler whether it is allowed to change weekly paid time
	DoNotChangeWeeklyPaidTime *bool `json:"doNotChangeWeeklyPaidTime,omitempty"`

	// DoNotChangeDailyPaidTime - Instructs the scheduler whether it is allowed to change daily paid time
	DoNotChangeDailyPaidTime *bool `json:"doNotChangeDailyPaidTime,omitempty"`

	// DoNotChangeShiftStartTimes - Instructs the scheduler whether it is allowed to change shift start times
	DoNotChangeShiftStartTimes *bool `json:"doNotChangeShiftStartTimes,omitempty"`

	// DoNotChangeManuallyEditedShifts - Instructs the scheduler whether it is allowed to change manually edited shifts
	DoNotChangeManuallyEditedShifts *bool `json:"doNotChangeManuallyEditedShifts,omitempty"`
}

Bureschedulerequest

func (*Bureschedulerequest) String

func (o *Bureschedulerequest) String() string

String returns a JSON representation of the model

type Burescheduleresult

type Burescheduleresult struct {
	// GenerationResults - The generation results.  Note the result will always be delivered via the downloadUrl; however the schema is included for documentation
	GenerationResults *Schedulegenerationresult `json:"generationResults,omitempty"`

	// GenerationResultsDownloadUrl - The download URL from which to fetch the generation results for the rescheduling run
	GenerationResultsDownloadUrl *string `json:"generationResultsDownloadUrl,omitempty"`

	// HeadcountForecast - The headcount forecast.  Note the result will always be delivered via the downloadUrl; however the schema is included for documentation
	HeadcountForecast *Buheadcountforecast `json:"headcountForecast,omitempty"`

	// HeadcountForecastDownloadUrl - The download URL from which to fetch the headcount forecast for the rescheduling run
	HeadcountForecastDownloadUrl *string `json:"headcountForecastDownloadUrl,omitempty"`

	// AgentSchedules - List of download links for agent schedules produced by the rescheduling run
	AgentSchedules *[]Burescheduleagentscheduleresult `json:"agentSchedules,omitempty"`
}

Burescheduleresult

func (*Burescheduleresult) String

func (o *Burescheduleresult) String() string

String returns a JSON representation of the model

type Buschedulelisting

type Buschedulelisting struct {
	// Entities
	Entities *[]Buschedulelistitem `json:"entities,omitempty"`
}

Buschedulelisting

func (*Buschedulelisting) String

func (o *Buschedulelisting) String() string

String returns a JSON representation of the model

type Buschedulelistitem

type Buschedulelistitem struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// WeekDate - The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	WeekDate *time.Time `json:"weekDate,omitempty"`

	// WeekCount - The number of weeks spanned by this schedule
	WeekCount *int `json:"weekCount,omitempty"`

	// Description - The description of this schedule
	Description *string `json:"description,omitempty"`

	// Published - Whether this schedule is published
	Published *bool `json:"published,omitempty"`

	// ShortTermForecast - The forecast used for this schedule, if applicable
	ShortTermForecast *Bushorttermforecastreference `json:"shortTermForecast,omitempty"`

	// GenerationResults - Generation result summary for this schedule, if applicable
	GenerationResults *Schedulegenerationresultsummary `json:"generationResults,omitempty"`

	// Metadata - Version metadata for this schedule
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Buschedulelistitem

func (*Buschedulelistitem) String

func (o *Buschedulelistitem) String() string

String returns a JSON representation of the model

type Buschedulemetadata

type Buschedulemetadata struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// WeekDate - The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	WeekDate *time.Time `json:"weekDate,omitempty"`

	// WeekCount - The number of weeks spanned by this schedule
	WeekCount *int `json:"weekCount,omitempty"`

	// Description - The description of this schedule
	Description *string `json:"description,omitempty"`

	// Published - Whether this schedule is published
	Published *bool `json:"published,omitempty"`

	// ShortTermForecast - The forecast used for this schedule, if applicable
	ShortTermForecast *Bushorttermforecastreference `json:"shortTermForecast,omitempty"`

	// GenerationResults - Generation result summary for this schedule, if applicable
	GenerationResults *Schedulegenerationresultsummary `json:"generationResults,omitempty"`

	// Metadata - Version metadata for this schedule
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// ManagementUnits - High level per-management unit schedule metadata
	ManagementUnits *[]Bumanagementunitschedulesummary `json:"managementUnits,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Buschedulemetadata

func (*Buschedulemetadata) String

func (o *Buschedulemetadata) String() string

String returns a JSON representation of the model

type Buschedulereference

type Buschedulereference struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// WeekDate - The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	WeekDate *time.Time `json:"weekDate,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Buschedulereference

func (*Buschedulereference) String

func (o *Buschedulereference) String() string

String returns a JSON representation of the model

type Buschedulereferenceformuroute

type Buschedulereferenceformuroute struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// WeekDate - The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	WeekDate *time.Time `json:"weekDate,omitempty"`

	// BusinessUnit - The start week date for this schedule
	BusinessUnit *Businessunitreference `json:"businessUnit,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Buschedulereferenceformuroute

func (*Buschedulereferenceformuroute) String

String returns a JSON representation of the model

type Buschedulerun

type Buschedulerun struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// SchedulerRunId - The scheduler run ID.  Reference this value for support
	SchedulerRunId *string `json:"schedulerRunId,omitempty"`

	// IntradayRescheduling - Whether this is an intraday rescheduling run
	IntradayRescheduling *bool `json:"intradayRescheduling,omitempty"`

	// State - The state of the generation run
	State *string `json:"state,omitempty"`

	// WeekCount - The number of weeks spanned by the schedule
	WeekCount *int `json:"weekCount,omitempty"`

	// PercentComplete - Percent completion of the schedule run
	PercentComplete *float64 `json:"percentComplete,omitempty"`

	// TargetWeek - The start date of the target week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	TargetWeek *time.Time `json:"targetWeek,omitempty"`

	// Schedule - The generated schedule.  Null unless the schedule run is complete
	Schedule *Buschedulereference `json:"schedule,omitempty"`

	// ScheduleDescription - The description of the generated schedule
	ScheduleDescription *string `json:"scheduleDescription,omitempty"`

	// SchedulingStartTime - When the schedule generation run started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	SchedulingStartTime *time.Time `json:"schedulingStartTime,omitempty"`

	// SchedulingStartedBy - The user who started the scheduling run
	SchedulingStartedBy *Userreference `json:"schedulingStartedBy,omitempty"`

	// SchedulingCanceledBy - The user who canceled the scheduling run, if applicable
	SchedulingCanceledBy *Userreference `json:"schedulingCanceledBy,omitempty"`

	// SchedulingCompletedTime - When the scheduling run was completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	SchedulingCompletedTime *time.Time `json:"schedulingCompletedTime,omitempty"`

	// MessageCount - The number of schedule generation messages for this schedule generation run
	MessageCount *int `json:"messageCount,omitempty"`

	// ReschedulingOptions - Rescheduling options for this run.  Null unless intradayRescheduling is true
	ReschedulingOptions *Reschedulingoptionsrunresponse `json:"reschedulingOptions,omitempty"`

	// ReschedulingResultExpiration - When the reschedule result will expire.  Null unless intradayRescheduling is true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ReschedulingResultExpiration *time.Time `json:"reschedulingResultExpiration,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Buschedulerun

func (*Buschedulerun) String

func (o *Buschedulerun) String() string

String returns a JSON representation of the model

type Buschedulerunlisting

type Buschedulerunlisting struct {
	// Entities
	Entities *[]Buschedulerun `json:"entities,omitempty"`
}

Buschedulerunlisting

func (*Buschedulerunlisting) String

func (o *Buschedulerunlisting) String() string

String returns a JSON representation of the model

type Busearchagentschedulesrequest

type Busearchagentschedulesrequest struct {
	// StartDate - Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndDate *time.Time `json:"endDate,omitempty"`

	// UserIds - IDs of the users for whose schedules to search
	UserIds *[]string `json:"userIds,omitempty"`
}

Busearchagentschedulesrequest

func (*Busearchagentschedulesrequest) String

String returns a JSON representation of the model

type Buservicelevel

type Buservicelevel struct {
	// Include - Whether to include service level targets in the associated configuration
	Include *bool `json:"include,omitempty"`

	// Percent - Service level target percent answered. Required if include == true
	Percent *int `json:"percent,omitempty"`

	// Seconds - Service level target answer time. Required if include == true
	Seconds *int `json:"seconds,omitempty"`
}

Buservicelevel - Service goal service level configuration

func (*Buservicelevel) String

func (o *Buservicelevel) String() string

String returns a JSON representation of the model

type Bushorttermforecast

type Bushorttermforecast struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// WeekDate - The start week date of this forecast in yyyy-MM-dd.  Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	WeekDate *time.Time `json:"weekDate,omitempty"`

	// WeekCount - The number of weeks this forecast covers
	WeekCount *int `json:"weekCount,omitempty"`

	// CreationMethod - The method by which this forecast was created
	CreationMethod *string `json:"creationMethod,omitempty"`

	// Description - The description of this forecast
	Description *string `json:"description,omitempty"`

	// Legacy - Whether this forecast contains modifications on legacy metrics
	Legacy *bool `json:"legacy,omitempty"`

	// Metadata - Metadata for this forecast
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// ReferenceStartDate - The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"`

	// SourceDays - The source day pointers for this forecast
	SourceDays *[]Forecastsourcedaypointer `json:"sourceDays,omitempty"`

	// Modifications - Any manual modifications applied to this forecast
	Modifications *[]Buforecastmodification `json:"modifications,omitempty"`

	// GenerationResults - Generation result metadata
	GenerationResults *Buforecastgenerationresult `json:"generationResults,omitempty"`

	// TimeZone - The time zone for this forecast
	TimeZone *string `json:"timeZone,omitempty"`

	// PlanningGroupsVersion - The version of the planning groups that was used for this forecast
	PlanningGroupsVersion *int `json:"planningGroupsVersion,omitempty"`

	// PlanningGroups - A snapshot of the planning groups used for this forecast as of the version number indicated
	PlanningGroups *Forecastplanninggroupsresponse `json:"planningGroups,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Bushorttermforecast

func (*Bushorttermforecast) String

func (o *Bushorttermforecast) String() string

String returns a JSON representation of the model

type Bushorttermforecastingsettings

type Bushorttermforecastingsettings struct {
	// DefaultHistoryWeeks - The number of historical weeks to consider when creating a forecast. This setting is only used for legacy weighted average forecasts
	DefaultHistoryWeeks *int `json:"defaultHistoryWeeks,omitempty"`
}

Bushorttermforecastingsettings

func (*Bushorttermforecastingsettings) String

String returns a JSON representation of the model

type Bushorttermforecastlisting

type Bushorttermforecastlisting struct {
	// Entities
	Entities *[]Bushorttermforecastlistitem `json:"entities,omitempty"`
}

Bushorttermforecastlisting

func (*Bushorttermforecastlisting) String

func (o *Bushorttermforecastlisting) String() string

String returns a JSON representation of the model

type Bushorttermforecastlistitem

type Bushorttermforecastlistitem struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// WeekDate - The start week date of this forecast in yyyy-MM-dd.  Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	WeekDate *time.Time `json:"weekDate,omitempty"`

	// WeekCount - The number of weeks this forecast covers
	WeekCount *int `json:"weekCount,omitempty"`

	// CreationMethod - The method by which this forecast was created
	CreationMethod *string `json:"creationMethod,omitempty"`

	// Description - The description of this forecast
	Description *string `json:"description,omitempty"`

	// Legacy - Whether this forecast contains modifications on legacy metrics
	Legacy *bool `json:"legacy,omitempty"`

	// Metadata - Metadata for this forecast
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Bushorttermforecastlistitem

func (*Bushorttermforecastlistitem) String

func (o *Bushorttermforecastlistitem) String() string

String returns a JSON representation of the model

type Bushorttermforecastreference

type Bushorttermforecastreference struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// WeekDate - The weekDate of the short term forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	WeekDate *time.Time `json:"weekDate,omitempty"`

	// Description - The description of the short term forecast
	Description *string `json:"description,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Bushorttermforecastreference - A pointer to a short term forecast

func (*Bushorttermforecastreference) String

String returns a JSON representation of the model

type Businessunit

type Businessunit struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Division `json:"division,omitempty"`

	// Settings - Settings for this business unit
	Settings *Businessunitsettings `json:"settings,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Businessunit

func (*Businessunit) String

func (o *Businessunit) String() string

String returns a JSON representation of the model

type Businessunitactivitycode

type Businessunitactivitycode struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Active - Whether this activity code is active or has been deleted
	Active *bool `json:"active,omitempty"`

	// DefaultCode - Whether this is a default activity code
	DefaultCode *bool `json:"defaultCode,omitempty"`

	// Category - The category of the activity code
	Category *string `json:"category,omitempty"`

	// LengthInMinutes - The default length of the activity in minutes
	LengthInMinutes *int `json:"lengthInMinutes,omitempty"`

	// CountsAsPaidTime - Whether an agent is paid while performing this activity
	CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"`

	// CountsAsWorkTime - Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints
	CountsAsWorkTime *bool `json:"countsAsWorkTime,omitempty"`

	// AgentTimeOffSelectable - Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off.
	AgentTimeOffSelectable *bool `json:"agentTimeOffSelectable,omitempty"`

	// Metadata - Version metadata of this activity code
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Businessunitactivitycode - Activity code data

func (*Businessunitactivitycode) String

func (o *Businessunitactivitycode) String() string

String returns a JSON representation of the model

type Businessunitactivitycodelisting

type Businessunitactivitycodelisting struct {
	// Entities
	Entities *[]Businessunitactivitycode `json:"entities,omitempty"`
}

Businessunitactivitycodelisting - List of BusinessUnitActivityCode

func (*Businessunitactivitycodelisting) String

String returns a JSON representation of the model

type Businessunitlisting

type Businessunitlisting struct {
	// Entities
	Entities *[]Businessunitlistitem `json:"entities,omitempty"`
}

Businessunitlisting

func (*Businessunitlisting) String

func (o *Businessunitlisting) String() string

String returns a JSON representation of the model

type Businessunitlistitem

type Businessunitlistitem struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Division `json:"division,omitempty"`

	// Authorized - Whether the user has authorization to interact with this business unit
	Authorized *bool `json:"authorized,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Businessunitlistitem

func (*Businessunitlistitem) String

func (o *Businessunitlistitem) String() string

String returns a JSON representation of the model

type Businessunitreference

type Businessunitreference struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Businessunitreference

func (*Businessunitreference) String

func (o *Businessunitreference) String() string

String returns a JSON representation of the model

type Businessunitsettings

type Businessunitsettings struct {
	// StartDayOfWeek - The start day of week for this business unit
	StartDayOfWeek *string `json:"startDayOfWeek,omitempty"`

	// TimeZone - The time zone for this business unit, using the Olsen tz database format
	TimeZone *string `json:"timeZone,omitempty"`

	// ShortTermForecasting - Short term forecasting settings
	ShortTermForecasting *Bushorttermforecastingsettings `json:"shortTermForecasting,omitempty"`

	// Metadata - Version metadata for this business unit
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Businessunitsettings

func (*Businessunitsettings) String

func (o *Businessunitsettings) String() string

String returns a JSON representation of the model

type Buttoncomponent

type Buttoncomponent struct {
	// Id - An ID assigned to this component
	Id *string `json:"id,omitempty"`

	// Text - Deprecated - Use title instead
	Text *string `json:"text,omitempty"`

	// Title - Text to show inside the button
	Title *string `json:"title,omitempty"`

	// Actions - User actions available on the content. All actions are optional and all actions are executed simultaneously.
	Actions *Contentactions `json:"actions,omitempty"`
}

Buttoncomponent - Structured template button object

func (*Buttoncomponent) String

func (o *Buttoncomponent) String() string

String returns a JSON representation of the model

type Calibration

type Calibration struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Calibrator
	Calibrator *User `json:"calibrator,omitempty"`

	// Agent
	Agent *User `json:"agent,omitempty"`

	// Conversation
	Conversation *Conversation `json:"conversation,omitempty"`

	// EvaluationForm
	EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// AverageScore
	AverageScore *int `json:"averageScore,omitempty"`

	// HighScore
	HighScore *int `json:"highScore,omitempty"`

	// LowScore
	LowScore *int `json:"lowScore,omitempty"`

	// CreatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CreatedDate *time.Time `json:"createdDate,omitempty"`

	// Evaluations
	Evaluations *[]Evaluation `json:"evaluations,omitempty"`

	// Evaluators
	Evaluators *[]User `json:"evaluators,omitempty"`

	// ScoringIndex
	ScoringIndex **Evaluation `json:"scoringIndex,omitempty"`

	// ExpertEvaluator
	ExpertEvaluator *User `json:"expertEvaluator,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Calibration

func (*Calibration) String

func (o *Calibration) String() string

String returns a JSON representation of the model

type Calibrationassignment

type Calibrationassignment struct {
	// Calibrator
	Calibrator *User `json:"calibrator,omitempty"`

	// Evaluators
	Evaluators *[]User `json:"evaluators,omitempty"`

	// EvaluationForm
	EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"`

	// ExpertEvaluator
	ExpertEvaluator *User `json:"expertEvaluator,omitempty"`
}

Calibrationassignment

func (*Calibrationassignment) String

func (o *Calibrationassignment) String() string

String returns a JSON representation of the model

type Calibrationcreate

type Calibrationcreate struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Calibrator
	Calibrator *User `json:"calibrator,omitempty"`

	// Agent
	Agent *User `json:"agent,omitempty"`

	// Conversation - The conversation to use for the calibration.
	Conversation *Conversation `json:"conversation,omitempty"`

	// EvaluationForm
	EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// AverageScore
	AverageScore *int `json:"averageScore,omitempty"`

	// HighScore
	HighScore *int `json:"highScore,omitempty"`

	// LowScore
	LowScore *int `json:"lowScore,omitempty"`

	// CreatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CreatedDate *time.Time `json:"createdDate,omitempty"`

	// Evaluations
	Evaluations *[]Evaluation `json:"evaluations,omitempty"`

	// Evaluators
	Evaluators *[]User `json:"evaluators,omitempty"`

	// ScoringIndex
	ScoringIndex *Evaluation `json:"scoringIndex,omitempty"`

	// ExpertEvaluator
	ExpertEvaluator *User `json:"expertEvaluator,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Calibrationcreate

func (*Calibrationcreate) String

func (o *Calibrationcreate) String() string

String returns a JSON representation of the model

type Calibrationentitylisting

type Calibrationentitylisting struct {
	// Entities
	Entities *[]Calibration `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Calibrationentitylisting

func (*Calibrationentitylisting) String

func (o *Calibrationentitylisting) String() string

String returns a JSON representation of the model

type Call

type Call struct {
	// State - The connection state of this communication.
	State *string `json:"state,omitempty"`

	// Id - A globally unique identifier for this communication.
	Id *string `json:"id,omitempty"`

	// Direction - The direction of the call
	Direction *string `json:"direction,omitempty"`

	// Recording - True if this call is being recorded.
	Recording *bool `json:"recording,omitempty"`

	// RecordingState - State of recording on this call.
	RecordingState *string `json:"recordingState,omitempty"`

	// Muted - True if this call is muted so that remote participants can't hear any audio from this end.
	Muted *bool `json:"muted,omitempty"`

	// Confined - True if this call is held and the person on this side hears hold music.
	Confined *bool `json:"confined,omitempty"`

	// Held - True if this call is held and the person on this side hears silence.
	Held *bool `json:"held,omitempty"`

	// RecordingId - A globally unique identifier for the recording associated with this call.
	RecordingId *string `json:"recordingId,omitempty"`

	// Segments - The time line of the participant's call, divided into activity segments.
	Segments *[]Segment `json:"segments,omitempty"`

	// ErrorInfo
	ErrorInfo *Errorinfo `json:"errorInfo,omitempty"`

	// DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime - The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// DocumentId - If call is an outbound fax of a document from content management, then this is the id in content management.
	DocumentId *string `json:"documentId,omitempty"`

	// StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"`

	// ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// DisconnectReasons - List of reasons that this call was disconnected. This will be set once the call disconnects.
	DisconnectReasons *[]Disconnectreason `json:"disconnectReasons,omitempty"`

	// FaxStatus - Extra information on fax transmission.
	FaxStatus *Faxstatus `json:"faxStatus,omitempty"`

	// Provider - The source provider for the call.
	Provider *string `json:"provider,omitempty"`

	// ScriptId - The UUID of the script to use.
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId - The id of the peer communication corresponding to a matching leg for this communication.
	PeerId *string `json:"peerId,omitempty"`

	// UuiData - User to User Information (UUI) data managed by SIP session application.
	UuiData *string `json:"uuiData,omitempty"`

	// Self - Address and name data for a call endpoint.
	Self *Address `json:"self,omitempty"`

	// Other - Address and name data for a call endpoint.
	Other *Address `json:"other,omitempty"`

	// Wrapup - Call wrap up or disposition data.
	Wrapup *Wrapup `json:"wrapup,omitempty"`

	// AfterCallWork - After-call work for the communication.
	AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested.
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AgentAssistantId - UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation.
	AgentAssistantId *string `json:"agentAssistantId,omitempty"`
}

Call

func (*Call) String

func (o *Call) String() string

String returns a JSON representation of the model

type Callablecontactsdiagnostic

type Callablecontactsdiagnostic struct {
	// AttemptLimits - Attempt limits for the campaign's contact list
	AttemptLimits *Domainentityref `json:"attemptLimits,omitempty"`

	// DncLists - Do not call lists for the campaign
	DncLists *[]Domainentityref `json:"dncLists,omitempty"`

	// CallableTimeSet - Callable time sets for the campaign
	CallableTimeSet *Domainentityref `json:"callableTimeSet,omitempty"`

	// RuleSets - Rule sets for the campaign
	RuleSets *[]Domainentityref `json:"ruleSets,omitempty"`
}

Callablecontactsdiagnostic

func (*Callablecontactsdiagnostic) String

func (o *Callablecontactsdiagnostic) String() string

String returns a JSON representation of the model

type Callabletime

type Callabletime struct {
	// TimeSlots - The time intervals for which it is acceptable to place outbound calls.
	TimeSlots *[]Campaigntimeslot `json:"timeSlots,omitempty"`

	// TimeZoneId - The time zone for the time slots; for example, Africa/Abidjan
	TimeZoneId *string `json:"timeZoneId,omitempty"`
}

Callabletime

func (*Callabletime) String

func (o *Callabletime) String() string

String returns a JSON representation of the model

type Callabletimeset

type Callabletimeset struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the CallableTimeSet.
	Name *string `json:"name,omitempty"`

	// DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Version - Required for updates, must match the version number of the most recent update
	Version *int `json:"version,omitempty"`

	// CallableTimes - The list of CallableTimes for which it is acceptable to place outbound calls.
	CallableTimes *[]Callabletime `json:"callableTimes,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Callabletimeset

func (*Callabletimeset) String

func (o *Callabletimeset) String() string

String returns a JSON representation of the model

type Callabletimesetentitylisting

type Callabletimesetentitylisting struct {
	// Entities
	Entities *[]Callabletimeset `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Callabletimesetentitylisting

func (*Callabletimesetentitylisting) String

String returns a JSON representation of the model

type Callablewindow

type Callablewindow struct {
	// Mapped - The time interval to place outbound calls, for contacts that can be mapped to a time zone.
	Mapped *Atzmtimeslot `json:"mapped,omitempty"`

	// Unmapped - The time interval and time zone to place outbound calls, for contacts that cannot be mapped to a time zone.
	Unmapped *Atzmtimeslotwithtimezone `json:"unmapped,omitempty"`
}

Callablewindow

func (*Callablewindow) String

func (o *Callablewindow) String() string

String returns a JSON representation of the model

type Callback

type Callback struct {
	// State - The connection state of this communication.
	State *string `json:"state,omitempty"`

	// Id - A globally unique identifier for this communication.
	Id *string `json:"id,omitempty"`

	// Segments - The time line of the participant's callback, divided into activity segments.
	Segments *[]Segment `json:"segments,omitempty"`

	// Direction - The direction of the call
	Direction *string `json:"direction,omitempty"`

	// Held - True if this call is held and the person on this side hears silence.
	Held *bool `json:"held,omitempty"`

	// DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime - The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// DialerPreview - The preview data to be used when this callback is a Preview.
	DialerPreview *Dialerpreview `json:"dialerPreview,omitempty"`

	// Voicemail - The voicemail data to be used when this callback is an ACD voicemail.
	Voicemail *Voicemail `json:"voicemail,omitempty"`

	// CallbackNumbers - The phone number(s) to use to place the callback.
	CallbackNumbers *[]string `json:"callbackNumbers,omitempty"`

	// CallbackUserName - The name of the user requesting a callback.
	CallbackUserName *string `json:"callbackUserName,omitempty"`

	// ScriptId - The UUID of the script to use.
	ScriptId *string `json:"scriptId,omitempty"`

	// ExternalCampaign - True if the call for the callback uses external dialing.
	ExternalCampaign *bool `json:"externalCampaign,omitempty"`

	// SkipEnabled - True if the ability to skip a callback should be enabled.
	SkipEnabled *bool `json:"skipEnabled,omitempty"`

	// TimeoutSeconds - The number of seconds before the system automatically places a call for a callback.  0 means the automatic placement is disabled.
	TimeoutSeconds *int `json:"timeoutSeconds,omitempty"`

	// StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"`

	// ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// CallbackScheduledTime - The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"`

	// AutomatedCallbackConfigId - The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal.
	AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"`

	// Provider - The source provider for the callback.
	Provider *string `json:"provider,omitempty"`

	// PeerId - The id of the peer communication corresponding to a matching leg for this communication.
	PeerId *string `json:"peerId,omitempty"`

	// Wrapup - Call wrap up or disposition data.
	Wrapup *Wrapup `json:"wrapup,omitempty"`

	// AfterCallWork - After-call work for the communication.
	AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested.
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`
}

Callback

func (*Callback) String

func (o *Callback) String() string

String returns a JSON representation of the model

type Callbackbasic

type Callbackbasic struct {
	// State - The connection state of this communication.
	State *string `json:"state,omitempty"`

	// Id - A globally unique identifier for this communication.
	Id *string `json:"id,omitempty"`

	// Segments - The time line of the participant's callback, divided into activity segments.
	Segments *[]Segment `json:"segments,omitempty"`

	// Direction - The direction of the call
	Direction *string `json:"direction,omitempty"`

	// Held - True if this call is held and the person on this side hears silence.
	Held *bool `json:"held,omitempty"`

	// DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime - The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// DialerPreview - The preview data to be used when this callback is a Preview.
	DialerPreview *Dialerpreview `json:"dialerPreview,omitempty"`

	// Voicemail - The voicemail data to be used when this callback is an ACD voicemail.
	Voicemail *Voicemail `json:"voicemail,omitempty"`

	// CallbackNumbers - The phone number(s) to use to place the callback.
	CallbackNumbers *[]string `json:"callbackNumbers,omitempty"`

	// CallbackUserName - The name of the user requesting a callback.
	CallbackUserName *string `json:"callbackUserName,omitempty"`

	// ScriptId - The UUID of the script to use.
	ScriptId *string `json:"scriptId,omitempty"`

	// ExternalCampaign - True if the call for the callback uses external dialing.
	ExternalCampaign *bool `json:"externalCampaign,omitempty"`

	// SkipEnabled - True if the ability to skip a callback should be enabled.
	SkipEnabled *bool `json:"skipEnabled,omitempty"`

	// TimeoutSeconds - The number of seconds before the system automatically places a call for a callback.  0 means the automatic placement is disabled.
	TimeoutSeconds *int `json:"timeoutSeconds,omitempty"`

	// StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"`

	// ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// CallbackScheduledTime - The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"`

	// AutomatedCallbackConfigId - The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal.
	AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"`

	// Provider - The source provider for the callback.
	Provider *string `json:"provider,omitempty"`

	// PeerId - The id of the peer communication corresponding to a matching leg for this communication.
	PeerId *string `json:"peerId,omitempty"`

	// Wrapup - Call wrap up or disposition data.
	Wrapup *Wrapup `json:"wrapup,omitempty"`

	// AfterCallWork - After-call work for the communication.
	AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested.
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`
}

Callbackbasic

func (*Callbackbasic) String

func (o *Callbackbasic) String() string

String returns a JSON representation of the model

type Callbackconversation

type Callbackconversation struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants - The list of participants involved in the conversation.
	Participants *[]Callbackmediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris - The list of other media channels involved in the conversation.
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Callbackconversation

func (*Callbackconversation) String

func (o *Callbackconversation) String() string

String returns a JSON representation of the model

type Callbackconversationentitylisting

type Callbackconversationentitylisting struct {
	// Entities
	Entities *[]Callbackconversation `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Callbackconversationentitylisting

func (*Callbackconversationentitylisting) String

String returns a JSON representation of the model

type Callbackidentifier

type Callbackidentifier struct {
	// VarType - The type of the associated callback participant
	VarType *string `json:"type,omitempty"`

	// Id - The identifier of the callback
	Id *string `json:"id,omitempty"`
}

Callbackidentifier

func (*Callbackidentifier) String

func (o *Callbackidentifier) String() string

String returns a JSON representation of the model

type Callbackmediaparticipant

type Callbackmediaparticipant struct {
	// Id - The unique participant ID.
	Id *string `json:"id,omitempty"`

	// Name - The display friendly name of the participant.
	Name *string `json:"name,omitempty"`

	// Address - The participant address.
	Address *string `json:"address,omitempty"`

	// StartTime - The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartTime *time.Time `json:"startTime,omitempty"`

	// ConnectedTime - The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// EndTime - The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndTime *time.Time `json:"endTime,omitempty"`

	// StartHoldTime - The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// Purpose - The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr
	Purpose *string `json:"purpose,omitempty"`

	// State - The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting
	State *string `json:"state,omitempty"`

	// Direction - The participant's direction.  Values can be: 'inbound' or 'outbound'
	Direction *string `json:"direction,omitempty"`

	// DisconnectType - The reason the participant was disconnected from the conversation.
	DisconnectType *string `json:"disconnectType,omitempty"`

	// Held - Value is true when the participant is on hold.
	Held *bool `json:"held,omitempty"`

	// WrapupRequired - Value is true when the participant requires wrap-up.
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupPrompt - The wrap-up prompt indicating the type of wrap-up to be performed.
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// User - The PureCloud user for this participant.
	User *Domainentityref `json:"user,omitempty"`

	// Queue - The PureCloud queue for this participant.
	Queue *Domainentityref `json:"queue,omitempty"`

	// Team - The PureCloud team for this participant.
	Team *Domainentityref `json:"team,omitempty"`

	// Attributes - A list of ad-hoc attributes for the participant.
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo - If the conversation ends in error, contains additional error details.
	ErrorInfo *Errorinfo `json:"errorInfo,omitempty"`

	// Script - The Engage script that should be used by this participant.
	Script *Domainentityref `json:"script,omitempty"`

	// WrapupTimeoutMs - The amount of time the participant has to complete wrap-up.
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// WrapupSkipped - Value is true when the participant has skipped wrap-up.
	WrapupSkipped *bool `json:"wrapupSkipped,omitempty"`

	// AlertingTimeoutMs - Specifies how long the agent has to answer an interaction before being marked as not responding.
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

	// Provider - The source provider for the communication.
	Provider *string `json:"provider,omitempty"`

	// ExternalContact - If this participant represents an external contact, then this will be the reference for the external contact.
	ExternalContact *Domainentityref `json:"externalContact,omitempty"`

	// ExternalOrganization - If this participant represents an external org, then this will be the reference for the external org.
	ExternalOrganization *Domainentityref `json:"externalOrganization,omitempty"`

	// Wrapup - Wrapup for this participant, if it has been applied.
	Wrapup *Wrapup `json:"wrapup,omitempty"`

	// Peer - The peer communication corresponding to a matching leg for this communication.
	Peer *string `json:"peer,omitempty"`

	// FlaggedReason - The reason specifying why participant flagged the conversation.
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext - Journey System data/context that is applicable to this communication.  When used for historical purposes, the context should be immutable.  When null, there is no applicable Journey System context.
	JourneyContext *Journeycontext `json:"journeyContext,omitempty"`

	// ConversationRoutingData - Information on how a communication should be routed to an agent.
	ConversationRoutingData *Conversationroutingdata `json:"conversationRoutingData,omitempty"`

	// StartAcwTime - The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime - The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// OutboundPreview - The outbound preview associated with this callback.
	OutboundPreview *Dialerpreview `json:"outboundPreview,omitempty"`

	// Voicemail - The voicemail associated with this callback.
	Voicemail *Voicemail `json:"voicemail,omitempty"`

	// CallbackNumbers - The list of phone number to use for this callback.
	CallbackNumbers *[]string `json:"callbackNumbers,omitempty"`

	// CallbackUserName - The name of the callback target.
	CallbackUserName *string `json:"callbackUserName,omitempty"`

	// ExternalCampaign - True if the call for the callback uses external dialing.
	ExternalCampaign *bool `json:"externalCampaign,omitempty"`

	// SkipEnabled - If true, the callback can be skipped.
	SkipEnabled *bool `json:"skipEnabled,omitempty"`

	// TimeoutSeconds - Duration in seconds before the callback will be auto-dialed.
	TimeoutSeconds *int `json:"timeoutSeconds,omitempty"`

	// AutomatedCallbackConfigId - The id of the config for automatically placing the callback (and handling the disposition). If absent, the callback will not be placed automatically but routed to an agent as per normal.
	AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"`

	// CallbackScheduledTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"`
}

Callbackmediaparticipant

func (*Callbackmediaparticipant) String

func (o *Callbackmediaparticipant) String() string

String returns a JSON representation of the model

type Callbasic

type Callbasic struct {
	// State - The connection state of this communication.
	State *string `json:"state,omitempty"`

	// Id - A globally unique identifier for this communication.
	Id *string `json:"id,omitempty"`

	// Direction - The direction of the call
	Direction *string `json:"direction,omitempty"`

	// Recording - True if this call is being recorded.
	Recording *bool `json:"recording,omitempty"`

	// RecordingState - State of recording on this call.
	RecordingState *string `json:"recordingState,omitempty"`

	// Muted - True if this call is muted so that remote participants can't hear any audio from this end.
	Muted *bool `json:"muted,omitempty"`

	// Confined - True if this call is held and the person on this side hears hold music.
	Confined *bool `json:"confined,omitempty"`

	// Held - True if this call is held and the person on this side hears silence.
	Held *bool `json:"held,omitempty"`

	// RecordingId - A globally unique identifier for the recording associated with this call.
	RecordingId *string `json:"recordingId,omitempty"`

	// Segments - The time line of the participant's call, divided into activity segments.
	Segments *[]Segment `json:"segments,omitempty"`

	// ErrorInfo
	ErrorInfo *Errorinfo `json:"errorInfo,omitempty"`

	// DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime - The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// DocumentId - If call is an outbound fax of a document from content management, then this is the id in content management.
	DocumentId *string `json:"documentId,omitempty"`

	// StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"`

	// ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// DisconnectReasons - List of reasons that this call was disconnected. This will be set once the call disconnects.
	DisconnectReasons *[]Disconnectreason `json:"disconnectReasons,omitempty"`

	// FaxStatus - Extra information on fax transmission.
	FaxStatus *Faxstatus `json:"faxStatus,omitempty"`

	// Provider - The source provider for the call.
	Provider *string `json:"provider,omitempty"`

	// ScriptId - The UUID of the script to use.
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId - The id of the peer communication corresponding to a matching leg for this communication.
	PeerId *string `json:"peerId,omitempty"`

	// UuiData - User to User Information (UUI) data managed by SIP session application.
	UuiData *string `json:"uuiData,omitempty"`

	// Self - Address and name data for a call endpoint.
	Self *Address `json:"self,omitempty"`

	// Other - Address and name data for a call endpoint.
	Other *Address `json:"other,omitempty"`

	// Wrapup - Call wrap up or disposition data.
	Wrapup *Wrapup `json:"wrapup,omitempty"`

	// AfterCallWork - After-call work for the communication.
	AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested.
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AgentAssistantId - UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation.
	AgentAssistantId *string `json:"agentAssistantId,omitempty"`
}

Callbasic

func (*Callbasic) String

func (o *Callbasic) String() string

String returns a JSON representation of the model

type Callcommand

type Callcommand struct {
	// CallNumber - The phone number to dial for this call.
	CallNumber *string `json:"callNumber,omitempty"`

	// PhoneColumn - For a dialer preview or scheduled callback, the phone column associated with the phone number
	PhoneColumn *string `json:"phoneColumn,omitempty"`
}

Callcommand

func (*Callcommand) String

func (o *Callcommand) String() string

String returns a JSON representation of the model

type Callconversation

type Callconversation struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants - The list of participants involved in the conversation.
	Participants *[]Callmediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris - The list of other media channels involved in the conversation.
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`

	// RecordingState
	RecordingState *string `json:"recordingState,omitempty"`

	// MaxParticipants - If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference.
	MaxParticipants *int `json:"maxParticipants,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Callconversation

func (*Callconversation) String

func (o *Callconversation) String() string

String returns a JSON representation of the model

type Callconversationentitylisting

type Callconversationentitylisting struct {
	// Entities
	Entities *[]Callconversation `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Callconversationentitylisting

func (*Callconversationentitylisting) String

String returns a JSON representation of the model

type Callforwarding

type Callforwarding struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// User
	User *User `json:"user,omitempty"`

	// Enabled - Whether or not CallForwarding is enabled
	Enabled *bool `json:"enabled,omitempty"`

	// PhoneNumber - This property is deprecated. Please use the calls property
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// Calls - An ordered list of CallRoutes to be executed when CallForwarding is enabled
	Calls *[]Callroute `json:"calls,omitempty"`

	// Voicemail - The type of voicemail to use with the callForwarding configuration
	Voicemail *string `json:"voicemail,omitempty"`

	// ModifiedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ModifiedDate *time.Time `json:"modifiedDate,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Callforwarding

func (*Callforwarding) String

func (o *Callforwarding) String() string

String returns a JSON representation of the model

type Callforwardingeventcall

type Callforwardingeventcall struct {
	// Targets
	Targets *[]Callforwardingeventtarget `json:"targets,omitempty"`
}

Callforwardingeventcall

func (*Callforwardingeventcall) String

func (o *Callforwardingeventcall) String() string

String returns a JSON representation of the model

type Callforwardingeventcallforwarding

type Callforwardingeventcallforwarding struct {
	// User
	User *Callforwardingeventuser `json:"user,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// Calls
	Calls *[]Callforwardingeventcall `json:"calls,omitempty"`

	// Voicemail
	Voicemail *string `json:"voicemail,omitempty"`

	// ModifiedDate
	ModifiedDate *time.Time `json:"modifiedDate,omitempty"`
}

Callforwardingeventcallforwarding

func (*Callforwardingeventcallforwarding) String

String returns a JSON representation of the model

type Callforwardingeventtarget

type Callforwardingeventtarget struct {
	// VarType
	VarType *string `json:"type,omitempty"`

	// Value
	Value *string `json:"value,omitempty"`
}

Callforwardingeventtarget

func (*Callforwardingeventtarget) String

func (o *Callforwardingeventtarget) String() string

String returns a JSON representation of the model

type Callforwardingeventuser

type Callforwardingeventuser struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Callforwardingeventuser

func (*Callforwardingeventuser) String

func (o *Callforwardingeventuser) String() string

String returns a JSON representation of the model

type Callhistoryconversation

type Callhistoryconversation struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants - The list of participants involved in the conversation.
	Participants *[]Callhistoryparticipant `json:"participants,omitempty"`

	// Direction - The direction of the call relating to the current user
	Direction *string `json:"direction,omitempty"`

	// WentToVoicemail - Did the call end in the current user's voicemail
	WentToVoicemail *bool `json:"wentToVoicemail,omitempty"`

	// MissedCall - Did the user not answer this conversation
	MissedCall *bool `json:"missedCall,omitempty"`

	// StartTime - The time the user joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartTime *time.Time `json:"startTime,omitempty"`

	// WasConference - Was this conversation a conference
	WasConference *bool `json:"wasConference,omitempty"`

	// WasCallback - Was this conversation a callback
	WasCallback *bool `json:"wasCallback,omitempty"`

	// HadScreenShare - Did this conversation have a screen share session
	HadScreenShare *bool `json:"hadScreenShare,omitempty"`

	// HadCobrowse - Did this conversation have a cobrowse session
	HadCobrowse *bool `json:"hadCobrowse,omitempty"`

	// WasOutboundCampaign - Was this conversation associated with an outbound campaign
	WasOutboundCampaign *bool `json:"wasOutboundCampaign,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Callhistoryconversation

func (*Callhistoryconversation) String

func (o *Callhistoryconversation) String() string

String returns a JSON representation of the model

type Callhistoryconversationentitylisting

type Callhistoryconversationentitylisting struct {
	// Entities
	Entities *[]Callhistoryconversation `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Callhistoryconversationentitylisting

func (*Callhistoryconversationentitylisting) String

String returns a JSON representation of the model

type Callhistoryparticipant

type Callhistoryparticipant struct {
	// Id - The unique participant ID.
	Id *string `json:"id,omitempty"`

	// Name - The display friendly name of the participant.
	Name *string `json:"name,omitempty"`

	// Address - The participant address.
	Address *string `json:"address,omitempty"`

	// StartTime - The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartTime *time.Time `json:"startTime,omitempty"`

	// EndTime - The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndTime *time.Time `json:"endTime,omitempty"`

	// Purpose - The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr
	Purpose *string `json:"purpose,omitempty"`

	// Direction - The participant's direction.  Values can be: 'inbound' or 'outbound'
	Direction *string `json:"direction,omitempty"`

	// Ani - The call ANI.
	Ani *string `json:"ani,omitempty"`

	// Dnis - The call DNIS.
	Dnis *string `json:"dnis,omitempty"`

	// User - The PureCloud user for this participant.
	User *User `json:"user,omitempty"`

	// Queue - The PureCloud queue for this participant.
	Queue *Queue `json:"queue,omitempty"`

	// Group - The group involved in the group ring call.
	Group *Group `json:"group,omitempty"`

	// DisconnectType - The reason the participant was disconnected from the conversation.
	DisconnectType *string `json:"disconnectType,omitempty"`

	// ExternalContact - The PureCloud external contact
	ExternalContact *Externalcontact `json:"externalContact,omitempty"`

	// ExternalOrganization - The PureCloud external organization
	ExternalOrganization *Externalorganization `json:"externalOrganization,omitempty"`

	// DidInteract - Indicates whether the contact ever connected
	DidInteract *bool `json:"didInteract,omitempty"`

	// SipResponseCodes - Indicates SIP Response codes associated with the participant
	SipResponseCodes *[]int `json:"sipResponseCodes,omitempty"`

	// FlaggedReason - The reason specifying why participant flagged the conversation.
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// OutboundCampaign - The outbound campaign associated with the participant
	OutboundCampaign *Campaign `json:"outboundCampaign,omitempty"`
}

Callhistoryparticipant

func (*Callhistoryparticipant) String

func (o *Callhistoryparticipant) String() string

String returns a JSON representation of the model

type Callmediaparticipant

type Callmediaparticipant struct {
	// Id - The unique participant ID.
	Id *string `json:"id,omitempty"`

	// Name - The display friendly name of the participant.
	Name *string `json:"name,omitempty"`

	// Address - The participant address.
	Address *string `json:"address,omitempty"`

	// StartTime - The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartTime *time.Time `json:"startTime,omitempty"`

	// ConnectedTime - The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// EndTime - The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndTime *time.Time `json:"endTime,omitempty"`

	// StartHoldTime - The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// Purpose - The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr
	Purpose *string `json:"purpose,omitempty"`

	// State - The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting
	State *string `json:"state,omitempty"`

	// Direction - The participant's direction.  Values can be: 'inbound' or 'outbound'
	Direction *string `json:"direction,omitempty"`

	// DisconnectType - The reason the participant was disconnected from the conversation.
	DisconnectType *string `json:"disconnectType,omitempty"`

	// Held - Value is true when the participant is on hold.
	Held *bool `json:"held,omitempty"`

	// WrapupRequired - Value is true when the participant requires wrap-up.
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupPrompt - The wrap-up prompt indicating the type of wrap-up to be performed.
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// User - The PureCloud user for this participant.
	User *Domainentityref `json:"user,omitempty"`

	// Queue - The PureCloud queue for this participant.
	Queue *Domainentityref `json:"queue,omitempty"`

	// Team - The PureCloud team for this participant.
	Team *Domainentityref `json:"team,omitempty"`

	// Attributes - A list of ad-hoc attributes for the participant.
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo - If the conversation ends in error, contains additional error details.
	ErrorInfo *Errorinfo `json:"errorInfo,omitempty"`

	// Script - The Engage script that should be used by this participant.
	Script *Domainentityref `json:"script,omitempty"`

	// WrapupTimeoutMs - The amount of time the participant has to complete wrap-up.
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// WrapupSkipped - Value is true when the participant has skipped wrap-up.
	WrapupSkipped *bool `json:"wrapupSkipped,omitempty"`

	// AlertingTimeoutMs - Specifies how long the agent has to answer an interaction before being marked as not responding.
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

	// Provider - The source provider for the communication.
	Provider *string `json:"provider,omitempty"`

	// ExternalContact - If this participant represents an external contact, then this will be the reference for the external contact.
	ExternalContact *Domainentityref `json:"externalContact,omitempty"`

	// ExternalOrganization - If this participant represents an external org, then this will be the reference for the external org.
	ExternalOrganization *Domainentityref `json:"externalOrganization,omitempty"`

	// Wrapup - Wrapup for this participant, if it has been applied.
	Wrapup *Wrapup `json:"wrapup,omitempty"`

	// Peer - The peer communication corresponding to a matching leg for this communication.
	Peer *string `json:"peer,omitempty"`

	// FlaggedReason - The reason specifying why participant flagged the conversation.
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext - Journey System data/context that is applicable to this communication.  When used for historical purposes, the context should be immutable.  When null, there is no applicable Journey System context.
	JourneyContext *Journeycontext `json:"journeyContext,omitempty"`

	// ConversationRoutingData - Information on how a communication should be routed to an agent.
	ConversationRoutingData *Conversationroutingdata `json:"conversationRoutingData,omitempty"`

	// StartAcwTime - The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime - The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// Muted - Value is true when the call is muted.
	Muted *bool `json:"muted,omitempty"`

	// Confined - Value is true when the call is confined.
	Confined *bool `json:"confined,omitempty"`

	// Recording - Value is true when the call is being recorded.
	Recording *bool `json:"recording,omitempty"`

	// RecordingState - The state of the call recording.
	RecordingState *string `json:"recordingState,omitempty"`

	// Group - The group involved in the group ring call.
	Group *Domainentityref `json:"group,omitempty"`

	// Ani - The call ANI.
	Ani *string `json:"ani,omitempty"`

	// Dnis - The call DNIS.
	Dnis *string `json:"dnis,omitempty"`

	// DocumentId - The ID of the Content Management document if the call is a fax.
	DocumentId *string `json:"documentId,omitempty"`

	// FaxStatus - Extra fax information if the call is a fax.
	FaxStatus *Faxstatus `json:"faxStatus,omitempty"`

	// MonitoredParticipantId - The ID of the participant being monitored when performing a call monitor.
	MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"`

	// ConsultParticipantId - The ID of the consult transfer target participant when performing a consult transfer.
	ConsultParticipantId *string `json:"consultParticipantId,omitempty"`

	// UuiData - User-to-User information which maps to a SIP header field defined in RFC7433. UUI data is used in the Public Switched Telephone Network (PSTN) for use cases described in RFC6567.
	UuiData *string `json:"uuiData,omitempty"`
}

Callmediaparticipant

func (*Callmediaparticipant) String

func (o *Callmediaparticipant) String() string

String returns a JSON representation of the model

type Callmediapolicy

type Callmediapolicy struct {
	// Actions - Actions applied when specified conditions are met
	Actions *Policyactions `json:"actions,omitempty"`

	// Conditions - Conditions for when actions should be applied
	Conditions *Callmediapolicyconditions `json:"conditions,omitempty"`
}

Callmediapolicy

func (*Callmediapolicy) String

func (o *Callmediapolicy) String() string

String returns a JSON representation of the model

type Callmediapolicyconditions

type Callmediapolicyconditions struct {
	// ForUsers
	ForUsers *[]User `json:"forUsers,omitempty"`

	// DateRanges
	DateRanges *[]string `json:"dateRanges,omitempty"`

	// ForQueues
	ForQueues *[]Queue `json:"forQueues,omitempty"`

	// WrapupCodes
	WrapupCodes *[]Wrapupcode `json:"wrapupCodes,omitempty"`

	// Languages
	Languages *[]Language `json:"languages,omitempty"`

	// TimeAllowed
	TimeAllowed *Timeallowed `json:"timeAllowed,omitempty"`

	// Directions
	Directions *[]string `json:"directions,omitempty"`

	// Duration
	Duration *Durationcondition `json:"duration,omitempty"`
}

Callmediapolicyconditions

func (*Callmediapolicyconditions) String

func (o *Callmediapolicyconditions) String() string

String returns a JSON representation of the model

type Callrecord

type Callrecord struct {
	// LastAttempt - Timestamp of the last attempt to reach this number. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	LastAttempt *time.Time `json:"lastAttempt,omitempty"`

	// LastResult - Result of the last attempt to reach this number
	LastResult *string `json:"lastResult,omitempty"`
}

Callrecord

func (*Callrecord) String

func (o *Callrecord) String() string

String returns a JSON representation of the model

type Callroute

type Callroute struct {
	// Targets - A list of CallTargets to be called when the CallRoute is executed
	Targets *[]Calltarget `json:"targets,omitempty"`
}

Callroute

func (*Callroute) String

func (o *Callroute) String() string

String returns a JSON representation of the model

type Calltarget

type Calltarget struct {
	// VarType - The type of call
	VarType *string `json:"type,omitempty"`

	// Value - The id of the station or an E.164 formatted phone number
	Value *string `json:"value,omitempty"`
}

Calltarget

func (*Calltarget) String

func (o *Calltarget) String() string

String returns a JSON representation of the model

type Calltoaction

type Calltoaction struct {
	// Text - Text displayed on the call to action button.
	Text *string `json:"text,omitempty"`

	// Url - URL to open when user clicks on the call to action button.
	Url *string `json:"url,omitempty"`

	// Target - Where the URL should be opened when the user clicks on the call to action button.
	Target *string `json:"target,omitempty"`
}

Calltoaction

func (*Calltoaction) String

func (o *Calltoaction) String() string

String returns a JSON representation of the model

type Campaign

type Campaign struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the Campaign.
	Name *string `json:"name,omitempty"`

	// DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Version - Required for updates, must match the version number of the most recent update
	Version *int `json:"version,omitempty"`

	// ContactList - The ContactList for this Campaign to dial.
	ContactList *Domainentityref `json:"contactList,omitempty"`

	// Queue - The Queue for this Campaign to route calls to. Required for all dialing modes except agentless.
	Queue *Domainentityref `json:"queue,omitempty"`

	// DialingMode - The strategy this Campaign will use for dialing.
	DialingMode *string `json:"dialingMode,omitempty"`

	// Script - The Script to be displayed to agents that are handling outbound calls. Required for all dialing modes except agentless.
	Script *Domainentityref `json:"script,omitempty"`

	// EdgeGroup - The EdgeGroup that will place the calls. Required for all dialing modes except preview.
	EdgeGroup *Domainentityref `json:"edgeGroup,omitempty"`

	// Site - The identifier of the site to be used for dialing; can be set in place of an edge group.
	Site *Domainentityref `json:"site,omitempty"`

	// CampaignStatus - The current status of the Campaign. A Campaign may be turned 'on' or 'off'. Required for updates.
	CampaignStatus *string `json:"campaignStatus,omitempty"`

	// PhoneColumns - The ContactPhoneNumberColumns on the ContactList that this Campaign should dial.
	PhoneColumns *[]Phonecolumn `json:"phoneColumns,omitempty"`

	// AbandonRate - The targeted abandon rate percentage. Required for progressive, power, and predictive campaigns.
	AbandonRate *float64 `json:"abandonRate,omitempty"`

	// DncLists - DncLists for this Campaign to check before placing a call.
	DncLists *[]Domainentityref `json:"dncLists,omitempty"`

	// CallableTimeSet - The callable time set for this campaign to check before placing a call.
	CallableTimeSet *Domainentityref `json:"callableTimeSet,omitempty"`

	// CallAnalysisResponseSet - The call analysis response set to handle call analysis results from the edge. Required for all dialing modes except preview.
	CallAnalysisResponseSet *Domainentityref `json:"callAnalysisResponseSet,omitempty"`

	// Errors - A list of current error conditions associated with the campaign.
	Errors *[]Resterrordetail `json:"errors,omitempty"`

	// CallerName - The caller id name to be displayed on the outbound call.
	CallerName *string `json:"callerName,omitempty"`

	// CallerAddress - The caller id phone number to be displayed on the outbound call.
	CallerAddress *string `json:"callerAddress,omitempty"`

	// OutboundLineCount - The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless.
	OutboundLineCount *int `json:"outboundLineCount,omitempty"`

	// RuleSets - Rule sets to be applied while this campaign is dialing.
	RuleSets *[]Domainentityref `json:"ruleSets,omitempty"`

	// SkipPreviewDisabled - Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns.
	SkipPreviewDisabled *bool `json:"skipPreviewDisabled,omitempty"`

	// PreviewTimeOutSeconds - The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns.
	PreviewTimeOutSeconds *int `json:"previewTimeOutSeconds,omitempty"`

	// AlwaysRunning - Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually.
	AlwaysRunning *bool `json:"alwaysRunning,omitempty"`

	// ContactSort - The order in which to sort contacts for dialing, based on a column.
	ContactSort *Contactsort `json:"contactSort,omitempty"`

	// ContactSorts - The order in which to sort contacts for dialing, based on up to four columns.
	ContactSorts *[]Contactsort `json:"contactSorts,omitempty"`

	// NoAnswerTimeout - How long to wait before dispositioning a call as 'no-answer'. Default 30 seconds. Only applicable to non-preview campaigns.
	NoAnswerTimeout *int `json:"noAnswerTimeout,omitempty"`

	// CallAnalysisLanguage - The language the edge will use to analyze the call.
	CallAnalysisLanguage *string `json:"callAnalysisLanguage,omitempty"`

	// Priority - The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest.
	Priority *int `json:"priority,omitempty"`

	// ContactListFilters - Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied.
	ContactListFilters *[]Domainentityref `json:"contactListFilters,omitempty"`

	// Division - The division this campaign belongs to.
	Division *Domainentityref `json:"division,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Campaign

func (*Campaign) String

func (o *Campaign) String() string

String returns a JSON representation of the model

type Campaigndiagnostics

type Campaigndiagnostics struct {
	// CallableContacts - Campaign properties that can impact which contacts are callable
	CallableContacts *Callablecontactsdiagnostic `json:"callableContacts,omitempty"`

	// QueueUtilizationDiagnostic - Information regarding the campaign's queue
	QueueUtilizationDiagnostic *Queueutilizationdiagnostic `json:"queueUtilizationDiagnostic,omitempty"`

	// RuleSetDiagnostics - Information regarding the campaign's rule sets
	RuleSetDiagnostics *[]Rulesetdiagnostic `json:"ruleSetDiagnostics,omitempty"`

	// OutstandingInteractionsCount - Current number of outstanding interactions on the campaign
	OutstandingInteractionsCount *int `json:"outstandingInteractionsCount,omitempty"`

	// ScheduledInteractionsCount - Current number of scheduled interactions on the campaign
	ScheduledInteractionsCount *int `json:"scheduledInteractionsCount,omitempty"`
}

Campaigndiagnostics

func (*Campaigndiagnostics) String

func (o *Campaigndiagnostics) String() string

String returns a JSON representation of the model

type Campaigndivisionview

type Campaigndivisionview struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Division `json:"division,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Campaigndivisionview

func (*Campaigndivisionview) String

func (o *Campaigndivisionview) String() string

String returns a JSON representation of the model

type Campaigndivisionviewlisting

type Campaigndivisionviewlisting struct {
	// Entities
	Entities *[]Campaigndivisionview `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Campaigndivisionviewlisting

func (*Campaigndivisionviewlisting) String

func (o *Campaigndivisionviewlisting) String() string

String returns a JSON representation of the model

type Campaignentitylisting

type Campaignentitylisting struct {
	// Entities
	Entities *[]Campaign `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Campaignentitylisting

func (*Campaignentitylisting) String

func (o *Campaignentitylisting) String() string

String returns a JSON representation of the model

type Campaigninteraction

type Campaigninteraction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Campaign
	Campaign *Domainentityref `json:"campaign,omitempty"`

	// Agent
	Agent *Domainentityref `json:"agent,omitempty"`

	// Contact
	Contact *Domainentityref `json:"contact,omitempty"`

	// DestinationAddress
	DestinationAddress *string `json:"destinationAddress,omitempty"`

	// ActivePreviewCall - Boolean value if there is an active preview call on the interaction
	ActivePreviewCall *bool `json:"activePreviewCall,omitempty"`

	// LastActivePreviewWrapupTime - The time when the last preview of the interaction was wrapped up. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	LastActivePreviewWrapupTime *time.Time `json:"lastActivePreviewWrapupTime,omitempty"`

	// CreationTime - The time when dialer created the interaction. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CreationTime *time.Time `json:"creationTime,omitempty"`

	// CallPlacedTime - The time when the agent or system places the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CallPlacedTime *time.Time `json:"callPlacedTime,omitempty"`

	// CallRoutedTime - The time when the agent was connected to the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CallRoutedTime *time.Time `json:"callRoutedTime,omitempty"`

	// PreviewConnectedTime - The time when the customer and routing participant are connected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	PreviewConnectedTime *time.Time `json:"previewConnectedTime,omitempty"`

	// Queue
	Queue *Domainentityref `json:"queue,omitempty"`

	// Script
	Script *Domainentityref `json:"script,omitempty"`

	// Disposition - Describes what happened with call analysis for instance: disposition.classification.callable.person, disposition.classification.callable.noanswer
	Disposition *string `json:"disposition,omitempty"`

	// CallerName
	CallerName *string `json:"callerName,omitempty"`

	// CallerAddress
	CallerAddress *string `json:"callerAddress,omitempty"`

	// PreviewPopDeliveredTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	PreviewPopDeliveredTime *time.Time `json:"previewPopDeliveredTime,omitempty"`

	// Conversation
	Conversation *Conversationbasic `json:"conversation,omitempty"`

	// DialerSystemParticipantId - conversation participant id that is the dialer system participant to monitor the call from dialer perspective
	DialerSystemParticipantId *string `json:"dialerSystemParticipantId,omitempty"`

	// DialingMode
	DialingMode *string `json:"dialingMode,omitempty"`

	// Skills - Any skills that are attached to the call for routing
	Skills *[]Domainentityref `json:"skills,omitempty"`
}

Campaigninteraction

func (*Campaigninteraction) String

func (o *Campaigninteraction) String() string

String returns a JSON representation of the model

type Campaigninteractions

type Campaigninteractions struct {
	// Campaign
	Campaign *Domainentityref `json:"campaign,omitempty"`

	// PendingInteractions
	PendingInteractions *[]Campaigninteraction `json:"pendingInteractions,omitempty"`

	// ProceedingInteractions
	ProceedingInteractions *[]Campaigninteraction `json:"proceedingInteractions,omitempty"`

	// PreviewingInteractions
	PreviewingInteractions *[]Campaigninteraction `json:"previewingInteractions,omitempty"`

	// InteractingInteractions
	InteractingInteractions *[]Campaigninteraction `json:"interactingInteractions,omitempty"`

	// ScheduledInteractions
	ScheduledInteractions *[]Campaigninteraction `json:"scheduledInteractions,omitempty"`
}

Campaigninteractions

func (*Campaigninteractions) String

func (o *Campaigninteractions) String() string

String returns a JSON representation of the model

type Campaignprogress

type Campaignprogress struct {
	// Campaign - Identifier of the campaign
	Campaign *Domainentityref `json:"campaign,omitempty"`

	// ContactList - Identifier of the contact list
	ContactList *Domainentityref `json:"contactList,omitempty"`

	// NumberOfContactsCalled - Number of contacts called during the campaign
	NumberOfContactsCalled *int `json:"numberOfContactsCalled,omitempty"`

	// NumberOfContactsMessaged - Number of contacts messaged during the campaign
	NumberOfContactsMessaged *int `json:"numberOfContactsMessaged,omitempty"`

	// TotalNumberOfContacts - Total number of contacts in the campaign
	TotalNumberOfContacts *int `json:"totalNumberOfContacts,omitempty"`

	// Percentage - Percentage of contacts processed during the campaign
	Percentage *int `json:"percentage,omitempty"`
}

Campaignprogress

func (*Campaignprogress) String

func (o *Campaignprogress) String() string

String returns a JSON representation of the model

type Campaignrule

type Campaignrule struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the CampaignRule.
	Name *string `json:"name,omitempty"`

	// DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Version - Required for updates, must match the version number of the most recent update
	Version *int `json:"version,omitempty"`

	// CampaignRuleEntities - The list of entities that this CampaignRule monitors.
	CampaignRuleEntities *Campaignruleentities `json:"campaignRuleEntities,omitempty"`

	// CampaignRuleConditions - The list of conditions that are evaluated on the entities.
	CampaignRuleConditions *[]Campaignrulecondition `json:"campaignRuleConditions,omitempty"`

	// CampaignRuleActions - The list of actions that are executed if the conditions are satisfied.
	CampaignRuleActions *[]Campaignruleaction `json:"campaignRuleActions,omitempty"`

	// MatchAnyConditions
	MatchAnyConditions *bool `json:"matchAnyConditions,omitempty"`

	// Enabled - Whether or not this CampaignRule is currently enabled. Required on updates.
	Enabled *bool `json:"enabled,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Campaignrule

func (*Campaignrule) String

func (o *Campaignrule) String() string

String returns a JSON representation of the model

type Campaignruleaction

type Campaignruleaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Parameters - The parameters for the CampaignRuleAction. Required for certain actionTypes.
	Parameters *Campaignruleparameters `json:"parameters,omitempty"`

	// ActionType - The action to take on the campaignRuleActionEntities.
	ActionType *string `json:"actionType,omitempty"`

	// CampaignRuleActionEntities - The list of entities that this action will apply to.
	CampaignRuleActionEntities *Campaignruleactionentities `json:"campaignRuleActionEntities,omitempty"`
}

Campaignruleaction

func (*Campaignruleaction) String

func (o *Campaignruleaction) String() string

String returns a JSON representation of the model

type Campaignruleactionentities

type Campaignruleactionentities struct {
	// Campaigns - The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign.
	Campaigns *[]Domainentityref `json:"campaigns,omitempty"`

	// Sequences - The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence.
	Sequences *[]Domainentityref `json:"sequences,omitempty"`

	// UseTriggeringEntity - If true, the CampaignRuleAction will apply to the same entity that triggered the CampaignRuleCondition.
	UseTriggeringEntity *bool `json:"useTriggeringEntity,omitempty"`
}

Campaignruleactionentities

func (*Campaignruleactionentities) String

func (o *Campaignruleactionentities) String() string

String returns a JSON representation of the model

type Campaignrulecondition

type Campaignrulecondition struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Parameters - The parameters for the CampaignRuleCondition.
	Parameters *Campaignruleparameters `json:"parameters,omitempty"`

	// ConditionType - The type of condition to evaluate.
	ConditionType *string `json:"conditionType,omitempty"`
}

Campaignrulecondition

func (*Campaignrulecondition) String

func (o *Campaignrulecondition) String() string

String returns a JSON representation of the model

type Campaignruleentities

type Campaignruleentities struct {
	// Campaigns - The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign.
	Campaigns *[]Domainentityref `json:"campaigns,omitempty"`

	// Sequences - The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence.
	Sequences *[]Domainentityref `json:"sequences,omitempty"`
}

Campaignruleentities

func (*Campaignruleentities) String

func (o *Campaignruleentities) String() string

String returns a JSON representation of the model

type Campaignruleentitylisting

type Campaignruleentitylisting struct {
	// Entities
	Entities *[]Campaignrule `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Campaignruleentitylisting

func (*Campaignruleentitylisting) String

func (o *Campaignruleentitylisting) String() string

String returns a JSON representation of the model

type Campaignruleparameters

type Campaignruleparameters struct {
	// Operator - The operator for comparison. Required for a CampaignRuleCondition.
	Operator *string `json:"operator,omitempty"`

	// Value - The value for comparison. Required for a CampaignRuleCondition.
	Value *string `json:"value,omitempty"`

	// Priority - The priority to set a campaign to. Required for the 'setCampaignPriority' action.
	Priority *string `json:"priority,omitempty"`

	// DialingMode - The dialing mode to set a campaign to. Required for the 'setCampaignDialingMode' action.
	DialingMode *string `json:"dialingMode,omitempty"`
}

Campaignruleparameters

func (*Campaignruleparameters) String

func (o *Campaignruleparameters) String() string

String returns a JSON representation of the model

type Campaignschedule

type Campaignschedule struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Version - Required for updates, must match the version number of the most recent update
	Version *int `json:"version,omitempty"`

	// Intervals - A list of intervals during which to run the associated Campaign.
	Intervals *[]Scheduleinterval `json:"intervals,omitempty"`

	// TimeZone - The time zone for this CampaignSchedule. For example, Africa/Abidjan.
	TimeZone *string `json:"timeZone,omitempty"`

	// Campaign - The Campaign that this CampaignSchedule is for.
	Campaign *Domainentityref `json:"campaign,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Campaignschedule

func (*Campaignschedule) String

func (o *Campaignschedule) String() string

String returns a JSON representation of the model

type Campaignsequence

type Campaignsequence struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Version - Required for updates, must match the version number of the most recent update
	Version *int `json:"version,omitempty"`

	// Campaigns - The ordered list of Campaigns that this CampaignSequence will run.
	Campaigns *[]Domainentityref `json:"campaigns,omitempty"`

	// CurrentCampaign - A zero-based index indicating which Campaign this CampaignSequence is currently on.
	CurrentCampaign *int `json:"currentCampaign,omitempty"`

	// Status - The current status of the CampaignSequence. A CampaignSequence can be turned 'on' or 'off'.
	Status *string `json:"status,omitempty"`

	// StopMessage - A message indicating if and why a CampaignSequence has stopped unexpectedly.
	StopMessage *string `json:"stopMessage,omitempty"`

	// Repeat - Indicates if a sequence should repeat from the beginning after the last campaign completes. Default is false.
	Repeat *bool `json:"repeat,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Campaignsequence

func (*Campaignsequence) String

func (o *Campaignsequence) String() string

String returns a JSON representation of the model

type Campaignsequenceentitylisting

type Campaignsequenceentitylisting struct {
	// Entities
	Entities *[]Campaignsequence `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Campaignsequenceentitylisting

func (*Campaignsequenceentitylisting) String

String returns a JSON representation of the model

type Campaignstats

type Campaignstats struct {
	// ContactRate - Information regarding the campaign's connect rate
	ContactRate *Connectrate `json:"contactRate,omitempty"`

	// IdleAgents - Number of available agents not currently being utilized
	IdleAgents *int `json:"idleAgents,omitempty"`

	// EffectiveIdleAgents - Number of effective available agents not currently being utilized
	EffectiveIdleAgents *float64 `json:"effectiveIdleAgents,omitempty"`

	// AdjustedCallsPerAgent - Calls per agent adjusted by pace
	AdjustedCallsPerAgent *float64 `json:"adjustedCallsPerAgent,omitempty"`

	// OutstandingCalls - Number of campaign calls currently ongoing
	OutstandingCalls *int `json:"outstandingCalls,omitempty"`

	// ScheduledCalls - Number of campaign calls currently scheduled
	ScheduledCalls *int `json:"scheduledCalls,omitempty"`
}

Campaignstats

func (*Campaignstats) String

func (o *Campaignstats) String() string

String returns a JSON representation of the model

type Campaigntimeslot

type Campaigntimeslot struct {
	// StartTime - The start time of the interval as an ISO-8601 string, i.e. HH:mm:ss
	StartTime *string `json:"startTime,omitempty"`

	// StopTime - The end time of the interval as an ISO-8601 string, i.e. HH:mm:ss
	StopTime *string `json:"stopTime,omitempty"`

	// Day - The day of the interval. Valid values: [1-7], representing Monday through Sunday
	Day *int `json:"day,omitempty"`
}

Campaigntimeslot

func (*Campaigntimeslot) String

func (o *Campaigntimeslot) String() string

String returns a JSON representation of the model

type Category

type Category struct {
	// Name - Category name
	Name *string `json:"name,omitempty"`
}

Category - List of available Action categories.

func (*Category) String

func (o *Category) String() string

String returns a JSON representation of the model

type Categoryentitylisting

type Categoryentitylisting struct {
	// Entities
	Entities *[]Category `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Categoryentitylisting

func (*Categoryentitylisting) String

func (o *Categoryentitylisting) String() string

String returns a JSON representation of the model

type Categorylisting

type Categorylisting struct {
	// Entities
	Entities *[]Knowledgecategory `json:"entities,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`
}

Categorylisting

func (*Categorylisting) String

func (o *Categorylisting) String() string

String returns a JSON representation of the model

type Certificate

type Certificate struct {
	// Certificate - The certificate to parse.
	Certificate *string `json:"certificate,omitempty"`
}

Certificate - Represents a certificate to parse.

func (*Certificate) String

func (o *Certificate) String() string

String returns a JSON representation of the model

type Certificateauthorityentitylisting

type Certificateauthorityentitylisting struct {
	// Entities
	Entities *[]Domaincertificateauthority `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Certificateauthorityentitylisting

func (*Certificateauthorityentitylisting) String

String returns a JSON representation of the model

type Certificatedetails

type Certificatedetails struct {
	// Issuer - Information about the issuer of the certificate.  The value of this property is a comma separated key=value format.  Each key is one of the attribute names supported by X.500.
	Issuer *string `json:"issuer,omitempty"`

	// Subject - Information about the subject of the certificate.  The value of this property is a comma separated key=value format.  Each key is one of the attribute names supported by X.500.
	Subject *string `json:"subject,omitempty"`

	// ExpirationDate - The expiration date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ExpirationDate *time.Time `json:"expirationDate,omitempty"`

	// IssueDate - The issue date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	IssueDate *time.Time `json:"issueDate,omitempty"`

	// Expired - True if the certificate is expired, false otherwise.
	Expired *bool `json:"expired,omitempty"`

	// SignatureValid
	SignatureValid *bool `json:"signatureValid,omitempty"`

	// Valid
	Valid *bool `json:"valid,omitempty"`
}

Certificatedetails - Represents the details of a parsed certificate.

func (*Certificatedetails) String

func (o *Certificatedetails) String() string

String returns a JSON representation of the model

type Change

type Change struct {
	// Entity
	Entity *Auditentity `json:"entity,omitempty"`

	// Property - The property that was changed
	Property *string `json:"property,omitempty"`

	// OldValues - The old values which were modified and/or removed by this action.
	OldValues *[]string `json:"oldValues,omitempty"`

	// NewValues - The new values which were modified and/or added by this action.
	NewValues *[]string `json:"newValues,omitempty"`
}

Change

func (*Change) String

func (o *Change) String() string

String returns a JSON representation of the model

type Changemypasswordrequest

type Changemypasswordrequest struct {
	// NewPassword - The new password
	NewPassword *string `json:"newPassword,omitempty"`

	// OldPassword - Your current password
	OldPassword *string `json:"oldPassword,omitempty"`
}

Changemypasswordrequest

func (*Changemypasswordrequest) String

func (o *Changemypasswordrequest) String() string

String returns a JSON representation of the model

type Changepasswordrequest

type Changepasswordrequest struct {
	// NewPassword - The new password
	NewPassword *string `json:"newPassword,omitempty"`
}

Changepasswordrequest

func (*Changepasswordrequest) String

func (o *Changepasswordrequest) String() string

String returns a JSON representation of the model

type Channel

type Channel struct {
	// ConnectUri
	ConnectUri *string `json:"connectUri,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Expires - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Expires *time.Time `json:"expires,omitempty"`
}

Channel

func (*Channel) String

func (o *Channel) String() string

String returns a JSON representation of the model

type Channelentitylisting

type Channelentitylisting struct {
	// Entities
	Entities *[]Channel `json:"entities,omitempty"`
}

Channelentitylisting

func (*Channelentitylisting) String

func (o *Channelentitylisting) String() string

String returns a JSON representation of the model

type Channeltopic

type Channeltopic struct {
	// Id
	Id *string `json:"id,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Channeltopic

func (*Channeltopic) String

func (o *Channeltopic) String() string

String returns a JSON representation of the model

type Channeltopicentitylisting

type Channeltopicentitylisting struct {
	// Entities
	Entities *[]Channeltopic `json:"entities,omitempty"`
}

Channeltopicentitylisting

func (*Channeltopicentitylisting) String

func (o *Channeltopicentitylisting) String() string

String returns a JSON representation of the model

type Chat

type Chat struct {
	// JabberId
	JabberId *string `json:"jabberId,omitempty"`
}

Chat

func (*Chat) String

func (o *Chat) String() string

String returns a JSON representation of the model

type ChatApi

type ChatApi struct {
	Configuration *Configuration
}

ChatApi provides functions for API endpoints

func NewChatApi

func NewChatApi() *ChatApi

NewChatApi creates an API instance using the default configuration

func NewChatApiWithConfig

func NewChatApiWithConfig(config *Configuration) *ChatApi

NewChatApiWithConfig creates an API instance using the provided configuration

func (ChatApi) GetChatSettings

func (a ChatApi) GetChatSettings() (*Chatsettings, *APIResponse, error)

GetChatSettings invokes GET /api/v2/chat/settings

Get Chat Settings.

func (ChatApi) PatchChatSettings

func (a ChatApi) PatchChatSettings(body Chatsettings) (*Chatsettings, *APIResponse, error)

PatchChatSettings invokes PATCH /api/v2/chat/settings

Patch Chat Settings.

func (ChatApi) PutChatSettings

func (a ChatApi) PutChatSettings(body Chatsettings) (*Chatsettings, *APIResponse, error)

PutChatSettings invokes PUT /api/v2/chat/settings

Update Chat Settings.

type Chatbadgetopicbadgeentity

type Chatbadgetopicbadgeentity struct {
	// JabberId
	JabberId *string `json:"jabberId,omitempty"`
}

Chatbadgetopicbadgeentity

func (*Chatbadgetopicbadgeentity) String

func (o *Chatbadgetopicbadgeentity) String() string

String returns a JSON representation of the model

type Chatbadgetopicchatbadge

type Chatbadgetopicchatbadge struct {
	// Entity
	Entity *Chatbadgetopicbadgeentity `json:"entity,omitempty"`

	// UnreadCount
	UnreadCount *int `json:"unreadCount,omitempty"`

	// LastUnreadNotificationDate
	LastUnreadNotificationDate *time.Time `json:"lastUnreadNotificationDate,omitempty"`
}

Chatbadgetopicchatbadge

func (*Chatbadgetopicchatbadge) String

func (o *Chatbadgetopicchatbadge) String() string

String returns a JSON representation of the model

type Chatconversation

type Chatconversation struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants - The list of participants involved in the conversation.
	Participants *[]Chatmediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris - The list of other media channels involved in the conversation.
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Chatconversation

func (*Chatconversation) String

func (o *Chatconversation) String() string

String returns a JSON representation of the model

type Chatconversationentitylisting

type Chatconversationentitylisting struct {
	// Entities
	Entities *[]Chatconversation `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Chatconversationentitylisting

func (*Chatconversationentitylisting) String

String returns a JSON representation of the model

type Chatmediaparticipant

type Chatmediaparticipant struct {
	// Id - The unique participant ID.
	Id *string `json:"id,omitempty"`

	// Name - The display friendly name of the participant.
	Name *string `json:"name,omitempty"`

	// Address - The participant address.
	Address *string `json:"address,omitempty"`

	// StartTime - The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartTime *time.Time `json:"startTime,omitempty"`

	// ConnectedTime - The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// EndTime - The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndTime *time.Time `json:"endTime,omitempty"`

	// StartHoldTime - The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// Purpose - The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr
	Purpose *string `json:"purpose,omitempty"`

	// State - The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting
	State *string `json:"state,omitempty"`

	// Direction - The participant's direction.  Values can be: 'inbound' or 'outbound'
	Direction *string `json:"direction,omitempty"`

	// DisconnectType - The reason the participant was disconnected from the conversation.
	DisconnectType *string `json:"disconnectType,omitempty"`

	// Held - Value is true when the participant is on hold.
	Held *bool `json:"held,omitempty"`

	// WrapupRequired - Value is true when the participant requires wrap-up.
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupPrompt - The wrap-up prompt indicating the type of wrap-up to be performed.
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// User - The PureCloud user for this participant.
	User *Domainentityref `json:"user,omitempty"`

	// Queue - The PureCloud queue for this participant.
	Queue *Domainentityref `json:"queue,omitempty"`

	// Team - The PureCloud team for this participant.
	Team *Domainentityref `json:"team,omitempty"`

	// Attributes - A list of ad-hoc attributes for the participant.
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo - If the conversation ends in error, contains additional error details.
	ErrorInfo *Errorinfo `json:"errorInfo,omitempty"`

	// Script - The Engage script that should be used by this participant.
	Script *Domainentityref `json:"script,omitempty"`

	// WrapupTimeoutMs - The amount of time the participant has to complete wrap-up.
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// WrapupSkipped - Value is true when the participant has skipped wrap-up.
	WrapupSkipped *bool `json:"wrapupSkipped,omitempty"`

	// AlertingTimeoutMs - Specifies how long the agent has to answer an interaction before being marked as not responding.
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

	// Provider - The source provider for the communication.
	Provider *string `json:"provider,omitempty"`

	// ExternalContact - If this participant represents an external contact, then this will be the reference for the external contact.
	ExternalContact *Domainentityref `json:"externalContact,omitempty"`

	// ExternalOrganization - If this participant represents an external org, then this will be the reference for the external org.
	ExternalOrganization *Domainentityref `json:"externalOrganization,omitempty"`

	// Wrapup - Wrapup for this participant, if it has been applied.
	Wrapup *Wrapup `json:"wrapup,omitempty"`

	// Peer - The peer communication corresponding to a matching leg for this communication.
	Peer *string `json:"peer,omitempty"`

	// FlaggedReason - The reason specifying why participant flagged the conversation.
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext - Journey System data/context that is applicable to this communication.  When used for historical purposes, the context should be immutable.  When null, there is no applicable Journey System context.
	JourneyContext *Journeycontext `json:"journeyContext,omitempty"`

	// ConversationRoutingData - Information on how a communication should be routed to an agent.
	ConversationRoutingData *Conversationroutingdata `json:"conversationRoutingData,omitempty"`

	// StartAcwTime - The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime - The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// RoomId - The ID of the chat room.
	RoomId *string `json:"roomId,omitempty"`

	// AvatarImageUrl - If available, the URI to the avatar image of this communication.
	AvatarImageUrl *string `json:"avatarImageUrl,omitempty"`
}

Chatmediaparticipant

func (*Chatmediaparticipant) String

func (o *Chatmediaparticipant) String() string

String returns a JSON representation of the model

type Chatmediapolicy

type Chatmediapolicy struct {
	// Actions - Actions applied when specified conditions are met
	Actions *Policyactions `json:"actions,omitempty"`

	// Conditions - Conditions for when actions should be applied
	Conditions *Chatmediapolicyconditions `json:"conditions,omitempty"`
}

Chatmediapolicy

func (*Chatmediapolicy) String

func (o *Chatmediapolicy) String() string

String returns a JSON representation of the model

type Chatmediapolicyconditions

type Chatmediapolicyconditions struct {
	// ForUsers
	ForUsers *[]User `json:"forUsers,omitempty"`

	// DateRanges
	DateRanges *[]string `json:"dateRanges,omitempty"`

	// ForQueues
	ForQueues *[]Queue `json:"forQueues,omitempty"`

	// WrapupCodes
	WrapupCodes *[]Wrapupcode `json:"wrapupCodes,omitempty"`

	// Languages
	Languages *[]Language `json:"languages,omitempty"`

	// TimeAllowed
	TimeAllowed *Timeallowed `json:"timeAllowed,omitempty"`

	// Duration
	Duration *Durationcondition `json:"duration,omitempty"`
}

Chatmediapolicyconditions

func (*Chatmediapolicyconditions) String

func (o *Chatmediapolicyconditions) String() string

String returns a JSON representation of the model

type Chatmessage

type Chatmessage struct {
	// Body - The message body
	Body *string `json:"body,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// To - The message recipient
	To *string `json:"to,omitempty"`

	// From - The message sender
	From *string `json:"from,omitempty"`

	// Utc
	Utc *string `json:"utc,omitempty"`

	// Chat - The interaction id (if available)
	Chat *string `json:"chat,omitempty"`

	// Message - The message id
	Message *string `json:"message,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// BodyType - Type of the message body (v2 chats only)
	BodyType *string `json:"bodyType,omitempty"`

	// SenderCommunicationId - Communication of sender (v2 chats only)
	SenderCommunicationId *string `json:"senderCommunicationId,omitempty"`

	// ParticipantPurpose - Participant purpose of sender (v2 chats only)
	ParticipantPurpose *string `json:"participantPurpose,omitempty"`

	// User - The user information for the sender (if available)
	User *Chatmessageuser `json:"user,omitempty"`
}

Chatmessage

func (*Chatmessage) String

func (o *Chatmessage) String() string

String returns a JSON representation of the model

type Chatmessageuser

type Chatmessageuser struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// DisplayName
	DisplayName *string `json:"displayName,omitempty"`

	// Username
	Username *string `json:"username,omitempty"`

	// Images
	Images *[]Userimage `json:"images,omitempty"`
}

Chatmessageuser

func (*Chatmessageuser) String

func (o *Chatmessageuser) String() string

String returns a JSON representation of the model

type Chatsettings

type Chatsettings struct {
	// MessageRetentionPeriodDays - Retention time for messages in days
	MessageRetentionPeriodDays *int `json:"messageRetentionPeriodDays,omitempty"`
}

Chatsettings

func (*Chatsettings) String

func (o *Chatsettings) String() string

String returns a JSON representation of the model

type Clientapp

type Clientapp struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the integration, used to distinguish this integration from others of the same type.
	Name *string `json:"name,omitempty"`

	// IntegrationType - Type of the integration
	IntegrationType *Integrationtype `json:"integrationType,omitempty"`

	// Notes - Notes about the integration.
	Notes *string `json:"notes,omitempty"`

	// IntendedState - Configured state of the integration.
	IntendedState *string `json:"intendedState,omitempty"`

	// Config - Configuration information for the integration.
	Config *Clientappconfigurationinfo `json:"config,omitempty"`

	// ReportedState - Last reported status of the integration.
	ReportedState *Integrationstatusinfo `json:"reportedState,omitempty"`

	// Attributes - Read-only attributes for the integration.
	Attributes *map[string]string `json:"attributes,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Clientapp - Details for a ClientApp

func (*Clientapp) String

func (o *Clientapp) String() string

String returns a JSON representation of the model

type Clientappconfigurationinfo

type Clientappconfigurationinfo struct {
	// Current - The current, active configuration for the integration.
	Current *Integrationconfiguration `json:"current,omitempty"`

	// Effective - The effective configuration for the app, containing the integration specific configuration along with overrides specified in the integration type.
	Effective *Effectiveconfiguration `json:"effective,omitempty"`
}

Clientappconfigurationinfo - Configuration information for the integration

func (*Clientappconfigurationinfo) String

func (o *Clientappconfigurationinfo) String() string

String returns a JSON representation of the model

type Clientappentitylisting

type Clientappentitylisting struct {
	// Entities
	Entities *[]Clientapp `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Clientappentitylisting

func (*Clientappentitylisting) String

func (o *Clientappentitylisting) String() string

String returns a JSON representation of the model

type Closebuttonstyleproperties

type Closebuttonstyleproperties struct {
	// Color - Color of button. (eg. #FF0000)
	Color *string `json:"color,omitempty"`

	// Opacity - Opacity of button.
	Opacity *float32 `json:"opacity,omitempty"`
}

Closebuttonstyleproperties

func (*Closebuttonstyleproperties) String

func (o *Closebuttonstyleproperties) String() string

String returns a JSON representation of the model

type CoachingApi

type CoachingApi struct {
	Configuration *Configuration
}

CoachingApi provides functions for API endpoints

func NewCoachingApi

func NewCoachingApi() *CoachingApi

NewCoachingApi creates an API instance using the default configuration

func NewCoachingApiWithConfig

func NewCoachingApiWithConfig(config *Configuration) *CoachingApi

NewCoachingApiWithConfig creates an API instance using the provided configuration

func (CoachingApi) DeleteCoachingAppointment

func (a CoachingApi) DeleteCoachingAppointment(appointmentId string) (*Coachingappointmentreference, *APIResponse, error)

DeleteCoachingAppointment invokes DELETE /api/v2/coaching/appointments/{appointmentId}

Delete an existing appointment

Permission not required if you are the creator of the appointment

func (CoachingApi) DeleteCoachingAppointmentAnnotation

func (a CoachingApi) DeleteCoachingAppointmentAnnotation(appointmentId string, annotationId string) (*APIResponse, error)

DeleteCoachingAppointmentAnnotation invokes DELETE /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}

Delete an existing annotation

You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment

func (CoachingApi) GetCoachingAppointment

func (a CoachingApi) GetCoachingAppointment(appointmentId string) (*Coachingappointmentresponse, *APIResponse, error)

GetCoachingAppointment invokes GET /api/v2/coaching/appointments/{appointmentId}

Retrieve an appointment

Permission not required if you are the attendee, creator or facilitator of the appointment

func (CoachingApi) GetCoachingAppointmentAnnotation

func (a CoachingApi) GetCoachingAppointmentAnnotation(appointmentId string, annotationId string) (*Coachingannotation, *APIResponse, error)

GetCoachingAppointmentAnnotation invokes GET /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}

Retrieve an annotation.

You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).

func (CoachingApi) GetCoachingAppointmentAnnotations

func (a CoachingApi) GetCoachingAppointmentAnnotations(appointmentId string, pageNumber int, pageSize int) (*Coachingannotationlist, *APIResponse, error)

GetCoachingAppointmentAnnotations invokes GET /api/v2/coaching/appointments/{appointmentId}/annotations

Get a list of annotations.

You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).

func (CoachingApi) GetCoachingAppointmentStatuses

func (a CoachingApi) GetCoachingAppointmentStatuses(appointmentId string, pageNumber int, pageSize int) (*Coachingappointmentstatusresponselist, *APIResponse, error)

GetCoachingAppointmentStatuses invokes GET /api/v2/coaching/appointments/{appointmentId}/statuses

Get the list of status changes for a coaching appointment.

Permission not required if you are an attendee, creator or facilitator of the appointment

func (CoachingApi) GetCoachingAppointments

func (a CoachingApi) GetCoachingAppointments(userIds []string, interval string, pageNumber int, pageSize int, statuses []string, facilitatorIds []string, sortOrder string, relationships []string, completionInterval string, overdue string) (*Coachingappointmentresponselist, *APIResponse, error)

GetCoachingAppointments invokes GET /api/v2/coaching/appointments

Get appointments for users and optional date range

func (CoachingApi) GetCoachingAppointmentsMe

func (a CoachingApi) GetCoachingAppointmentsMe(interval string, pageNumber int, pageSize int, statuses []string, facilitatorIds []string, sortOrder string, relationships []string, completionInterval string, overdue string) (*Coachingappointmentresponselist, *APIResponse, error)

GetCoachingAppointmentsMe invokes GET /api/v2/coaching/appointments/me

Get my appointments for a given date range

func (CoachingApi) GetCoachingNotification

func (a CoachingApi) GetCoachingNotification(notificationId string, expand []string) (*Coachingnotification, *APIResponse, error)

GetCoachingNotification invokes GET /api/v2/coaching/notifications/{notificationId}

Get an existing notification

Permission not required if you are the owner of the notification.

func (CoachingApi) GetCoachingNotifications

func (a CoachingApi) GetCoachingNotifications(pageNumber int, pageSize int, expand []string) (*Coachingnotificationlist, *APIResponse, error)

GetCoachingNotifications invokes GET /api/v2/coaching/notifications

Retrieve the list of your notifications.

func (CoachingApi) PatchCoachingAppointment

func (a CoachingApi) PatchCoachingAppointment(appointmentId string, body Updatecoachingappointmentrequest) (*Coachingappointmentresponse, *APIResponse, error)

PatchCoachingAppointment invokes PATCH /api/v2/coaching/appointments/{appointmentId}

Update an existing appointment

Permission not required if you are the creator or facilitator of the appointment

func (CoachingApi) PatchCoachingAppointmentAnnotation

func (a CoachingApi) PatchCoachingAppointmentAnnotation(appointmentId string, annotationId string, body Coachingannotation) (*Coachingannotation, *APIResponse, error)

PatchCoachingAppointmentAnnotation invokes PATCH /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}

Update an existing annotation.

You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment

func (CoachingApi) PatchCoachingAppointmentStatus

func (a CoachingApi) PatchCoachingAppointmentStatus(appointmentId string, body Coachingappointmentstatusrequest) (*Coachingappointmentstatusresponse, *APIResponse, error)

PatchCoachingAppointmentStatus invokes PATCH /api/v2/coaching/appointments/{appointmentId}/status

Update the status of a coaching appointment

Permission not required if you are an attendee, creator or facilitator of the appointment

func (CoachingApi) PatchCoachingNotification

func (a CoachingApi) PatchCoachingNotification(notificationId string, body Coachingnotification) (*Coachingnotification, *APIResponse, error)

PatchCoachingNotification invokes PATCH /api/v2/coaching/notifications/{notificationId}

Update an existing notification.

Can only update your own notifications.

func (CoachingApi) PostCoachingAppointmentAnnotations

func (a CoachingApi) PostCoachingAppointmentAnnotations(appointmentId string, body Coachingannotationcreaterequest) (*Coachingannotation, *APIResponse, error)

PostCoachingAppointmentAnnotations invokes POST /api/v2/coaching/appointments/{appointmentId}/annotations

Create a new annotation.

You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can create private annotations).

func (CoachingApi) PostCoachingAppointmentConversations

func (a CoachingApi) PostCoachingAppointmentConversations(appointmentId string, body Addconversationrequest) (*Addconversationresponse, *APIResponse, error)

PostCoachingAppointmentConversations invokes POST /api/v2/coaching/appointments/{appointmentId}/conversations

Add a conversation to an appointment

Permission not required if you are the creator or facilitator of the appointment

func (CoachingApi) PostCoachingAppointments

PostCoachingAppointments invokes POST /api/v2/coaching/appointments

Create a new appointment

func (CoachingApi) PostCoachingAppointmentsAggregatesQuery

func (a CoachingApi) PostCoachingAppointmentsAggregatesQuery(body Coachingappointmentaggregaterequest) (*Coachingappointmentaggregateresponse, *APIResponse, error)

PostCoachingAppointmentsAggregatesQuery invokes POST /api/v2/coaching/appointments/aggregates/query

Retrieve aggregated appointment data

type Coachingannotation

type Coachingannotation struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// CreatedBy - The user who created the annotation.
	CreatedBy *Userreference `json:"createdBy,omitempty"`

	// DateCreated - The date/time the annotation was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// ModifiedBy - The last user to modify the annotation.
	ModifiedBy *Userreference `json:"modifiedBy,omitempty"`

	// DateModified - The date/time the annotation was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Text - The text of the annotation.
	Text *string `json:"text,omitempty"`

	// IsDeleted - Flag indicating whether the annotation is deleted.
	IsDeleted *bool `json:"isDeleted,omitempty"`

	// AccessType - Determines the permissions required to view this item.
	AccessType *string `json:"accessType,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Coachingannotation

func (*Coachingannotation) String

func (o *Coachingannotation) String() string

String returns a JSON representation of the model

type Coachingannotationcreaterequest

type Coachingannotationcreaterequest struct {
	// Text - The text of the annotation.
	Text *string `json:"text,omitempty"`

	// AccessType - Determines the permissions required to view this item.
	AccessType *string `json:"accessType,omitempty"`
}

Coachingannotationcreaterequest

func (*Coachingannotationcreaterequest) String

String returns a JSON representation of the model

type Coachingannotationlist

type Coachingannotationlist struct {
	// Entities
	Entities *[]Coachingannotation `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Coachingannotationlist

func (*Coachingannotationlist) String

func (o *Coachingannotationlist) String() string

String returns a JSON representation of the model

type Coachingappointmentaggregaterequest

type Coachingappointmentaggregaterequest struct {
	// Interval - Interval to aggregate across. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
	Interval *string `json:"interval,omitempty"`

	// Metrics - A list of metrics to aggregate.  If omitted, all metrics are returned.
	Metrics *[]string `json:"metrics,omitempty"`

	// GroupBy - An optional list of items by which to group the result data.
	GroupBy *[]string `json:"groupBy,omitempty"`

	// Filter - The filter applied to the data
	Filter *Queryrequestfilter `json:"filter,omitempty"`
}

Coachingappointmentaggregaterequest

func (*Coachingappointmentaggregaterequest) String

String returns a JSON representation of the model

type Coachingappointmentaggregateresponse

type Coachingappointmentaggregateresponse struct {
	// Results - The results of the query
	Results *[]Queryresponsegroupeddata `json:"results,omitempty"`
}

Coachingappointmentaggregateresponse

func (*Coachingappointmentaggregateresponse) String

String returns a JSON representation of the model

type Coachingappointmentreference

type Coachingappointmentreference struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Coachingappointmentreference

func (*Coachingappointmentreference) String

String returns a JSON representation of the model

type Coachingappointmentresponse

type Coachingappointmentresponse struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of coaching appointment
	Name *string `json:"name,omitempty"`

	// Description - The description of coaching appointment
	Description *string `json:"description,omitempty"`

	// DateStart - The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateStart *time.Time `json:"dateStart,omitempty"`

	// LengthInMinutes - The duration of coaching appointment in minutes
	LengthInMinutes *int `json:"lengthInMinutes,omitempty"`

	// Status - The status of coaching appointment
	Status *string `json:"status,omitempty"`

	// Facilitator - The facilitator of coaching appointment
	Facilitator *Userreference `json:"facilitator,omitempty"`

	// Attendees - The list of attendees attending the coaching
	Attendees *[]Userreference `json:"attendees,omitempty"`

	// CreatedBy - The user who created the coaching appointment
	CreatedBy *Userreference `json:"createdBy,omitempty"`

	// DateCreated - The date/time the coaching appointment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// ModifiedBy - The last user to modify the coaching appointment
	ModifiedBy *Userreference `json:"modifiedBy,omitempty"`

	// DateModified - The date/time the coaching appointment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Conversations - The list of conversations associated with coaching appointment.
	Conversations *[]Conversationreference `json:"conversations,omitempty"`

	// Documents - The list of documents associated with coaching appointment.
	Documents *[]Documentreference `json:"documents,omitempty"`

	// IsOverdue - Whether the appointment is overdue.
	IsOverdue *bool `json:"isOverdue,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Coachingappointmentresponse - Coaching appointment response

func (*Coachingappointmentresponse) String

func (o *Coachingappointmentresponse) String() string

String returns a JSON representation of the model

type Coachingappointmentresponselist

type Coachingappointmentresponselist struct {
	// Entities
	Entities *[]Coachingappointmentresponse `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Coachingappointmentresponselist

func (*Coachingappointmentresponselist) String

String returns a JSON representation of the model

type Coachingappointmentstatusdto

type Coachingappointmentstatusdto struct {
	// Appointment - The coaching appointment this status belongs to
	Appointment *Coachingappointmentreference `json:"appointment,omitempty"`

	// CreatedBy - User who updated the status
	CreatedBy *Userreference `json:"createdBy,omitempty"`

	// DateCreated - Creation time of the status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// Status - The status of the coaching appointment
	Status *string `json:"status,omitempty"`
}

Coachingappointmentstatusdto

func (*Coachingappointmentstatusdto) String

String returns a JSON representation of the model

type Coachingappointmentstatusdtolist

type Coachingappointmentstatusdtolist struct {
	// Entities
	Entities *[]Coachingappointmentstatusdto `json:"entities,omitempty"`

	// PageSize
	PageSize *int32 `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int32 `json:"pageNumber,omitempty"`

	// Total
	Total *int64 `json:"total,omitempty"`

	// PageCount
	PageCount *int32 `json:"pageCount,omitempty"`
}

Coachingappointmentstatusdtolist

func (*Coachingappointmentstatusdtolist) String

String returns a JSON representation of the model

type Coachingappointmentstatusrequest

type Coachingappointmentstatusrequest struct {
	// Status - The status of the coaching appointment
	Status *string `json:"status,omitempty"`
}

Coachingappointmentstatusrequest

func (*Coachingappointmentstatusrequest) String

String returns a JSON representation of the model

type Coachingappointmentstatusresponse

type Coachingappointmentstatusresponse struct {
	// Appointment - The coaching appointment this status belongs to
	Appointment *Coachingappointmentreference `json:"appointment,omitempty"`

	// CreatedBy - User who updated the status
	CreatedBy *Userreference `json:"createdBy,omitempty"`

	// DateCreated - Creation time of the status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// Status - The status of the coaching appointment
	Status *string `json:"status,omitempty"`
}

Coachingappointmentstatusresponse

func (*Coachingappointmentstatusresponse) String

String returns a JSON representation of the model

type Coachingappointmentstatusresponselist

type Coachingappointmentstatusresponselist struct {
	// Entities
	Entities *[]Coachingappointmentstatusresponse `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Coachingappointmentstatusresponselist

func (*Coachingappointmentstatusresponselist) String

String returns a JSON representation of the model

type Coachingnotification

type Coachingnotification struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the appointment for this notification.
	Name *string `json:"name,omitempty"`

	// MarkedAsRead - Indicates if notification is read or unread
	MarkedAsRead *bool `json:"markedAsRead,omitempty"`

	// ActionType - Action causing the notification.
	ActionType *string `json:"actionType,omitempty"`

	// Relationship - The relationship of this user to this notification's appointment
	Relationship *string `json:"relationship,omitempty"`

	// DateStart - The start time of the appointment relating to this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateStart *time.Time `json:"dateStart,omitempty"`

	// LengthInMinutes - The duration of the appointment on this notification
	LengthInMinutes *int `json:"lengthInMinutes,omitempty"`

	// Status - The status of the appointment for this notification
	Status *string `json:"status,omitempty"`

	// User - The user of this notification
	User *Userreference `json:"user,omitempty"`

	// Appointment - The appointment
	Appointment *Coachingappointmentresponse `json:"appointment,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Coachingnotification

func (*Coachingnotification) String

func (o *Coachingnotification) String() string

String returns a JSON representation of the model

type Coachingnotificationlist

type Coachingnotificationlist struct {
	// Entities
	Entities *[]Coachingnotification `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Coachingnotificationlist

func (*Coachingnotificationlist) String

func (o *Coachingnotificationlist) String() string

String returns a JSON representation of the model

type Cobrowseconversation

type Cobrowseconversation struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants - The list of participants involved in the conversation.
	Participants *[]Cobrowsemediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris - The list of other media channels involved in the conversation.
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Cobrowseconversation

func (*Cobrowseconversation) String

func (o *Cobrowseconversation) String() string

String returns a JSON representation of the model

type Cobrowseconversationentitylisting

type Cobrowseconversationentitylisting struct {
	// Entities
	Entities *[]Cobrowseconversation `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Cobrowseconversationentitylisting

func (*Cobrowseconversationentitylisting) String

String returns a JSON representation of the model

type Cobrowsemediaparticipant

type Cobrowsemediaparticipant struct {
	// Id - The unique participant ID.
	Id *string `json:"id,omitempty"`

	// Name - The display friendly name of the participant.
	Name *string `json:"name,omitempty"`

	// Address - The participant address.
	Address *string `json:"address,omitempty"`

	// StartTime - The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartTime *time.Time `json:"startTime,omitempty"`

	// ConnectedTime - The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// EndTime - The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndTime *time.Time `json:"endTime,omitempty"`

	// StartHoldTime - The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// Purpose - The participant's purpose.  Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr
	Purpose *string `json:"purpose,omitempty"`

	// State - The participant's state.  Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting
	State *string `json:"state,omitempty"`

	// Direction - The participant's direction.  Values can be: 'inbound' or 'outbound'
	Direction *string `json:"direction,omitempty"`

	// DisconnectType - The reason the participant was disconnected from the conversation.
	DisconnectType *string `json:"disconnectType,omitempty"`

	// Held - Value is true when the participant is on hold.
	Held *bool `json:"held,omitempty"`

	// WrapupRequired - Value is true when the participant requires wrap-up.
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupPrompt - The wrap-up prompt indicating the type of wrap-up to be performed.
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// User - The PureCloud user for this participant.
	User *Domainentityref `json:"user,omitempty"`

	// Queue - The PureCloud queue for this participant.
	Queue *Domainentityref `json:"queue,omitempty"`

	// Team - The PureCloud team for this participant.
	Team *Domainentityref `json:"team,omitempty"`

	// Attributes - A list of ad-hoc attributes for the participant.
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo - If the conversation ends in error, contains additional error details.
	ErrorInfo *Errorinfo `json:"errorInfo,omitempty"`

	// Script - The Engage script that should be used by this participant.
	Script *Domainentityref `json:"script,omitempty"`

	// WrapupTimeoutMs - The amount of time the participant has to complete wrap-up.
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// WrapupSkipped - Value is true when the participant has skipped wrap-up.
	WrapupSkipped *bool `json:"wrapupSkipped,omitempty"`

	// AlertingTimeoutMs - Specifies how long the agent has to answer an interaction before being marked as not responding.
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

	// Provider - The source provider for the communication.
	Provider *string `json:"provider,omitempty"`

	// ExternalContact - If this participant represents an external contact, then this will be the reference for the external contact.
	ExternalContact *Domainentityref `json:"externalContact,omitempty"`

	// ExternalOrganization - If this participant represents an external org, then this will be the reference for the external org.
	ExternalOrganization *Domainentityref `json:"externalOrganization,omitempty"`

	// Wrapup - Wrapup for this participant, if it has been applied.
	Wrapup *Wrapup `json:"wrapup,omitempty"`

	// Peer - The peer communication corresponding to a matching leg for this communication.
	Peer *string `json:"peer,omitempty"`

	// FlaggedReason - The reason specifying why participant flagged the conversation.
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext - Journey System data/context that is applicable to this communication.  When used for historical purposes, the context should be immutable.  When null, there is no applicable Journey System context.
	JourneyContext *Journeycontext `json:"journeyContext,omitempty"`

	// ConversationRoutingData - Information on how a communication should be routed to an agent.
	ConversationRoutingData *Conversationroutingdata `json:"conversationRoutingData,omitempty"`

	// StartAcwTime - The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime - The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// CobrowseSessionId - The co-browse session ID.
	CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"`

	// CobrowseRole - This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer).
	CobrowseRole *string `json:"cobrowseRole,omitempty"`

	// Controlling - ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).
	Controlling *[]string `json:"controlling,omitempty"`

	// ViewerUrl - The URL that can be used to open co-browse session in web browser.
	ViewerUrl *string `json:"viewerUrl,omitempty"`

	// ProviderEventTime - The time when the provider event which triggered this conversation update happened in the corrected provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ProviderEventTime *time.Time `json:"providerEventTime,omitempty"`
}

Cobrowsemediaparticipant

func (*Cobrowsemediaparticipant) String

func (o *Cobrowsemediaparticipant) String() string

String returns a JSON representation of the model

type Cobrowsesession

type Cobrowsesession struct {
	// State - The connection state of this communication.
	State *string `json:"state,omitempty"`

	// Id - A globally unique identifier for this communication.
	Id *string `json:"id,omitempty"`

	// DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
	DisconnectType *string `json:"disconnectType,omitempty"`

	// Self - Address and name data for a call endpoint.
	Self *Address `json:"self,omitempty"`

	// CobrowseSessionId - The co-browse session ID.
	CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"`

	// CobrowseRole - This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer).
	CobrowseRole *string `json:"cobrowseRole,omitempty"`

	// Controlling - ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).
	Controlling *[]string `json:"controlling,omitempty"`

	// ViewerUrl - The URL that can be used to open co-browse session in web browser.
	ViewerUrl *string `json:"viewerUrl,omitempty"`

	// ProviderEventTime - The time when the provider event which triggered this conversation update happened in the corrected provider clock (milliseconds since 1970-01-01 00:00:00 UTC). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ProviderEventTime *time.Time `json:"providerEventTime,omitempty"`

	// StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"`

	// ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Provider - The source provider for the co-browse session.
	Provider *string `json:"provider,omitempty"`

	// PeerId - The id of the peer communication corresponding to a matching leg for this communication.
	PeerId *string `json:"peerId,omitempty"`

	// Segments - The time line of the participant's call, divided into activity segments.
	Segments *[]Segment `json:"segments,omitempty"`

	// Wrapup - Call wrap up or disposition data.
	Wrapup *Wrapup `json:"wrapup,omitempty"`

	// AfterCallWork - After-call work for the communication.
	AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested.
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`
}

Cobrowsesession

func (*Cobrowsesession) String

func (o *Cobrowsesession) String() string

String returns a JSON representation of the model

type Commandstatus

type Commandstatus struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Expiration - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Expiration *time.Time `json:"expiration,omitempty"`

	// UserId
	UserId *string `json:"userId,omitempty"`

	// StatusCode
	StatusCode *string `json:"statusCode,omitempty"`

	// CommandType
	CommandType *string `json:"commandType,omitempty"`

	// Document
	Document *Document `json:"document,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Commandstatus

func (*Commandstatus) String

func (o *Commandstatus) String() string

String returns a JSON representation of the model

type Commandstatusentitylisting

type Commandstatusentitylisting struct {
	// Entities
	Entities *[]Commandstatus `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Commandstatusentitylisting

func (*Commandstatusentitylisting) String

func (o *Commandstatusentitylisting) String() string

String returns a JSON representation of the model

type Commoncampaign

type Commoncampaign struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the Campaign.
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Division `json:"division,omitempty"`

	// MediaType - The media type used for this campaign.
	MediaType *string `json:"mediaType,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Commoncampaign

func (*Commoncampaign) String

func (o *Commoncampaign) String() string

String returns a JSON representation of the model

type Commoncampaigndivisionview

type Commoncampaigndivisionview struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the Campaign.
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Division `json:"division,omitempty"`

	// MediaType - The media type used for this campaign.
	MediaType *string `json:"mediaType,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Commoncampaigndivisionview

func (*Commoncampaigndivisionview) String

func (o *Commoncampaigndivisionview) String() string

String returns a JSON representation of the model

type Commoncampaigndivisionviewentitylisting

type Commoncampaigndivisionviewentitylisting struct {
	// Entities
	Entities *[]Commoncampaigndivisionview `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Commoncampaigndivisionviewentitylisting

func (*Commoncampaigndivisionviewentitylisting) String

String returns a JSON representation of the model

type Commoncampaignentitylisting

type Commoncampaignentitylisting struct {
	// Entities
	Entities *[]Commoncampaign `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Commoncampaignentitylisting

func (*Commoncampaignentitylisting) String

func (o *Commoncampaignentitylisting) String() string

String returns a JSON representation of the model

type Condition

type Condition struct {
	// VarType - The type of the condition.
	VarType *string `json:"type,omitempty"`

	// Inverted - If true, inverts the result of evaluating this Condition. Default is false.
	Inverted *bool `json:"inverted,omitempty"`

	// AttributeName - An attribute name associated with this Condition. Required for a contactAttributeCondition.
	AttributeName *string `json:"attributeName,omitempty"`

	// Value - A value associated with this Condition. This could be text, a number, or a relative time. Not used for a DataActionCondition.
	Value *string `json:"value,omitempty"`

	// ValueType - The type of the value associated with this Condition. Not used for a DataActionCondition.
	ValueType *string `json:"valueType,omitempty"`

	// Operator - An operation with which to evaluate the Condition. Not used for a DataActionCondition.
	Operator *string `json:"operator,omitempty"`

	// Codes - List of wrap-up code identifiers. Required for a wrapupCondition.
	Codes *[]string `json:"codes,omitempty"`

	// Property - A value associated with the property type of this Condition. Required for a contactPropertyCondition.
	Property *string `json:"property,omitempty"`

	// PropertyType - The type of the property associated with this Condition. Required for a contactPropertyCondition.
	PropertyType *string `json:"propertyType,omitempty"`
}

Condition

func (*Condition) String

func (o *Condition) String() string

String returns a JSON representation of the model

type Configuration

type Configuration struct {
	UserName     string            `json:"userName,omitempty"`
	Password     string            `json:"password,omitempty"`
	APIKeyPrefix map[string]string `json:"APIKeyPrefix,omitempty"`
	APIKey       map[string]string `json:"APIKey,omitempty"`

	DebugFile                string            `json:"debugFile,omitempty"`
	OAuthToken               string            `json:"oAuthToken,omitempty"`
	Timeout                  int               `json:"timeout,omitempty"`
	BasePath                 string            `json:"basePath,omitempty"`
	Host                     string            `json:"host,omitempty"`
	Scheme                   string            `json:"scheme,omitempty"`
	AccessToken              string            `json:"accessToken,omitempty"`
	RefreshToken             string            `json:"refreshToken,omitempty"`
	ClientID                 string            `json:"clientId,omitempty"`
	ClientSecret             string            `json:"clientSecret,omitempty"`
	ShouldRefreshAccessToken bool              `json:"shouldRefreshAccessToken,omitempty"`
	RefreshInProgress        int64             `json:"refreshInProgress,omitempty"`
	RefreshTokenWaitTime     int               `json:"refreshTokenWaitTime,omitempty"`
	DefaultHeader            map[string]string `json:"defaultHeader,omitempty"`
	UserAgent                string            `json:"userAgent,omitempty"`
	APIClient                APIClient         `json:"APIClient,omitempty"`
	// contains filtered or unexported fields
}

Configuration has settings to configure the SDK

func GetDefaultConfiguration

func GetDefaultConfiguration() *Configuration

GetDefaultConfiguration returns the shared default configuration instance

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration instance

func (*Configuration) AddDefaultHeader

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

AddDefaultHeader sets a header that will be set on every request

func (*Configuration) AuthorizeClientCredentials

func (c *Configuration) AuthorizeClientCredentials(clientID string, clientSecret string) error

AuthorizeClientCredentials authorizes this Configuration instance using client credentials. The access token will be set automatically and API instances using this configuration object can now make authorized requests.

func (*Configuration) AuthorizeCodeGrant

func (c *Configuration) AuthorizeCodeGrant(clientID string, clientSecret string, authCode string, redirectUri string) (*AuthResponse, error)

AuthorizeCodeGrant authorizes this Configuration instance using an authorization code grant. The access and refresh tokens will be set automatically and API instances using this configuration object can now make authorized requests.

func (*Configuration) Debug

func (c *Configuration) Debug(msg interface{})

Debug prints the provided message using Println if debug tracing is enabled

func (*Configuration) Debugf

func (c *Configuration) Debugf(msg string, params ...interface{})

Debugf prints the provided formatted message using Printf if debug tracing is enabled

func (*Configuration) GetAPIKeyWithPrefix

func (c *Configuration) GetAPIKeyWithPrefix(APIKeyIdentifier string) string

GetAPIKeyWithPrefix appends a prefix to the API key

func (*Configuration) GetDebug

func (c *Configuration) GetDebug() bool

GetDebug tells you the value of the debug setting in case you forgot

func (*Configuration) RefreshAuthorizationCodeGrant

func (c *Configuration) RefreshAuthorizationCodeGrant(clientID string, clientSecret string, refreshToken string) (*AuthResponse, error)

RefreshAuthorizationCodeGrant requests a new access token for the authorization code grant. The access and refresh tokens will be set automatically and API instances using this configuration object can continue to make authorized requests.

func (*Configuration) SetDebug

func (c *Configuration) SetDebug(enable bool)

SetDebug enables debug tracing for HTTP requests, and probably some other stuff

type Connectrate

type Connectrate struct {
	// Attempts - Number of call attempts made
	Attempts *int `json:"attempts,omitempty"`

	// Connects - Number of calls with a live voice detected
	Connects *int `json:"connects,omitempty"`

	// ConnectRatio - Ratio of connects to attempts
	ConnectRatio *float64 `json:"connectRatio,omitempty"`
}

Connectrate

func (*Connectrate) String

func (o *Connectrate) String() string

String returns a JSON representation of the model

type Constraintconflictmessage

type Constraintconflictmessage struct {
	// Message - Message for how to resolve a set of conflicted work plan constraints
	Message *Workplanconstraintconflictmessage `json:"message,omitempty"`

	// ConflictedConstraintMessages - Messages for the set of conflicted work plan constraints. Each element indicates the message of a work plan constraint that is conflicted in the set
	ConflictedConstraintMessages *[]Workplanconstraintmessage `json:"conflictedConstraintMessages,omitempty"`
}

Constraintconflictmessage

func (*Constraintconflictmessage) String

func (o *Constraintconflictmessage) String() string

String returns a JSON representation of the model

type Consulttransfer

type Consulttransfer struct {
	// SpeakTo - Determines to whom the initiating participant is speaking. Defaults to DESTINATION
	SpeakTo *string `json:"speakTo,omitempty"`

	// Destination - Destination phone number and name.
	Destination *Destination `json:"destination,omitempty"`
}

Consulttransfer

func (*Consulttransfer) String

func (o *Consulttransfer) String() string

String returns a JSON representation of the model

type Consulttransferresponse

type Consulttransferresponse struct {
	// DestinationParticipantId - Participant ID to whom the call is being transferred.
	DestinationParticipantId *string `json:"destinationParticipantId,omitempty"`
}

Consulttransferresponse

func (*Consulttransferresponse) String

func (o *Consulttransferresponse) String() string

String returns a JSON representation of the model

type Consulttransferupdate

type Consulttransferupdate struct {
	// SpeakTo - Determines to whom the initiating participant is speaking.
	SpeakTo *string `json:"speakTo,omitempty"`
}

Consulttransferupdate

func (*Consulttransferupdate) String

func (o *Consulttransferupdate) String() string

String returns a JSON representation of the model

type Consumedresourcesentitylisting

type Consumedresourcesentitylisting struct {
	// Entities
	Entities *[]Dependency `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Consumedresourcesentitylisting

func (*Consumedresourcesentitylisting) String

String returns a JSON representation of the model

type Consumingresourcesentitylisting

type Consumingresourcesentitylisting struct {
	// Entities
	Entities *[]Dependency `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Consumingresourcesentitylisting

func (*Consumingresourcesentitylisting) String

String returns a JSON representation of the model

type Contact

type Contact struct {
	// Address - Email address or phone number for this contact type
	Address *string `json:"address,omitempty"`

	// Display - Formatted version of the address property
	Display *string `json:"display,omitempty"`

	// MediaType
	MediaType *string `json:"mediaType,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// Extension - Use internal extension instead of address. Mutually exclusive with the address field.
	Extension *string `json:"extension,omitempty"`

	// CountryCode
	CountryCode *string `json:"countryCode,omitempty"`
}

Contact

func (*Contact) String

func (o *Contact) String() string

String returns a JSON representation of the model

type Contactaddress

type Contactaddress struct {
	// Address1
	Address1 *string `json:"address1,omitempty"`

	// Address2
	Address2 *string `json:"address2,omitempty"`

	// City
	City *string `json:"city,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// PostalCode
	PostalCode *string `json:"postalCode,omitempty"`

	// CountryCode
	CountryCode *string `json:"countryCode,omitempty"`
}

Contactaddress

func (*Contactaddress) String

func (o *Contactaddress) String() string

String returns a JSON representation of the model

type Contactcallbackrequest

type Contactcallbackrequest struct {
	// CampaignId - Campaign identifier
	CampaignId *string `json:"campaignId,omitempty"`

	// ContactListId - Contact list identifier
	ContactListId *string `json:"contactListId,omitempty"`

	// ContactId - Contact identifier
	ContactId *string `json:"contactId,omitempty"`

	// PhoneColumn - Name of the phone column containing the number to be called
	PhoneColumn *string `json:"phoneColumn,omitempty"`

	// Schedule - The scheduled time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ\", example = \"2016-01-02T16:59:59\"
	Schedule *string `json:"schedule,omitempty"`
}

Contactcallbackrequest

func (*Contactcallbackrequest) String

func (o *Contactcallbackrequest) String() string

String returns a JSON representation of the model

type Contactcentersettings

type Contactcentersettings struct {
	// RemoveSkillsFromBlindTransfer - Strip skills from transfer
	RemoveSkillsFromBlindTransfer *bool `json:"removeSkillsFromBlindTransfer,omitempty"`
}

Contactcentersettings

func (*Contactcentersettings) String

func (o *Contactcentersettings) String() string

String returns a JSON representation of the model

type Contactcolumntimezone

type Contactcolumntimezone struct {
	// TimeZone - Time zone that the column matched to. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
	TimeZone *string `json:"timeZone,omitempty"`

	// ColumnType - Column Type will be either PHONE or ZIP
	ColumnType *string `json:"columnType,omitempty"`
}

Contactcolumntimezone

func (*Contactcolumntimezone) String

func (o *Contactcolumntimezone) String() string

String returns a JSON representation of the model

type Contactcolumntodataactionfieldmapping

type Contactcolumntodataactionfieldmapping struct{}

Contactcolumntodataactionfieldmapping

func (*Contactcolumntodataactionfieldmapping) String

String returns a JSON representation of the model

type Contactlist

type Contactlist struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Version - Required for updates, must match the version number of the most recent update
	Version *int `json:"version,omitempty"`

	// Division - The division this entity belongs to.
	Division *Domainentityref `json:"division,omitempty"`

	// ColumnNames - The names of the contact data columns.
	ColumnNames *[]string `json:"columnNames,omitempty"`

	// PhoneColumns - Indicates which columns are phone numbers.
	PhoneColumns *[]Contactphonenumbercolumn `json:"phoneColumns,omitempty"`

	// ImportStatus - The status of the import process.
	ImportStatus *Importstatus `json:"importStatus,omitempty"`

	// PreviewModeColumnName - A column to check if a contact should always be dialed in preview mode.
	PreviewModeColumnName *string `json:"previewModeColumnName,omitempty"`

	// PreviewModeAcceptedValues - The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode.
	PreviewModeAcceptedValues *[]string `json:"previewModeAcceptedValues,omitempty"`

	// Size - The number of contacts in the ContactList.
	Size *int `json:"size,omitempty"`

	// AttemptLimits - AttemptLimits for this ContactList.
	AttemptLimits *Domainentityref `json:"attemptLimits,omitempty"`

	// AutomaticTimeZoneMapping - Indicates if automatic time zone mapping is to be used for this ContactList.
	AutomaticTimeZoneMapping *bool `json:"automaticTimeZoneMapping,omitempty"`

	// ZipCodeColumnName - The name of contact list column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true.
	ZipCodeColumnName *string `json:"zipCodeColumnName,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Contactlist

func (*Contactlist) String

func (o *Contactlist) String() string

String returns a JSON representation of the model

type Contactlistdivisionview

type Contactlistdivisionview struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Division `json:"division,omitempty"`

	// ColumnNames - The names of the contact data columns.
	ColumnNames *[]string `json:"columnNames,omitempty"`

	// PhoneColumns - Indicates which columns are phone numbers.
	PhoneColumns *[]Contactphonenumbercolumn `json:"phoneColumns,omitempty"`

	// ImportStatus - The status of the import process.
	ImportStatus *Importstatus `json:"importStatus,omitempty"`

	// Size - The number of contacts in the ContactList.
	Size *int `json:"size,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Contactlistdivisionview

func (*Contactlistdivisionview) String

func (o *Contactlistdivisionview) String() string

String returns a JSON representation of the model

type Contactlistdivisionviewlisting

type Contactlistdivisionviewlisting struct {
	// Entities
	Entities *[]Contactlistdivisionview `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Contactlistdivisionviewlisting

func (*Contactlistdivisionviewlisting) String

String returns a JSON representation of the model

type Contactlistdownloadreadyexporturi

type Contactlistdownloadreadyexporturi struct {
	// Uri
	Uri *string `json:"uri,omitempty"`

	// ExportTimestamp
	ExportTimestamp *string `json:"exportTimestamp,omitempty"`

	// AdditionalProperties
	AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"`
}

Contactlistdownloadreadyexporturi

func (*Contactlistdownloadreadyexporturi) String

String returns a JSON representation of the model

type Contactlistentitylisting

type Contactlistentitylisting struct {
	// Entities
	Entities *[]Contactlist `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Contactlistentitylisting

func (*Contactlistentitylisting) String

func (o *Contactlistentitylisting) String() string

String returns a JSON representation of the model

type Contactlistfilter

type Contactlistfilter struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the list.
	Name *string `json:"name,omitempty"`

	// DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Version - Required for updates, must match the version number of the most recent update
	Version *int `json:"version,omitempty"`

	// ContactList - The contact list the filter is based on.
	ContactList *Domainentityref `json:"contactList,omitempty"`

	// Clauses - Groups of conditions to filter the contacts by.
	Clauses *[]Contactlistfilterclause `json:"clauses,omitempty"`

	// FilterType - How to join clauses together.
	FilterType *string `json:"filterType,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Contactlistfilter

func (*Contactlistfilter) String

func (o *Contactlistfilter) String() string

String returns a JSON representation of the model

type Contactlistfilterclause

type Contactlistfilterclause struct {
	// FilterType - How to join predicates together.
	FilterType *string `json:"filterType,omitempty"`

	// Predicates - Conditions to filter the contacts by.
	Predicates *[]Contactlistfilterpredicate `json:"predicates,omitempty"`
}

Contactlistfilterclause

func (*Contactlistfilterclause) String

func (o *Contactlistfilterclause) String() string

String returns a JSON representation of the model

type Contactlistfilterentitylisting

type Contactlistfilterentitylisting struct {
	// Entities
	Entities *[]Contactlistfilter `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Contactlistfilterentitylisting

func (*Contactlistfilterentitylisting) String

String returns a JSON representation of the model

type Contactlistfilterpredicate

type Contactlistfilterpredicate struct {
	// Column - Contact list column from the ContactListFilter's contactList.
	Column *string `json:"column,omitempty"`

	// ColumnType - The type of data in the contact column.
	ColumnType *string `json:"columnType,omitempty"`

	// Operator - The operator for this ContactListFilterPredicate.
	Operator *string `json:"operator,omitempty"`

	// Value - Value with which to compare the contact's data. This could be text, a number, or a relative time. A value for relative time should follow the format PxxDTyyHzzM, where xx, yy, and zz specify the days, hours and minutes. For example, a value of P01DT08H30M corresponds to 1 day, 8 hours, and 30 minutes from now. To specify a time in the past, include a negative sign before each numeric value. For example, a value of P-01DT-08H-30M corresponds to 1 day, 8 hours, and 30 minutes in the past. You can also do things like P01DT00H-30M, which would correspond to 23 hours and 30 minutes from now (1 day - 30 minutes).
	Value *string `json:"value,omitempty"`

	// VarRange - A range of values. Required for operators BETWEEN and IN.
	VarRange *Contactlistfilterrange `json:"range,omitempty"`

	// Inverted - Inverts the result of the predicate (i.e., if the predicate returns true, inverting it will return false).
	Inverted *bool `json:"inverted,omitempty"`
}

Contactlistfilterpredicate

func (*Contactlistfilterpredicate) String

func (o *Contactlistfilterpredicate) String() string

String returns a JSON representation of the model

type Contactlistfilterrange

type Contactlistfilterrange struct {
	// Min - The minimum value of the range. Required for the operator BETWEEN.
	Min *string `json:"min,omitempty"`

	// Max - The maximum value of the range. Required for the operator BETWEEN.
	Max *string `json:"max,omitempty"`

	// MinInclusive - Whether or not to include the minimum in the range.
	MinInclusive *bool `json:"minInclusive,omitempty"`

	// MaxInclusive - Whether or not to include the maximum in the range.
	MaxInclusive *bool `json:"maxInclusive,omitempty"`

	// InSet - A set of values that the contact data should be in. Required for the IN operator.
	InSet *[]string `json:"inSet,omitempty"`
}

Contactlistfilterrange

func (*Contactlistfilterrange) String

func (o *Contactlistfilterrange) String() string

String returns a JSON representation of the model

type Contactlistimportstatusimportstatus

type Contactlistimportstatusimportstatus struct {
	// ImportState
	ImportState *string `json:"importState,omitempty"`

	// TotalRecords
	TotalRecords *int `json:"totalRecords,omitempty"`

	// CompletedRecords
	CompletedRecords *int `json:"completedRecords,omitempty"`

	// PercentageComplete
	PercentageComplete *int `json:"percentageComplete,omitempty"`

	// FailureReason
	FailureReason *string `json:"failureReason,omitempty"`

	// AdditionalProperties
	AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"`
}

Contactlistimportstatusimportstatus

func (*Contactlistimportstatusimportstatus) String

String returns a JSON representation of the model

type Contactlisting

type Contactlisting struct {
	// Entities
	Entities *[]Externalcontact `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Contactlisting

func (*Contactlisting) String

func (o *Contactlisting) String() string

String returns a JSON representation of the model

type Contactphonenumbercolumn

type Contactphonenumbercolumn struct {
	// ColumnName - The name of the phone column.
	ColumnName *string `json:"columnName,omitempty"`

	// VarType - Indicates the type of the phone column. For example, 'cell' or 'home'.
	VarType *string `json:"type,omitempty"`

	// CallableTimeColumn - A column that indicates the timezone to use for a given contact when checking callable times. Not allowed if 'automaticTimeZoneMapping' is set to true.
	CallableTimeColumn *string `json:"callableTimeColumn,omitempty"`
}

Contactphonenumbercolumn

func (*Contactphonenumbercolumn) String

func (o *Contactphonenumbercolumn) String() string

String returns a JSON representation of the model

type Contactsort

type Contactsort struct {
	// FieldName
	FieldName *string `json:"fieldName,omitempty"`

	// Direction - The direction in which to sort contacts.
	Direction *string `json:"direction,omitempty"`

	// Numeric - Whether or not the column contains numeric data.
	Numeric *bool `json:"numeric,omitempty"`
}

Contactsort

func (*Contactsort) String

func (o *Contactsort) String() string

String returns a JSON representation of the model

type ContentManagementApi

type ContentManagementApi struct {
	Configuration *Configuration
}

ContentManagementApi provides functions for API endpoints

func NewContentManagementApi

func NewContentManagementApi() *ContentManagementApi

NewContentManagementApi creates an API instance using the default configuration

func NewContentManagementApiWithConfig

func NewContentManagementApiWithConfig(config *Configuration) *ContentManagementApi

NewContentManagementApiWithConfig creates an API instance using the provided configuration

func (ContentManagementApi) DeleteContentmanagementDocument

func (a ContentManagementApi) DeleteContentmanagementDocument(documentId string, override bool) (*APIResponse, error)

DeleteContentmanagementDocument invokes DELETE /api/v2/contentmanagement/documents/{documentId}

Delete a document.

func (ContentManagementApi) DeleteContentmanagementShare

func (a ContentManagementApi) DeleteContentmanagementShare(shareId string) (*APIResponse, error)

DeleteContentmanagementShare invokes DELETE /api/v2/contentmanagement/shares/{shareId}

Deletes an existing share.

This revokes sharing rights specified in the share record

func (ContentManagementApi) DeleteContentmanagementStatusStatusId

func (a ContentManagementApi) DeleteContentmanagementStatusStatusId(statusId string) (*APIResponse, error)

DeleteContentmanagementStatusStatusId invokes DELETE /api/v2/contentmanagement/status/{statusId}

Cancel the command for this status

func (ContentManagementApi) DeleteContentmanagementWorkspace

func (a ContentManagementApi) DeleteContentmanagementWorkspace(workspaceId string, moveChildrenToWorkspaceId string) (*APIResponse, error)

DeleteContentmanagementWorkspace invokes DELETE /api/v2/contentmanagement/workspaces/{workspaceId}

Delete a workspace

func (ContentManagementApi) DeleteContentmanagementWorkspaceMember

func (a ContentManagementApi) DeleteContentmanagementWorkspaceMember(workspaceId string, memberId string) (*APIResponse, error)

DeleteContentmanagementWorkspaceMember invokes DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}

Delete a member from a workspace

func (ContentManagementApi) DeleteContentmanagementWorkspaceTagvalue

func (a ContentManagementApi) DeleteContentmanagementWorkspaceTagvalue(workspaceId string, tagId string) (*APIResponse, error)

DeleteContentmanagementWorkspaceTagvalue invokes DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}

Delete workspace tag

Delete a tag from a workspace. Will remove this tag from all documents.

func (ContentManagementApi) GetContentmanagementDocument

func (a ContentManagementApi) GetContentmanagementDocument(documentId string, expand []string) (*Document, *APIResponse, error)

GetContentmanagementDocument invokes GET /api/v2/contentmanagement/documents/{documentId}

Get a document.

func (ContentManagementApi) GetContentmanagementDocumentAudits

func (a ContentManagementApi) GetContentmanagementDocumentAudits(documentId string, pageSize int, pageNumber int, transactionFilter string, level string, sortBy string, sortOrder string) (*Documentauditentitylisting, *APIResponse, error)

GetContentmanagementDocumentAudits invokes GET /api/v2/contentmanagement/documents/{documentId}/audits

Get a list of audits for a document.

func (ContentManagementApi) GetContentmanagementDocumentContent

func (a ContentManagementApi) GetContentmanagementDocumentContent(documentId string, disposition string, contentType string) (*Downloadresponse, *APIResponse, error)

GetContentmanagementDocumentContent invokes GET /api/v2/contentmanagement/documents/{documentId}/content

Download a document.

func (ContentManagementApi) GetContentmanagementDocuments

func (a ContentManagementApi) GetContentmanagementDocuments(workspaceId string, name string, expand []string, pageSize int, pageNumber int, sortBy string, sortOrder string) (*Documententitylisting, *APIResponse, error)

GetContentmanagementDocuments invokes GET /api/v2/contentmanagement/documents

Get a list of documents.

func (ContentManagementApi) GetContentmanagementQuery

func (a ContentManagementApi) GetContentmanagementQuery(queryPhrase string, pageSize int, pageNumber int, sortBy string, sortOrder string, expand []string) (*Queryresults, *APIResponse, error)

GetContentmanagementQuery invokes GET /api/v2/contentmanagement/query

Query content

func (ContentManagementApi) GetContentmanagementSecurityprofile

func (a ContentManagementApi) GetContentmanagementSecurityprofile(securityProfileId string) (*Securityprofile, *APIResponse, error)

GetContentmanagementSecurityprofile invokes GET /api/v2/contentmanagement/securityprofiles/{securityProfileId}

Get a Security Profile

func (ContentManagementApi) GetContentmanagementSecurityprofiles

func (a ContentManagementApi) GetContentmanagementSecurityprofiles() (*Securityprofileentitylisting, *APIResponse, error)

GetContentmanagementSecurityprofiles invokes GET /api/v2/contentmanagement/securityprofiles

Get a List of Security Profiles

func (ContentManagementApi) GetContentmanagementShare

func (a ContentManagementApi) GetContentmanagementShare(shareId string, expand []string) (*Share, *APIResponse, error)

GetContentmanagementShare invokes GET /api/v2/contentmanagement/shares/{shareId}

Retrieve details about an existing share.

func (ContentManagementApi) GetContentmanagementSharedSharedId

func (a ContentManagementApi) GetContentmanagementSharedSharedId(sharedId string, redirect bool, disposition string, contentType string, expand string) (*Sharedresponse, *APIResponse, error)

GetContentmanagementSharedSharedId invokes GET /api/v2/contentmanagement/shared/{sharedId}

Get shared documents. Securely download a shared document.

This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.

func (ContentManagementApi) GetContentmanagementShares

func (a ContentManagementApi) GetContentmanagementShares(entityId string, expand []string, pageSize int, pageNumber int) (*Shareentitylisting, *APIResponse, error)

GetContentmanagementShares invokes GET /api/v2/contentmanagement/shares

Gets a list of shares. You must specify at least one filter (e.g. entityId).

Failing to specify a filter will return 400.

func (ContentManagementApi) GetContentmanagementStatus

func (a ContentManagementApi) GetContentmanagementStatus(pageSize int, pageNumber int) (*Commandstatusentitylisting, *APIResponse, error)

GetContentmanagementStatus invokes GET /api/v2/contentmanagement/status

Get a list of statuses for pending operations

func (ContentManagementApi) GetContentmanagementStatusStatusId

func (a ContentManagementApi) GetContentmanagementStatusStatusId(statusId string) (*Commandstatus, *APIResponse, error)

GetContentmanagementStatusStatusId invokes GET /api/v2/contentmanagement/status/{statusId}

Get a status.

func (ContentManagementApi) GetContentmanagementUsage

func (a ContentManagementApi) GetContentmanagementUsage() (*Usage, *APIResponse, error)

GetContentmanagementUsage invokes GET /api/v2/contentmanagement/usage

Get usage details.

func (ContentManagementApi) GetContentmanagementWorkspace

func (a ContentManagementApi) GetContentmanagementWorkspace(workspaceId string, expand []string) (*Workspace, *APIResponse, error)

GetContentmanagementWorkspace invokes GET /api/v2/contentmanagement/workspaces/{workspaceId}

Get a workspace.

func (ContentManagementApi) GetContentmanagementWorkspaceDocuments

func (a ContentManagementApi) GetContentmanagementWorkspaceDocuments(workspaceId string, expand []string, pageSize int, pageNumber int, sortBy string, sortOrder string) (*Documententitylisting, *APIResponse, error)

GetContentmanagementWorkspaceDocuments invokes GET /api/v2/contentmanagement/workspaces/{workspaceId}/documents

Get a list of documents.

func (ContentManagementApi) GetContentmanagementWorkspaceMember

func (a ContentManagementApi) GetContentmanagementWorkspaceMember(workspaceId string, memberId string, expand []string) (*Workspacemember, *APIResponse, error)

GetContentmanagementWorkspaceMember invokes GET /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}

Get a workspace member

func (ContentManagementApi) GetContentmanagementWorkspaceMembers

func (a ContentManagementApi) GetContentmanagementWorkspaceMembers(workspaceId string, pageSize int, pageNumber int, expand []string) (*Workspacememberentitylisting, *APIResponse, error)

GetContentmanagementWorkspaceMembers invokes GET /api/v2/contentmanagement/workspaces/{workspaceId}/members

Get a list workspace members

func (ContentManagementApi) GetContentmanagementWorkspaceTagvalue

func (a ContentManagementApi) GetContentmanagementWorkspaceTagvalue(workspaceId string, tagId string, expand []string) (*Tagvalue, *APIResponse, error)

GetContentmanagementWorkspaceTagvalue invokes GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}

Get a workspace tag

func (ContentManagementApi) GetContentmanagementWorkspaceTagvalues

func (a ContentManagementApi) GetContentmanagementWorkspaceTagvalues(workspaceId string, value string, pageSize int, pageNumber int, expand []string) (*Tagvalueentitylisting, *APIResponse, error)

GetContentmanagementWorkspaceTagvalues invokes GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues

Get a list of workspace tags

func (ContentManagementApi) GetContentmanagementWorkspaces

func (a ContentManagementApi) GetContentmanagementWorkspaces(pageSize int, pageNumber int, access []string, expand []string) (*Workspaceentitylisting, *APIResponse, error)

GetContentmanagementWorkspaces invokes GET /api/v2/contentmanagement/workspaces

Get a list of workspaces.

Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.

func (ContentManagementApi) PostContentmanagementAuditquery

func (a ContentManagementApi) PostContentmanagementAuditquery(body Contentqueryrequest) (*Queryresults, *APIResponse, error)

PostContentmanagementAuditquery invokes POST /api/v2/contentmanagement/auditquery

Query audits

func (ContentManagementApi) PostContentmanagementDocument

func (a ContentManagementApi) PostContentmanagementDocument(documentId string, body Documentupdate, expand string, override bool) (*Document, *APIResponse, error)

PostContentmanagementDocument invokes POST /api/v2/contentmanagement/documents/{documentId}

Update a document.

func (ContentManagementApi) PostContentmanagementDocumentContent

func (a ContentManagementApi) PostContentmanagementDocumentContent(documentId string, body Replacerequest, override bool) (*Replaceresponse, *APIResponse, error)

PostContentmanagementDocumentContent invokes POST /api/v2/contentmanagement/documents/{documentId}/content

Replace the contents of a document.

func (ContentManagementApi) PostContentmanagementDocuments

func (a ContentManagementApi) PostContentmanagementDocuments(body Documentupload, copySource string, moveSource string, override bool) (*Document, *APIResponse, error)

PostContentmanagementDocuments invokes POST /api/v2/contentmanagement/documents

Add a document.

func (ContentManagementApi) PostContentmanagementQuery

func (a ContentManagementApi) PostContentmanagementQuery(body Queryrequest, expand string) (*Queryresults, *APIResponse, error)

PostContentmanagementQuery invokes POST /api/v2/contentmanagement/query

Query content

func (ContentManagementApi) PostContentmanagementShares

func (a ContentManagementApi) PostContentmanagementShares(body Createsharerequest) (*Createshareresponse, *APIResponse, error)

PostContentmanagementShares invokes POST /api/v2/contentmanagement/shares

Creates a new share or updates an existing share if the entity has already been shared

func (ContentManagementApi) PostContentmanagementWorkspaceTagvalues

func (a ContentManagementApi) PostContentmanagementWorkspaceTagvalues(workspaceId string, body Tagvalue) (*Tagvalue, *APIResponse, error)

PostContentmanagementWorkspaceTagvalues invokes POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues

Create a workspace tag

func (ContentManagementApi) PostContentmanagementWorkspaceTagvaluesQuery

func (a ContentManagementApi) PostContentmanagementWorkspaceTagvaluesQuery(workspaceId string, body Tagqueryrequest, expand []string) (*Tagvalueentitylisting, *APIResponse, error)

PostContentmanagementWorkspaceTagvaluesQuery invokes POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query

Perform a prefix query on tags in the workspace

func (ContentManagementApi) PostContentmanagementWorkspaces

func (a ContentManagementApi) PostContentmanagementWorkspaces(body Workspacecreate) (*Workspace, *APIResponse, error)

PostContentmanagementWorkspaces invokes POST /api/v2/contentmanagement/workspaces

Create a group workspace

func (ContentManagementApi) PutContentmanagementWorkspace

func (a ContentManagementApi) PutContentmanagementWorkspace(workspaceId string, body Workspace) (*Workspace, *APIResponse, error)

PutContentmanagementWorkspace invokes PUT /api/v2/contentmanagement/workspaces/{workspaceId}

Update a workspace

func (ContentManagementApi) PutContentmanagementWorkspaceMember

func (a ContentManagementApi) PutContentmanagementWorkspaceMember(workspaceId string, memberId string, body Workspacemember) (*Workspacemember, *APIResponse, error)

PutContentmanagementWorkspaceMember invokes PUT /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}

Add a member to a workspace

func (ContentManagementApi) PutContentmanagementWorkspaceTagvalue

func (a ContentManagementApi) PutContentmanagementWorkspaceTagvalue(workspaceId string, tagId string, body Tagvalue) (*Tagvalue, *APIResponse, error)

PutContentmanagementWorkspaceTagvalue invokes PUT /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}

Update a workspace tag. Will update all documents with the new tag value.

type Contentactions

type Contentactions struct {
	// Url - A URL for a web page to redirect the user to
	Url *string `json:"url,omitempty"`

	// UrlTarget - The target window or tab within the URL's web page. If empty will open a blank page or tab.
	UrlTarget *string `json:"urlTarget,omitempty"`

	// Textback - Text to be sent back in reply when a list item is selected
	Textback *string `json:"textback,omitempty"`

	// CommandName - Execute an organization's specific command
	CommandName *string `json:"commandName,omitempty"`

	// Context - Additional context for the command
	Context *map[string]interface{} `json:"context,omitempty"`
}

Contentactions - User actions available on the content. All actions are optional and all actions are executed simultaneously.

func (*Contentactions) String

func (o *Contentactions) String() string

String returns a JSON representation of the model

type Contentattachment

type Contentattachment struct {
	// Id - Vendor specific ID for media. For example, a LINE sticker ID
	Id *string `json:"id,omitempty"`

	// MediaType - The type of media this instance represents
	MediaType *string `json:"mediaType,omitempty"`

	// Url - Content element url
	Url *string `json:"url,omitempty"`

	// Mime - Content mime type from https://www.iana.org/assignments/media-types/media-types.xhtml
	Mime *string `json:"mime,omitempty"`

	// Text - Text message associated with media element: e.g. caption in case of image.
	Text *string `json:"text,omitempty"`

	// Sha256 - Secure hash of the media content
	Sha256 *string `json:"sha256,omitempty"`

	// Filename - Suggested file name for media file
	Filename *string `json:"filename,omitempty"`
}

Contentattachment - Attachment object

func (*Contentattachment) String

func (o *Contentattachment) String() string

String returns a JSON representation of the model

type Contentattributefilteritem

type Contentattributefilteritem struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Operator
	Operator *string `json:"operator,omitempty"`

	// Values
	Values *[]string `json:"values,omitempty"`
}

Contentattributefilteritem

func (*Contentattributefilteritem) String

func (o *Contentattributefilteritem) String() string

String returns a JSON representation of the model

type Contentfacetfilteritem

type Contentfacetfilteritem struct {
	// Name
	Name *string `json:"name,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// Operator
	Operator *string `json:"operator,omitempty"`

	// Values
	Values *[]string `json:"values,omitempty"`
}

Contentfacetfilteritem

func (*Contentfacetfilteritem) String

func (o *Contentfacetfilteritem) String() string

String returns a JSON representation of the model

type Contentfilteritem

type Contentfilteritem struct {
	// Name
	Name *string `json:"name,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// Operator
	Operator *string `json:"operator,omitempty"`

	// Values
	Values *[]string `json:"values,omitempty"`
}

Contentfilteritem

func (*Contentfilteritem) String

func (o *Contentfilteritem) String() string

String returns a JSON representation of the model

type Contentgeneric

type Contentgeneric struct {
	// Id - An ID assigned to this rich message content. Each instance inside the content array has a unique ID.
	Id *string `json:"id,omitempty"`

	// Title - Text to show in the title row
	Title *string `json:"title,omitempty"`

	// Description - Text to show in the description row. This is immediately below the title
	Description *string `json:"description,omitempty"`

	// Image - Path or URI to an image file
	Image *string `json:"image,omitempty"`

	// Video - Path or URI to a video file
	Video *string `json:"video,omitempty"`

	// Actions - User actions available on the content. All actions are optional and all actions are executed simultaneously.
	Actions *Contentactions `json:"actions,omitempty"`

	// Components - An array of component objects
	Components *[]Buttoncomponent `json:"components,omitempty"`
}

Contentgeneric - Generic content object

func (*Contentgeneric) String

func (o *Contentgeneric) String() string

String returns a JSON representation of the model

type Contentlist

type Contentlist struct {
	// Id - An ID assigned to this rich message content. Each instance inside the content array has a unique ID.
	Id *string `json:"id,omitempty"`

	// ListType - The type of list this instance represents
	ListType *string `json:"listType,omitempty"`

	// Title - Text to show in the title row
	Title *string `json:"title,omitempty"`

	// Description - Text to show in the description row. This is immediately below the title
	Description *string `json:"description,omitempty"`

	// SubmitLabel - Label for Submit button
	SubmitLabel *string `json:"submitLabel,omitempty"`

	// Actions - User actions available on the content. All actions are optional and all actions are executed simultaneously.
	Actions *Contentactions `json:"actions,omitempty"`

	// Components - An array of component objects
	Components *[]Listitemcomponent `json:"components,omitempty"`
}

Contentlist - List content object

func (*Contentlist) String

func (o *Contentlist) String() string

String returns a JSON representation of the model

type Contentlocation

type Contentlocation struct {
	// Url - Location map url
	Url *string `json:"url,omitempty"`

	// Address - Location postal address
	Address *string `json:"address,omitempty"`

	// Text - Location name
	Text *string `json:"text,omitempty"`

	// Latitude - Latitude of the location
	Latitude *float64 `json:"latitude,omitempty"`

	// Longitude - Longitude of the location
	Longitude *float64 `json:"longitude,omitempty"`
}

Contentlocation - Location object

func (*Contentlocation) String

func (o *Contentlocation) String() string

String returns a JSON representation of the model

type Contentmanagementsingledocumenttopicdocumentdatav2

type Contentmanagementsingledocumenttopicdocumentdatav2 struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// DateCreated
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateModified
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Workspace
	Workspace *Contentmanagementsingledocumenttopicworkspacedata `json:"workspace,omitempty"`

	// CreatedBy
	CreatedBy *Contentmanagementsingledocumenttopicuserdata `json:"createdBy,omitempty"`

	// ContentType
	ContentType *string `json:"contentType,omitempty"`

	// ContentLength
	ContentLength *int `json:"contentLength,omitempty"`

	// Filename
	Filename *string `json:"filename,omitempty"`

	// ChangeNumber
	ChangeNumber *int `json:"changeNumber,omitempty"`

	// DateUploaded
	DateUploaded *time.Time `json:"dateUploaded,omitempty"`

	// UploadedBy
	UploadedBy *Contentmanagementsingledocumenttopicuserdata `json:"uploadedBy,omitempty"`

	// LockInfo
	LockInfo *Contentmanagementsingledocumenttopiclockdata `json:"lockInfo,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`
}

Contentmanagementsingledocumenttopicdocumentdatav2

func (*Contentmanagementsingledocumenttopicdocumentdatav2) String

String returns a JSON representation of the model

type Contentmanagementsingledocumenttopiclockdata

type Contentmanagementsingledocumenttopiclockdata struct {
	// LockedBy
	LockedBy *Contentmanagementsingledocumenttopicuserdata `json:"lockedBy,omitempty"`

	// DateCreated
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateExpires
	DateExpires *time.Time `json:"dateExpires,omitempty"`
}

Contentmanagementsingledocumenttopiclockdata

func (*Contentmanagementsingledocumenttopiclockdata) String

String returns a JSON representation of the model

type Contentmanagementsingledocumenttopicuserdata

type Contentmanagementsingledocumenttopicuserdata struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Contentmanagementsingledocumenttopicuserdata

func (*Contentmanagementsingledocumenttopicuserdata) String

String returns a JSON representation of the model

type Contentmanagementsingledocumenttopicworkspacedata

type Contentmanagementsingledocumenttopicworkspacedata struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Contentmanagementsingledocumenttopicworkspacedata

func (*Contentmanagementsingledocumenttopicworkspacedata) String

String returns a JSON representation of the model

type Contentmanagementworkspacedocumentstopicdocumentdatav2

type Contentmanagementworkspacedocumentstopicdocumentdatav2 struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// DateCreated
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateModified
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Workspace
	Workspace *Contentmanagementworkspacedocumentstopicworkspacedata `json:"workspace,omitempty"`

	// CreatedBy
	CreatedBy *Contentmanagementworkspacedocumentstopicuserdata `json:"createdBy,omitempty"`

	// ContentType
	ContentType *string `json:"contentType,omitempty"`

	// ContentLength
	ContentLength *int `json:"contentLength,omitempty"`

	// Filename
	Filename *string `json:"filename,omitempty"`

	// ChangeNumber
	ChangeNumber *int `json:"changeNumber,omitempty"`

	// DateUploaded
	DateUploaded *time.Time `json:"dateUploaded,omitempty"`

	// UploadedBy
	UploadedBy *Contentmanagementworkspacedocumentstopicuserdata `json:"uploadedBy,omitempty"`

	// LockInfo
	LockInfo *Contentmanagementworkspacedocumentstopiclockdata `json:"lockInfo,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`
}

Contentmanagementworkspacedocumentstopicdocumentdatav2

func (*Contentmanagementworkspacedocumentstopicdocumentdatav2) String

String returns a JSON representation of the model

type Contentmanagementworkspacedocumentstopiclockdata

type Contentmanagementworkspacedocumentstopiclockdata struct {
	// LockedBy
	LockedBy *Contentmanagementworkspacedocumentstopicuserdata `json:"lockedBy,omitempty"`

	// DateCreated
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateExpires
	DateExpires *time.Time `json:"dateExpires,omitempty"`
}

Contentmanagementworkspacedocumentstopiclockdata

func (*Contentmanagementworkspacedocumentstopiclockdata) String

String returns a JSON representation of the model

type Contentmanagementworkspacedocumentstopicuserdata

type Contentmanagementworkspacedocumentstopicuserdata struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Contentmanagementworkspacedocumentstopicuserdata

func (*Contentmanagementworkspacedocumentstopicuserdata) String

String returns a JSON representation of the model

type Contentmanagementworkspacedocumentstopicworkspacedata

type Contentmanagementworkspacedocumentstopicworkspacedata struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Contentmanagementworkspacedocumentstopicworkspacedata

func (*Contentmanagementworkspacedocumentstopicworkspacedata) String

String returns a JSON representation of the model

type Contentnotificationtemplate

type Contentnotificationtemplate struct {
	// Id - The messaging channel template id. For WhatsApp, 'namespace@name'
	Id *string `json:"id,omitempty"`

	// Language - Template language
	Language *string `json:"language,omitempty"`

	// Header - Template header object
	Header *Notificationtemplateheader `json:"header,omitempty"`

	// Body - Template body object
	Body *Notificationtemplatebody `json:"body,omitempty"`

	// Footer - Template footer object
	Footer *Notificationtemplatefooter `json:"footer,omitempty"`
}

Contentnotificationtemplate - Template notification object

func (*Contentnotificationtemplate) String

func (o *Contentnotificationtemplate) String() string

String returns a JSON representation of the model

type Contentoffer

type Contentoffer struct {
	// ImageUrl - URL for image displayed to the customer when displaying content offer.
	ImageUrl *string `json:"imageUrl,omitempty"`

	// DisplayMode - The display mode of Genesys Widgets when displaying content offer.
	DisplayMode *string `json:"displayMode,omitempty"`

	// LayoutMode - The layout mode of the text shown to the user when displaying content offer.
	LayoutMode *string `json:"layoutMode,omitempty"`

	// Title - Title used in the header of the content offer.
	Title *string `json:"title,omitempty"`

	// Headline - Headline displayed above the body text of the content offer.
	Headline *string `json:"headline,omitempty"`

	// Body - Body text of the content offer.
	Body *string `json:"body,omitempty"`

	// CallToAction - Properties customizing the call to action button on the content offer.
	CallToAction *Calltoaction `json:"callToAction,omitempty"`

	// Style - Properties customizing the styling of the content offer.
	Style *Contentofferstylingconfiguration `json:"style,omitempty"`
}

Contentoffer

func (*Contentoffer) String

func (o *Contentoffer) String() string

String returns a JSON representation of the model

type Contentofferstyleproperties

type Contentofferstyleproperties struct {
	// Padding - Padding of the offer. (eg. 10px)
	Padding *string `json:"padding,omitempty"`

	// Color - Text color of the offer. (eg. #FF0000)
	Color *string `json:"color,omitempty"`

	// BackgroundColor - Background color of the offer. (eg. #000000)
	BackgroundColor *string `json:"backgroundColor,omitempty"`
}

Contentofferstyleproperties

func (*Contentofferstyleproperties) String

func (o *Contentofferstyleproperties) String() string

String returns a JSON representation of the model

type Contentofferstylingconfiguration

type Contentofferstylingconfiguration struct {
	// Position - Properties for customizing the positioning of the content offer.
	Position *Contentpositionproperties `json:"position,omitempty"`

	// Offer - Properties for customizing the appearance of the content offer.
	Offer *Contentofferstyleproperties `json:"offer,omitempty"`

	// CloseButton - Properties for customizing the appearance of the close button.
	CloseButton *Closebuttonstyleproperties `json:"closeButton,omitempty"`

	// CtaButton - Properties for customizing the appearance of the CTA button.
	CtaButton *Ctabuttonstyleproperties `json:"ctaButton,omitempty"`

	// Title - Properties for customizing the appearance of the title text.
	Title *Textstyleproperties `json:"title,omitempty"`

	// Headline - Properties for customizing the appearance of the headline text.
	Headline *Textstyleproperties `json:"headline,omitempty"`

	// Body - Properties for customizing the appearance of the body text.
	Body *Textstyleproperties `json:"body,omitempty"`
}

Contentofferstylingconfiguration

func (*Contentofferstylingconfiguration) String

String returns a JSON representation of the model

type Contentpositionproperties

type Contentpositionproperties struct {
	// Top - Top positioning offset.
	Top *string `json:"top,omitempty"`

	// Bottom - Bottom positioning offset.
	Bottom *string `json:"bottom,omitempty"`

	// Left - Left positioning offset.
	Left *string `json:"left,omitempty"`

	// Right - Right positioning offset.
	Right *string `json:"right,omitempty"`
}

Contentpositionproperties

func (*Contentpositionproperties) String

func (o *Contentpositionproperties) String() string

String returns a JSON representation of the model

type Contentpostback

type Contentpostback struct {
	// Id - An ID assigned to the postback reply. Each object inside the content array has a unique ID.
	Id *string `json:"id,omitempty"`

	// Text - The text inside the button clicked (in the structured message template)
	Text *string `json:"text,omitempty"`

	// Payload - Content of the textback payload after clicking a quick reply
	Payload *string `json:"payload,omitempty"`
}

Contentpostback - The postback object result of a user clicking in a button

func (*Contentpostback) String

func (o *Contentpostback) String() string

String returns a JSON representation of the model

type Contentqueryrequest

type Contentqueryrequest struct {
	// QueryPhrase
	QueryPhrase *string `json:"queryPhrase,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// FacetNameRequests
	FacetNameRequests *[]string `json:"facetNameRequests,omitempty"`

	// Sort
	Sort *[]Contentsortitem `json:"sort,omitempty"`

	// Filters
	Filters *[]Contentfacetfilteritem `json:"filters,omitempty"`

	// AttributeFilters
	AttributeFilters *[]Contentattributefilteritem `json:"attributeFilters,omitempty"`

	// IncludeShares
	IncludeShares *bool `json:"includeShares,omitempty"`
}

Contentqueryrequest

func (*Contentqueryrequest) String

func (o *Contentqueryrequest) String() string

String returns a JSON representation of the model

type Contentquickreply

type Contentquickreply struct {
	// Id - An ID assigned to the quick reply. Each object inside the content array has a unique ID.
	Id *string `json:"id,omitempty"`

	// Text - Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply.
	Text *string `json:"text,omitempty"`

	// Payload - Content of the textback payload after clicking a quick reply
	Payload *string `json:"payload,omitempty"`

	// Image - Image associated with quick reply
	Image *string `json:"image,omitempty"`

	// Action - Specifies the type of action that is triggered upon clicking the quick reply. Currently, the only supported action is \"Message\" which sends a message using the quick reply text.
	Action *string `json:"action,omitempty"`
}

Contentquickreply - Quick reply object

func (*Contentquickreply) String

func (o *Contentquickreply) String() string

String returns a JSON representation of the model

type Contentreaction

type Contentreaction struct {
	// ReactionType - Type of reaction
	ReactionType *string `json:"reactionType,omitempty"`

	// Count - Number of users that reacted this way to this public message
	Count *int `json:"count,omitempty"`
}

Contentreaction - User reaction to public message

func (*Contentreaction) String

func (o *Contentreaction) String() string

String returns a JSON representation of the model

type Contentsortitem

type Contentsortitem struct {
	// Name
	Name *string `json:"name,omitempty"`

	// Ascending
	Ascending *bool `json:"ascending,omitempty"`
}

Contentsortitem

func (*Contentsortitem) String

func (o *Contentsortitem) String() string

String returns a JSON representation of the model

type Context

type Context struct {
	// Patterns - A list of one or more patterns to match.
	Patterns *[]Contextpattern `json:"patterns,omitempty"`
}

Context

func (*Context) String

func (o *Context) String() string

String returns a JSON representation of the model

type Contextentity

type Contextentity struct {
	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`
}

Contextentity

func (*Contextentity) String

func (o *Contextentity) String() string

String returns a JSON representation of the model

type Contextintent

type Contextintent struct {
	// Name - The name of the intent.
	Name *string `json:"name,omitempty"`
}

Contextintent

func (*Contextintent) String

func (o *Contextintent) String() string

String returns a JSON representation of the model

type Contextpattern

type Contextpattern struct {
	// Criteria - A list of one or more criteria to satisfy.
	Criteria *[]Entitytypecriteria `json:"criteria,omitempty"`
}

Contextpattern

func (*Contextpattern) String

func (o *Contextpattern) String() string

String returns a JSON representation of the model

type Conversation

type Conversation struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// StartTime - The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartTime *time.Time `json:"startTime,omitempty"`

	// EndTime - The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndTime *time.Time `json:"endTime,omitempty"`

	// Address - The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound.
	Address *string `json:"address,omitempty"`

	// Participants - The list of all participants in the conversation.
	Participants *[]Participant `json:"participants,omitempty"`

	// ConversationIds - A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference.
	ConversationIds *[]string `json:"conversationIds,omitempty"`

	// MaxParticipants - If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference.
	MaxParticipants *int `json:"maxParticipants,omitempty"`

	// RecordingState - On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.
	RecordingState *string `json:"recordingState,omitempty"`

	// State - The conversation's state
	State *string `json:"state,omitempty"`

	// Divisions - Identifiers of divisions associated with this conversation
	Divisions *[]Conversationdivisionmembership `json:"divisions,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Conversation

func (*Conversation) String

func (o *Conversation) String() string

String returns a JSON representation of the model

type Conversationaggregatedatacontainer

type Conversationaggregatedatacontainer struct {
	// Group - A mapping from dimension to value
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Statisticalresponse `json:"data,omitempty"`
}

Conversationaggregatedatacontainer

func (*Conversationaggregatedatacontainer) String

String returns a JSON representation of the model

type Conversationaggregatequeryclause

type Conversationaggregatequeryclause struct {
	// VarType - Boolean operation to apply to the provided predicates
	VarType *string `json:"type,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Conversationaggregatequerypredicate `json:"predicates,omitempty"`
}

Conversationaggregatequeryclause

func (*Conversationaggregatequeryclause) String

String returns a JSON representation of the model

type Conversationaggregatequeryfilter

type Conversationaggregatequeryfilter struct {
	// VarType - Boolean operation to apply to the provided predicates and clauses
	VarType *string `json:"type,omitempty"`

	// Clauses - Boolean 'and/or' logic with up to two-levels of nesting
	Clauses *[]Conversationaggregatequeryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Conversationaggregatequerypredicate `json:"predicates,omitempty"`
}

Conversationaggregatequeryfilter

func (*Conversationaggregatequeryfilter) String

String returns a JSON representation of the model

type Conversationaggregatequerypredicate

type Conversationaggregatequerypredicate struct {
	// VarType - Optional type, can usually be inferred
	VarType *string `json:"type,omitempty"`

	// Dimension - Left hand side for dimension predicates
	Dimension *string `json:"dimension,omitempty"`

	// Operator - Optional operator, default is matches
	Operator *string `json:"operator,omitempty"`

	// Value - Right hand side for dimension predicates
	Value *string `json:"value,omitempty"`

	// VarRange - Right hand side for dimension predicates
	VarRange *Numericrange `json:"range,omitempty"`
}

Conversationaggregatequerypredicate

func (*Conversationaggregatequerypredicate) String

String returns a JSON representation of the model

type Conversationaggregatequeryresponse

type Conversationaggregatequeryresponse struct {
	// Results
	Results *[]Conversationaggregatedatacontainer `json:"results,omitempty"`
}

Conversationaggregatequeryresponse

func (*Conversationaggregatequeryresponse) String

String returns a JSON representation of the model

type Conversationaggregationquery

type Conversationaggregationquery struct {
	// Interval - Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
	Interval *string `json:"interval,omitempty"`

	// Granularity - Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
	Granularity *string `json:"granularity,omitempty"`

	// TimeZone - Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
	TimeZone *string `json:"timeZone,omitempty"`

	// GroupBy - Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
	GroupBy *[]string `json:"groupBy,omitempty"`

	// Filter - Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters
	Filter *Conversationaggregatequeryfilter `json:"filter,omitempty"`

	// Metrics - Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
	Metrics *[]string `json:"metrics,omitempty"`

	// FlattenMultivaluedDimensions - Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')
	FlattenMultivaluedDimensions *bool `json:"flattenMultivaluedDimensions,omitempty"`

	// Views - Custom derived metric views
	Views *[]Conversationaggregationview `json:"views,omitempty"`

	// AlternateTimeDimension - Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.
	AlternateTimeDimension *string `json:"alternateTimeDimension,omitempty"`
}

Conversationaggregationquery

func (*Conversationaggregationquery) String

String returns a JSON representation of the model

type Conversationaggregationview

type Conversationaggregationview struct {
	// Target - Target metric name
	Target *string `json:"target,omitempty"`

	// Name - A unique name for this view. Must be distinct from other views and built-in metric names.
	Name *string `json:"name,omitempty"`

	// Function - Type of view you wish to create
	Function *string `json:"function,omitempty"`

	// VarRange - Range of numbers for slicing up data
	VarRange *Aggregationrange `json:"range,omitempty"`
}

Conversationaggregationview

func (*Conversationaggregationview) String

func (o *Conversationaggregationview) String() string

String returns a JSON representation of the model

type Conversationassociation

type Conversationassociation struct {
	// ExternalContactId - An external contact ID.  If not supplied, implies the conversation should be disassociated with any external contact.
	ExternalContactId *string `json:"externalContactId,omitempty"`

	// ConversationId - Conversation ID
	ConversationId *string `json:"conversationId,omitempty"`

	// CommunicationId - Communication ID
	CommunicationId *string `json:"communicationId,omitempty"`

	// MediaType - Media type
	MediaType *string `json:"mediaType,omitempty"`
}

Conversationassociation

func (*Conversationassociation) String

func (o *Conversationassociation) String() string

String returns a JSON representation of the model

type Conversationbasic

type Conversationbasic struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// StartTime - The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartTime *time.Time `json:"startTime,omitempty"`

	// EndTime - The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndTime *time.Time `json:"endTime,omitempty"`

	// Divisions - Identifiers of divisions associated with this conversation
	Divisions *[]Conversationdivisionmembership `json:"divisions,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// Participants
	Participants *[]Participantbasic `json:"participants,omitempty"`
}

Conversationbasic

func (*Conversationbasic) String

func (o *Conversationbasic) String() string

String returns a JSON representation of the model

type Conversationcallbackeventtopiccallbackconversation

type Conversationcallbackeventtopiccallbackconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants
	Participants *[]Conversationcallbackeventtopiccallbackmediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`
}

Conversationcallbackeventtopiccallbackconversation

func (*Conversationcallbackeventtopiccallbackconversation) String

String returns a JSON representation of the model

type Conversationcallbackeventtopiccallbackmediaparticipant

type Conversationcallbackeventtopiccallbackmediaparticipant struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Address
	Address *string `json:"address,omitempty"`

	// StartTime
	StartTime *time.Time `json:"startTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// Purpose
	Purpose *string `json:"purpose,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// WrapupRequired
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupPrompt
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// User
	User *Conversationcallbackeventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Conversationcallbackeventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Conversationcallbackeventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Conversationcallbackeventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Conversationcallbackeventtopicurireference `json:"script,omitempty"`

	// WrapupTimeoutMs
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// WrapupSkipped
	WrapupSkipped *bool `json:"wrapupSkipped,omitempty"`

	// AlertingTimeoutMs
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ExternalContact
	ExternalContact *Conversationcallbackeventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Conversationcallbackeventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Conversationcallbackeventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Conversationcallbackeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Conversationcallbackeventtopicjourneycontext `json:"journeyContext,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// OutboundPreview
	OutboundPreview *Conversationcallbackeventtopicdialerpreview `json:"outboundPreview,omitempty"`

	// Voicemail
	Voicemail *Conversationcallbackeventtopicvoicemail `json:"voicemail,omitempty"`

	// CallbackNumbers
	CallbackNumbers *[]string `json:"callbackNumbers,omitempty"`

	// CallbackUserName
	CallbackUserName *string `json:"callbackUserName,omitempty"`

	// SkipEnabled
	SkipEnabled *bool `json:"skipEnabled,omitempty"`

	// ExternalCampaign
	ExternalCampaign *bool `json:"externalCampaign,omitempty"`

	// TimeoutSeconds
	TimeoutSeconds *int `json:"timeoutSeconds,omitempty"`

	// CallbackScheduledTime
	CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"`

	// AutomatedCallbackConfigId
	AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"`
}

Conversationcallbackeventtopiccallbackmediaparticipant

func (*Conversationcallbackeventtopiccallbackmediaparticipant) String

String returns a JSON representation of the model

type Conversationcallbackeventtopicconversationroutingdata

type Conversationcallbackeventtopicconversationroutingdata struct {
	// Queue
	Queue *Conversationcallbackeventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Conversationcallbackeventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Conversationcallbackeventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Conversationcallbackeventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Conversationcallbackeventtopicconversationroutingdata

func (*Conversationcallbackeventtopicconversationroutingdata) String

String returns a JSON representation of the model

type Conversationcallbackeventtopicdetail

type Conversationcallbackeventtopicdetail struct {
	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// FieldName
	FieldName *string `json:"fieldName,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`
}

Conversationcallbackeventtopicdetail

func (*Conversationcallbackeventtopicdetail) String

String returns a JSON representation of the model

type Conversationcallbackeventtopicdialerpreview

type Conversationcallbackeventtopicdialerpreview struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ContactId
	ContactId *string `json:"contactId,omitempty"`

	// ContactListId
	ContactListId *string `json:"contactListId,omitempty"`

	// CampaignId
	CampaignId *string `json:"campaignId,omitempty"`

	// PhoneNumberColumns
	PhoneNumberColumns *[]Conversationcallbackeventtopicphonenumbercolumn `json:"phoneNumberColumns,omitempty"`

	// AdditionalProperties
	AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"`
}

Conversationcallbackeventtopicdialerpreview

func (*Conversationcallbackeventtopicdialerpreview) String

String returns a JSON representation of the model

type Conversationcallbackeventtopicerrorbody

type Conversationcallbackeventtopicerrorbody struct {
	// Status
	Status *int `json:"status,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Conversationcallbackeventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Conversationcallbackeventtopicerrorbody `json:"errors,omitempty"`
}

Conversationcallbackeventtopicerrorbody

func (*Conversationcallbackeventtopicerrorbody) String

String returns a JSON representation of the model

type Conversationcallbackeventtopicjourneyaction

type Conversationcallbackeventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Conversationcallbackeventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Conversationcallbackeventtopicjourneyaction

func (*Conversationcallbackeventtopicjourneyaction) String

String returns a JSON representation of the model

type Conversationcallbackeventtopicjourneyactionmap

type Conversationcallbackeventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Conversationcallbackeventtopicjourneyactionmap

func (*Conversationcallbackeventtopicjourneyactionmap) String

String returns a JSON representation of the model

type Conversationcallbackeventtopicjourneycontext

type Conversationcallbackeventtopicjourneycontext struct {
	// Customer
	Customer *Conversationcallbackeventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Conversationcallbackeventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Conversationcallbackeventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Conversationcallbackeventtopicjourneycontext

func (*Conversationcallbackeventtopicjourneycontext) String

String returns a JSON representation of the model

type Conversationcallbackeventtopicjourneycustomer

type Conversationcallbackeventtopicjourneycustomer struct {
	// Id
	Id *string `json:"id,omitempty"`

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Conversationcallbackeventtopicjourneycustomer

func (*Conversationcallbackeventtopicjourneycustomer) String

String returns a JSON representation of the model

type Conversationcallbackeventtopicjourneycustomersession

type Conversationcallbackeventtopicjourneycustomersession struct {
	// Id
	Id *string `json:"id,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Conversationcallbackeventtopicjourneycustomersession

func (*Conversationcallbackeventtopicjourneycustomersession) String

String returns a JSON representation of the model

type Conversationcallbackeventtopicphonenumbercolumn

type Conversationcallbackeventtopicphonenumbercolumn struct {
	// ColumnName
	ColumnName *string `json:"columnName,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// AdditionalProperties
	AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"`
}

Conversationcallbackeventtopicphonenumbercolumn

func (*Conversationcallbackeventtopicphonenumbercolumn) String

String returns a JSON representation of the model

type Conversationcallbackeventtopicscoredagent

type Conversationcallbackeventtopicscoredagent struct {
	// Agent
	Agent *Conversationcallbackeventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Conversationcallbackeventtopicscoredagent

func (*Conversationcallbackeventtopicscoredagent) String

String returns a JSON representation of the model

type Conversationcallbackeventtopicurireference

type Conversationcallbackeventtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Conversationcallbackeventtopicurireference

func (*Conversationcallbackeventtopicurireference) String

String returns a JSON representation of the model

type Conversationcallbackeventtopicvoicemail

type Conversationcallbackeventtopicvoicemail struct {
	// Id
	Id *string `json:"id,omitempty"`

	// UploadStatus
	UploadStatus *string `json:"uploadStatus,omitempty"`
}

Conversationcallbackeventtopicvoicemail

func (*Conversationcallbackeventtopicvoicemail) String

String returns a JSON representation of the model

type Conversationcallbackeventtopicwrapup

type Conversationcallbackeventtopicwrapup struct {
	// Code
	Code *string `json:"code,omitempty"`

	// Notes
	Notes *string `json:"notes,omitempty"`

	// Tags
	Tags *[]string `json:"tags,omitempty"`

	// DurationSeconds
	DurationSeconds *int `json:"durationSeconds,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`

	// AdditionalProperties
	AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"`
}

Conversationcallbackeventtopicwrapup

func (*Conversationcallbackeventtopicwrapup) String

String returns a JSON representation of the model

type Conversationcalleventtopiccallconversation

type Conversationcalleventtopiccallconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants
	Participants *[]Conversationcalleventtopiccallmediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`

	// RecordingState
	RecordingState *string `json:"recordingState,omitempty"`

	// MaxParticipants
	MaxParticipants *int `json:"maxParticipants,omitempty"`
}

Conversationcalleventtopiccallconversation

func (*Conversationcalleventtopiccallconversation) String

String returns a JSON representation of the model

type Conversationcalleventtopiccallmediaparticipant

type Conversationcalleventtopiccallmediaparticipant struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Address
	Address *string `json:"address,omitempty"`

	// StartTime
	StartTime *time.Time `json:"startTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// Purpose
	Purpose *string `json:"purpose,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// WrapupRequired
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupPrompt
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// User
	User *Conversationcalleventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Conversationcalleventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Conversationcalleventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Conversationcalleventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Conversationcalleventtopicurireference `json:"script,omitempty"`

	// WrapupTimeoutMs
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// WrapupSkipped
	WrapupSkipped *bool `json:"wrapupSkipped,omitempty"`

	// AlertingTimeoutMs
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ExternalContact
	ExternalContact *Conversationcalleventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Conversationcalleventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Conversationcalleventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Conversationcalleventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Conversationcalleventtopicjourneycontext `json:"journeyContext,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// Muted
	Muted *bool `json:"muted,omitempty"`

	// Confined
	Confined *bool `json:"confined,omitempty"`

	// Recording
	Recording *bool `json:"recording,omitempty"`

	// RecordingState
	RecordingState *string `json:"recordingState,omitempty"`

	// Group
	Group *Conversationcalleventtopicurireference `json:"group,omitempty"`

	// Ani
	Ani *string `json:"ani,omitempty"`

	// Dnis
	Dnis *string `json:"dnis,omitempty"`

	// DocumentId
	DocumentId *string `json:"documentId,omitempty"`

	// MonitoredParticipantId
	MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"`

	// ConsultParticipantId
	ConsultParticipantId *string `json:"consultParticipantId,omitempty"`

	// FaxStatus
	FaxStatus *Conversationcalleventtopicfaxstatus `json:"faxStatus,omitempty"`
}

Conversationcalleventtopiccallmediaparticipant

func (*Conversationcalleventtopiccallmediaparticipant) String

String returns a JSON representation of the model

type Conversationcalleventtopicconversationroutingdata

type Conversationcalleventtopicconversationroutingdata struct {
	// Queue
	Queue *Conversationcalleventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Conversationcalleventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Conversationcalleventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Conversationcalleventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Conversationcalleventtopicconversationroutingdata

func (*Conversationcalleventtopicconversationroutingdata) String

String returns a JSON representation of the model

type Conversationcalleventtopicdetail

type Conversationcalleventtopicdetail struct {
	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// FieldName
	FieldName *string `json:"fieldName,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`
}

Conversationcalleventtopicdetail

func (*Conversationcalleventtopicdetail) String

String returns a JSON representation of the model

type Conversationcalleventtopicerrorbody

type Conversationcalleventtopicerrorbody struct {
	// Status
	Status *int `json:"status,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Conversationcalleventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Conversationcalleventtopicerrorbody `json:"errors,omitempty"`
}

Conversationcalleventtopicerrorbody

func (*Conversationcalleventtopicerrorbody) String

String returns a JSON representation of the model

type Conversationcalleventtopicfaxstatus

type Conversationcalleventtopicfaxstatus struct {
	// Direction
	Direction *string `json:"direction,omitempty"`

	// ExpectedPages
	ExpectedPages *int `json:"expectedPages,omitempty"`

	// ActivePage
	ActivePage *int `json:"activePage,omitempty"`

	// LinesTransmitted
	LinesTransmitted *int `json:"linesTransmitted,omitempty"`

	// BytesTransmitted
	BytesTransmitted *int `json:"bytesTransmitted,omitempty"`

	// DataRate
	DataRate *int `json:"dataRate,omitempty"`

	// PageErrors
	PageErrors *int `json:"pageErrors,omitempty"`

	// LineErrors
	LineErrors *int `json:"lineErrors,omitempty"`
}

Conversationcalleventtopicfaxstatus

func (*Conversationcalleventtopicfaxstatus) String

String returns a JSON representation of the model

type Conversationcalleventtopicjourneyaction

type Conversationcalleventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Conversationcalleventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Conversationcalleventtopicjourneyaction

func (*Conversationcalleventtopicjourneyaction) String

String returns a JSON representation of the model

type Conversationcalleventtopicjourneyactionmap

type Conversationcalleventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Conversationcalleventtopicjourneyactionmap

func (*Conversationcalleventtopicjourneyactionmap) String

String returns a JSON representation of the model

type Conversationcalleventtopicjourneycontext

type Conversationcalleventtopicjourneycontext struct {
	// Customer
	Customer *Conversationcalleventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Conversationcalleventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Conversationcalleventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Conversationcalleventtopicjourneycontext

func (*Conversationcalleventtopicjourneycontext) String

String returns a JSON representation of the model

type Conversationcalleventtopicjourneycustomer

type Conversationcalleventtopicjourneycustomer struct {
	// Id
	Id *string `json:"id,omitempty"`

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Conversationcalleventtopicjourneycustomer

func (*Conversationcalleventtopicjourneycustomer) String

String returns a JSON representation of the model

type Conversationcalleventtopicjourneycustomersession

type Conversationcalleventtopicjourneycustomersession struct {
	// Id
	Id *string `json:"id,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Conversationcalleventtopicjourneycustomersession

func (*Conversationcalleventtopicjourneycustomersession) String

String returns a JSON representation of the model

type Conversationcalleventtopicscoredagent

type Conversationcalleventtopicscoredagent struct {
	// Agent
	Agent *Conversationcalleventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Conversationcalleventtopicscoredagent

func (*Conversationcalleventtopicscoredagent) String

String returns a JSON representation of the model

type Conversationcalleventtopicurireference

type Conversationcalleventtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Conversationcalleventtopicurireference

func (*Conversationcalleventtopicurireference) String

String returns a JSON representation of the model

type Conversationcalleventtopicwrapup

type Conversationcalleventtopicwrapup struct {
	// Code
	Code *string `json:"code,omitempty"`

	// Notes
	Notes *string `json:"notes,omitempty"`

	// Tags
	Tags *[]string `json:"tags,omitempty"`

	// DurationSeconds
	DurationSeconds *int `json:"durationSeconds,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`

	// AdditionalProperties
	AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"`
}

Conversationcalleventtopicwrapup

func (*Conversationcalleventtopicwrapup) String

String returns a JSON representation of the model

type Conversationchat

type Conversationchat struct {
	// State - The connection state of this communication.
	State *string `json:"state,omitempty"`

	// Id - A globally unique identifier for this communication.
	Id *string `json:"id,omitempty"`

	// RoomId - The room id for the chat.
	RoomId *string `json:"roomId,omitempty"`

	// RecordingId - A globally unique identifier for the recording associated with this chat.
	RecordingId *string `json:"recordingId,omitempty"`

	// Segments - The time line of the participant's chat, divided into activity segments.
	Segments *[]Segment `json:"segments,omitempty"`

	// Held - True if this call is held and the person on this side hears silence.
	Held *bool `json:"held,omitempty"`

	// Direction - The direction of the chat
	Direction *string `json:"direction,omitempty"`

	// DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime - The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"`

	// ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Provider - The source provider for the email.
	Provider *string `json:"provider,omitempty"`

	// ScriptId - The UUID of the script to use.
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId - The id of the peer communication corresponding to a matching leg for this communication.
	PeerId *string `json:"peerId,omitempty"`

	// AvatarImageUrl - If available, the URI to the avatar image of this communication.
	AvatarImageUrl *string `json:"avatarImageUrl,omitempty"`

	// JourneyContext - A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context).
	JourneyContext *Journeycontext `json:"journeyContext,omitempty"`

	// Wrapup - Call wrap up or disposition data.
	Wrapup *Wrapup `json:"wrapup,omitempty"`

	// AfterCallWork - After-call work for the communication.
	AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested.
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`
}

Conversationchat

func (*Conversationchat) String

func (o *Conversationchat) String() string

String returns a JSON representation of the model

type Conversationchateventtopicchatconversation

type Conversationchateventtopicchatconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants
	Participants *[]Conversationchateventtopicchatmediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`
}

Conversationchateventtopicchatconversation

func (*Conversationchateventtopicchatconversation) String

String returns a JSON representation of the model

type Conversationchateventtopicchatmediaparticipant

type Conversationchateventtopicchatmediaparticipant struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Address
	Address *string `json:"address,omitempty"`

	// StartTime
	StartTime *time.Time `json:"startTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// Purpose
	Purpose *string `json:"purpose,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// WrapupRequired
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupPrompt
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// User
	User *Conversationchateventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Conversationchateventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Conversationchateventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Conversationchateventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Conversationchateventtopicurireference `json:"script,omitempty"`

	// WrapupTimeoutMs
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// WrapupSkipped
	WrapupSkipped *bool `json:"wrapupSkipped,omitempty"`

	// AlertingTimeoutMs
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ExternalContact
	ExternalContact *Conversationchateventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Conversationchateventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Conversationchateventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Conversationchateventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Conversationchateventtopicjourneycontext `json:"journeyContext,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// RoomId
	RoomId *string `json:"roomId,omitempty"`

	// AvatarImageUrl
	AvatarImageUrl *string `json:"avatarImageUrl,omitempty"`
}

Conversationchateventtopicchatmediaparticipant

func (*Conversationchateventtopicchatmediaparticipant) String

String returns a JSON representation of the model

type Conversationchateventtopicconversationroutingdata

type Conversationchateventtopicconversationroutingdata struct {
	// Queue
	Queue *Conversationchateventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Conversationchateventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Conversationchateventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Conversationchateventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Conversationchateventtopicconversationroutingdata

func (*Conversationchateventtopicconversationroutingdata) String

String returns a JSON representation of the model

type Conversationchateventtopicdetail

type Conversationchateventtopicdetail struct {
	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// FieldName
	FieldName *string `json:"fieldName,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`
}

Conversationchateventtopicdetail

func (*Conversationchateventtopicdetail) String

String returns a JSON representation of the model

type Conversationchateventtopicerrorbody

type Conversationchateventtopicerrorbody struct {
	// Status
	Status *int `json:"status,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Conversationchateventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Conversationchateventtopicerrorbody `json:"errors,omitempty"`
}

Conversationchateventtopicerrorbody

func (*Conversationchateventtopicerrorbody) String

String returns a JSON representation of the model

type Conversationchateventtopicjourneyaction

type Conversationchateventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Conversationchateventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Conversationchateventtopicjourneyaction

func (*Conversationchateventtopicjourneyaction) String

String returns a JSON representation of the model

type Conversationchateventtopicjourneyactionmap

type Conversationchateventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Conversationchateventtopicjourneyactionmap

func (*Conversationchateventtopicjourneyactionmap) String

String returns a JSON representation of the model

type Conversationchateventtopicjourneycontext

type Conversationchateventtopicjourneycontext struct {
	// Customer
	Customer *Conversationchateventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Conversationchateventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Conversationchateventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Conversationchateventtopicjourneycontext

func (*Conversationchateventtopicjourneycontext) String

String returns a JSON representation of the model

type Conversationchateventtopicjourneycustomer

type Conversationchateventtopicjourneycustomer struct {
	// Id
	Id *string `json:"id,omitempty"`

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Conversationchateventtopicjourneycustomer

func (*Conversationchateventtopicjourneycustomer) String

String returns a JSON representation of the model

type Conversationchateventtopicjourneycustomersession

type Conversationchateventtopicjourneycustomersession struct {
	// Id
	Id *string `json:"id,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Conversationchateventtopicjourneycustomersession

func (*Conversationchateventtopicjourneycustomersession) String

String returns a JSON representation of the model

type Conversationchateventtopicscoredagent

type Conversationchateventtopicscoredagent struct {
	// Agent
	Agent *Conversationchateventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Conversationchateventtopicscoredagent

func (*Conversationchateventtopicscoredagent) String

String returns a JSON representation of the model

type Conversationchateventtopicurireference

type Conversationchateventtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Conversationchateventtopicurireference

func (*Conversationchateventtopicurireference) String

String returns a JSON representation of the model

type Conversationchateventtopicwrapup

type Conversationchateventtopicwrapup struct {
	// Code
	Code *string `json:"code,omitempty"`

	// Notes
	Notes *string `json:"notes,omitempty"`

	// Tags
	Tags *[]string `json:"tags,omitempty"`

	// DurationSeconds
	DurationSeconds *int `json:"durationSeconds,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`

	// AdditionalProperties
	AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"`
}

Conversationchateventtopicwrapup

func (*Conversationchateventtopicwrapup) String

String returns a JSON representation of the model

type Conversationcobrowseeventtopiccobrowseconversation

type Conversationcobrowseeventtopiccobrowseconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants
	Participants *[]Conversationcobrowseeventtopiccobrowsemediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`
}

Conversationcobrowseeventtopiccobrowseconversation

func (*Conversationcobrowseeventtopiccobrowseconversation) String

String returns a JSON representation of the model

type Conversationcobrowseeventtopiccobrowsemediaparticipant

type Conversationcobrowseeventtopiccobrowsemediaparticipant struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Address
	Address *string `json:"address,omitempty"`

	// StartTime
	StartTime *time.Time `json:"startTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// Purpose
	Purpose *string `json:"purpose,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// WrapupRequired
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupPrompt
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// User
	User *Conversationcobrowseeventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Conversationcobrowseeventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Conversationcobrowseeventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Conversationcobrowseeventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Conversationcobrowseeventtopicurireference `json:"script,omitempty"`

	// WrapupTimeoutMs
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// WrapupSkipped
	WrapupSkipped *bool `json:"wrapupSkipped,omitempty"`

	// AlertingTimeoutMs
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ExternalContact
	ExternalContact *Conversationcobrowseeventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Conversationcobrowseeventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Conversationcobrowseeventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Conversationcobrowseeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Conversationcobrowseeventtopicjourneycontext `json:"journeyContext,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// CobrowseSessionId
	CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"`

	// CobrowseRole
	CobrowseRole *string `json:"cobrowseRole,omitempty"`

	// ViewerUrl
	ViewerUrl *string `json:"viewerUrl,omitempty"`

	// ProviderEventTime
	ProviderEventTime *time.Time `json:"providerEventTime,omitempty"`

	// Controlling
	Controlling *[]string `json:"controlling,omitempty"`
}

Conversationcobrowseeventtopiccobrowsemediaparticipant

func (*Conversationcobrowseeventtopiccobrowsemediaparticipant) String

String returns a JSON representation of the model

type Conversationcobrowseeventtopicconversationroutingdata

type Conversationcobrowseeventtopicconversationroutingdata struct {
	// Queue
	Queue *Conversationcobrowseeventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Conversationcobrowseeventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Conversationcobrowseeventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Conversationcobrowseeventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Conversationcobrowseeventtopicconversationroutingdata

func (*Conversationcobrowseeventtopicconversationroutingdata) String

String returns a JSON representation of the model

type Conversationcobrowseeventtopicdetail

type Conversationcobrowseeventtopicdetail struct {
	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// FieldName
	FieldName *string `json:"fieldName,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`
}

Conversationcobrowseeventtopicdetail

func (*Conversationcobrowseeventtopicdetail) String

String returns a JSON representation of the model

type Conversationcobrowseeventtopicerrorbody

type Conversationcobrowseeventtopicerrorbody struct {
	// Status
	Status *int `json:"status,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Conversationcobrowseeventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Conversationcobrowseeventtopicerrorbody `json:"errors,omitempty"`
}

Conversationcobrowseeventtopicerrorbody

func (*Conversationcobrowseeventtopicerrorbody) String

String returns a JSON representation of the model

type Conversationcobrowseeventtopicjourneyaction

type Conversationcobrowseeventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Conversationcobrowseeventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Conversationcobrowseeventtopicjourneyaction

func (*Conversationcobrowseeventtopicjourneyaction) String

String returns a JSON representation of the model

type Conversationcobrowseeventtopicjourneyactionmap

type Conversationcobrowseeventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Conversationcobrowseeventtopicjourneyactionmap

func (*Conversationcobrowseeventtopicjourneyactionmap) String

String returns a JSON representation of the model

type Conversationcobrowseeventtopicjourneycontext

type Conversationcobrowseeventtopicjourneycontext struct {
	// Customer
	Customer *Conversationcobrowseeventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Conversationcobrowseeventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Conversationcobrowseeventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Conversationcobrowseeventtopicjourneycontext

func (*Conversationcobrowseeventtopicjourneycontext) String

String returns a JSON representation of the model

type Conversationcobrowseeventtopicjourneycustomer

type Conversationcobrowseeventtopicjourneycustomer struct {
	// Id
	Id *string `json:"id,omitempty"`

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Conversationcobrowseeventtopicjourneycustomer

func (*Conversationcobrowseeventtopicjourneycustomer) String

String returns a JSON representation of the model

type Conversationcobrowseeventtopicjourneycustomersession

type Conversationcobrowseeventtopicjourneycustomersession struct {
	// Id
	Id *string `json:"id,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Conversationcobrowseeventtopicjourneycustomersession

func (*Conversationcobrowseeventtopicjourneycustomersession) String

String returns a JSON representation of the model

type Conversationcobrowseeventtopicscoredagent

type Conversationcobrowseeventtopicscoredagent struct {
	// Agent
	Agent *Conversationcobrowseeventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Conversationcobrowseeventtopicscoredagent

func (*Conversationcobrowseeventtopicscoredagent) String

String returns a JSON representation of the model

type Conversationcobrowseeventtopicurireference

type Conversationcobrowseeventtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Conversationcobrowseeventtopicurireference

func (*Conversationcobrowseeventtopicurireference) String

String returns a JSON representation of the model

type Conversationcobrowseeventtopicwrapup

type Conversationcobrowseeventtopicwrapup struct {
	// Code
	Code *string `json:"code,omitempty"`

	// Notes
	Notes *string `json:"notes,omitempty"`

	// Tags
	Tags *[]string `json:"tags,omitempty"`

	// DurationSeconds
	DurationSeconds *int `json:"durationSeconds,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`

	// AdditionalProperties
	AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"`
}

Conversationcobrowseeventtopicwrapup

func (*Conversationcobrowseeventtopicwrapup) String

String returns a JSON representation of the model

type Conversationdeletionprotectionquery

type Conversationdeletionprotectionquery struct {
	// ConversationIds - This is a list of ConversationIds. The list cannot exceed 100 conversationids.
	ConversationIds *[]string `json:"conversationIds,omitempty"`
}

Conversationdeletionprotectionquery

func (*Conversationdeletionprotectionquery) String

String returns a JSON representation of the model

type Conversationdetailqueryclause

type Conversationdetailqueryclause struct {
	// VarType - Boolean operation to apply to the provided predicates
	VarType *string `json:"type,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Conversationdetailquerypredicate `json:"predicates,omitempty"`
}

Conversationdetailqueryclause

func (*Conversationdetailqueryclause) String

String returns a JSON representation of the model

type Conversationdetailqueryfilter

type Conversationdetailqueryfilter struct {
	// VarType - Boolean operation to apply to the provided predicates and clauses
	VarType *string `json:"type,omitempty"`

	// Clauses - Boolean 'and/or' logic with up to two-levels of nesting
	Clauses *[]Conversationdetailqueryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Conversationdetailquerypredicate `json:"predicates,omitempty"`
}

Conversationdetailqueryfilter

func (*Conversationdetailqueryfilter) String

String returns a JSON representation of the model

type Conversationdetailquerypredicate

type Conversationdetailquerypredicate struct {
	// VarType - Optional type, can usually be inferred
	VarType *string `json:"type,omitempty"`

	// Dimension - Left hand side for dimension predicates
	Dimension *string `json:"dimension,omitempty"`

	// Metric - Left hand side for metric predicates
	Metric *string `json:"metric,omitempty"`

	// Operator - Optional operator, default is matches
	Operator *string `json:"operator,omitempty"`

	// Value - Right hand side for dimension or metric predicates
	Value *string `json:"value,omitempty"`

	// VarRange - Right hand side for dimension or metric predicates
	VarRange *Numericrange `json:"range,omitempty"`
}

Conversationdetailquerypredicate

func (*Conversationdetailquerypredicate) String

String returns a JSON representation of the model

type Conversationdetailsdatalakeavailabilitytopicdataavailabilitychangenotification

type Conversationdetailsdatalakeavailabilitytopicdataavailabilitychangenotification struct {
	// DataAvailabilityDate
	DataAvailabilityDate *Conversationdetailsdatalakeavailabilitytopicdatetime `json:"dataAvailabilityDate,omitempty"`
}

Conversationdetailsdatalakeavailabilitytopicdataavailabilitychangenotification

func (*Conversationdetailsdatalakeavailabilitytopicdataavailabilitychangenotification) String

String returns a JSON representation of the model

type Conversationdetailsdatalakeavailabilitytopicdatetime

type Conversationdetailsdatalakeavailabilitytopicdatetime struct {
	// IMillis
	IMillis *int `json:"iMillis,omitempty"`

	// BeforeNow
	BeforeNow *bool `json:"beforeNow,omitempty"`

	// AfterNow
	AfterNow *bool `json:"afterNow,omitempty"`

	// EqualNow
	EqualNow *bool `json:"equalNow,omitempty"`
}

Conversationdetailsdatalakeavailabilitytopicdatetime

func (*Conversationdetailsdatalakeavailabilitytopicdatetime) String

String returns a JSON representation of the model

type Conversationdivisionmembership

type Conversationdivisionmembership struct {
	// Division - A division the conversation belongs to.
	Division *Domainentityref `json:"division,omitempty"`

	// Entities - The entities on the conversation within the division. These are the users, queues, work flows, etc. that can be on conversations and and be assigned to different divisions.
	Entities *[]Domainentityref `json:"entities,omitempty"`
}

Conversationdivisionmembership

func (*Conversationdivisionmembership) String

String returns a JSON representation of the model

type Conversationemaileventtopicattachment

type Conversationemaileventtopicattachment struct {
	// AttachmentId
	AttachmentId *string `json:"attachmentId,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ContentUri
	ContentUri *string `json:"contentUri,omitempty"`

	// ContentType
	ContentType *string `json:"contentType,omitempty"`

	// ContentLength
	ContentLength *int `json:"contentLength,omitempty"`

	// AdditionalProperties
	AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"`
}

Conversationemaileventtopicattachment

func (*Conversationemaileventtopicattachment) String

String returns a JSON representation of the model

type Conversationemaileventtopicconversationroutingdata

type Conversationemaileventtopicconversationroutingdata struct {
	// Queue
	Queue *Conversationemaileventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Conversationemaileventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Conversationemaileventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Conversationemaileventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Conversationemaileventtopicconversationroutingdata

func (*Conversationemaileventtopicconversationroutingdata) String

String returns a JSON representation of the model

type Conversationemaileventtopicdetail

type Conversationemaileventtopicdetail struct {
	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// FieldName
	FieldName *string `json:"fieldName,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`
}

Conversationemaileventtopicdetail

func (*Conversationemaileventtopicdetail) String

String returns a JSON representation of the model

type Conversationemaileventtopicemailconversation

type Conversationemaileventtopicemailconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants
	Participants *[]Conversationemaileventtopicemailmediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`
}

Conversationemaileventtopicemailconversation

func (*Conversationemaileventtopicemailconversation) String

String returns a JSON representation of the model

type Conversationemaileventtopicemailmediaparticipant

type Conversationemaileventtopicemailmediaparticipant struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Address
	Address *string `json:"address,omitempty"`

	// StartTime
	StartTime *time.Time `json:"startTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// Purpose
	Purpose *string `json:"purpose,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// WrapupRequired
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupPrompt
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// User
	User *Conversationemaileventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Conversationemaileventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Conversationemaileventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Conversationemaileventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Conversationemaileventtopicurireference `json:"script,omitempty"`

	// WrapupTimeoutMs
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// WrapupSkipped
	WrapupSkipped *bool `json:"wrapupSkipped,omitempty"`

	// AlertingTimeoutMs
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ExternalContact
	ExternalContact *Conversationemaileventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Conversationemaileventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Conversationemaileventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Conversationemaileventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Conversationemaileventtopicjourneycontext `json:"journeyContext,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// Subject
	Subject *string `json:"subject,omitempty"`

	// MessagesSent
	MessagesSent *int `json:"messagesSent,omitempty"`

	// AutoGenerated
	AutoGenerated *bool `json:"autoGenerated,omitempty"`

	// MessageId
	MessageId *string `json:"messageId,omitempty"`

	// DraftAttachments
	DraftAttachments *[]Conversationemaileventtopicattachment `json:"draftAttachments,omitempty"`

	// Spam
	Spam *bool `json:"spam,omitempty"`
}

Conversationemaileventtopicemailmediaparticipant

func (*Conversationemaileventtopicemailmediaparticipant) String

String returns a JSON representation of the model

type Conversationemaileventtopicerrorbody

type Conversationemaileventtopicerrorbody struct {
	// Status
	Status *int `json:"status,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Conversationemaileventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Conversationemaileventtopicerrorbody `json:"errors,omitempty"`
}

Conversationemaileventtopicerrorbody

func (*Conversationemaileventtopicerrorbody) String

String returns a JSON representation of the model

type Conversationemaileventtopicjourneyaction

type Conversationemaileventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Conversationemaileventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Conversationemaileventtopicjourneyaction

func (*Conversationemaileventtopicjourneyaction) String

String returns a JSON representation of the model

type Conversationemaileventtopicjourneyactionmap

type Conversationemaileventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Conversationemaileventtopicjourneyactionmap

func (*Conversationemaileventtopicjourneyactionmap) String

String returns a JSON representation of the model

type Conversationemaileventtopicjourneycontext

type Conversationemaileventtopicjourneycontext struct {
	// Customer
	Customer *Conversationemaileventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Conversationemaileventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Conversationema