platformclientv2

package
v48.0.0 Latest Latest
Warning

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

Go to latest
Published: Jul 2, 2021 License: MIT Imports: 25 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())
Output:

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())
Output:

Index ¶

Examples ¶

Constants ¶

View Source
const (
	USEast1      = "https://api.mypurecloud.com"
	EUWest1      = "https://api.mypurecloud.ie"
	APSoutheast2 = "https://api.mypurecloud.com.au"
	APNortheast1 = "https://api.mypurecloud.jp"
	EUCentral1   = "https://api.mypurecloud.de"
	USWest2      = "https://api.usw2.pure.cloud"
	CACentral1   = "https://api.cac1.pure.cloud"
	APNortheast2 = "https://api.apne2.pure.cloud"
	EUWest2      = "https://api.euw2.pure.cloud"
	APSouth1     = "https://api.aps1.pure.cloud"
	USEast2      = "https://api.use2.us-gov-pure.cloud"
)

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 string                 `json:"messageWithParams,omitempty"`
	MessageParams     map[string]interface{} `json:"messageParams,omitempty"`
	Code              string                 `json:"code,omitempty"`
	ContextID         string                 `json:"contextId,omitempty"`
	Details           []Detail               `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 Acknowledgescreenrecordingrequest ¶

type Acknowledgescreenrecordingrequest struct {
	// ParticipantJid
	ParticipantJid *string `json:"participantJid,omitempty"`

	// RoomId
	RoomId *string `json:"roomId,omitempty"`

	// ConversationId
	ConversationId *string `json:"conversationId,omitempty"`
}

Acknowledgescreenrecordingrequest

func (*Acknowledgescreenrecordingrequest) String ¶

String returns a JSON representation of the model

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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

	// WebMessagingOfferFields - Admin-configurable fields of a web messaging offer action.
	WebMessagingOfferFields *Webmessagingofferfields `json:"webMessagingOfferFields,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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 *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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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. See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
	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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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 Agentmanagementunitreference ¶

type Agentmanagementunitreference struct {
	// User - The user (agent) for whom the management unit was requested
	User *Userreference `json:"user,omitempty"`

	// ManagementUnit - The management to which the user (agent) belongs
	ManagementUnit *Managementunitreference `json:"managementUnit,omitempty"`

	// BusinessUnit - The business unit to which the user (agent) belongs. Populate with expand=businessUnit
	BusinessUnit *Businessunitreference `json:"businessUnit,omitempty"`
}

Agentmanagementunitreference - A reference from agent to management unit

func (*Agentmanagementunitreference) String ¶

String returns a JSON representation of the model

type Agentmaxutilization ¶

type Agentmaxutilization struct {
	// Utilization - Map of media type to utilization settings.  Valid media types include call, callback, chat, email, and message.
	Utilization *map[string]Mediautilization `json:"utilization,omitempty"`

	// Level
	Level *string `json:"level,omitempty"`
}

Agentmaxutilization

func (*Agentmaxutilization) String ¶

func (o *Agentmaxutilization) String() string

String returns a JSON representation of the model

type Agentownedmappingpreview ¶

type Agentownedmappingpreview struct {
	// AgentOwnedColumn - The raw value of the agent-owned column
	AgentOwnedColumn *string `json:"agentOwnedColumn,omitempty"`

	// Email - The email address of the user, if it exists
	Email *string `json:"email,omitempty"`

	// UserId - The id of the user, if it exists
	UserId *string `json:"userId,omitempty"`

	// Exists - Whether the user exists
	Exists *bool `json:"exists,omitempty"`

	// IsQueueMember - Whether the user is a member of the campaign's queue
	IsQueueMember *bool `json:"isQueueMember,omitempty"`

	// RecordCount - The number of contact records whose agent-owned column matches the raw value
	RecordCount *int `json:"recordCount,omitempty"`
}

Agentownedmappingpreview

func (*Agentownedmappingpreview) String ¶

func (o *Agentownedmappingpreview) String() string

String returns a JSON representation of the model

type Agentownedmappingpreviewlisting ¶

type Agentownedmappingpreviewlisting struct {
	// Entities
	Entities *[]Agentownedmappingpreview `json:"entities,omitempty"`
}

Agentownedmappingpreviewlisting

func (*Agentownedmappingpreviewlisting) 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 Alltimepoints ¶

type Alltimepoints struct {
	// User - Queried user
	User *Userreference `json:"user,omitempty"`

	// DateEndWorkday - Queried end workday for all time points to be collected. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateEndWorkday *time.Time `json:"dateEndWorkday,omitempty"`

	// AllTimePoints - All time point collected bt the user
	AllTimePoints *int `json:"allTimePoints,omitempty"`
}

Alltimepoints

func (*Alltimepoints) String ¶

func (o *Alltimepoints) String() string

String returns a JSON representation of the model

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) PostAnalyticsBotsAggregatesQuery ¶

func (a AnalyticsApi) PostAnalyticsBotsAggregatesQuery(body Botaggregationquery) (*Botaggregatequeryresponse, *APIResponse, error)

PostAnalyticsBotsAggregatesQuery invokes POST /api/v2/analytics/bots/aggregates/query

Query for bot aggregates

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 {
	// ConversationEnd - The end time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConversationEnd *time.Time `json:"conversationEnd,omitempty"`

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

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

	// DivisionIds - Identifier(s) of division(s) associated with a conversation
	DivisionIds *[]string `json:"divisionIds,omitempty"`

	// ExternalTag - External tag for the conversation
	ExternalTag *string `json:"externalTag,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 associated with this conversation
	Evaluations *[]Analyticsevaluation `json:"evaluations,omitempty"`

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

	// Resolutions - Resolutions associated with this conversation
	Resolutions *[]Analyticsresolution `json:"resolutions,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"`

	// TotalHits
	TotalHits *int `json:"totalHits,omitempty"`
}

Analyticsconversationqueryresponse

func (*Analyticsconversationqueryresponse) String ¶

String returns a JSON representation of the model

type Analyticsconversationsegment ¶

type Analyticsconversationsegment struct {
	// AudioMuted - Flag indicating if audio is muted or not (true/false)
	AudioMuted *bool `json:"audioMuted,omitempty"`

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

	// DestinationConversationId - The unique identifier of a new conversation when a conversation is ended for a conference
	DestinationConversationId *string `json:"destinationConversationId,omitempty"`

	// DestinationSessionId - The unique identifier of a new session when a session is ended for a conference
	DestinationSessionId *string `json:"destinationSessionId,omitempty"`

	// DisconnectType - The session disconnect type
	DisconnectType *string `json:"disconnectType,omitempty"`

	// ErrorCode - A code corresponding to the error that occurred
	ErrorCode *string `json:"errorCode,omitempty"`

	// GroupId - Unique identifier for a PureCloud group
	GroupId *string `json:"groupId,omitempty"`

	// Q850ResponseCodes - Q.850 response code(s)
	Q850ResponseCodes *[]int `json:"q850ResponseCodes,omitempty"`

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

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

	// RequestedRoutingSkillIds - Unique identifier(s) for skill(s) requested for an interaction
	RequestedRoutingSkillIds *[]string `json:"requestedRoutingSkillIds,omitempty"`

	// RequestedRoutingUserIds - Unique identifier(s) for agent(s) requested for an interaction
	RequestedRoutingUserIds *[]string `json:"requestedRoutingUserIds,omitempty"`

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

	// SegmentStart - The start time of a segment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	SegmentStart *time.Time `json:"segmentStart,omitempty"`

	// SegmentType - The activity that takes place in the segment, such as hold or interact
	SegmentType *string `json:"segmentType,omitempty"`

	// SipResponseCodes - SIP response code(s)
	SipResponseCodes *[]int `json:"sipResponseCodes,omitempty"`

	// SourceConversationId - The unique identifier of the previous conversation when a new conversation is created for a conference
	SourceConversationId *string `json:"sourceConversationId,omitempty"`

	// SourceSessionId - The unique identifier of the previous session when a new session is created for a conference
	SourceSessionId *string `json:"sourceSessionId,omitempty"`

	// Subject - The subject for the initial email that started this conversation
	Subject *string `json:"subject,omitempty"`

	// VideoMuted - Flag indicating if video is muted/paused or not (true/false)
	VideoMuted *bool `json:"videoMuted,omitempty"`

	// WrapUpCode - Wrap up code
	WrapUpCode *string `json:"wrapUpCode,omitempty"`

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

	// WrapUpTags - Tag(s) assigned during after-call work
	WrapUpTags *[]string `json:"wrapUpTags,omitempty"`

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

	// Properties - Additional segment properties
	Properties *[]Analyticsproperty `json:"properties,omitempty"`
}

Analyticsconversationsegment

func (*Analyticsconversationsegment) String ¶

String returns a JSON representation of the model

type Analyticsconversationwithoutattributes ¶

type Analyticsconversationwithoutattributes struct {
	// ConversationEnd - The end time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConversationEnd *time.Time `json:"conversationEnd,omitempty"`

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

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

	// DivisionIds - Identifier(s) of division(s) associated with a conversation
	DivisionIds *[]string `json:"divisionIds,omitempty"`

	// ExternalTag - External tag for the conversation
	ExternalTag *string `json:"externalTag,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 associated with this conversation
	Evaluations *[]Analyticsevaluation `json:"evaluations,omitempty"`

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

	// Resolutions - Resolutions associated with this conversation
	Resolutions *[]Analyticsresolution `json:"resolutions,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 {
	// CalibrationId - The calibration ID used for the purpose of training evaluators
	CalibrationId *string `json:"calibrationId,omitempty"`

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

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

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

	// EvaluatorId - A unique identifier of the user who evaluated the interaction
	EvaluatorId *string `json:"evaluatorId,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"`

	// FormId - ID of the evaluation form used
	FormId *string `json:"formId,omitempty"`

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

	// QueueId - The ID of the associated queue
	QueueId *string `json:"queueId,omitempty"`

	// Rescored - Whether the evaluation has been rescored at least once
	Rescored *bool `json:"rescored,omitempty"`

	// UserId - ID of the agent the evaluation was performed against
	UserId *string `json:"userId,omitempty"`

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

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

Analyticsevaluation

func (*Analyticsevaluation) String ¶

func (o *Analyticsevaluation) String() string

String returns a JSON representation of the model

type Analyticsflow ¶

type Analyticsflow struct {
	// EndingLanguage - Flow ending language, e.g. en-us
	EndingLanguage *string `json:"endingLanguage,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, e.g. dnis, dialer, agent, flow, or direct
	EntryType *string `json:"entryType,omitempty"`

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

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

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

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

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

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

	// RecognitionFailureReason - The recognition failure reason causing to exit/disconnect
	RecognitionFailureReason *string `json:"recognitionFailureReason,omitempty"`

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

	// TransferTargetAddress - The address of a flow transfer target, e.g. a phone number, an email address, or a queueId
	TransferTargetAddress *string `json:"transferTargetAddress,omitempty"`

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

	// TransferType - The type of transfer for flows that ended with a transfer
	TransferType *string `json:"transferType,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 {
	// FlowOutcome - Combination of unique flow outcome identifier and its value separated by colon
	FlowOutcome *string `json:"flowOutcome,omitempty"`

	// FlowOutcomeEndTimestamp - The outcome ending timestamp in ISO 8601 format. This may be null if the outcome did not succeed.
	FlowOutcomeEndTimestamp *time.Time `json:"flowOutcomeEndTimestamp,omitempty"`

	// FlowOutcomeId - Unique identifier of a flow outcome
	FlowOutcomeId *string `json:"flowOutcomeId,omitempty"`

	// FlowOutcomeStartTimestamp - The outcome starting timestamp in ISO 8601 format
	FlowOutcomeStartTimestamp *time.Time `json:"flowOutcomeStartTimestamp,omitempty"`

	// FlowOutcomeValue - Flow outcome value, e.g. SUCCESS
	FlowOutcomeValue *string `json:"flowOutcomeValue,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 type(s) of the audio encodings used by the audio streams belonging to this endpoint
	Codecs *[]string `json:"codecs,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"`

	// EventTime - Specifies when an event 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"`

	// 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"`

	// MaxLatencyMs - The maximum latency experienced by any audio stream belonging to this endpoint, in milliseconds
	MaxLatencyMs *int `json:"maxLatencyMs,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"`

	// 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"`

	// 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"`

	// 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 {
	// 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"`

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

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

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

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

	// UserId - Unique identifier for the user
	UserId *string `json:"userId,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 {
	// 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"`

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

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

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

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

	// UserId - Unique identifier for the user
	UserId *string `json:"userId,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 {
	// 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"`

	// 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"`

	// 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 {
	// AgentRank - Proposed agent rank for this conversation from predictive routing (lower is better)
	AgentRank *int `json:"agentRank,omitempty"`

	// ProposedAgentId - Unique identifier for the agent that was proposed by predictive routing
	ProposedAgentId *string `json:"proposedAgentId,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 {
	// EventTime - Specifies when an event 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 - 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"`

	// NNextContactAvoided
	NNextContactAvoided *int `json:"nNextContactAvoided,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 {
	// AgentScore - Assigned agent score for this conversation (0 - 100, higher being better)
	AgentScore *int `json:"agentScore,omitempty"`

	// ScoredAgentId - Unique identifier for the agent that was scored for this conversation
	ScoredAgentId *string `json:"scoredAgentId,omitempty"`
}

Analyticsscoredagent

func (*Analyticsscoredagent) String ¶

func (o *Analyticsscoredagent) String() string

String returns a JSON representation of the model

type Analyticssession ¶

type Analyticssession struct {
	// ActiveSkillIds - ID(s) of Skill(s) that are active on the conversation
	ActiveSkillIds *[]string `json:"activeSkillIds,omitempty"`

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

	// AddressFrom - The address that initiated an action
	AddressFrom *string `json:"addressFrom,omitempty"`

	// AddressOther - The email address for the participant on the other side of the email conversation
	AddressOther *string `json:"addressOther,omitempty"`

	// AddressSelf - The email address for the participant on this side of the email conversation
	AddressSelf *string `json:"addressSelf,omitempty"`

	// AddressTo - The address receiving an action
	AddressTo *string `json:"addressTo,omitempty"`

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

	// AgentBullseyeRing - Bullseye ring of the targeted agent
	AgentBullseyeRing *int `json:"agentBullseyeRing,omitempty"`

	// AgentOwned - Flag indicating an agent-owned callback
	AgentOwned *bool `json:"agentOwned,omitempty"`

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

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

	// Authenticated - Flag that indicates that the identity of the customer has been asserted as verified by the provider.
	Authenticated *bool `json:"authenticated,omitempty"`

	// CallbackNumbers - Callback phone number(s)
	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"`

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

	// CobrowseRole - Describes 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"`

	// Direction - The direction of the communication
	Direction *string `json:"direction,omitempty"`

	// DispositionAnalyzer - (Dialer) Analyzer (for example speech.person)
	DispositionAnalyzer *string `json:"dispositionAnalyzer,omitempty"`

	// DispositionName - (Dialer) Result of the analysis (for example disposition.classification.callable.machine)
	DispositionName *string `json:"dispositionName,omitempty"`

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

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

	// FlowInType - Type of flow in that occurred when entering ACD.
	FlowInType *string `json:"flowInType,omitempty"`

	// FlowOutType - Type of flow out that occurred when emitting tFlowOut.
	FlowOutType *string `json:"flowOutType,omitempty"`

	// JourneyActionId - Identifier of the journey action.
	JourneyActionId *string `json:"journeyActionId,omitempty"`

	// JourneyActionMapId - Identifier of the journey action map that triggered the action.
	JourneyActionMapId *string `json:"journeyActionMapId,omitempty"`

	// JourneyActionMapVersion - Version of the journey action map that triggered the action.
	JourneyActionMapVersion *int `json:"journeyActionMapVersion,omitempty"`

	// JourneyCustomerId - Primary identifier of the journey customer in the source where the activities originate from.
	JourneyCustomerId *string `json:"journeyCustomerId,omitempty"`

	// JourneyCustomerIdType - Type of primary identifier of the journey customer (e.g. cookie).
	JourneyCustomerIdType *string `json:"journeyCustomerIdType,omitempty"`

	// JourneyCustomerSessionId - Unique identifier of the journey session.
	JourneyCustomerSessionId *string `json:"journeyCustomerSessionId,omitempty"`

	// JourneyCustomerSessionIdType - Type or category of journey sessions (e.g. web, ticket, delivery, atm).
	JourneyCustomerSessionIdType *string `json:"journeyCustomerSessionIdType,omitempty"`

	// MediaBridgeId - Media bridge ID for the conference session consistent across all participants
	MediaBridgeId *string `json:"mediaBridgeId,omitempty"`

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

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

	// MessageType - Message type for messaging services. E.g.: sms, facebook, twitter, line
	MessageType *string `json:"messageType,omitempty"`

	// MonitoredParticipantId - The participantId being monitored (if someone (e.g. an agent) is being monitored, this would be the ID of the participant that was monitored that would correspond to other participantIds present in the conversation)
	MonitoredParticipantId *string `json:"monitoredParticipantId,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"`

	// PeerId - This identifies pairs of related sessions on a conversation. E.g. an external session’s peerId will be the session that the call originally connected to, e.g. if an IVR was dialed, the IVR session, which will also have the external session’s ID as its peer. After that point, any transfers of that session to other internal components (acd, agent, etc.) will all spawn new sessions whose peerIds point back to that original external session.
	PeerId *string `json:"peerId,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"`

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

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

	// RemoteNameDisplayable - Unique identifier for the remote party
	RemoteNameDisplayable *string `json:"remoteNameDisplayable,omitempty"`

	// RemovedSkillIds - ID(s) of Skill(s) that have been removed by bullseye routing
	RemovedSkillIds *[]string `json:"removedSkillIds,omitempty"`

	// RequestedRoutings - Routing type(s) for requested/attempted routing methods.
	RequestedRoutings *[]string `json:"requestedRoutings,omitempty"`

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

	// RoutingRing - Routing ring for bullseye or preferred agent routing
	RoutingRing *int `json:"routingRing,omitempty"`

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

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

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

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

	// SelectedAgentRank - Selected agent GPR rank
	SelectedAgentRank *int `json:"selectedAgentRank,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"`

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

	// SharingScreen - Flag determining if screenShare is started or not (true/false)
	SharingScreen *bool `json:"sharingScreen,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"`

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

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

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

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

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

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

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

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

Analyticssession

func (*Analyticssession) String ¶

func (o *Analyticssession) String() string

String returns a JSON representation of the model

type Analyticssessionmetric ¶

type Analyticssessionmetric struct {
	// 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"`

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

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

Analyticssessionmetric

func (*Analyticssessionmetric) String ¶

func (o *Analyticssessionmetric) String() string

String returns a JSON representation of the model

type Analyticssurvey ¶

type Analyticssurvey struct {
	// EventTime - Specifies when an event 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 - The ID of the associated queue
	QueueId *string `json:"queueId,omitempty"`

	// SurveyCompletedDate - Completion datetime of the survey in ISO 8601 format
	SurveyCompletedDate *time.Time `json:"surveyCompletedDate,omitempty"`

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

	// SurveyFormId - ID of the survey form used
	SurveyFormId *string `json:"surveyFormId,omitempty"`

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

	// SurveyId - ID of the survey
	SurveyId *string `json:"surveyId,omitempty"`

	// SurveyPromoterScore - Score of the survey used with NPS
	SurveyPromoterScore *int `json:"surveyPromoterScore,omitempty"`

	// SurveyStatus - The status of the survey
	SurveyStatus *string `json:"surveyStatus,omitempty"`

	// UserId - ID of the agent the survey was performed against
	UserId *string `json:"userId,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"`

	// TotalHits
	TotalHits *int `json:"totalHits,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"`

	// 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, divisionId []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, divisionId []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) (*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) (*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, divisionId []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, divisionId []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) GetFlowsMilestonesDivisionviews ¶

func (a ArchitectApi) GetFlowsMilestonesDivisionviews(pageNumber int, pageSize int, sortBy string, sortOrder string, id []string, name string, divisionId []string) (*Flowmilestonedivisionviewentitylisting, *APIResponse, error)

GetFlowsMilestonesDivisionviews invokes GET /api/v2/flows/milestones/divisionviews

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

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

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, divisionId []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) GetFlowsOutcomesDivisionviews ¶

func (a ArchitectApi) GetFlowsOutcomesDivisionviews(pageNumber int, pageSize int, sortBy string, sortOrder string, id []string, name string, divisionId []string) (*Flowoutcomedivisionviewentitylisting, *APIResponse, error)

GetFlowsOutcomesDivisionviews invokes GET /api/v2/flows/outcomes/divisionviews

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

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

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) PostFlowHistory ¶

func (a ArchitectApi) PostFlowHistory(flowId string) (*Operation, *APIResponse, error)

PostFlowHistory invokes POST /api/v2/flows/{flowId}/history

Generate flow history ¶

Asynchronous. Notification topic: v2.flows.{flowId}

func (ArchitectApi) PostFlowVersions ¶

func (a ArchitectApi) PostFlowVersions(flowId string, body interface{}) (*Flowversion, *APIResponse, error)

PostFlowVersions invokes POST /api/v2/flows/{flowId}/versions

Create flow version

func (ArchitectApi) PostFlows ¶

func (a ArchitectApi) PostFlows(body Flow, language string) (*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 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 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"`

	// ValueNode
	ValueNode *bool `json:"valueNode,omitempty"`

	// ContainerNode
	ContainerNode *bool `json:"containerNode,omitempty"`

	// FloatingPointNumber
	FloatingPointNumber *bool `json:"floatingPointNumber,omitempty"`

	// MissingNode
	MissingNode *bool `json:"missingNode,omitempty"`

	// Object
	Object *bool `json:"object,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"`

	// Boolean
	Boolean *bool `json:"boolean,omitempty"`

	// Binary
	Binary *bool `json:"binary,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 Articlecontent ¶

type Articlecontent struct {
	// Body - Body of the article content.
	Body *Articlecontentbody `json:"body,omitempty"`
}

Articlecontent

func (*Articlecontent) String ¶

func (o *Articlecontent) String() string

String returns a JSON representation of the model

type Articlecontentbody ¶

type Articlecontentbody struct {
	// LocationUrl - Presigned URL to retrieve the document content.
	LocationUrl *string `json:"locationUrl,omitempty"`
}

Articlecontentbody

func (*Articlecontentbody) String ¶

func (o *Articlecontentbody) String() string

String returns a JSON representation of the model

type Asgscalerequest ¶

type Asgscalerequest struct {
	// DesiredCapacity - The desired capacity of the ASG
	DesiredCapacity *int `json:"desiredCapacity,omitempty"`

	// MinimumCapacity - The minimum capacity of the ASG
	MinimumCapacity *int `json:"minimumCapacity,omitempty"`
}

Asgscalerequest

func (*Asgscalerequest) String ¶

func (o *Asgscalerequest) String() string

String returns a JSON representation of the model

type Assessmentform ¶

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

	// DateModified - Last modified date of the assessment form. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// ContextId - The unique Id for all versions of this assessment form
	ContextId *string `json:"contextId,omitempty"`

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

	// Published - If true, assessment form is published
	Published *bool `json:"published,omitempty"`

	// PassPercent - The pass percent for the assessment form
	PassPercent *int `json:"passPercent,omitempty"`

	// QuestionGroups - A list of question groups
	QuestionGroups *[]Assessmentformquestiongroup `json:"questionGroups,omitempty"`
}

Assessmentform

func (*Assessmentform) String ¶

func (o *Assessmentform) String() string

String returns a JSON representation of the model

type Assessmentformquestion ¶

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

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

	// Text - The question text
	Text *string `json:"text,omitempty"`

	// HelpText
	HelpText *string `json:"helpText,omitempty"`

	// NaEnabled
	NaEnabled *bool `json:"naEnabled,omitempty"`

	// CommentsRequired
	CommentsRequired *bool `json:"commentsRequired,omitempty"`

	// VisibilityCondition
	VisibilityCondition *Visibilitycondition `json:"visibilityCondition,omitempty"`

	// AnswerOptions - Options from which to choose an answer for this question. Only used by Multiple Choice type questions.
	AnswerOptions *[]Answeroption `json:"answerOptions,omitempty"`

	// MaxResponseCharacters - How many characters are allowed in the text response to this question. Used by Free Text question types.
	MaxResponseCharacters *int `json:"maxResponseCharacters,omitempty"`

	// IsKill - Does an incorrect answer to this question mark the form as having a failed kill question. Only used by Multiple Choice type questions.
	IsKill *bool `json:"isKill,omitempty"`

	// IsCritical - Does this question contribute to the critical score. Only used by Multiple Choice type questions.
	IsCritical *bool `json:"isCritical,omitempty"`
}

Assessmentformquestion

func (*Assessmentformquestion) String ¶

func (o *Assessmentformquestion) String() string

String returns a JSON representation of the model

type Assessmentformquestiongroup ¶

type Assessmentformquestiongroup struct {
	// Id - The ID of the question group,
	Id *string `json:"id,omitempty"`

	// Name - The question group name
	Name *string `json:"name,omitempty"`

	// VarType - The question group type
	VarType *string `json:"type,omitempty"`

	// DefaultAnswersToHighest
	DefaultAnswersToHighest *bool `json:"defaultAnswersToHighest,omitempty"`

	// DefaultAnswersToNA
	DefaultAnswersToNA *bool `json:"defaultAnswersToNA,omitempty"`

	// NaEnabled
	NaEnabled *bool `json:"naEnabled,omitempty"`

	// Weight
	Weight *float32 `json:"weight,omitempty"`

	// ManualWeight
	ManualWeight *bool `json:"manualWeight,omitempty"`

	// Questions - The list of questions for this question group
	Questions *[]Assessmentformquestion `json:"questions,omitempty"`

	// VisibilityCondition
	VisibilityCondition *Visibilitycondition `json:"visibilityCondition,omitempty"`

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

Assessmentformquestiongroup

func (*Assessmentformquestiongroup) String ¶

func (o *Assessmentformquestiongroup) String() string

String returns a JSON representation of the model

type Assessmentjoblisting ¶

type Assessmentjoblisting struct {
	// Total
	Total *int `json:"total,omitempty"`

	// Entities
	Entities *[]Benefitassessmentjob `json:"entities,omitempty"`

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

Assessmentjoblisting

func (*Assessmentjoblisting) String ¶

func (o *Assessmentjoblisting) String() string

String returns a JSON representation of the model

type Assessmentlisting ¶

type Assessmentlisting struct {
	// Entities
	Entities *[]Benefitassessment `json:"entities,omitempty"`

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

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

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

Assessmentlisting

func (*Assessmentlisting) String ¶

func (o *Assessmentlisting) String() string

String returns a JSON representation of the model

type Assessmentquestiongroupscore ¶

type Assessmentquestiongroupscore struct {
	// QuestionGroupId - The ID of the question group
	QuestionGroupId *string `json:"questionGroupId,omitempty"`

	// TotalScore - The total score for the questions
	TotalScore *float32 `json:"totalScore,omitempty"`

	// MaxTotalScore - The maximum total score for the questions
	MaxTotalScore *float32 `json:"maxTotalScore,omitempty"`

	// MarkedNA - True if this question group is marked NA
	MarkedNA *bool `json:"markedNA,omitempty"`

	// TotalCriticalScore - The total score for the critical questions
	TotalCriticalScore *float32 `json:"totalCriticalScore,omitempty"`

	// MaxTotalCriticalScore - The maximum total score for the critical questions
	MaxTotalCriticalScore *float32 `json:"maxTotalCriticalScore,omitempty"`

	// TotalNonCriticalScore - The total score for the non-critical questions
	TotalNonCriticalScore *float32 `json:"totalNonCriticalScore,omitempty"`

	// MaxTotalNonCriticalScore - The maximum total score for the non-critical questions
	MaxTotalNonCriticalScore *float32 `json:"maxTotalNonCriticalScore,omitempty"`

	// TotalScoreUnweighted - The unweighted total score for this question group
	TotalScoreUnweighted *float32 `json:"totalScoreUnweighted,omitempty"`

	// MaxTotalScoreUnweighted - The maximum unweighted total score for this question group
	MaxTotalScoreUnweighted *float32 `json:"maxTotalScoreUnweighted,omitempty"`

	// TotalCriticalScoreUnweighted - The unweighted total score for the critical questions
	TotalCriticalScoreUnweighted *float32 `json:"totalCriticalScoreUnweighted,omitempty"`

	// MaxTotalCriticalScoreUnweighted - The maximum unweighted total score for the critical questions
	MaxTotalCriticalScoreUnweighted *float32 `json:"maxTotalCriticalScoreUnweighted,omitempty"`

	// TotalNonCriticalScoreUnweighted - The total unweighted score for the non-critical questions
	TotalNonCriticalScoreUnweighted *float32 `json:"totalNonCriticalScoreUnweighted,omitempty"`

	// MaxTotalNonCriticalScoreUnweighted - The maximum unweighted total score for the non-critical questions
	MaxTotalNonCriticalScoreUnweighted *float32 `json:"maxTotalNonCriticalScoreUnweighted,omitempty"`

	// QuestionScores - The individual question scores
	QuestionScores *[]Assessmentquestionscore `json:"questionScores,omitempty"`
}

Assessmentquestiongroupscore

func (*Assessmentquestiongroupscore) String ¶

String returns a JSON representation of the model

type Assessmentquestionscore ¶

type Assessmentquestionscore struct {
	// FailedKillQuestion - True if this was a failed Kill question
	FailedKillQuestion *bool `json:"failedKillQuestion,omitempty"`

	// Comments - Comments provided for the answer
	Comments *string `json:"comments,omitempty"`

	// QuestionId - The ID of the question
	QuestionId *string `json:"questionId,omitempty"`

	// AnswerId - The ID of the selected answer
	AnswerId *string `json:"answerId,omitempty"`

	// Score - The score received for this question
	Score *int `json:"score,omitempty"`

	// MarkedNA - True if this question was marked as NA
	MarkedNA *bool `json:"markedNA,omitempty"`

	// FreeTextAnswer - Answer for free text answer type
	FreeTextAnswer *string `json:"freeTextAnswer,omitempty"`
}

Assessmentquestionscore

func (*Assessmentquestionscore) String ¶

func (o *Assessmentquestionscore) String() string

String returns a JSON representation of the model

type Assessmentscoringset ¶

type Assessmentscoringset struct {
	// TotalScore - The total score of the answers
	TotalScore *float32 `json:"totalScore,omitempty"`

	// TotalCriticalScore - The total score for the critical questions
	TotalCriticalScore *float32 `json:"totalCriticalScore,omitempty"`

	// TotalNonCriticalScore - The total score for the non-critical questions
	TotalNonCriticalScore *float32 `json:"totalNonCriticalScore,omitempty"`

	// QuestionGroupScores - The individual scores for each question group
	QuestionGroupScores *[]Assessmentquestiongroupscore `json:"questionGroupScores,omitempty"`

	// FailureReasons - If the assessment was not passed, the reasons for failure.
	FailureReasons *[]string `json:"failureReasons,omitempty"`

	// Comments - Comments provided for these answers.
	Comments *string `json:"comments,omitempty"`

	// AgentComments - Comments provided by agent.
	AgentComments *string `json:"agentComments,omitempty"`

	// IsPassed - True if the assessment was passed
	IsPassed *bool `json:"isPassed,omitempty"`
}

Assessmentscoringset

func (*Assessmentscoringset) String ¶

func (o *Assessmentscoringset) 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"`

	// 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 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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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 Attendancestatus ¶

type Attendancestatus struct {
	// DateWorkday - the workday date of this attendance status. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateWorkday *time.Time `json:"dateWorkday,omitempty"`

	// AttendanceStatusType - the attendance status
	AttendanceStatusType *string `json:"attendanceStatusType,omitempty"`
}

Attendancestatus

func (*Attendancestatus) String ¶

func (o *Attendancestatus) String() string

String returns a JSON representation of the model

type Attendancestatuslisting ¶

type Attendancestatuslisting struct {
	// Entities
	Entities *[]Attendancestatus `json:"entities,omitempty"`
}

Attendancestatuslisting

func (*Attendancestatuslisting) String ¶

func (o *Attendancestatuslisting) 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 Audittopicaddressableentityref ¶

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

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

Audittopicaddressableentityref

func (*Audittopicaddressableentityref) String ¶

String returns a JSON representation of the model

type Audittopicauditlogmessage ¶

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

	// UserId
	UserId *string `json:"userId,omitempty"`

	// UserHomeOrgId
	UserHomeOrgId *string `json:"userHomeOrgId,omitempty"`

	// Username
	Username *Audittopicdomainentityref `json:"username,omitempty"`

	// UserDisplay
	UserDisplay *string `json:"userDisplay,omitempty"`

	// ClientId
	ClientId *Audittopicaddressableentityref `json:"clientId,omitempty"`

	// RemoteIp
	RemoteIp *[]string `json:"remoteIp,omitempty"`

	// ServiceName
	ServiceName *string `json:"serviceName,omitempty"`

	// EventTime
	EventTime *time.Time `json:"eventTime,omitempty"`

	// Message
	Message *Audittopicmessageinfo `json:"message,omitempty"`

	// Action
	Action *string `json:"action,omitempty"`

	// EntityType
	EntityType *string `json:"entityType,omitempty"`

	// Entity
	Entity *Audittopicdomainentityref `json:"entity,omitempty"`

	// PropertyChanges
	PropertyChanges *[]Audittopicpropertychange `json:"propertyChanges,omitempty"`

	// Context
	Context *map[string]string `json:"context,omitempty"`
}

Audittopicauditlogmessage

func (*Audittopicauditlogmessage) String ¶

func (o *Audittopicauditlogmessage) String() string

String returns a JSON representation of the model

type Audittopicdomainentityref ¶

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

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

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

Audittopicdomainentityref

func (*Audittopicdomainentityref) String ¶

func (o *Audittopicdomainentityref) String() string

String returns a JSON representation of the model

type Audittopicmessageinfo ¶

type Audittopicmessageinfo struct {
	// LocalizableMessageCode
	LocalizableMessageCode *string `json:"localizableMessageCode,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`
}

Audittopicmessageinfo

func (*Audittopicmessageinfo) String ¶

func (o *Audittopicmessageinfo) String() string

String returns a JSON representation of the model

type Audittopicpropertychange ¶

type Audittopicpropertychange struct {
	// Property
	Property *string `json:"property,omitempty"`

	// OldValues
	OldValues *[]string `json:"oldValues,omitempty"`

	// NewValues
	NewValues *[]string `json:"newValues,omitempty"`
}

Audittopicpropertychange

func (*Audittopicpropertychange) String ¶

func (o *Audittopicpropertychange) 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, DATATABLES 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) PostAuthorizationDivisionRestore ¶

func (a AuthorizationApi) PostAuthorizationDivisionRestore(divisionId string, body Authzdivision) (*Authzdivision, *APIResponse, error)

PostAuthorizationDivisionRestore invokes POST /api/v2/authorization/divisions/{divisionId}/restore

Recreate a previously deleted division.

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) PostAuthorizationSubjectBulkreplace ¶

func (a AuthorizationApi) PostAuthorizationSubjectBulkreplace(subjectId string, body Roledivisiongrants, subjectType string) (*APIResponse, error)

PostAuthorizationSubjectBulkreplace invokes POST /api/v2/authorization/subjects/{subjectId}/bulkreplace

Replace subject's roles and divisions with the exact list supplied in the request.

This operation will not remove grants that are inherited from group membership. It will only set the grants directly applied to the 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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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 Availabletime ¶

type Availabletime struct {
	// DateStart - Start of the availability period. 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 - Length of availability period in minutes
	LengthInMinutes *int `json:"lengthInMinutes,omitempty"`

	// IsPaid - Indicates if this availability period is paid in Workforce Management schedule
	IsPaid *bool `json:"isPaid,omitempty"`

	// ActivityCategory - Workforce Management activity category for this availability period
	ActivityCategory *string `json:"activityCategory,omitempty"`

	// WfmSchedule - Workforce Management schedule information associated with the available time
	WfmSchedule *Wfmschedulereference `json:"wfmSchedule,omitempty"`
}

Availabletime

func (*Availabletime) String ¶

func (o *Availabletime) 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"`

	// PermissionDetails - Full detailed permissions required to subscribe to the topic
	PermissionDetails *[]Permissiondetails `json:"permissionDetails,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 Baseprogramentity ¶

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

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

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

Baseprogramentity

func (*Baseprogramentity) String ¶

func (o *Baseprogramentity) String() string

String returns a JSON representation of the model

type Basetopicentitiy ¶

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

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

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

Basetopicentitiy

func (*Basetopicentitiy) String ¶

func (o *Basetopicentitiy) 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 Benefitassessment ¶

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

	// Queues - The list of queues that are assessed for Predictive Routing benefit.
	Queues *[]Addressableentityref `json:"queues,omitempty"`

	// KpiAssessments - A set of key performance indicators applied on the queue to determine suitability of Predictive Routing.
	KpiAssessments *[]Keyperformanceindicatorassessment `json:"kpiAssessments,omitempty"`

	// State - State of the benefit assessment.
	State *string `json:"state,omitempty"`

	// DateCreated - Creation Date of the benefit assessment. 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 - Modified Date of the benefit assessment. 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"`
}

Benefitassessment

func (*Benefitassessment) String ¶

func (o *Benefitassessment) String() string

String returns a JSON representation of the model

type Benefitassessmentjob ¶

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

	// State - State of the benefit assessment job.
	State *string `json:"state,omitempty"`

	// DateCreated - Creation Date of the benefit assessment job. 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 - Modified Date of the benefit assessment job. 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"`
}

Benefitassessmentjob

func (*Benefitassessmentjob) String ¶

func (o *Benefitassessmentjob) 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 Botaggregatedatacontainer ¶

type Botaggregatedatacontainer struct {
	// Group - A mapping from dimension to value
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Statisticalresponse `json:"data,omitempty"`
}

Botaggregatedatacontainer

func (*Botaggregatedatacontainer) String ¶

func (o *Botaggregatedatacontainer) String() string

String returns a JSON representation of the model

type Botaggregatequeryclause ¶

type Botaggregatequeryclause 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 *[]Botaggregatequerypredicate `json:"predicates,omitempty"`
}

Botaggregatequeryclause

func (*Botaggregatequeryclause) String ¶

func (o *Botaggregatequeryclause) String() string

String returns a JSON representation of the model

type Botaggregatequeryfilter ¶

type Botaggregatequeryfilter 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 *[]Botaggregatequeryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Botaggregatequerypredicate `json:"predicates,omitempty"`
}

Botaggregatequeryfilter

func (*Botaggregatequeryfilter) String ¶

func (o *Botaggregatequeryfilter) String() string

String returns a JSON representation of the model

type Botaggregatequerypredicate ¶

type Botaggregatequerypredicate 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"`
}

Botaggregatequerypredicate

func (*Botaggregatequerypredicate) String ¶

func (o *Botaggregatequerypredicate) String() string

String returns a JSON representation of the model

type Botaggregatequeryresponse ¶

type Botaggregatequeryresponse struct {
	// Results
	Results *[]Botaggregatedatacontainer `json:"results,omitempty"`
}

Botaggregatequeryresponse

func (*Botaggregatequeryresponse) String ¶

func (o *Botaggregatequeryresponse) String() string

String returns a JSON representation of the model

type Botaggregationquery ¶

type Botaggregationquery 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 *Botaggregatequeryfilter `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 *[]Botaggregationview `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"`
}

Botaggregationquery

func (*Botaggregationquery) String ¶

func (o *Botaggregationquery) String() string

String returns a JSON representation of the model

type Botaggregationview ¶

type Botaggregationview 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"`
}

Botaggregationview

func (*Botaggregationview) String ¶

func (o *Botaggregationview) 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"`

	// ForecastType - The forecasting type in this forecast result
	ForecastType *string `json:"forecastType,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 Bulkcontactsrequest ¶

type Bulkcontactsrequest struct {
	// Entities
	Entities *[]Externalcontact `json:"entities,omitempty"`
}

Bulkcontactsrequest

func (*Bulkcontactsrequest) String ¶

func (o *Bulkcontactsrequest) String() string

String returns a JSON representation of the model

type Bulkcontactsresponse ¶

type Bulkcontactsresponse struct {
	// Results
	Results *[]Bulkresponseresultexternalcontactexternalcontact `json:"results,omitempty"`

	// ErrorCount
	ErrorCount *int `json:"errorCount,omitempty"`

	// ErrorIndexes
	ErrorIndexes *[]int `json:"errorIndexes,omitempty"`
}

Bulkcontactsresponse

func (*Bulkcontactsresponse) String ¶

func (o *Bulkcontactsresponse) String() string

String returns a JSON representation of the model

type Bulkdeleteresponse ¶

type Bulkdeleteresponse struct {
	// Results
	Results *[]Bulkresponseresultvoidentity `json:"results,omitempty"`

	// ErrorCount
	ErrorCount *int `json:"errorCount,omitempty"`

	// ErrorIndexes
	ErrorIndexes *[]int `json:"errorIndexes,omitempty"`
}

Bulkdeleteresponse

func (*Bulkdeleteresponse) String ¶

func (o *Bulkdeleteresponse) String() string

String returns a JSON representation of the model

type Bulkerrordetail ¶

type Bulkerrordetail struct {
	// FieldName
	FieldName *string `json:"fieldName,omitempty"`

	// Value
	Value *string `json:"value,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`
}

Bulkerrordetail

func (*Bulkerrordetail) String ¶

func (o *Bulkerrordetail) String() string

String returns a JSON representation of the model

type Bulkerrorentity ¶

type Bulkerrorentity struct {
	// Code
	Code *string `json:"code,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// Retryable
	Retryable *bool `json:"retryable,omitempty"`

	// Entity
	Entity *Entity `json:"entity,omitempty"`

	// Details
	Details *[]Bulkerrordetail `json:"details,omitempty"`
}

Bulkerrorentity

func (*Bulkerrorentity) String ¶

func (o *Bulkerrorentity) String() string

String returns a JSON representation of the model

type Bulkerrorexternalcontact ¶

type Bulkerrorexternalcontact struct {
	// Code
	Code *string `json:"code,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// Retryable
	Retryable *bool `json:"retryable,omitempty"`

	// Entity
	Entity *Externalcontact `json:"entity,omitempty"`

	// Details
	Details *[]Bulkerrordetail `json:"details,omitempty"`
}

Bulkerrorexternalcontact

func (*Bulkerrorexternalcontact) String ¶

func (o *Bulkerrorexternalcontact) String() string

String returns a JSON representation of the model

type Bulkerrorexternalorganization ¶

type Bulkerrorexternalorganization struct {
	// Code
	Code *string `json:"code,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// Retryable
	Retryable *bool `json:"retryable,omitempty"`

	// Entity
	Entity *Externalorganization `json:"entity,omitempty"`

	// Details
	Details *[]Bulkerrordetail `json:"details,omitempty"`
}

Bulkerrorexternalorganization

func (*Bulkerrorexternalorganization) String ¶

String returns a JSON representation of the model

type Bulkerrornote ¶

type Bulkerrornote struct {
	// Code
	Code *string `json:"code,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// Retryable
	Retryable *bool `json:"retryable,omitempty"`

	// Entity
	Entity *Note `json:"entity,omitempty"`

	// Details
	Details *[]Bulkerrordetail `json:"details,omitempty"`
}

Bulkerrornote

func (*Bulkerrornote) String ¶

func (o *Bulkerrornote) String() string

String returns a JSON representation of the model

type Bulkerrorrelationship ¶

type Bulkerrorrelationship struct {
	// Code
	Code *string `json:"code,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// Retryable
	Retryable *bool `json:"retryable,omitempty"`

	// Entity
	Entity *Relationship `json:"entity,omitempty"`

	// Details
	Details *[]Bulkerrordetail `json:"details,omitempty"`
}

Bulkerrorrelationship

func (*Bulkerrorrelationship) String ¶

func (o *Bulkerrorrelationship) String() string

String returns a JSON representation of the model

type Bulkfetchcontactsresponse ¶

type Bulkfetchcontactsresponse struct {
	// Results
	Results *[]Bulkresponseresultexternalcontactentity `json:"results,omitempty"`

	// ErrorCount
	ErrorCount *int `json:"errorCount,omitempty"`

	// ErrorIndexes
	ErrorIndexes *[]int `json:"errorIndexes,omitempty"`
}

Bulkfetchcontactsresponse

func (*Bulkfetchcontactsresponse) String ¶

func (o *Bulkfetchcontactsresponse) String() string

String returns a JSON representation of the model

type Bulkfetchnotesresponse ¶

type Bulkfetchnotesresponse struct {
	// Results
	Results *[]Bulkresponseresultnoteentity `json:"results,omitempty"`

	// ErrorCount
	ErrorCount *int `json:"errorCount,omitempty"`

	// ErrorIndexes
	ErrorIndexes *[]int `json:"errorIndexes,omitempty"`
}

Bulkfetchnotesresponse

func (*Bulkfetchnotesresponse) String ¶

func (o *Bulkfetchnotesresponse) String() string

String returns a JSON representation of the model

type Bulkfetchorganizationsresponse ¶

type Bulkfetchorganizationsresponse struct {
	// Results
	Results *[]Bulkresponseresultexternalorganizationentity `json:"results,omitempty"`

	// ErrorCount
	ErrorCount *int `json:"errorCount,omitempty"`

	// ErrorIndexes
	ErrorIndexes *[]int `json:"errorIndexes,omitempty"`
}

Bulkfetchorganizationsresponse

func (*Bulkfetchorganizationsresponse) String ¶

String returns a JSON representation of the model

type Bulkfetchrelationshipsresponse ¶

type Bulkfetchrelationshipsresponse struct {
	// Results
	Results *[]Bulkresponseresultrelationshipentity `json:"results,omitempty"`

	// ErrorCount
	ErrorCount *int `json:"errorCount,omitempty"`

	// ErrorIndexes
	ErrorIndexes *[]int `json:"errorIndexes,omitempty"`
}

Bulkfetchrelationshipsresponse

func (*Bulkfetchrelationshipsresponse) String ¶

String returns a JSON representation of the model

type Bulkidsrequest ¶

type Bulkidsrequest struct {
	// Entities
	Entities *[]Entity `json:"entities,omitempty"`
}

Bulkidsrequest

func (*Bulkidsrequest) String ¶

func (o *Bulkidsrequest) String() string

String returns a JSON representation of the model

type Bulknotesrequest ¶

type Bulknotesrequest struct {
	// Entities
	Entities *[]Note `json:"entities,omitempty"`
}

Bulknotesrequest

func (*Bulknotesrequest) String ¶

func (o *Bulknotesrequest) String() string

String returns a JSON representation of the model

type Bulknotesresponse ¶

type Bulknotesresponse struct {
	// Results
	Results *[]Bulkresponseresultnotenote `json:"results,omitempty"`

	// ErrorCount
	ErrorCount *int `json:"errorCount,omitempty"`

	// ErrorIndexes
	ErrorIndexes *[]int `json:"errorIndexes,omitempty"`
}

Bulknotesresponse

func (*Bulknotesresponse) String ¶

func (o *Bulknotesresponse) String() string

String returns a JSON representation of the model

type Bulkorganizationsrequest ¶

type Bulkorganizationsrequest struct {
	// Entities
	Entities *[]Externalorganization `json:"entities,omitempty"`
}

Bulkorganizationsrequest

func (*Bulkorganizationsrequest) String ¶

func (o *Bulkorganizationsrequest) String() string

String returns a JSON representation of the model

type Bulkorganizationsresponse ¶

type Bulkorganizationsresponse struct {
	// Results
	Results *[]Bulkresponseresultexternalorganizationexternalorganization `json:"results,omitempty"`

	// ErrorCount
	ErrorCount *int `json:"errorCount,omitempty"`

	// ErrorIndexes
	ErrorIndexes *[]int `json:"errorIndexes,omitempty"`
}

Bulkorganizationsresponse

func (*Bulkorganizationsresponse) String ¶

func (o *Bulkorganizationsresponse) String() string

String returns a JSON representation of the model

type Bulkrelationshipsrequest ¶

type Bulkrelationshipsrequest struct {
	// Entities
	Entities *[]Relationship `json:"entities,omitempty"`
}

Bulkrelationshipsrequest

func (*Bulkrelationshipsrequest) String ¶

func (o *Bulkrelationshipsrequest) String() string

String returns a JSON representation of the model

type Bulkrelationshipsresponse ¶

type Bulkrelationshipsresponse struct {
	// Results
	Results *[]Bulkresponseresultrelationshiprelationship `json:"results,omitempty"`

	// ErrorCount
	ErrorCount *int `json:"errorCount,omitempty"`

	// ErrorIndexes
	ErrorIndexes *[]int `json:"errorIndexes,omitempty"`
}

Bulkrelationshipsresponse

func (*Bulkrelationshipsresponse) String ¶

func (o *Bulkrelationshipsresponse) String() string

String returns a JSON representation of the model

type Bulkresponseresultexternalcontactentity ¶

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

	// Success
	Success *bool `json:"success,omitempty"`

	// Entity
	Entity *Externalcontact `json:"entity,omitempty"`

	// VarError
	VarError *Bulkerrorentity `json:"error,omitempty"`
}

Bulkresponseresultexternalcontactentity

func (*Bulkresponseresultexternalcontactentity) String ¶

String returns a JSON representation of the model

type Bulkresponseresultexternalcontactexternalcontact ¶

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

	// Success
	Success *bool `json:"success,omitempty"`

	// Entity
	Entity *Externalcontact `json:"entity,omitempty"`

	// VarError
	VarError *Bulkerrorexternalcontact `json:"error,omitempty"`
}

Bulkresponseresultexternalcontactexternalcontact

func (*Bulkresponseresultexternalcontactexternalcontact) String ¶

String returns a JSON representation of the model

type Bulkresponseresultexternalorganizationentity ¶

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

	// Success
	Success *bool `json:"success,omitempty"`

	// Entity
	Entity *Externalorganization `json:"entity,omitempty"`

	// VarError
	VarError *Bulkerrorentity `json:"error,omitempty"`
}

Bulkresponseresultexternalorganizationentity

func (*Bulkresponseresultexternalorganizationentity) String ¶

String returns a JSON representation of the model

type Bulkresponseresultexternalorganizationexternalorganization ¶

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

	// Success
	Success *bool `json:"success,omitempty"`

	// Entity
	Entity *Externalorganization `json:"entity,omitempty"`

	// VarError
	VarError *Bulkerrorexternalorganization `json:"error,omitempty"`
}

Bulkresponseresultexternalorganizationexternalorganization

func (*Bulkresponseresultexternalorganizationexternalorganization) String ¶

String returns a JSON representation of the model

type Bulkresponseresultnoteentity ¶

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

	// Success
	Success *bool `json:"success,omitempty"`

	// Entity
	Entity *Note `json:"entity,omitempty"`

	// VarError
	VarError *Bulkerrorentity `json:"error,omitempty"`
}

Bulkresponseresultnoteentity

func (*Bulkresponseresultnoteentity) String ¶

String returns a JSON representation of the model

type Bulkresponseresultnotenote ¶

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

	// Success
	Success *bool `json:"success,omitempty"`

	// Entity
	Entity *Note `json:"entity,omitempty"`

	// VarError
	VarError *Bulkerrornote `json:"error,omitempty"`
}

Bulkresponseresultnotenote

func (*Bulkresponseresultnotenote) String ¶

func (o *Bulkresponseresultnotenote) String() string

String returns a JSON representation of the model

type Bulkresponseresultrelationshipentity ¶

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

	// Success
	Success *bool `json:"success,omitempty"`

	// Entity
	Entity *Relationship `json:"entity,omitempty"`

	// VarError
	VarError *Bulkerrorentity `json:"error,omitempty"`
}

Bulkresponseresultrelationshipentity

func (*Bulkresponseresultrelationshipentity) String ¶

String returns a JSON representation of the model

type Bulkresponseresultrelationshiprelationship ¶

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

	// Success
	Success *bool `json:"success,omitempty"`

	// Entity
	Entity *Relationship `json:"entity,omitempty"`

	// VarError
	VarError *Bulkerrorrelationship `json:"error,omitempty"`
}

Bulkresponseresultrelationshiprelationship

func (*Bulkresponseresultrelationshiprelationship) String ¶

String returns a JSON representation of the model

type Bulkresponseresultvoidentity ¶

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

	// Success
	Success *bool `json:"success,omitempty"`

	// Entity
	Entity *Void `json:"entity,omitempty"`

	// VarError
	VarError *Bulkerrorentity `json:"error,omitempty"`
}

Bulkresponseresultvoidentity

func (*Bulkresponseresultvoidentity) 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.
	UserIds *[]string `json:"userIds,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"`

	// CanUseForScheduling - Whether this forecast can be used for scheduling
	CanUseForScheduling *bool `json:"canUseForScheduling,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"`

	// CanUseForScheduling - Whether this forecast can be used for scheduling
	CanUseForScheduling *bool `json:"canUseForScheduling,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"`

	// Settings - Settings for this business unit
	Settings *Businessunitsettings `json:"settings,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Divisionreference `json:"division,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"`

	// Authorized - Whether the user has authorization to interact with this business unit
	Authorized *bool `json:"authorized,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Divisionreference `json:"division,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 - The ID of 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 - The button actions.
	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 Buttonresponse ¶

type Buttonresponse struct {
	// VarType - Button response type that captures Button and QuickReply type responses
	VarType *string `json:"type,omitempty"`

	// Text - Text to show inside the Button reply. This is also used as the response text after clicking on the Button.
	Text *string `json:"text,omitempty"`

	// Payload - Content of the textback payload after clicking a button
	Payload *string `json:"payload,omitempty"`
}

Buttonresponse

func (*Buttonresponse) String ¶

func (o *Buttonresponse) 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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

	// CallerId - The phone number displayed to recipients of the phone call. The value should conform to the E164 format.
	CallerId *string `json:"callerId,omitempty"`

	// CallerIdName - The name displayed to recipients of the phone call.
	CallerIdName *string `json:"callerIdName,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"`

	// CallerId - The phone number displayed to recipients of the phone call. The value should conform to the E164 format.
	CallerId *string `json:"callerId,omitempty"`

	// CallerIdName - The name displayed to recipients of the phone call.
	CallerIdName *string `json:"callerIdName,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

	// Valid
	Valid *bool `json:"valid,omitempty"`

	// SignatureValid
	SignatureValid *bool `json:"signatureValid,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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 Check ¶

type Check struct {
	// Result - The result of a check executed. This indicates if the check was successful or not.
	Result *string `json:"result,omitempty"`

	// VarType - The type of check executed.
	VarType *string `json:"type,omitempty"`
}

Check

func (*Check) String ¶

func (o *Check) 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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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

func (CoachingApi) PostCoachingScheduleslotsQuery ¶

func (a CoachingApi) PostCoachingScheduleslotsQuery(body Coachingslotsrequest) (*Coachingslotsresponse, *APIResponse, error)

PostCoachingScheduleslotsQuery invokes POST /api/v2/coaching/scheduleslots/query

Get list of possible slots where a coaching appointment can be scheduled.

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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

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

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

Coachingappointmentresponselist

func (*Coachingappointmentresponselist) 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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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 Coachingslot ¶

type Coachingslot struct {
	// DateStart - Start date and time of scheduled coaching appointment slot. 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 - Length of coaching appointment slot in minutes
	LengthInMinutes *int `json:"lengthInMinutes,omitempty"`

	// StaffingDifference - Difference between scheduled and forecast headcount for this slot after scheduling the coaching appointment
	StaffingDifference *float64 `json:"staffingDifference,omitempty"`

	// DifferenceRating - Rating based on the staffing difference for scheduled slot
	DifferenceRating *string `json:"differenceRating,omitempty"`

	// WfmSchedule - Workforce Management schedule information associated with the slot
	WfmSchedule *Wfmschedulereference `json:"wfmSchedule,omitempty"`
}

Coachingslot

func (*Coachingslot) String ¶

func (o *Coachingslot) String() string

String returns a JSON representation of the model

type Coachingslotsrequest ¶

type Coachingslotsrequest struct {
	// Interval - Range of time to get slots for scheduling coaching appointments. 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"`

	// LengthInMinutes - The duration of coaching appointment to schedule in 15 minutes granularity up to maximum of 60 minutes
	LengthInMinutes *int `json:"lengthInMinutes,omitempty"`

	// AttendeeIds - List of attendees to determine coaching appointment slots
	AttendeeIds *[]string `json:"attendeeIds,omitempty"`

	// FacilitatorIds - List of facilitators to determine coaching appointment slots
	FacilitatorIds *[]string `json:"facilitatorIds,omitempty"`
}

Coachingslotsrequest

func (*Coachingslotsrequest) String ¶

func (o *Coachingslotsrequest) String() string

String returns a JSON representation of the model

type Coachingslotsresponse ¶

type Coachingslotsresponse struct {
	// SuggestedSlots - List of slots where coaching appointment can be scheduled
	SuggestedSlots *[]Coachingslot `json:"suggestedSlots,omitempty"`

	// AttendeeSchedules - Periods of availability for attendees to schedule coaching appointment
	AttendeeSchedules *[]Useravailabletimes `json:"attendeeSchedules,omitempty"`

	// FacilitatorSchedules - Periods of availability for facilitators to schedule coaching appointment
	FacilitatorSchedules *[]Useravailabletimes `json:"facilitatorSchedules,omitempty"`
}

Coachingslotsresponse

func (*Coachingslotsresponse) String ¶

func (o *Coachingslotsresponse) 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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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 Comparisonperiod ¶

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

	// Kpi - Key Performance Indicator optimised during the comparison period.
	Kpi *string `json:"kpi,omitempty"`

	// DateStarted - Start date of the comparison period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateStarted *time.Time `json:"dateStarted,omitempty"`

	// DateEnded - End date of the comparison period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateEnded *time.Time `json:"dateEnded,omitempty"`

	// KpiTotalOn - Absolute metric (in which the KPI is based) total for the interactions handled by predictive routing (GPR was on)
	KpiTotalOn *int `json:"kpiTotalOn,omitempty"`

	// KpiTotalOff - Absolute metric (in which the KPI is based) total for the interactions not routed by predictive routing (GPR was off)
	KpiTotalOff *int `json:"kpiTotalOff,omitempty"`

	// InteractionCountOn - Total interactions handled by predictive routing (GPR was on)
	InteractionCountOn *int `json:"interactionCountOn,omitempty"`

	// InteractionCountOff - Total interactions not routed by predictive routing (GPR was off)
	InteractionCountOff *int `json:"interactionCountOff,omitempty"`

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

Comparisonperiod

func (*Comparisonperiod) String ¶

func (o *Comparisonperiod) String() string

String returns a JSON representation of the model

type Comparisonperiodlisting ¶

type Comparisonperiodlisting struct {
	// Total
	Total *int `json:"total,omitempty"`

	// Entities
	Entities *[]Comparisonperiod `json:"entities,omitempty"`

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

Comparisonperiodlisting

func (*Comparisonperiodlisting) String ¶

func (o *Comparisonperiodlisting) 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"`
	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"`
	RetryConfiguration       *RetryConfiguration   `json:"retryConfiguration,omitempty"`
	LoggingConfiguration     *LoggingConfiguration `json:"loggingConfiguration,omitempty"`
	ConfigFilePath           string                `json:"configFilePath,omitempty"`
	AutoReloadConfig         bool                  `json:"autoReloadConfig,omitempty"`
}

Configuration has settings to configure the SDK

func GetDefaultConfiguration ¶

func GetDefaultConfiguration() *Configuration

GetDefaultConfiguration returns the shared default Configuration instance

func GetDefaultConfigurationWithConfigFile ¶

func GetDefaultConfigurationWithConfigFile(filePath string, autoReload bool) *Configuration

GetDefaultConfigurationWithConfigFile returns the shared default Configuration instance with overrides provided by a config file

func NewConfiguration ¶

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration instance

func NewConfigurationWithConfigFile ¶

func NewConfigurationWithConfigFile(filePath string, autoReload bool) *Configuration

NewConfigurationWithConfigFile returns a new Configuration instance with overrides provided by a config file

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) GetAPIKeyWithPrefix ¶

func (c *Configuration) GetAPIKeyWithPrefix(APIKeyIdentifier string) string

GetAPIKeyWithPrefix appends a prefix to the API key

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.

type Configurationoverrides ¶

type Configurationoverrides struct {
	// Priority - Indicates whether or not the contact will be placed in front of the queue or at the end of the queue.
	Priority *bool `json:"priority,omitempty"`
}

Configurationoverrides

func (*Configurationoverrides) String ¶

func (o *Configurationoverrides) String() string

String returns a JSON representation of the model

type Connectededge ¶

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

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

	// InterfaceName - Edge interface name used for the connection
	InterfaceName *string `json:"interfaceName,omitempty"`

	// InterfaceIpAddress - Edge interface IP address
	InterfaceIpAddress *string `json:"interfaceIpAddress,omitempty"`

	// EdgeConnectionList
	EdgeConnectionList *[]Edgeconnectioninfo `json:"edgeConnectionList,omitempty"`

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

Connectededge

func (*Connectededge) String ¶

func (o *Connectededge) String() string

String returns a JSON representation of the model

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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

	// Integration - Integration tag value if this number is associated with an external integration.
	Integration *string `json:"integration,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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 *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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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 *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"`

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

	// LastUri
	LastUri *string `json:"lastUri,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 of a web page to direct the user to.
	Url *string `json:"url,omitempty"`

	// UrlTarget - The target window in which to open the URL. If empty will open a blank page or tab.
	UrlTarget *string `json:"urlTarget,omitempty"`

	// Textback - Text to be sent back in reply when the 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 - Provider specific ID for attachment. For example, a LINE sticker ID.
	Id *string `json:"id,omitempty"`

	// MediaType - The type of attachment this instance represents.
	MediaType *string `json:"mediaType,omitempty"`

	// Url - URL of the attachment.
	Url *string `json:"url,omitempty"`

	// Mime - Attachment mime type (https://www.iana.org/assignments/media-types/media-types.xhtml).
	Mime *string `json:"mime,omitempty"`

	// Text - Text associated with attachment such as an image caption.
	Text *string `json:"text,omitempty"`

	// Sha256 - Secure hash of the attachment content.
	Sha256 *string `json:"sha256,omitempty"`

	// Filename - Suggested file name for attachment.
	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 Contentbuttonresponse ¶

type Contentbuttonresponse struct {
	// Id - An ID assigned to the button response (Deprecated).
	Id *string `json:"id,omitempty"`

	// VarType - Describes the button that resulted in the Button Response.
	VarType *string `json:"type,omitempty"`

	// Text - The response text from the button click.
	Text *string `json:"text,omitempty"`

	// Payload - The response payload associated with the clicked button.
	Payload *string `json:"payload,omitempty"`
}

Contentbuttonresponse - Button response object representing the click of a structured message button, such as a quick reply.

func (*Contentbuttonresponse) String ¶

func (o *Contentbuttonresponse) 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 - A unique ID assigned to this rich message content.
	Id *string `json:"id,omitempty"`

	// Title - Text to show in the title.
	Title *string `json:"title,omitempty"`

	// Description - Text to show in the description.
	Description *string `json:"description,omitempty"`

	// Image - URL of an image.
	Image *string `json:"image,omitempty"`

	// Video - URL of a video.
	Video *string `json:"video,omitempty"`

	// Actions - Actions to be taken.
	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 - A unique ID assigned to this rich message content.
	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.
	Title *string `json:"title,omitempty"`

	// Description - Text to show in the description.
	Description *string `json:"description,omitempty"`

	// SubmitLabel - Label for Submit button.
	SubmitLabel *string `json:"submitLabel,omitempty"`

	// Actions - The list actions.
	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 - URL of the Location.
	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 provider template ID. For WhatsApp, 'namespace@name'.
	Id *string `json:"id,omitempty"`

	// Language - Template language.
	Language *string `json:"language,omitempty"`

	// Header - The template header.
	Header *Notificationtemplateheader `json:"header,omitempty"`

	// Body - The template body.
	Body *Notificationtemplatebody `json:"body,omitempty"`

	// Footer - The template footer.
	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 button response.
	Id *string `json:"id,omitempty"`

	// Text - The response text from the button click.
	Text *string `json:"text,omitempty"`

	// Payload - The response payload associated with the clicked button.
	Payload *string `json:"payload,omitempty"`
}

Contentpostback - Postback response object representing the click of a rich media button (Deprecated).

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 - A unique ID assigned to the quick reply (Deprecated).
	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 payload included in the quick reply response. Could be an ID identifying the quick reply response.
	Payload *string `json:"payload,omitempty"`

	// Image - URL of an image associated with the quick reply.
	Image *string `json:"image,omitempty"`

	// Action - Specifies the type of action that is triggered upon clicking the quick reply.
	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 the 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"`

	// ExternalTag - The external tag associated with the conversation.
	ExternalTag *string `json:"externalTag,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"`

	// ExternalTag - The external tag associated with the conversation.
	ExternalTag *string `json:"externalTag,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 *interface{} `json:"additionalProperties,omitempty"`
}

Conversationcallbackeventtopicdialerpreview

func (*Conversationcallbackeventtopicdialerpreview) String ¶

String returns a JSON representation of the model

type Conversationcallbackeventtopicerrorbody ¶

type Conversationcallbackeventtopicerrorbody struct {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,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 *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 *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 {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,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 *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 {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,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 *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 {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,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 *interface{} `json:"additionalProperties,omitempty"`
}

Conversationcobrowseeventtopicwrapup

func (*Conversationcobrowseeventtopicwrapup) String ¶

String returns a JSON representation of the model

type Conversationcontentattachment ¶

type Conversationcontentattachment struct {
	// Id - Provider specific ID for attachment. For example, a LINE sticker ID.
	Id *string `json:"id,omitempty"`

	// MediaType - The type of attachment this instance represents.
	MediaType *string `json:"mediaType,omitempty"`

	// Url - URL of the attachment.
	Url *string `json:"url,omitempty"`

	// Mime - Attachment mime type (https://www.iana.org/assignments/media-types/media-types.xhtml).
	Mime *string `json:"mime,omitempty"`

	// Text - Text associated with attachment such as an image caption.
	Text *string `json:"text,omitempty"`

	// Sha256 - Secure hash of the attachment content.
	Sha256 *string `json:"sha256,omitempty"`

	// Filename - Suggested file name for attachment.
	Filename *string `json:"filename,omitempty"`
}

Conversationcontentattachment - Attachment object.

func (*Conversationcontentattachment) String ¶

String returns a JSON representation of the model

type Conversationcontentbuttonresponse ¶

type Conversationcontentbuttonresponse struct {
	// VarType - Describes the button that resulted in the Button Response.
	VarType *string `json:"type,omitempty"`

	// Text - The response text from the button click.
	Text *string `json:"text,omitempty"`

	// Payload - The response payload associated with the clicked button.
	Payload *string `json:"payload,omitempty"`
}

Conversationcontentbuttonresponse - Button response object representing the click of a structured message button, such as a quick reply.

func (*Conversationcontentbuttonresponse) String ¶

String returns a JSON representation of the model

type Conversationcontentnotificationtemplate ¶

type Conversationcontentnotificationtemplate struct {
	// Id - The messaging provider template ID. For WhatsApp, 'namespace@name'.
	Id *string `json:"id,omitempty"`

	// Language - Template language.
	Language *string `json:"language,omitempty"`

	// Header - The template header.
	Header *Conversationnotificationtemplateheader `json:"header,omitempty"`

	// Body - The template body.
	Body *Conversationnotificationtemplatebody `json:"body,omitempty"`

	// Footer - The template footer.
	Footer *Conversationnotificationtemplatefooter `json:"footer,omitempty"`
}

Conversationcontentnotificationtemplate - Template notification object.

func (*Conversationcontentnotificationtemplate) String ¶

String returns a JSON representation of the model

type Conversationcontentquickreply ¶

type Conversationcontentquickreply struct {
	// 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 payload included in the quick reply response. Could be an ID identifying the quick reply response.
	Payload *string `json:"payload,omitempty"`

	// Image - URL of an image associated with the quick reply.
	Image *string `json:"image,omitempty"`

	// Action - Specifies the type of action that is triggered upon clicking the quick reply.
	Action *string `json:"action,omitempty"`
}

Conversationcontentquickreply - Quick reply object.

func (*Conversationcontentquickreply) 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{}

Conversationdetailsdatalakeavailabilitytopicdataavailabilitychangenotification

func (*Conversationdetailsdatalakeavailabilitytopicdataavailabilitychangenotification) 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 *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 {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,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 *Conversationemaileventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Conversationemaileventtopicjourneycontext

func (*Conversationemaileventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Conversationemaileventtopicjourneycustomer ¶

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

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Conversationemaileventtopicjourneycustomer

func (*Conversationemaileventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Conversationemaileventtopicjourneycustomersession ¶

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

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

Conversationemaileventtopicjourneycustomersession

func (*Conversationemaileventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Conversationemaileventtopicscoredagent ¶

type Conversationemaileventtopicscoredagent struct {
	// Agent
	Agent *Conversationemaileventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Conversationemaileventtopicscoredagent

func (*Conversationemaileventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Conversationemaileventtopicurireference ¶

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

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

Conversationemaileventtopicurireference

func (*Conversationemaileventtopicurireference) String ¶

String returns a JSON representation of the model

type Conversationemaileventtopicwrapup ¶

type Conversationemaileventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Conversationemaileventtopicwrapup

func (*Conversationemaileventtopicwrapup) String ¶

String returns a JSON representation of the model

type Conversationentitylisting ¶

type Conversationentitylisting struct {
	// Entities
	Entities *[]Conversation `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"`

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

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

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

Conversationentitylisting

func (*Conversationentitylisting) String ¶

func (o *Conversationentitylisting) String() string

String returns a JSON representation of the model

type Conversationeventtopicaddress ¶

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

	// NameRaw
	NameRaw *string `json:"nameRaw,omitempty"`

	// AddressNormalized
	AddressNormalized *string `json:"addressNormalized,omitempty"`

	// AddressRaw
	AddressRaw *string `json:"addressRaw,omitempty"`

	// AddressDisplayable
	AddressDisplayable *string `json:"addressDisplayable,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopicaddress

func (*Conversationeventtopicaddress) String ¶

String returns a JSON representation of the model

type Conversationeventtopicaftercallwork ¶

type Conversationeventtopicaftercallwork struct {
	// State
	State *string `json:"state,omitempty"`

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

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`
}

Conversationeventtopicaftercallwork

func (*Conversationeventtopicaftercallwork) String ¶

String returns a JSON representation of the model

type Conversationeventtopicattachment ¶

type Conversationeventtopicattachment 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 *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopicattachment

func (*Conversationeventtopicattachment) String ¶

String returns a JSON representation of the model

type Conversationeventtopiccall ¶

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

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

	// Recording
	Recording *bool `json:"recording,omitempty"`

	// RecordingState
	RecordingState *string `json:"recordingState,omitempty"`

	// Muted
	Muted *bool `json:"muted,omitempty"`

	// Confined
	Confined *bool `json:"confined,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// ErrorInfo
	ErrorInfo *Conversationeventtopicerrordetails `json:"errorInfo,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

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

	// DocumentId
	DocumentId *string `json:"documentId,omitempty"`

	// Self
	Self *Conversationeventtopicaddress `json:"self,omitempty"`

	// Other
	Other *Conversationeventtopicaddress `json:"other,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// DisconnectReasons
	DisconnectReasons *[]Conversationeventtopicdisconnectreason `json:"disconnectReasons,omitempty"`

	// FaxStatus
	FaxStatus *Conversationeventtopicfaxstatus `json:"faxStatus,omitempty"`

	// UuiData
	UuiData *string `json:"uuiData,omitempty"`

	// Wrapup
	Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AgentAssistantId
	AgentAssistantId *string `json:"agentAssistantId,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopiccall

func (*Conversationeventtopiccall) String ¶

func (o *Conversationeventtopiccall) String() string

String returns a JSON representation of the model

type Conversationeventtopiccallback ¶

type Conversationeventtopiccallback struct {
	// State
	State *string `json:"state,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

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

	// Held
	Held *bool `json:"held,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// DialerPreview
	DialerPreview *Conversationeventtopicdialerpreview `json:"dialerPreview,omitempty"`

	// Voicemail
	Voicemail *Conversationeventtopicvoicemail `json:"voicemail,omitempty"`

	// CallbackNumbers
	CallbackNumbers *[]string `json:"callbackNumbers,omitempty"`

	// CallbackUserName
	CallbackUserName *string `json:"callbackUserName,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// ExternalCampaign
	ExternalCampaign *bool `json:"externalCampaign,omitempty"`

	// SkipEnabled
	SkipEnabled *bool `json:"skipEnabled,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// TimeoutSeconds
	TimeoutSeconds *int `json:"timeoutSeconds,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// CallbackScheduledTime
	CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"`

	// AutomatedCallbackConfigId
	AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"`

	// Wrapup
	Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// CallerId
	CallerId *string `json:"callerId,omitempty"`

	// CallerIdName
	CallerIdName *string `json:"callerIdName,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopiccallback

func (*Conversationeventtopiccallback) String ¶

String returns a JSON representation of the model

type Conversationeventtopicchat ¶

type Conversationeventtopicchat struct {
	// State
	State *string `json:"state,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// RoomId
	RoomId *string `json:"roomId,omitempty"`

	// AvatarImageUrl
	AvatarImageUrl *string `json:"avatarImageUrl,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// JourneyContext
	JourneyContext *Conversationeventtopicjourneycontext `json:"journeyContext,omitempty"`

	// Wrapup
	Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopicchat

func (*Conversationeventtopicchat) String ¶

func (o *Conversationeventtopicchat) String() string

String returns a JSON representation of the model

type Conversationeventtopiccobrowse ¶

type Conversationeventtopiccobrowse struct {
	// State
	State *string `json:"state,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Self
	Self *Conversationeventtopicaddress `json:"self,omitempty"`

	// RoomId
	RoomId *string `json:"roomId,omitempty"`

	// CobrowseSessionId
	CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"`

	// CobrowseRole
	CobrowseRole *string `json:"cobrowseRole,omitempty"`

	// Controlling
	Controlling *[]string `json:"controlling,omitempty"`

	// ViewerUrl
	ViewerUrl *string `json:"viewerUrl,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// ProviderEventTime
	ProviderEventTime *time.Time `json:"providerEventTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Wrapup
	Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopiccobrowse

func (*Conversationeventtopiccobrowse) String ¶

String returns a JSON representation of the model

type Conversationeventtopicconversation ¶

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

	// MaxParticipants
	MaxParticipants *int `json:"maxParticipants,omitempty"`

	// Participants
	Participants *[]Conversationeventtopicparticipant `json:"participants,omitempty"`

	// RecordingState
	RecordingState *string `json:"recordingState,omitempty"`

	// Address
	Address *string `json:"address,omitempty"`

	// ExternalTag
	ExternalTag *string `json:"externalTag,omitempty"`
}

Conversationeventtopicconversation

func (*Conversationeventtopicconversation) String ¶

String returns a JSON representation of the model

type Conversationeventtopicconversationroutingdata ¶

type Conversationeventtopicconversationroutingdata struct {
	// Queue
	Queue *Conversationeventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Conversationeventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Conversationeventtopicurireference `json:"skills,omitempty"`

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

Conversationeventtopicconversationroutingdata

func (*Conversationeventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Conversationeventtopicdialerpreview ¶

type Conversationeventtopicdialerpreview 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 *[]Conversationeventtopicphonenumbercolumn `json:"phoneNumberColumns,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopicdialerpreview

func (*Conversationeventtopicdialerpreview) String ¶

String returns a JSON representation of the model

type Conversationeventtopicdisconnectreason ¶

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

	// Code
	Code *int `json:"code,omitempty"`

	// Phrase
	Phrase *string `json:"phrase,omitempty"`
}

Conversationeventtopicdisconnectreason

func (*Conversationeventtopicdisconnectreason) String ¶

String returns a JSON representation of the model

type Conversationeventtopicemail ¶

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

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

	// Held
	Held *bool `json:"held,omitempty"`

	// AutoGenerated
	AutoGenerated *bool `json:"autoGenerated,omitempty"`

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

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// MessagesSent
	MessagesSent *int `json:"messagesSent,omitempty"`

	// ErrorInfo
	ErrorInfo *Conversationeventtopicerrordetails `json:"errorInfo,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// MessageId
	MessageId *string `json:"messageId,omitempty"`

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

	// DraftAttachments
	DraftAttachments *[]Conversationeventtopicattachment `json:"draftAttachments,omitempty"`

	// Spam
	Spam *bool `json:"spam,omitempty"`

	// Wrapup
	Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopicemail

func (*Conversationeventtopicemail) String ¶

func (o *Conversationeventtopicemail) String() string

String returns a JSON representation of the model

type Conversationeventtopicerrordetails ¶

type Conversationeventtopicerrordetails struct {
	// Status
	Status *int `json:"status,omitempty"`

	// Code
	Code *string `json:"code,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"`

	// Uri
	Uri *string `json:"uri,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopicerrordetails

func (*Conversationeventtopicerrordetails) String ¶

String returns a JSON representation of the model

type Conversationeventtopicfaxstatus ¶

type Conversationeventtopicfaxstatus 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"`

	// BaudRate
	BaudRate *int `json:"baudRate,omitempty"`

	// PageErrors
	PageErrors *int `json:"pageErrors,omitempty"`

	// LineErrors
	LineErrors *int `json:"lineErrors,omitempty"`
}

Conversationeventtopicfaxstatus

func (*Conversationeventtopicfaxstatus) String ¶

String returns a JSON representation of the model

type Conversationeventtopicjourneyaction ¶

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

	// ActionMap
	ActionMap *Conversationeventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Conversationeventtopicjourneyaction

func (*Conversationeventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Conversationeventtopicjourneyactionmap ¶

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

	// Version
	Version *int `json:"version,omitempty"`
}

Conversationeventtopicjourneyactionmap

func (*Conversationeventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Conversationeventtopicjourneycontext ¶

type Conversationeventtopicjourneycontext struct {
	// Customer
	Customer *Conversationeventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Conversationeventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Conversationeventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Conversationeventtopicjourneycontext

func (*Conversationeventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Conversationeventtopicjourneycustomer ¶

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

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Conversationeventtopicjourneycustomer

func (*Conversationeventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Conversationeventtopicjourneycustomersession ¶

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

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

Conversationeventtopicjourneycustomersession

func (*Conversationeventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Conversationeventtopicmessage ¶

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

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

	// Held
	Held *bool `json:"held,omitempty"`

	// ErrorInfo
	ErrorInfo *Conversationeventtopicerrordetails `json:"errorInfo,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// ToAddress
	ToAddress *Conversationeventtopicaddress `json:"toAddress,omitempty"`

	// FromAddress
	FromAddress *Conversationeventtopicaddress `json:"fromAddress,omitempty"`

	// Messages
	Messages *[]Conversationeventtopicmessagedetails `json:"messages,omitempty"`

	// MessagesTranscriptUri
	MessagesTranscriptUri *string `json:"messagesTranscriptUri,omitempty"`

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

	// RecipientCountry
	RecipientCountry *string `json:"recipientCountry,omitempty"`

	// RecipientType
	RecipientType *string `json:"recipientType,omitempty"`

	// JourneyContext
	JourneyContext *Conversationeventtopicjourneycontext `json:"journeyContext,omitempty"`

	// Wrapup
	Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopicmessage

func (*Conversationeventtopicmessage) String ¶

String returns a JSON representation of the model

type Conversationeventtopicmessagedetails ¶

type Conversationeventtopicmessagedetails struct {
	// MessageId
	MessageId *string `json:"messageId,omitempty"`

	// MessageTime
	MessageTime *time.Time `json:"messageTime,omitempty"`

	// MessageStatus
	MessageStatus *string `json:"messageStatus,omitempty"`

	// MessageSegmentCount
	MessageSegmentCount *int `json:"messageSegmentCount,omitempty"`

	// Media
	Media *[]Conversationeventtopicmessagemedia `json:"media,omitempty"`

	// Stickers
	Stickers *[]Conversationeventtopicmessagesticker `json:"stickers,omitempty"`
}

Conversationeventtopicmessagedetails

func (*Conversationeventtopicmessagedetails) String ¶

String returns a JSON representation of the model

type Conversationeventtopicmessagemedia ¶

type Conversationeventtopicmessagemedia struct {
	// Url
	Url *string `json:"url,omitempty"`

	// MediaType
	MediaType *string `json:"mediaType,omitempty"`

	// ContentLengthBytes
	ContentLengthBytes *int `json:"contentLengthBytes,omitempty"`

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

	// Id
	Id *string `json:"id,omitempty"`
}

Conversationeventtopicmessagemedia

func (*Conversationeventtopicmessagemedia) String ¶

String returns a JSON representation of the model

type Conversationeventtopicmessagesticker ¶

type Conversationeventtopicmessagesticker struct {
	// Url
	Url *string `json:"url,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`
}

Conversationeventtopicmessagesticker

func (*Conversationeventtopicmessagesticker) String ¶

String returns a JSON representation of the model

type Conversationeventtopicparticipant ¶

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

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`

	// UserId
	UserId *string `json:"userId,omitempty"`

	// ExternalContactId
	ExternalContactId *string `json:"externalContactId,omitempty"`

	// ExternalOrganizationId
	ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"`

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

	// QueueId
	QueueId *string `json:"queueId,omitempty"`

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

	// TeamId
	TeamId *string `json:"teamId,omitempty"`

	// Purpose
	Purpose *string `json:"purpose,omitempty"`

	// ConsultParticipantId
	ConsultParticipantId *string `json:"consultParticipantId,omitempty"`

	// Address
	Address *string `json:"address,omitempty"`

	// WrapupRequired
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupExpected
	WrapupExpected *bool `json:"wrapupExpected,omitempty"`

	// WrapupPrompt
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// WrapupTimeoutMs
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// Wrapup
	Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Conversationeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// AlertingTimeoutMs
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

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

	// CoachedParticipantId
	CoachedParticipantId *string `json:"coachedParticipantId,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// Calls
	Calls *[]Conversationeventtopiccall `json:"calls,omitempty"`

	// Callbacks
	Callbacks *[]Conversationeventtopiccallback `json:"callbacks,omitempty"`

	// Chats
	Chats *[]Conversationeventtopicchat `json:"chats,omitempty"`

	// Cobrowsesessions
	Cobrowsesessions *[]Conversationeventtopiccobrowse `json:"cobrowsesessions,omitempty"`

	// Emails
	Emails *[]Conversationeventtopicemail `json:"emails,omitempty"`

	// Messages
	Messages *[]Conversationeventtopicmessage `json:"messages,omitempty"`

	// Screenshares
	Screenshares *[]Conversationeventtopicscreenshare `json:"screenshares,omitempty"`

	// SocialExpressions
	SocialExpressions *[]Conversationeventtopicsocialexpression `json:"socialExpressions,omitempty"`

	// Videos
	Videos *[]Conversationeventtopicvideo `json:"videos,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopicparticipant

func (*Conversationeventtopicparticipant) String ¶

String returns a JSON representation of the model

type Conversationeventtopicphonenumbercolumn ¶

type Conversationeventtopicphonenumbercolumn struct {
	// ColumnName
	ColumnName *string `json:"columnName,omitempty"`

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

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopicphonenumbercolumn

func (*Conversationeventtopicphonenumbercolumn) String ¶

String returns a JSON representation of the model

type Conversationeventtopicscoredagent ¶

type Conversationeventtopicscoredagent struct {
	// Agent
	Agent *Conversationeventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Conversationeventtopicscoredagent

func (*Conversationeventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Conversationeventtopicscreenshare ¶

type Conversationeventtopicscreenshare struct {
	// State
	State *string `json:"state,omitempty"`

	// Self
	Self *Conversationeventtopicaddress `json:"self,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Context
	Context *string `json:"context,omitempty"`

	// Sharing
	Sharing *bool `json:"sharing,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Wrapup
	Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopicscreenshare

func (*Conversationeventtopicscreenshare) String ¶

String returns a JSON representation of the model

type Conversationeventtopicsocialexpression ¶

type Conversationeventtopicsocialexpression struct {
	// State
	State *string `json:"state,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// SocialMediaId
	SocialMediaId *string `json:"socialMediaId,omitempty"`

	// SocialMediaHub
	SocialMediaHub *string `json:"socialMediaHub,omitempty"`

	// SocialUserName
	SocialUserName *string `json:"socialUserName,omitempty"`

	// PreviewText
	PreviewText *string `json:"previewText,omitempty"`

	// RecordingId
	RecordingId *string `json:"recordingId,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Wrapup
	Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopicsocialexpression

func (*Conversationeventtopicsocialexpression) String ¶

String returns a JSON representation of the model

type Conversationeventtopicurireference ¶

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

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

Conversationeventtopicurireference

func (*Conversationeventtopicurireference) String ¶

String returns a JSON representation of the model

type Conversationeventtopicvideo ¶

type Conversationeventtopicvideo struct {
	// State
	State *string `json:"state,omitempty"`

	// Self
	Self *Conversationeventtopicaddress `json:"self,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Context
	Context *string `json:"context,omitempty"`

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

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

	// SharingScreen
	SharingScreen *bool `json:"sharingScreen,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Msids
	Msids *[]string `json:"msids,omitempty"`

	// Wrapup
	Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopicvideo

func (*Conversationeventtopicvideo) String ¶

func (o *Conversationeventtopicvideo) String() string

String returns a JSON representation of the model

type Conversationeventtopicvoicemail ¶

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

	// UploadStatus
	UploadStatus *string `json:"uploadStatus,omitempty"`
}

Conversationeventtopicvoicemail

func (*Conversationeventtopicvoicemail) String ¶

String returns a JSON representation of the model

type Conversationeventtopicwrapup ¶

type Conversationeventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Conversationeventtopicwrapup

func (*Conversationeventtopicwrapup) String ¶

String returns a JSON representation of the model

type Conversationmessagecontent ¶

type Conversationmessagecontent struct {
	// ContentType - Type of this content element. If contentType = \"Attachment\" only one item is allowed.
	ContentType *string `json:"contentType,omitempty"`

	// Attachment - Attachment content.
	Attachment *Conversationcontentattachment `json:"attachment,omitempty"`

	// QuickReply - Quick reply content.
	QuickReply *Conversationcontentquickreply `json:"quickReply,omitempty"`

	// Template - Template notification content.
	Template *Conversationcontentnotificationtemplate `json:"template,omitempty"`

	// ButtonResponse - Button response content.
	ButtonResponse *Conversationcontentbuttonresponse `json:"buttonResponse,omitempty"`
}

Conversationmessagecontent - Message content element.

func (*Conversationmessagecontent) String ¶

func (o *Conversationmessagecontent) String() string

String returns a JSON representation of the model

type Conversationmessageeventtopicconversationroutingdata ¶

type Conversationmessageeventtopicconversationroutingdata struct {
	// Queue
	Queue *Conversationmessageeventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Conversationmessageeventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Conversationmessageeventtopicurireference `json:"skills,omitempty"`

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

Conversationmessageeventtopicconversationroutingdata

func (*Conversationmessageeventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicdetail ¶

type Conversationmessageeventtopicdetail 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"`
}

Conversationmessageeventtopicdetail

func (*Conversationmessageeventtopicdetail) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicerrorbody ¶

type Conversationmessageeventtopicerrorbody struct {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Conversationmessageeventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Conversationmessageeventtopicerrorbody `json:"errors,omitempty"`
}

Conversationmessageeventtopicerrorbody

func (*Conversationmessageeventtopicerrorbody) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicjourneyaction ¶

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

	// ActionMap
	ActionMap *Conversationmessageeventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Conversationmessageeventtopicjourneyaction

func (*Conversationmessageeventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicjourneyactionmap ¶

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

	// Version
	Version *int `json:"version,omitempty"`
}

Conversationmessageeventtopicjourneyactionmap

func (*Conversationmessageeventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicjourneycontext ¶

type Conversationmessageeventtopicjourneycontext struct {
	// Customer
	Customer *Conversationmessageeventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Conversationmessageeventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Conversationmessageeventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Conversationmessageeventtopicjourneycontext

func (*Conversationmessageeventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicjourneycustomer ¶

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

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Conversationmessageeventtopicjourneycustomer

func (*Conversationmessageeventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicjourneycustomersession ¶

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

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

Conversationmessageeventtopicjourneycustomersession

func (*Conversationmessageeventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicmessageconversation ¶

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

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

	// Participants
	Participants *[]Conversationmessageeventtopicmessagemediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`
}

Conversationmessageeventtopicmessageconversation

func (*Conversationmessageeventtopicmessageconversation) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicmessagedetails ¶

type Conversationmessageeventtopicmessagedetails struct {
	// Message
	Message *Conversationmessageeventtopicurireference `json:"message,omitempty"`

	// MessageTime
	MessageTime *time.Time `json:"messageTime,omitempty"`

	// MessageSegmentCount
	MessageSegmentCount *int `json:"messageSegmentCount,omitempty"`

	// MessageStatus
	MessageStatus *string `json:"messageStatus,omitempty"`

	// Media
	Media *[]Conversationmessageeventtopicmessagemedia `json:"media,omitempty"`

	// Stickers
	Stickers *[]Conversationmessageeventtopicmessagesticker `json:"stickers,omitempty"`
}

Conversationmessageeventtopicmessagedetails

func (*Conversationmessageeventtopicmessagedetails) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicmessagemedia ¶

type Conversationmessageeventtopicmessagemedia struct {
	// Url
	Url *string `json:"url,omitempty"`

	// MediaType
	MediaType *string `json:"mediaType,omitempty"`

	// ContentLengthBytes
	ContentLengthBytes *int `json:"contentLengthBytes,omitempty"`

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

	// Id
	Id *string `json:"id,omitempty"`
}

Conversationmessageeventtopicmessagemedia

func (*Conversationmessageeventtopicmessagemedia) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicmessagemediaparticipant ¶

type Conversationmessageeventtopicmessagemediaparticipant 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 *Conversationmessageeventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Conversationmessageeventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Conversationmessageeventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Conversationmessageeventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Conversationmessageeventtopicurireference `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 *Conversationmessageeventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Conversationmessageeventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Conversationmessageeventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Conversationmessageeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Conversationmessageeventtopicjourneycontext `json:"journeyContext,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// Messages
	Messages *[]Conversationmessageeventtopicmessagedetails `json:"messages,omitempty"`

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

	// RecipientCountry
	RecipientCountry *string `json:"recipientCountry,omitempty"`

	// RecipientType
	RecipientType *string `json:"recipientType,omitempty"`
}

Conversationmessageeventtopicmessagemediaparticipant

func (*Conversationmessageeventtopicmessagemediaparticipant) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicmessagesticker ¶

type Conversationmessageeventtopicmessagesticker struct {
	// Url
	Url *string `json:"url,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`
}

Conversationmessageeventtopicmessagesticker

func (*Conversationmessageeventtopicmessagesticker) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicscoredagent ¶

type Conversationmessageeventtopicscoredagent struct {
	// Agent
	Agent *Conversationmessageeventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Conversationmessageeventtopicscoredagent

func (*Conversationmessageeventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicurireference ¶

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

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

Conversationmessageeventtopicurireference

func (*Conversationmessageeventtopicurireference) String ¶

String returns a JSON representation of the model

type Conversationmessageeventtopicwrapup ¶

type Conversationmessageeventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Conversationmessageeventtopicwrapup

func (*Conversationmessageeventtopicwrapup) String ¶

String returns a JSON representation of the model

type Conversationmessagingchannel ¶

type Conversationmessagingchannel struct {
	// Id - The integration ID.
	Id *string `json:"id,omitempty"`

	// Platform - The provider type.
	Platform *string `json:"platform,omitempty"`

	// MessageId - Unique provider ID of the message such as a Facebook message ID.
	MessageId *string `json:"messageId,omitempty"`

	// To - Information about the recipient the message is sent to.
	To *Conversationmessagingtorecipient `json:"to,omitempty"`

	// From - Information about the recipient the message is received from.
	From *Conversationmessagingfromrecipient `json:"from,omitempty"`

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

	// DateModified - Time the message was edited. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// DateDeleted - Time the message was deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateDeleted *time.Time `json:"dateDeleted,omitempty"`
}

Conversationmessagingchannel - Channel-specific information that describes the message and the message channel/provider.

func (*Conversationmessagingchannel) String ¶

String returns a JSON representation of the model

type Conversationmessagingfromrecipient ¶

type Conversationmessagingfromrecipient struct {
	// Nickname - Nickname or display name of the recipient.
	Nickname *string `json:"nickname,omitempty"`

	// Id - The recipient ID specific to the provider.
	Id *string `json:"id,omitempty"`

	// IdType - The recipient ID type. This is used to indicate the format used for the ID.
	IdType *string `json:"idType,omitempty"`

	// Image - URL of an image that represents the recipient.
	Image *string `json:"image,omitempty"`

	// FirstName - First name of the recipient.
	FirstName *string `json:"firstName,omitempty"`

	// LastName - Last name of the recipient.
	LastName *string `json:"lastName,omitempty"`

	// Email - E-mail address of the recipient.
	Email *string `json:"email,omitempty"`
}

Conversationmessagingfromrecipient - Information about the recipient the message is received from.

func (*Conversationmessagingfromrecipient) String ¶

String returns a JSON representation of the model

type Conversationmessagingtorecipient ¶

type Conversationmessagingtorecipient struct {
	// Nickname - Nickname or display name of the recipient.
	Nickname *string `json:"nickname,omitempty"`

	// Id - The recipient ID specific to the provider.
	Id *string `json:"id,omitempty"`

	// IdType - The recipient ID type. This is used to indicate the format used for the ID.
	IdType *string `json:"idType,omitempty"`

	// Image - URL of an image that represents the recipient.
	Image *string `json:"image,omitempty"`

	// FirstName - First name of the recipient.
	FirstName *string `json:"firstName,omitempty"`

	// LastName - Last name of the recipient.
	LastName *string `json:"lastName,omitempty"`

	// Email - E-mail address of the recipient.
	Email *string `json:"email,omitempty"`
}

Conversationmessagingtorecipient - Information about the recipient the message is sent to.

func (*Conversationmessagingtorecipient) String ¶

String returns a JSON representation of the model

type Conversationmetrics ¶

type Conversationmetrics struct {
	// Conversation - The Conversation Reference
	Conversation *Addressableentityref `json:"conversation,omitempty"`

	// SentimentScore - The Sentiment Score
	SentimentScore *float64 `json:"sentimentScore,omitempty"`

	// SentimentTrend - The Sentiment Trend
	SentimentTrend *float64 `json:"sentimentTrend,omitempty"`
}

Conversationmetrics

func (*Conversationmetrics) String ¶

func (o *Conversationmetrics) String() string

String returns a JSON representation of the model

type Conversationnormalizedmessage ¶

type Conversationnormalizedmessage struct {
	// Id - Unique ID of the message. Message receipts will have the same ID as the message they reference.
	Id *string `json:"id,omitempty"`

	// Channel - Channel-specific information that describes the message and the message channel/provider.
	Channel *Conversationmessagingchannel `json:"channel,omitempty"`

	// VarType - Message type.
	VarType *string `json:"type,omitempty"`

	// Text - Message text.
	Text *string `json:"text,omitempty"`

	// Content - List of content elements
	Content *[]Conversationmessagecontent `json:"content,omitempty"`

	// Status - Message receipt status, only used with type Receipt.
	Status *string `json:"status,omitempty"`

	// Reasons - List of reasons for a message receipt that indicates the message has failed. Only used with Failed status.
	Reasons *[]Conversationreason `json:"reasons,omitempty"`

	// OriginatingEntity - Specifies if this message was sent by a human agent or bot. The platform may use this to apply appropriate provider policies.
	OriginatingEntity *string `json:"originatingEntity,omitempty"`

	// IsFinalReceipt - Indicates if this is the last message receipt for this message, or if another message receipt can be expected.
	IsFinalReceipt *bool `json:"isFinalReceipt,omitempty"`

	// Direction - The direction of the message.
	Direction *string `json:"direction,omitempty"`

	// Metadata - Additional metadata about this message.
	Metadata *map[string]string `json:"metadata,omitempty"`
}

Conversationnormalizedmessage - General rich media message structure with normalized feature support across many messaging channels.

func (*Conversationnormalizedmessage) String ¶

String returns a JSON representation of the model

type Conversationnotificationtemplatebody ¶

type Conversationnotificationtemplatebody struct {
	// Text - Body text. For WhatsApp, ignored.
	Text *string `json:"text,omitempty"`

	// Parameters - Template parameters for placeholders in template.
	Parameters *[]Conversationnotificationtemplateparameter `json:"parameters,omitempty"`
}

Conversationnotificationtemplatebody - Template body object.

func (*Conversationnotificationtemplatebody) String ¶

String returns a JSON representation of the model

type Conversationnotificationtemplatefooter ¶

type Conversationnotificationtemplatefooter struct {
	// Text - Footer text. For WhatsApp, ignored.
	Text *string `json:"text,omitempty"`
}

Conversationnotificationtemplatefooter - Template footer object.

func (*Conversationnotificationtemplatefooter) String ¶

String returns a JSON representation of the model

type Conversationnotificationtemplateheader ¶

type Conversationnotificationtemplateheader struct {
	// VarType - Template header type.
	VarType *string `json:"type,omitempty"`

	// Text - Header text. For WhatsApp, ignored.
	Text *string `json:"text,omitempty"`

	// Media - Media template header image.
	Media *Conversationcontentattachment `json:"media,omitempty"`

	// Parameters - Template parameters for placeholders in template.
	Parameters *[]Conversationnotificationtemplateparameter `json:"parameters,omitempty"`
}

Conversationnotificationtemplateheader - Template header object.

func (*Conversationnotificationtemplateheader) String ¶

String returns a JSON representation of the model

type Conversationnotificationtemplateparameter ¶

type Conversationnotificationtemplateparameter struct {
	// Name - Parameter name.
	Name *string `json:"name,omitempty"`

	// Text - Parameter text value.
	Text *string `json:"text,omitempty"`
}

Conversationnotificationtemplateparameter - Template parameters for placeholders in template.

func (*Conversationnotificationtemplateparameter) String ¶

String returns a JSON representation of the model

type Conversationproperties ¶

type Conversationproperties struct {
	// IsWaiting - Indicates filtering for waiting
	IsWaiting *bool `json:"isWaiting,omitempty"`

	// IsActive - Indicates filtering for active
	IsActive *bool `json:"isActive,omitempty"`

	// IsAcd - Indicates filtering for Acd
	IsAcd *bool `json:"isAcd,omitempty"`

	// IsPreferred - Indicates filtering for Preferred Agent Routing
	IsPreferred *bool `json:"isPreferred,omitempty"`

	// IsScreenshare - Indicates filtering for screenshare
	IsScreenshare *bool `json:"isScreenshare,omitempty"`

	// IsCobrowse - Indicates filtering for Cobrowse
	IsCobrowse *bool `json:"isCobrowse,omitempty"`

	// IsVoicemail - Indicates filtering for Voice mail
	IsVoicemail *bool `json:"isVoicemail,omitempty"`

	// IsFlagged - Indicates filtering for flagged
	IsFlagged *bool `json:"isFlagged,omitempty"`

	// IsMonitored - Indicates filtering for monitored
	IsMonitored *bool `json:"isMonitored,omitempty"`

	// FilterWrapUpNotes - Indicates filtering for WrapUpNotes
	FilterWrapUpNotes *bool `json:"filterWrapUpNotes,omitempty"`

	// MatchAll - Indicates comparison operation, TRUE indicates filters will use AND logic, FALSE indicates OR logic
	MatchAll *bool `json:"matchAll,omitempty"`
}

Conversationproperties

func (*Conversationproperties) String ¶

func (o *Conversationproperties) String() string

String returns a JSON representation of the model

type Conversationquery ¶

type Conversationquery 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"`

	// 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 only include conversations that started on a day touched by 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"`

	// Aggregations - Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters
	Aggregations *[]Analyticsqueryaggregation `json:"aggregations,omitempty"`

	// Paging - Page size and number to control iterating through large result sets. Default page size is 25
	Paging *Pagingspec `json:"paging,omitempty"`
}

Conversationquery

func (*Conversationquery) String ¶

func (o *Conversationquery) String() string

String returns a JSON representation of the model

type Conversationreason ¶

type Conversationreason struct {
	// Code - The reason code for the failed message receipt.
	Code *string `json:"code,omitempty"`

	// Message - Description of the reason for the failed message receipt.
	Message *string `json:"message,omitempty"`
}

Conversationreason - Reasons for a failed message receipt.

func (*Conversationreason) String ¶

func (o *Conversationreason) String() string

String returns a JSON representation of the model

type Conversationreference ¶

type Conversationreference 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"`
}

Conversationreference

func (*Conversationreference) String ¶

func (o *Conversationreference) String() string

String returns a JSON representation of the model

type Conversationroutingdata ¶

type Conversationroutingdata struct {
	// Queue - The queue to use for routing decisions
	Queue *Addressableentityref `json:"queue,omitempty"`

	// Language - The language to use for routing decisions
	Language *Addressableentityref `json:"language,omitempty"`

	// Priority - The priority of the conversation to use for routing decisions
	Priority *int `json:"priority,omitempty"`

	// Skills - The skills to use for routing decisions
	Skills *[]Addressableentityref `json:"skills,omitempty"`

	// ScoredAgents - A collection of agents and their assigned scores for this conversation (0 - 100, higher being better), for use in routing to preferred agents
	ScoredAgents *[]Scoredagent `json:"scoredAgents,omitempty"`
}

Conversationroutingdata

func (*Conversationroutingdata) String ¶

func (o *Conversationroutingdata) String() string

String returns a JSON representation of the model

type ConversationsApi ¶

type ConversationsApi struct {
	Configuration *Configuration
}

ConversationsApi provides functions for API endpoints

func NewConversationsApi ¶

func NewConversationsApi() *ConversationsApi

NewConversationsApi creates an API instance using the default configuration

func NewConversationsApiWithConfig ¶

func NewConversationsApiWithConfig(config *Configuration) *ConversationsApi

NewConversationsApiWithConfig creates an API instance using the provided configuration

func (ConversationsApi) DeleteAnalyticsConversationsDetailsJob ¶

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

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

Delete/cancel an async request

func (ConversationsApi) DeleteConversationParticipantCode ¶

func (a ConversationsApi) DeleteConversationParticipantCode(conversationId string, participantId string, addCommunicationCode string) (*APIResponse, error)

DeleteConversationParticipantCode invokes DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}

Delete a code used to add a communication to this participant

func (ConversationsApi) DeleteConversationParticipantFlaggedreason ¶

func (a ConversationsApi) DeleteConversationParticipantFlaggedreason(conversationId string, participantId string) (*APIResponse, error)

DeleteConversationParticipantFlaggedreason invokes DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason

Remove flagged reason from conversation participant.

func (ConversationsApi) DeleteConversationsCallParticipantConsult ¶

func (a ConversationsApi) DeleteConversationsCallParticipantConsult(conversationId string, participantId string) (*APIResponse, error)

DeleteConversationsCallParticipantConsult invokes DELETE /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult

Cancel the transfer

func (ConversationsApi) DeleteConversationsEmailMessagesDraftAttachment ¶

func (a ConversationsApi) DeleteConversationsEmailMessagesDraftAttachment(conversationId string, attachmentId string) (*APIResponse, error)

DeleteConversationsEmailMessagesDraftAttachment invokes DELETE /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId}

Delete attachment from draft

func (ConversationsApi) DeleteConversationsMessagingIntegrationsFacebookIntegrationId ¶

func (a ConversationsApi) DeleteConversationsMessagingIntegrationsFacebookIntegrationId(integrationId string) (*APIResponse, error)

DeleteConversationsMessagingIntegrationsFacebookIntegrationId invokes DELETE /api/v2/conversations/messaging/integrations/facebook/{integrationId}

Delete a Facebook messaging integration

func (ConversationsApi) DeleteConversationsMessagingIntegrationsLineIntegrationId ¶

func (a ConversationsApi) DeleteConversationsMessagingIntegrationsLineIntegrationId(integrationId string) (*APIResponse, error)

DeleteConversationsMessagingIntegrationsLineIntegrationId invokes DELETE /api/v2/conversations/messaging/integrations/line/{integrationId}

Delete a LINE messenger integration

func (ConversationsApi) DeleteConversationsMessagingIntegrationsOpenIntegrationId ¶

func (a ConversationsApi) DeleteConversationsMessagingIntegrationsOpenIntegrationId(integrationId string) (*APIResponse, error)

DeleteConversationsMessagingIntegrationsOpenIntegrationId invokes DELETE /api/v2/conversations/messaging/integrations/open/{integrationId}

Delete an Open messaging integration ¶

See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.

func (ConversationsApi) DeleteConversationsMessagingIntegrationsTwitterIntegrationId ¶

func (a ConversationsApi) DeleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId string) (*APIResponse, error)

DeleteConversationsMessagingIntegrationsTwitterIntegrationId invokes DELETE /api/v2/conversations/messaging/integrations/twitter/{integrationId}

Delete a Twitter messaging integration

func (ConversationsApi) DeleteConversationsMessagingIntegrationsWhatsappIntegrationId ¶

func (a ConversationsApi) DeleteConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId string) (*Whatsappintegration, *APIResponse, error)

DeleteConversationsMessagingIntegrationsWhatsappIntegrationId invokes DELETE /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}

Delete a WhatsApp messaging integration

func (ConversationsApi) GetAnalyticsConversationDetails ¶

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

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

Get a conversation by id

func (ConversationsApi) GetAnalyticsConversationsDetails ¶

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

Gets multiple conversations by id

func (ConversationsApi) GetAnalyticsConversationsDetailsJob ¶

func (a ConversationsApi) 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 (ConversationsApi) GetAnalyticsConversationsDetailsJobResults ¶

func (a ConversationsApi) 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 (ConversationsApi) GetAnalyticsConversationsDetailsJobsAvailability ¶

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

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

Lookup the datalake availability date and time

func (ConversationsApi) GetConversation ¶

func (a ConversationsApi) GetConversation(conversationId string) (*Conversation, *APIResponse, error)

GetConversation invokes GET /api/v2/conversations/{conversationId}

Get conversation

func (ConversationsApi) GetConversationParticipantSecureivrsession ¶

func (a ConversationsApi) GetConversationParticipantSecureivrsession(conversationId string, participantId string, secureSessionId string) (*Securesession, *APIResponse, error)

GetConversationParticipantSecureivrsession invokes GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}

Fetch info on a secure session

func (ConversationsApi) GetConversationParticipantSecureivrsessions ¶

func (a ConversationsApi) GetConversationParticipantSecureivrsessions(conversationId string, participantId string) (*Securesessionentitylisting, *APIResponse, error)

GetConversationParticipantSecureivrsessions invokes GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions

Get a list of secure sessions for this participant.

func (ConversationsApi) GetConversationParticipantWrapup ¶

func (a ConversationsApi) GetConversationParticipantWrapup(conversationId string, participantId string, provisional bool) (*Assignedwrapupcode, *APIResponse, error)

GetConversationParticipantWrapup invokes GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapup

Get the wrap-up for this conversation participant.

func (ConversationsApi) GetConversationParticipantWrapupcodes ¶

func (a ConversationsApi) GetConversationParticipantWrapupcodes(conversationId string, participantId string) ([]Wrapupcode, *APIResponse, error)

GetConversationParticipantWrapupcodes invokes GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes

Get list of wrapup codes for this conversation participant

func (ConversationsApi) GetConversations ¶

func (a ConversationsApi) GetConversations(communicationType string) (*Conversationentitylisting, *APIResponse, error)

GetConversations invokes GET /api/v2/conversations

Get active conversations for the logged in user

func (ConversationsApi) GetConversationsCall ¶

func (a ConversationsApi) GetConversationsCall(conversationId string) (*Callconversation, *APIResponse, error)

GetConversationsCall invokes GET /api/v2/conversations/calls/{conversationId}

Get call conversation

func (ConversationsApi) GetConversationsCallParticipantWrapup ¶

func (a ConversationsApi) GetConversationsCallParticipantWrapup(conversationId string, participantId string, provisional bool) (*Assignedwrapupcode, *APIResponse, error)

GetConversationsCallParticipantWrapup invokes GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup

Get the wrap-up for this conversation participant.

func (ConversationsApi) GetConversationsCallParticipantWrapupcodes ¶

func (a ConversationsApi) GetConversationsCallParticipantWrapupcodes(conversationId string, participantId string) ([]Wrapupcode, *APIResponse, error)

GetConversationsCallParticipantWrapupcodes invokes GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes

Get list of wrapup codes for this conversation participant

func (ConversationsApi) GetConversationsCallback ¶

func (a ConversationsApi) GetConversationsCallback(conversationId string) (*Callbackconversation, *APIResponse, error)

GetConversationsCallback invokes GET /api/v2/conversations/callbacks/{conversationId}

Get callback conversation

func (ConversationsApi) GetConversationsCallbackParticipantWrapup ¶

func (a ConversationsApi) GetConversationsCallbackParticipantWrapup(conversationId string, participantId string, provisional bool) (*Assignedwrapupcode, *APIResponse, error)

GetConversationsCallbackParticipantWrapup invokes GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup

Get the wrap-up for this conversation participant.

func (ConversationsApi) GetConversationsCallbackParticipantWrapupcodes ¶

func (a ConversationsApi) GetConversationsCallbackParticipantWrapupcodes(conversationId string, participantId string) ([]Wrapupcode, *APIResponse, error)

GetConversationsCallbackParticipantWrapupcodes invokes GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes

Get list of wrapup codes for this conversation participant

func (ConversationsApi) GetConversationsCallbacks ¶

func (a ConversationsApi) GetConversationsCallbacks() (*Callbackconversationentitylisting, *APIResponse, error)

GetConversationsCallbacks invokes GET /api/v2/conversations/callbacks

Get active callback conversations for the logged in user

func (ConversationsApi) GetConversationsCalls ¶

func (a ConversationsApi) GetConversationsCalls() (*Callconversationentitylisting, *APIResponse, error)

GetConversationsCalls invokes GET /api/v2/conversations/calls

Get active call conversations for the logged in user

func (ConversationsApi) GetConversationsCallsHistory ¶

func (a ConversationsApi) GetConversationsCallsHistory(pageSize int, pageNumber int, interval string, expand []string) (*Callhistoryconversationentitylisting, *APIResponse, error)

GetConversationsCallsHistory invokes GET /api/v2/conversations/calls/history

Get call history

func (ConversationsApi) GetConversationsCallsMaximumconferenceparties ¶

func (a ConversationsApi) GetConversationsCallsMaximumconferenceparties() (*Maxparticipants, *APIResponse, error)

GetConversationsCallsMaximumconferenceparties invokes GET /api/v2/conversations/calls/maximumconferenceparties

Get the maximum number of participants that this user can have on a conference

func (ConversationsApi) GetConversationsChat ¶

func (a ConversationsApi) GetConversationsChat(conversationId string) (*Chatconversation, *APIResponse, error)

GetConversationsChat invokes GET /api/v2/conversations/chats/{conversationId}

Get chat conversation

func (ConversationsApi) GetConversationsChatMessage ¶

func (a ConversationsApi) GetConversationsChatMessage(conversationId string, messageId string) (*Webchatmessage, *APIResponse, error)

GetConversationsChatMessage invokes GET /api/v2/conversations/chats/{conversationId}/messages/{messageId}

Get a web chat conversation message ¶

The current user must be involved with the conversation to get its messages.

func (ConversationsApi) GetConversationsChatMessages ¶

func (a ConversationsApi) GetConversationsChatMessages(conversationId string, after string, before string, sortOrder string, maxResults int) (*Webchatmessageentitylist, *APIResponse, error)

GetConversationsChatMessages invokes GET /api/v2/conversations/chats/{conversationId}/messages

Get the messages of a chat conversation.

The current user must be involved with the conversation to get its messages.

func (ConversationsApi) GetConversationsChatParticipantWrapup ¶

func (a ConversationsApi) GetConversationsChatParticipantWrapup(conversationId string, participantId string, provisional bool) (*Assignedwrapupcode, *APIResponse, error)

GetConversationsChatParticipantWrapup invokes GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup

Get the wrap-up for this conversation participant.

func (ConversationsApi) GetConversationsChatParticipantWrapupcodes ¶

func (a ConversationsApi) GetConversationsChatParticipantWrapupcodes(conversationId string, participantId string) ([]Wrapupcode, *APIResponse, error)

GetConversationsChatParticipantWrapupcodes invokes GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes

Get list of wrapup codes for this conversation participant

func (ConversationsApi) GetConversationsChats ¶

func (a ConversationsApi) GetConversationsChats() (*Chatconversationentitylisting, *APIResponse, error)

GetConversationsChats invokes GET /api/v2/conversations/chats

Get active chat conversations for the logged in user

func (ConversationsApi) GetConversationsCobrowsesession ¶

func (a ConversationsApi) GetConversationsCobrowsesession(conversationId string) (*Cobrowseconversation, *APIResponse, error)

GetConversationsCobrowsesession invokes GET /api/v2/conversations/cobrowsesessions/{conversationId}

Get cobrowse conversation

func (ConversationsApi) GetConversationsCobrowsesessionParticipantWrapup ¶

func (a ConversationsApi) GetConversationsCobrowsesessionParticipantWrapup(conversationId string, participantId string, provisional bool) (*Assignedwrapupcode, *APIResponse, error)

GetConversationsCobrowsesessionParticipantWrapup invokes GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup

Get the wrap-up for this conversation participant.

func (ConversationsApi) GetConversationsCobrowsesessionParticipantWrapupcodes ¶

func (a ConversationsApi) GetConversationsCobrowsesessionParticipantWrapupcodes(conversationId string, participantId string) ([]Wrapupcode, *APIResponse, error)

GetConversationsCobrowsesessionParticipantWrapupcodes invokes GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes

Get list of wrapup codes for this conversation participant

func (ConversationsApi) GetConversationsCobrowsesessions ¶

func (a ConversationsApi) GetConversationsCobrowsesessions() (*Cobrowseconversationentitylisting, *APIResponse, error)

GetConversationsCobrowsesessions invokes GET /api/v2/conversations/cobrowsesessions

Get active cobrowse conversations for the logged in user

func (ConversationsApi) GetConversationsEmail ¶

func (a ConversationsApi) GetConversationsEmail(conversationId string) (*Emailconversation, *APIResponse, error)

GetConversationsEmail invokes GET /api/v2/conversations/emails/{conversationId}

Get email conversation

func (ConversationsApi) GetConversationsEmailMessage ¶

func (a ConversationsApi) GetConversationsEmailMessage(conversationId string, messageId string) (*Emailmessage, *APIResponse, error)

GetConversationsEmailMessage invokes GET /api/v2/conversations/emails/{conversationId}/messages/{messageId}

Get conversation message

func (ConversationsApi) GetConversationsEmailMessages ¶

func (a ConversationsApi) GetConversationsEmailMessages(conversationId string) (*Emailmessagelisting, *APIResponse, error)

GetConversationsEmailMessages invokes GET /api/v2/conversations/emails/{conversationId}/messages

Get conversation messages

func (ConversationsApi) GetConversationsEmailMessagesDraft ¶

func (a ConversationsApi) GetConversationsEmailMessagesDraft(conversationId string) (*Emailmessage, *APIResponse, error)

GetConversationsEmailMessagesDraft invokes GET /api/v2/conversations/emails/{conversationId}/messages/draft

Get conversation draft reply

func (ConversationsApi) GetConversationsEmailParticipantWrapup ¶

func (a ConversationsApi) GetConversationsEmailParticipantWrapup(conversationId string, participantId string, provisional bool) (*Assignedwrapupcode, *APIResponse, error)

GetConversationsEmailParticipantWrapup invokes GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup

Get the wrap-up for this conversation participant.

func (ConversationsApi) GetConversationsEmailParticipantWrapupcodes ¶

func (a ConversationsApi) GetConversationsEmailParticipantWrapupcodes(conversationId string, participantId string) ([]Wrapupcode, *APIResponse, error)

GetConversationsEmailParticipantWrapupcodes invokes GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes

Get list of wrapup codes for this conversation participant

func (ConversationsApi) GetConversationsEmails ¶

func (a ConversationsApi) GetConversationsEmails() (*Emailconversationentitylisting, *APIResponse, error)

GetConversationsEmails invokes GET /api/v2/conversations/emails

Get active email conversations for the logged in user

func (ConversationsApi) GetConversationsMessage ¶

func (a ConversationsApi) GetConversationsMessage(conversationId string) (*Messageconversation, *APIResponse, error)

GetConversationsMessage invokes GET /api/v2/conversations/messages/{conversationId}

Get message conversation

func (ConversationsApi) GetConversationsMessageCommunicationMessagesMediaMediaId ¶

func (a ConversationsApi) GetConversationsMessageCommunicationMessagesMediaMediaId(conversationId string, communicationId string, mediaId string) (*Messagemediadata, *APIResponse, error)

GetConversationsMessageCommunicationMessagesMediaMediaId invokes GET /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}

Get media ¶

See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.

func (ConversationsApi) GetConversationsMessageMessage ¶

func (a ConversationsApi) GetConversationsMessageMessage(conversationId string, messageId string) (*Messagedata, *APIResponse, error)

GetConversationsMessageMessage invokes GET /api/v2/conversations/messages/{conversationId}/messages/{messageId}

Get message

func (ConversationsApi) GetConversationsMessageParticipantWrapup ¶

func (a ConversationsApi) GetConversationsMessageParticipantWrapup(conversationId string, participantId string, provisional bool) (*Assignedwrapupcode, *APIResponse, error)

GetConversationsMessageParticipantWrapup invokes GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup

Get the wrap-up for this conversation participant.

func (ConversationsApi) GetConversationsMessageParticipantWrapupcodes ¶

func (a ConversationsApi) GetConversationsMessageParticipantWrapupcodes(conversationId string, participantId string) ([]Wrapupcode, *APIResponse, error)

GetConversationsMessageParticipantWrapupcodes invokes GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes

Get list of wrapup codes for this conversation participant

func (ConversationsApi) GetConversationsMessages ¶

func (a ConversationsApi) GetConversationsMessages() (*Messageconversationentitylisting, *APIResponse, error)

GetConversationsMessages invokes GET /api/v2/conversations/messages

Get active message conversations for the logged in user

func (ConversationsApi) GetConversationsMessagingFacebookApp ¶

func (a ConversationsApi) GetConversationsMessagingFacebookApp() (*Facebookappcredentials, *APIResponse, error)

GetConversationsMessagingFacebookApp invokes GET /api/v2/conversations/messaging/facebook/app

Get Genesys Facebook App Id

func (ConversationsApi) GetConversationsMessagingIntegrations ¶

func (a ConversationsApi) GetConversationsMessagingIntegrations(pageSize int, pageNumber int, expand string, supportedContentId string) (*Messagingintegrationentitylisting, *APIResponse, error)

GetConversationsMessagingIntegrations invokes GET /api/v2/conversations/messaging/integrations

Get a list of Integrations

func (ConversationsApi) GetConversationsMessagingIntegrationsFacebook ¶

func (a ConversationsApi) GetConversationsMessagingIntegrationsFacebook(pageSize int, pageNumber int, expand string, supportedContentId string) (*Facebookintegrationentitylisting, *APIResponse, error)

GetConversationsMessagingIntegrationsFacebook invokes GET /api/v2/conversations/messaging/integrations/facebook

Get a list of Facebook Integrations

func (ConversationsApi) GetConversationsMessagingIntegrationsFacebookIntegrationId ¶

func (a ConversationsApi) GetConversationsMessagingIntegrationsFacebookIntegrationId(integrationId string, expand string) (*Facebookintegration, *APIResponse, error)

GetConversationsMessagingIntegrationsFacebookIntegrationId invokes GET /api/v2/conversations/messaging/integrations/facebook/{integrationId}

Get a Facebook messaging integration

func (ConversationsApi) GetConversationsMessagingIntegrationsLine ¶

func (a ConversationsApi) GetConversationsMessagingIntegrationsLine(pageSize int, pageNumber int, expand string, supportedContentId string) (*Lineintegrationentitylisting, *APIResponse, error)

GetConversationsMessagingIntegrationsLine invokes GET /api/v2/conversations/messaging/integrations/line

Get a list of LINE messenger Integrations

func (ConversationsApi) GetConversationsMessagingIntegrationsLineIntegrationId ¶

func (a ConversationsApi) GetConversationsMessagingIntegrationsLineIntegrationId(integrationId string, expand string) (*Lineintegration, *APIResponse, error)

GetConversationsMessagingIntegrationsLineIntegrationId invokes GET /api/v2/conversations/messaging/integrations/line/{integrationId}

Get a LINE messenger integration

func (ConversationsApi) GetConversationsMessagingIntegrationsOpen ¶

func (a ConversationsApi) GetConversationsMessagingIntegrationsOpen(pageSize int, pageNumber int, expand string, supportedContentId string) (*Openintegrationentitylisting, *APIResponse, error)

GetConversationsMessagingIntegrationsOpen invokes GET /api/v2/conversations/messaging/integrations/open

Get a list of Open messaging integrations ¶

See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.

func (ConversationsApi) GetConversationsMessagingIntegrationsOpenIntegrationId ¶

func (a ConversationsApi) GetConversationsMessagingIntegrationsOpenIntegrationId(integrationId string, expand string) (*Openintegration, *APIResponse, error)

GetConversationsMessagingIntegrationsOpenIntegrationId invokes GET /api/v2/conversations/messaging/integrations/open/{integrationId}

Get an Open messaging integration ¶

See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.

func (ConversationsApi) GetConversationsMessagingIntegrationsTwitter ¶

func (a ConversationsApi) GetConversationsMessagingIntegrationsTwitter(pageSize int, pageNumber int, expand string, supportedContentId string) (*Twitterintegrationentitylisting, *APIResponse, error)

GetConversationsMessagingIntegrationsTwitter invokes GET /api/v2/conversations/messaging/integrations/twitter

Get a list of Twitter Integrations

func (ConversationsApi) GetConversationsMessagingIntegrationsTwitterIntegrationId ¶

func (a ConversationsApi) GetConversationsMessagingIntegrationsTwitterIntegrationId(integrationId string, expand string) (*Twitterintegration, *APIResponse, error)

GetConversationsMessagingIntegrationsTwitterIntegrationId invokes GET /api/v2/conversations/messaging/integrations/twitter/{integrationId}

Get a Twitter messaging integration

func (ConversationsApi) GetConversationsMessagingIntegrationsWhatsapp ¶

func (a ConversationsApi) GetConversationsMessagingIntegrationsWhatsapp(pageSize int, pageNumber int, expand string, supportedContentId string) (*Whatsappintegrationentitylisting, *APIResponse, error)

GetConversationsMessagingIntegrationsWhatsapp invokes GET /api/v2/conversations/messaging/integrations/whatsapp

Get a list of WhatsApp Integrations

func (ConversationsApi) GetConversationsMessagingIntegrationsWhatsappIntegrationId ¶

func (a ConversationsApi) GetConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId string, expand string) (*Whatsappintegration, *APIResponse, error)

GetConversationsMessagingIntegrationsWhatsappIntegrationId invokes GET /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}

Get a WhatsApp messaging integration

func (ConversationsApi) GetConversationsMessagingSticker ¶

func (a ConversationsApi) GetConversationsMessagingSticker(messengerType string, pageSize int, pageNumber int) (*Messagingstickerentitylisting, *APIResponse, error)

GetConversationsMessagingSticker invokes GET /api/v2/conversations/messaging/stickers/{messengerType}

Get a list of Messaging Stickers

func (ConversationsApi) GetConversationsMessagingThreadingtimeline ¶

func (a ConversationsApi) GetConversationsMessagingThreadingtimeline() (*Conversationthreadingwindow, *APIResponse, error)

GetConversationsMessagingThreadingtimeline invokes GET /api/v2/conversations/messaging/threadingtimeline

Get conversation threading window timeline for each messaging type ¶

Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline expires, a new conversation is created.

func (ConversationsApi) PatchConversationParticipant ¶

func (a ConversationsApi) PatchConversationParticipant(conversationId string, participantId string, body Mediaparticipantrequest) (*APIResponse, error)

PatchConversationParticipant invokes PATCH /api/v2/conversations/{conversationId}/participants/{participantId}

Update a participant.

Update conversation participant.

func (ConversationsApi) PatchConversationParticipantAttributes ¶

func (a ConversationsApi) PatchConversationParticipantAttributes(conversationId string, participantId string, body Participantattributes) (*APIResponse, error)

PatchConversationParticipantAttributes invokes PATCH /api/v2/conversations/{conversationId}/participants/{participantId}/attributes

Update the attributes on a conversation participant.

func (ConversationsApi) PatchConversationsCall ¶

func (a ConversationsApi) PatchConversationsCall(conversationId string, body Conversation) (*Conversation, *APIResponse, error)

PatchConversationsCall invokes PATCH /api/v2/conversations/calls/{conversationId}

Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants

func (ConversationsApi) PatchConversationsCallParticipant ¶

func (a ConversationsApi) PatchConversationsCallParticipant(conversationId string, participantId string, body Mediaparticipantrequest) (*APIResponse, error)

PatchConversationsCallParticipant invokes PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}

Update conversation participant

func (ConversationsApi) PatchConversationsCallParticipantAttributes ¶

func (a ConversationsApi) PatchConversationsCallParticipantAttributes(conversationId string, participantId string, body Participantattributes) (*APIResponse, error)

PatchConversationsCallParticipantAttributes invokes PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes

Update the attributes on a conversation participant.

func (ConversationsApi) PatchConversationsCallParticipantCommunication ¶

func (a ConversationsApi) PatchConversationsCallParticipantCommunication(conversationId string, participantId string, communicationId string, body Mediaparticipantrequest) (*Empty, *APIResponse, error)

PatchConversationsCallParticipantCommunication invokes PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}

Update conversation participant's communication by disconnecting it.

func (ConversationsApi) PatchConversationsCallParticipantConsult ¶

func (a ConversationsApi) PatchConversationsCallParticipantConsult(conversationId string, participantId string, body Consulttransferupdate) (*Consulttransferresponse, *APIResponse, error)

PatchConversationsCallParticipantConsult invokes PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult

Change who can speak

func (ConversationsApi) PatchConversationsCallback ¶

func (a ConversationsApi) PatchConversationsCallback(conversationId string, body Conversation) (*Conversation, *APIResponse, error)

PatchConversationsCallback invokes PATCH /api/v2/conversations/callbacks/{conversationId}

Update a conversation by disconnecting all of the participants

func (ConversationsApi) PatchConversationsCallbackParticipant ¶

func (a ConversationsApi) PatchConversationsCallbackParticipant(conversationId string, participantId string, body Mediaparticipantrequest) (*APIResponse, error)

PatchConversationsCallbackParticipant invokes PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}

Update conversation participant

func (ConversationsApi) PatchConversationsCallbackParticipantAttributes ¶

func (a ConversationsApi) PatchConversationsCallbackParticipantAttributes(conversationId string, participantId string, body Participantattributes) (*APIResponse, error)

PatchConversationsCallbackParticipantAttributes invokes PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes

Update the attributes on a conversation participant.

func (ConversationsApi) PatchConversationsCallbackParticipantCommunication ¶

func (a ConversationsApi) PatchConversationsCallbackParticipantCommunication(conversationId string, participantId string, communicationId string, body Mediaparticipantrequest) (*Empty, *APIResponse, error)

PatchConversationsCallbackParticipantCommunication invokes PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}

Update conversation participant's communication by disconnecting it.

func (ConversationsApi) PatchConversationsChat ¶

func (a ConversationsApi) PatchConversationsChat(conversationId string, body Conversation) (*Conversation, *APIResponse, error)

PatchConversationsChat invokes PATCH /api/v2/conversations/chats/{conversationId}

Update a conversation by disconnecting all of the participants

func (ConversationsApi) PatchConversationsChatParticipant ¶

func (a ConversationsApi) PatchConversationsChatParticipant(conversationId string, participantId string, body Mediaparticipantrequest) (*APIResponse, error)

PatchConversationsChatParticipant invokes PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}

Update conversation participant

func (ConversationsApi) PatchConversationsChatParticipantAttributes ¶

func (a ConversationsApi) PatchConversationsChatParticipantAttributes(conversationId string, participantId string, body Participantattributes) (*APIResponse, error)

PatchConversationsChatParticipantAttributes invokes PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes

Update the attributes on a conversation participant.

func (ConversationsApi) PatchConversationsChatParticipantCommunication ¶

func (a ConversationsApi) PatchConversationsChatParticipantCommunication(conversationId string, participantId string, communicationId string, body Mediaparticipantrequest) (*Empty, *APIResponse, error)

PatchConversationsChatParticipantCommunication invokes PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}

Update conversation participant's communication by disconnecting it.

func (ConversationsApi) PatchConversationsCobrowsesession ¶

func (a ConversationsApi) PatchConversationsCobrowsesession(conversationId string, body Conversation) (*Conversation, *APIResponse, error)

PatchConversationsCobrowsesession invokes PATCH /api/v2/conversations/cobrowsesessions/{conversationId}

Update a conversation by disconnecting all of the participants

func (ConversationsApi) PatchConversationsCobrowsesessionParticipant ¶

func (a ConversationsApi) PatchConversationsCobrowsesessionParticipant(conversationId string, participantId string, body Mediaparticipantrequest) (*APIResponse, error)

PatchConversationsCobrowsesessionParticipant invokes PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}

Update conversation participant

func (ConversationsApi) PatchConversationsCobrowsesessionParticipantAttributes ¶

func (a ConversationsApi) PatchConversationsCobrowsesessionParticipantAttributes(conversationId string, participantId string, body Participantattributes) (*APIResponse, error)

PatchConversationsCobrowsesessionParticipantAttributes invokes PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes

Update the attributes on a conversation participant.

func (ConversationsApi) PatchConversationsCobrowsesessionParticipantCommunication ¶

func (a ConversationsApi) PatchConversationsCobrowsesessionParticipantCommunication(conversationId string, participantId string, communicationId string, body Mediaparticipantrequest) (*Empty, *APIResponse, error)

PatchConversationsCobrowsesessionParticipantCommunication invokes PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}

Update conversation participant's communication by disconnecting it.

func (ConversationsApi) PatchConversationsEmail ¶

func (a ConversationsApi) PatchConversationsEmail(conversationId string, body Conversation) (*Conversation, *APIResponse, error)

PatchConversationsEmail invokes PATCH /api/v2/conversations/emails/{conversationId}

Update a conversation by disconnecting all of the participants

func (ConversationsApi) PatchConversationsEmailParticipant ¶

func (a ConversationsApi) PatchConversationsEmailParticipant(conversationId string, participantId string, body Mediaparticipantrequest) (*APIResponse, error)

PatchConversationsEmailParticipant invokes PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}

Update conversation participant

func (ConversationsApi) PatchConversationsEmailParticipantAttributes ¶

func (a ConversationsApi) PatchConversationsEmailParticipantAttributes(conversationId string, participantId string, body Participantattributes) (*APIResponse, error)

PatchConversationsEmailParticipantAttributes invokes PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes

Update the attributes on a conversation participant.

func (ConversationsApi) PatchConversationsEmailParticipantCommunication ¶

func (a ConversationsApi) PatchConversationsEmailParticipantCommunication(conversationId string, participantId string, communicationId string, body Mediaparticipantrequest) (*Empty, *APIResponse, error)

PatchConversationsEmailParticipantCommunication invokes PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}

Update conversation participant's communication by disconnecting it.

func (ConversationsApi) PatchConversationsMessage ¶

func (a ConversationsApi) PatchConversationsMessage(conversationId string, body Conversation) (*Conversation, *APIResponse, error)

PatchConversationsMessage invokes PATCH /api/v2/conversations/messages/{conversationId}

Update a conversation by disconnecting all of the participants

func (ConversationsApi) PatchConversationsMessageParticipant ¶

func (a ConversationsApi) PatchConversationsMessageParticipant(conversationId string, participantId string, body Mediaparticipantrequest) (*APIResponse, error)

PatchConversationsMessageParticipant invokes PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}

Update conversation participant

func (ConversationsApi) PatchConversationsMessageParticipantAttributes ¶

func (a ConversationsApi) PatchConversationsMessageParticipantAttributes(conversationId string, participantId string, body Participantattributes) (*APIResponse, error)

PatchConversationsMessageParticipantAttributes invokes PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes

Update the attributes on a conversation participant.

func (ConversationsApi) PatchConversationsMessageParticipantCommunication ¶

func (a ConversationsApi) PatchConversationsMessageParticipantCommunication(conversationId string, participantId string, communicationId string, body Mediaparticipantrequest) (*Empty, *APIResponse, error)

PatchConversationsMessageParticipantCommunication invokes PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}

Update conversation participant's communication by disconnecting it.

func (ConversationsApi) PatchConversationsMessagingIntegrationsFacebookIntegrationId ¶

func (a ConversationsApi) PatchConversationsMessagingIntegrationsFacebookIntegrationId(integrationId string, body Facebookintegrationupdaterequest) (*Facebookintegration, *APIResponse, error)

PatchConversationsMessagingIntegrationsFacebookIntegrationId invokes PATCH /api/v2/conversations/messaging/integrations/facebook/{integrationId}

Update Facebook messaging integration

func (ConversationsApi) PatchConversationsMessagingIntegrationsOpenIntegrationId ¶

func (a ConversationsApi) PatchConversationsMessagingIntegrationsOpenIntegrationId(integrationId string, body Openintegrationupdaterequest) (*Openintegration, *APIResponse, error)

PatchConversationsMessagingIntegrationsOpenIntegrationId invokes PATCH /api/v2/conversations/messaging/integrations/open/{integrationId}

Update an Open messaging integration ¶

See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.

func (ConversationsApi) PatchConversationsMessagingIntegrationsTwitterIntegrationId ¶

func (a ConversationsApi) PatchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId string, body Twitterintegrationrequest) (*Twitterintegration, *APIResponse, error)

PatchConversationsMessagingIntegrationsTwitterIntegrationId invokes PATCH /api/v2/conversations/messaging/integrations/twitter/{integrationId}

Update Twitter messaging integration

func (ConversationsApi) PatchConversationsMessagingIntegrationsWhatsappIntegrationId ¶

func (a ConversationsApi) PatchConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId string, body Whatsappintegrationupdaterequest) (*Whatsappintegration, *APIResponse, error)

PatchConversationsMessagingIntegrationsWhatsappIntegrationId invokes PATCH /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}

Update or activate a WhatsApp messaging integration.

The following steps are required in order to fully activate a Whatsapp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.

func (ConversationsApi) PostAnalyticsConversationDetailsProperties ¶

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

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

Index conversation properties

func (ConversationsApi) PostAnalyticsConversationsAggregatesQuery ¶

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

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

Query for conversation aggregates

func (ConversationsApi) PostAnalyticsConversationsDetailsJobs ¶

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

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

Query for conversation details asynchronously

func (ConversationsApi) PostAnalyticsConversationsDetailsQuery ¶

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

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

Query for conversation details

func (ConversationsApi) PostConversationAssign ¶

func (a ConversationsApi) PostConversationAssign(conversationId string, body Conversationuser) (*string, *APIResponse, error)

PostConversationAssign invokes POST /api/v2/conversations/{conversationId}/assign

Attempts to manually assign a specified conversation to a specified agent. Ignores bullseye ring, PAR score, skills, and languages.

func (ConversationsApi) PostConversationDisconnect ¶

func (a ConversationsApi) PostConversationDisconnect(conversationId string) (*string, *APIResponse, error)

PostConversationDisconnect invokes POST /api/v2/conversations/{conversationId}/disconnect

Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.

func (ConversationsApi) PostConversationParticipantCallbacks ¶

func (a ConversationsApi) PostConversationParticipantCallbacks(conversationId string, participantId string, body Createcallbackonconversationcommand) (*APIResponse, error)

PostConversationParticipantCallbacks invokes POST /api/v2/conversations/{conversationId}/participants/{participantId}/callbacks

Create a new callback for the specified participant on the conversation.

func (ConversationsApi) PostConversationParticipantDigits ¶

func (a ConversationsApi) PostConversationParticipantDigits(conversationId string, participantId string, body Digits) (*APIResponse, error)

PostConversationParticipantDigits invokes POST /api/v2/conversations/{conversationId}/participants/{participantId}/digits

Sends DTMF to the participant

func (ConversationsApi) PostConversationParticipantReplace ¶

func (a ConversationsApi) PostConversationParticipantReplace(conversationId string, participantId string, body Transferrequest) (*APIResponse, error)

PostConversationParticipantReplace invokes POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace

Replace this participant with the specified user and/or address

func (ConversationsApi) PostConversationParticipantSecureivrsessions ¶

func (a ConversationsApi) PostConversationParticipantSecureivrsessions(conversationId string, participantId string, body Createsecuresession) (*Securesession, *APIResponse, error)

PostConversationParticipantSecureivrsessions invokes POST /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions

Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.

func (ConversationsApi) PostConversationsCall ¶

func (a ConversationsApi) PostConversationsCall(conversationId string, body Callcommand) (*Conversation, *APIResponse, error)

PostConversationsCall invokes POST /api/v2/conversations/calls/{conversationId}

Place a new call as part of a callback conversation.

func (ConversationsApi) PostConversationsCallParticipantCoach ¶

func (a ConversationsApi) PostConversationsCallParticipantCoach(conversationId string, participantId string) (*APIResponse, error)

PostConversationsCallParticipantCoach invokes POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach

Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.

func (ConversationsApi) PostConversationsCallParticipantConsult ¶

func (a ConversationsApi) PostConversationsCallParticipantConsult(conversationId string, participantId string, body Consulttransfer) (*Consulttransferresponse, *APIResponse, error)

PostConversationsCallParticipantConsult invokes POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult

Initiate and update consult transfer

func (ConversationsApi) PostConversationsCallParticipantMonitor ¶

func (a ConversationsApi) PostConversationsCallParticipantMonitor(conversationId string, participantId string) (*APIResponse, error)

PostConversationsCallParticipantMonitor invokes POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor

Listen in on the conversation from the point of view of a given participant.

func (ConversationsApi) PostConversationsCallParticipantReplace ¶

func (a ConversationsApi) PostConversationsCallParticipantReplace(conversationId string, participantId string, body Transferrequest) (*APIResponse, error)

PostConversationsCallParticipantReplace invokes POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace

Replace this participant with the specified user and/or address

func (ConversationsApi) PostConversationsCallParticipants ¶

func (a ConversationsApi) PostConversationsCallParticipants(conversationId string, body Conversation) (*Conversation, *APIResponse, error)

PostConversationsCallParticipants invokes POST /api/v2/conversations/calls/{conversationId}/participants

Add participants to a conversation

func (ConversationsApi) PostConversationsCallbackParticipantReplace ¶

func (a ConversationsApi) PostConversationsCallbackParticipantReplace(conversationId string, participantId string, body Transferrequest) (*APIResponse, error)

PostConversationsCallbackParticipantReplace invokes POST /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace

Replace this participant with the specified user and/or address

func (ConversationsApi) PostConversationsCallbacks ¶

func (a ConversationsApi) PostConversationsCallbacks(body Createcallbackcommand) (*Createcallbackresponse, *APIResponse, error)

PostConversationsCallbacks invokes POST /api/v2/conversations/callbacks

Create a Callback

func (ConversationsApi) PostConversationsCalls ¶

func (a ConversationsApi) PostConversationsCalls(body Createcallrequest) (*Createcallresponse, *APIResponse, error)

PostConversationsCalls invokes POST /api/v2/conversations/calls

Create a call conversation

func (ConversationsApi) PostConversationsChatCommunicationMessages ¶

func (a ConversationsApi) PostConversationsChatCommunicationMessages(conversationId string, communicationId string, body Createwebchatmessagerequest) (*Webchatmessage, *APIResponse, error)

PostConversationsChatCommunicationMessages invokes POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages

Send a message on behalf of a communication in a chat conversation.

func (ConversationsApi) PostConversationsChatCommunicationTyping ¶

func (a ConversationsApi) PostConversationsChatCommunicationTyping(conversationId string, communicationId string) (*Webchattyping, *APIResponse, error)

PostConversationsChatCommunicationTyping invokes POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing

Send a typing-indicator on behalf of a communication in a chat conversation.

func (ConversationsApi) PostConversationsChatParticipantReplace ¶

func (a ConversationsApi) PostConversationsChatParticipantReplace(conversationId string, participantId string, body Transferrequest) (*APIResponse, error)

PostConversationsChatParticipantReplace invokes POST /api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace

Replace this participant with the specified user and/or address

func (ConversationsApi) PostConversationsChats ¶

func (a ConversationsApi) PostConversationsChats(body Createwebchatrequest) (*Chatconversation, *APIResponse, error)

PostConversationsChats invokes POST /api/v2/conversations/chats

Create a web chat conversation

func (ConversationsApi) PostConversationsCobrowsesessionParticipantReplace ¶

func (a ConversationsApi) PostConversationsCobrowsesessionParticipantReplace(conversationId string, participantId string, body Transferrequest) (*APIResponse, error)

PostConversationsCobrowsesessionParticipantReplace invokes POST /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace

Replace this participant with the specified user and/or address

func (ConversationsApi) PostConversationsEmailInboundmessages ¶

func (a ConversationsApi) PostConversationsEmailInboundmessages(conversationId string, body Inboundmessagerequest) (*Emailconversation, *APIResponse, error)

PostConversationsEmailInboundmessages invokes POST /api/v2/conversations/emails/{conversationId}/inboundmessages

Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.

func (ConversationsApi) PostConversationsEmailMessages ¶

func (a ConversationsApi) PostConversationsEmailMessages(conversationId string, body Emailmessage) (*Emailmessage, *APIResponse, error)

PostConversationsEmailMessages invokes POST /api/v2/conversations/emails/{conversationId}/messages

Send an email reply

func (ConversationsApi) PostConversationsEmailMessagesDraftAttachmentsCopy ¶

func (a ConversationsApi) PostConversationsEmailMessagesDraftAttachmentsCopy(conversationId string, body Copyattachmentsrequest) (*Emailmessage, *APIResponse, error)

PostConversationsEmailMessagesDraftAttachmentsCopy invokes POST /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy

Copy attachments from an email message to the current draft.

func (ConversationsApi) PostConversationsEmailParticipantReplace ¶

func (a ConversationsApi) PostConversationsEmailParticipantReplace(conversationId string, participantId string, body Transferrequest) (*APIResponse, error)

PostConversationsEmailParticipantReplace invokes POST /api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace

Replace this participant with the specified user and/or address

func (ConversationsApi) PostConversationsEmails ¶

func (a ConversationsApi) PostConversationsEmails(body Createemailrequest) (*Emailconversation, *APIResponse, error)

PostConversationsEmails invokes POST /api/v2/conversations/emails

Create an email conversation ¶

If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.

func (ConversationsApi) PostConversationsFaxes ¶

func (a ConversationsApi) PostConversationsFaxes(body Faxsendrequest) (*Faxsendresponse, *APIResponse, error)

PostConversationsFaxes invokes POST /api/v2/conversations/faxes

Create Fax Conversation

func (ConversationsApi) PostConversationsMessageCommunicationMessages ¶

func (a ConversationsApi) PostConversationsMessageCommunicationMessages(conversationId string, communicationId string, body Additionalmessage) (*Messagedata, *APIResponse, error)

PostConversationsMessageCommunicationMessages invokes POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages

Send message ¶

Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, 1 stickerId, or 1 messageTemplate.

func (ConversationsApi) PostConversationsMessageCommunicationMessagesMedia ¶

func (a ConversationsApi) PostConversationsMessageCommunicationMessagesMedia(conversationId string, communicationId string) (*Messagemediadata, *APIResponse, error)

PostConversationsMessageCommunicationMessagesMedia invokes POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media

Create media ¶

See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.

func (ConversationsApi) PostConversationsMessageMessagesBulk ¶

func (a ConversationsApi) PostConversationsMessageMessagesBulk(conversationId string, body []string) (*Textmessagelisting, *APIResponse, error)

PostConversationsMessageMessagesBulk invokes POST /api/v2/conversations/messages/{conversationId}/messages/bulk

Get messages in batch ¶

The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: [\"a3069a33b-bbb1-4703-9d68-061d9e9db96e\", \"55bc6be3-078c-4a49-a4e6-1e05776ed7e8\"]

func (ConversationsApi) PostConversationsMessageParticipantReplace ¶

func (a ConversationsApi) PostConversationsMessageParticipantReplace(conversationId string, participantId string, body Transferrequest) (*APIResponse, error)

PostConversationsMessageParticipantReplace invokes POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace

Replace this participant with the specified user and/or address

func (ConversationsApi) PostConversationsMessages ¶

PostConversationsMessages invokes POST /api/v2/conversations/messages

Create an outbound messaging conversation.

If there is an existing conversation between the remote address and the address associated with the queue specified in createOutboundRequest then the result of this request depends on the state of that conversation and the useExistingConversation field of createOutboundRequest. If the existing conversation is in alerting or connected state, then the request will fail. If the existing conversation is disconnected but still within the conversation window then the request will fail unless useExistingConversation is set to true.

func (ConversationsApi) PostConversationsMessagesAgentless ¶

PostConversationsMessagesAgentless invokes POST /api/v2/conversations/messages/agentless

Send an agentless outbound message ¶

Send an agentlesss (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail.

func (ConversationsApi) PostConversationsMessagesInboundOpen ¶

func (a ConversationsApi) PostConversationsMessagesInboundOpen(body Opennormalizedmessage) (*Opennormalizedmessage, *APIResponse, error)

PostConversationsMessagesInboundOpen invokes POST /api/v2/conversations/messages/inbound/open

Send an inbound Open Message ¶

Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.

func (ConversationsApi) PostConversationsMessagingIntegrationsFacebook ¶

func (a ConversationsApi) PostConversationsMessagingIntegrationsFacebook(body Facebookintegrationrequest) (*Facebookintegration, *APIResponse, error)

PostConversationsMessagingIntegrationsFacebook invokes POST /api/v2/conversations/messaging/integrations/facebook

Create a Facebook Integration

func (ConversationsApi) PostConversationsMessagingIntegrationsLine ¶

func (a ConversationsApi) PostConversationsMessagingIntegrationsLine(body Lineintegrationrequest) (*Lineintegration, *APIResponse, error)

PostConversationsMessagingIntegrationsLine invokes POST /api/v2/conversations/messaging/integrations/line

Create a LINE messenger Integration

func (ConversationsApi) PostConversationsMessagingIntegrationsOpen ¶

func (a ConversationsApi) PostConversationsMessagingIntegrationsOpen(body Openintegrationrequest) (*Openintegration, *APIResponse, error)

PostConversationsMessagingIntegrationsOpen invokes POST /api/v2/conversations/messaging/integrations/open

Create an Open messaging integration ¶

See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.

func (ConversationsApi) PostConversationsMessagingIntegrationsTwitter ¶

func (a ConversationsApi) PostConversationsMessagingIntegrationsTwitter(body Twitterintegrationrequest) (*Twitterintegration, *APIResponse, error)

PostConversationsMessagingIntegrationsTwitter invokes POST /api/v2/conversations/messaging/integrations/twitter

Create a Twitter Integration

func (ConversationsApi) PostConversationsMessagingIntegrationsWhatsapp ¶

func (a ConversationsApi) PostConversationsMessagingIntegrationsWhatsapp(body Whatsappintegrationrequest) (*Whatsappintegration, *APIResponse, error)

PostConversationsMessagingIntegrationsWhatsapp invokes POST /api/v2/conversations/messaging/integrations/whatsapp

Create a WhatsApp Integration ¶

You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.

func (ConversationsApi) PutConversationParticipantFlaggedreason ¶

func (a ConversationsApi) PutConversationParticipantFlaggedreason(conversationId string, participantId string) (*APIResponse, error)

PutConversationParticipantFlaggedreason invokes PUT /api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason

Set flagged reason on conversation participant to indicate bad conversation quality.

func (ConversationsApi) PutConversationsCallParticipantCommunicationUuidata ¶

func (a ConversationsApi) PutConversationsCallParticipantCommunicationUuidata(conversationId string, participantId string, communicationId string, body Setuuidatarequest) (*Empty, *APIResponse, error)

PutConversationsCallParticipantCommunicationUuidata invokes PUT /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata

Set uuiData to be sent on future commands.

func (ConversationsApi) PutConversationsEmailMessagesDraft ¶

func (a ConversationsApi) PutConversationsEmailMessagesDraft(conversationId string, body Emailmessage) (*Emailmessage, *APIResponse, error)

PutConversationsEmailMessagesDraft invokes PUT /api/v2/conversations/emails/{conversationId}/messages/draft

Update conversation draft reply

func (ConversationsApi) PutConversationsMessagingIntegrationsLineIntegrationId ¶

func (a ConversationsApi) PutConversationsMessagingIntegrationsLineIntegrationId(integrationId string, body Lineintegrationrequest) (*Lineintegration, *APIResponse, error)

PutConversationsMessagingIntegrationsLineIntegrationId invokes PUT /api/v2/conversations/messaging/integrations/line/{integrationId}

Update a LINE messenger integration

func (ConversationsApi) PutConversationsMessagingThreadingtimeline ¶

func (a ConversationsApi) PutConversationsMessagingThreadingtimeline(body Conversationthreadingwindow) (*Conversationthreadingwindow, *APIResponse, error)

PutConversationsMessagingThreadingtimeline invokes PUT /api/v2/conversations/messaging/threadingtimeline

Update conversation threading window timeline for each messaging type ¶

PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. The PUT replaces the existing setting(s) that were previously set for each messengerType.

type Conversationscreenshareeventtopicconversationroutingdata ¶

type Conversationscreenshareeventtopicconversationroutingdata struct {
	// Queue
	Queue *Conversationscreenshareeventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Conversationscreenshareeventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Conversationscreenshareeventtopicurireference `json:"skills,omitempty"`

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

Conversationscreenshareeventtopicconversationroutingdata

func (*Conversationscreenshareeventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Conversationscreenshareeventtopicdetail ¶

type Conversationscreenshareeventtopicdetail 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"`
}

Conversationscreenshareeventtopicdetail

func (*Conversationscreenshareeventtopicdetail) String ¶

String returns a JSON representation of the model

type Conversationscreenshareeventtopicerrorbody ¶

type Conversationscreenshareeventtopicerrorbody struct {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Conversationscreenshareeventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Conversationscreenshareeventtopicerrorbody `json:"errors,omitempty"`
}

Conversationscreenshareeventtopicerrorbody

func (*Conversationscreenshareeventtopicerrorbody) String ¶

String returns a JSON representation of the model

type Conversationscreenshareeventtopicjourneyaction ¶

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

	// ActionMap
	ActionMap *Conversationscreenshareeventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Conversationscreenshareeventtopicjourneyaction

func (*Conversationscreenshareeventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Conversationscreenshareeventtopicjourneyactionmap ¶

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

	// Version
	Version *int `json:"version,omitempty"`
}

Conversationscreenshareeventtopicjourneyactionmap

func (*Conversationscreenshareeventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Conversationscreenshareeventtopicjourneycontext ¶

type Conversationscreenshareeventtopicjourneycontext struct {
	// Customer
	Customer *Conversationscreenshareeventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Conversationscreenshareeventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Conversationscreenshareeventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Conversationscreenshareeventtopicjourneycontext

func (*Conversationscreenshareeventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Conversationscreenshareeventtopicjourneycustomer ¶

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

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Conversationscreenshareeventtopicjourneycustomer

func (*Conversationscreenshareeventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Conversationscreenshareeventtopicjourneycustomersession ¶

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

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

Conversationscreenshareeventtopicjourneycustomersession

func (*Conversationscreenshareeventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Conversationscreenshareeventtopicscoredagent ¶

type Conversationscreenshareeventtopicscoredagent struct {
	// Agent
	Agent *Conversationscreenshareeventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Conversationscreenshareeventtopicscoredagent

func (*Conversationscreenshareeventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Conversationscreenshareeventtopicscreenshareconversation ¶

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

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

	// Participants
	Participants *[]Conversationscreenshareeventtopicscreensharemediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`
}

Conversationscreenshareeventtopicscreenshareconversation

func (*Conversationscreenshareeventtopicscreenshareconversation) String ¶

String returns a JSON representation of the model

type Conversationscreenshareeventtopicscreensharemediaparticipant ¶

type Conversationscreenshareeventtopicscreensharemediaparticipant 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 *Conversationscreenshareeventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Conversationscreenshareeventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Conversationscreenshareeventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Conversationscreenshareeventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Conversationscreenshareeventtopicurireference `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 *Conversationscreenshareeventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Conversationscreenshareeventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Conversationscreenshareeventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Conversationscreenshareeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Conversationscreenshareeventtopicjourneycontext `json:"journeyContext,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// Context
	Context *string `json:"context,omitempty"`

	// PeerCount
	PeerCount *int `json:"peerCount,omitempty"`

	// Sharing
	Sharing *bool `json:"sharing,omitempty"`
}

Conversationscreenshareeventtopicscreensharemediaparticipant

func (*Conversationscreenshareeventtopicscreensharemediaparticipant) String ¶

String returns a JSON representation of the model

type Conversationscreenshareeventtopicurireference ¶

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

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

Conversationscreenshareeventtopicurireference

func (*Conversationscreenshareeventtopicurireference) String ¶

String returns a JSON representation of the model

type Conversationscreenshareeventtopicwrapup ¶

type Conversationscreenshareeventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Conversationscreenshareeventtopicwrapup

func (*Conversationscreenshareeventtopicwrapup) String ¶

String returns a JSON representation of the model

type Conversationsocialexpressioneventtopicconversationroutingdata ¶

type Conversationsocialexpressioneventtopicconversationroutingdata struct {
	// Queue
	Queue *Conversationsocialexpressioneventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Conversationsocialexpressioneventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Conversationsocialexpressioneventtopicurireference `json:"skills,omitempty"`

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

Conversationsocialexpressioneventtopicconversationroutingdata

func (*Conversationsocialexpressioneventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Conversationsocialexpressioneventtopicdetail ¶

type Conversationsocialexpressioneventtopicdetail 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"`
}

Conversationsocialexpressioneventtopicdetail

func (*Conversationsocialexpressioneventtopicdetail) String ¶

String returns a JSON representation of the model

type Conversationsocialexpressioneventtopicerrorbody ¶

type Conversationsocialexpressioneventtopicerrorbody struct {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Conversationsocialexpressioneventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Conversationsocialexpressioneventtopicerrorbody `json:"errors,omitempty"`
}

Conversationsocialexpressioneventtopicerrorbody

func (*Conversationsocialexpressioneventtopicerrorbody) String ¶

String returns a JSON representation of the model

type Conversationsocialexpressioneventtopicjourneyaction ¶

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

	// ActionMap
	ActionMap *Conversationsocialexpressioneventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Conversationsocialexpressioneventtopicjourneyaction

func (*Conversationsocialexpressioneventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Conversationsocialexpressioneventtopicjourneyactionmap ¶

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

	// Version
	Version *int `json:"version,omitempty"`
}

Conversationsocialexpressioneventtopicjourneyactionmap

func (*Conversationsocialexpressioneventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Conversationsocialexpressioneventtopicjourneycontext ¶

type Conversationsocialexpressioneventtopicjourneycontext struct {
	// Customer
	Customer *Conversationsocialexpressioneventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Conversationsocialexpressioneventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Conversationsocialexpressioneventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Conversationsocialexpressioneventtopicjourneycontext

func (*Conversationsocialexpressioneventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Conversationsocialexpressioneventtopicjourneycustomer ¶

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

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Conversationsocialexpressioneventtopicjourneycustomer

func (*Conversationsocialexpressioneventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Conversationsocialexpressioneventtopicjourneycustomersession ¶

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

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

Conversationsocialexpressioneventtopicjourneycustomersession

func (*Conversationsocialexpressioneventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Conversationsocialexpressioneventtopicscoredagent ¶

type Conversationsocialexpressioneventtopicscoredagent struct {
	// Agent
	Agent *Conversationsocialexpressioneventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Conversationsocialexpressioneventtopicscoredagent

func (*Conversationsocialexpressioneventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Conversationsocialexpressioneventtopicsocialconversation ¶

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

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

	// Participants
	Participants *[]Conversationsocialexpressioneventtopicsocialmediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`
}

Conversationsocialexpressioneventtopicsocialconversation

func (*Conversationsocialexpressioneventtopicsocialconversation) String ¶

String returns a JSON representation of the model

type Conversationsocialexpressioneventtopicsocialmediaparticipant ¶

type Conversationsocialexpressioneventtopicsocialmediaparticipant 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 *Conversationsocialexpressioneventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Conversationsocialexpressioneventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Conversationsocialexpressioneventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Conversationsocialexpressioneventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Conversationsocialexpressioneventtopicurireference `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 *Conversationsocialexpressioneventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Conversationsocialexpressioneventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Conversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Conversationsocialexpressioneventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Conversationsocialexpressioneventtopicjourneycontext `json:"journeyContext,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// SocialMediaId
	SocialMediaId *string `json:"socialMediaId,omitempty"`

	// SocialMediaHub
	SocialMediaHub *string `json:"socialMediaHub,omitempty"`

	// SocialUserName
	SocialUserName *string `json:"socialUserName,omitempty"`

	// PreviewText
	PreviewText *string `json:"previewText,omitempty"`
}

Conversationsocialexpressioneventtopicsocialmediaparticipant

func (*Conversationsocialexpressioneventtopicsocialmediaparticipant) String ¶

String returns a JSON representation of the model

type Conversationsocialexpressioneventtopicurireference ¶

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

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

Conversationsocialexpressioneventtopicurireference

func (*Conversationsocialexpressioneventtopicurireference) String ¶

String returns a JSON representation of the model

type Conversationsocialexpressioneventtopicwrapup ¶

type Conversationsocialexpressioneventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Conversationsocialexpressioneventtopicwrapup

func (*Conversationsocialexpressioneventtopicwrapup) String ¶

String returns a JSON representation of the model

type Conversationthreadingwindow ¶

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

	// Settings - The conversation threading window timeout (Minutes) for each messaging type
	Settings *[]Conversationthreadingwindowsetting `json:"settings,omitempty"`

	// DefaultTimeoutMinutes - The default conversation threading window timeout (Minutes)
	DefaultTimeoutMinutes *int `json:"defaultTimeoutMinutes,omitempty"`
}

Conversationthreadingwindow

func (*Conversationthreadingwindow) String ¶

func (o *Conversationthreadingwindow) String() string

String returns a JSON representation of the model

type Conversationthreadingwindowsetting ¶

type Conversationthreadingwindowsetting struct {
	// MessengerType - The type of messenger
	MessengerType *string `json:"messengerType,omitempty"`

	// TimeoutInMinutes - The conversation threading window timeout (Minutes) of specified messenger type
	TimeoutInMinutes *int `json:"timeoutInMinutes,omitempty"`
}

Conversationthreadingwindowsetting

func (*Conversationthreadingwindowsetting) String ¶

String returns a JSON representation of the model

type Conversationuser ¶

type Conversationuser struct {
	// Id - The globally unique identifier for this user.
	Id *string `json:"id,omitempty"`
}

Conversationuser

func (*Conversationuser) String ¶

func (o *Conversationuser) String() string

String returns a JSON representation of the model

type Conversationvideoeventtopicconversationroutingdata ¶

type Conversationvideoeventtopicconversationroutingdata struct {
	// Queue
	Queue *Conversationvideoeventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Conversationvideoeventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Conversationvideoeventtopicurireference `json:"skills,omitempty"`

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

Conversationvideoeventtopicconversationroutingdata

func (*Conversationvideoeventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Conversationvideoeventtopicdetail ¶

type Conversationvideoeventtopicdetail 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"`
}

Conversationvideoeventtopicdetail

func (*Conversationvideoeventtopicdetail) String ¶

String returns a JSON representation of the model

type Conversationvideoeventtopicerrorbody ¶

type Conversationvideoeventtopicerrorbody struct {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Conversationvideoeventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Conversationvideoeventtopicerrorbody `json:"errors,omitempty"`
}

Conversationvideoeventtopicerrorbody

func (*Conversationvideoeventtopicerrorbody) String ¶

String returns a JSON representation of the model

type Conversationvideoeventtopicjourneyaction ¶

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

	// ActionMap
	ActionMap *Conversationvideoeventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Conversationvideoeventtopicjourneyaction

func (*Conversationvideoeventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Conversationvideoeventtopicjourneyactionmap ¶

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

	// Version
	Version *int `json:"version,omitempty"`
}

Conversationvideoeventtopicjourneyactionmap

func (*Conversationvideoeventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Conversationvideoeventtopicjourneycontext ¶

type Conversationvideoeventtopicjourneycontext struct {
	// Customer
	Customer *Conversationvideoeventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Conversationvideoeventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Conversationvideoeventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Conversationvideoeventtopicjourneycontext

func (*Conversationvideoeventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Conversationvideoeventtopicjourneycustomer ¶

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

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Conversationvideoeventtopicjourneycustomer

func (*Conversationvideoeventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Conversationvideoeventtopicjourneycustomersession ¶

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

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

Conversationvideoeventtopicjourneycustomersession

func (*Conversationvideoeventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Conversationvideoeventtopicscoredagent ¶

type Conversationvideoeventtopicscoredagent struct {
	// Agent
	Agent *Conversationvideoeventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Conversationvideoeventtopicscoredagent

func (*Conversationvideoeventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Conversationvideoeventtopicurireference ¶

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

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

Conversationvideoeventtopicurireference

func (*Conversationvideoeventtopicurireference) String ¶

String returns a JSON representation of the model

type Conversationvideoeventtopicvideoconversation ¶

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

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

	// Participants
	Participants *[]Conversationvideoeventtopicvideomediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`
}

Conversationvideoeventtopicvideoconversation

func (*Conversationvideoeventtopicvideoconversation) String ¶

String returns a JSON representation of the model

type Conversationvideoeventtopicvideomediaparticipant ¶

type Conversationvideoeventtopicvideomediaparticipant 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 *Conversationvideoeventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Conversationvideoeventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Conversationvideoeventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Conversationvideoeventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Conversationvideoeventtopicurireference `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 *Conversationvideoeventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Conversationvideoeventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Conversationvideoeventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Conversationvideoeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Conversationvideoeventtopicjourneycontext `json:"journeyContext,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

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

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

	// SharingScreen
	SharingScreen *bool `json:"sharingScreen,omitempty"`

	// PeerCount
	PeerCount *int `json:"peerCount,omitempty"`

	// Context
	Context *string `json:"context,omitempty"`

	// Msids
	Msids *[]string `json:"msids,omitempty"`
}

Conversationvideoeventtopicvideomediaparticipant

func (*Conversationvideoeventtopicvideomediaparticipant) String ¶

String returns a JSON representation of the model

type Conversationvideoeventtopicwrapup ¶

type Conversationvideoeventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Conversationvideoeventtopicwrapup

func (*Conversationvideoeventtopicwrapup) String ¶

String returns a JSON representation of the model

type Copyattachmentsrequest ¶

type Copyattachmentsrequest struct {
	// SourceMessage - A reference to the email message within the current conversation that owns the attachments to be copied
	SourceMessage *Domainentityref `json:"sourceMessage,omitempty"`

	// Attachments - A list of attachments that will be copied from the source message to the current draft
	Attachments *[]Attachment `json:"attachments,omitempty"`
}

Copyattachmentsrequest

func (*Copyattachmentsrequest) String ¶

func (o *Copyattachmentsrequest) String() string

String returns a JSON representation of the model

type Copybuforecastrequest ¶

type Copybuforecastrequest struct {
	// Description - The description for the forecast
	Description *string `json:"description,omitempty"`

	// WeekDate - The start date of the new forecast to create from the existing forecast. Must correspond to the start day of week for the business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	WeekDate *time.Time `json:"weekDate,omitempty"`
}

Copybuforecastrequest

func (*Copybuforecastrequest) String ¶

func (o *Copybuforecastrequest) String() string

String returns a JSON representation of the model

type Copyvoicemailmessage ¶

type Copyvoicemailmessage struct {
	// VoicemailMessageId - The id of the VoicemailMessage to copy
	VoicemailMessageId *string `json:"voicemailMessageId,omitempty"`

	// UserId - The id of the User to copy the VoicemailMessage to
	UserId *string `json:"userId,omitempty"`

	// GroupId - The id of the Group to copy the VoicemailMessage to
	GroupId *string `json:"groupId,omitempty"`
}

Copyvoicemailmessage - Used to copy a VoicemailMessage to either a User or a Group

func (*Copyvoicemailmessage) String ¶

func (o *Copyvoicemailmessage) String() string

String returns a JSON representation of the model

type Copyworkplan ¶

type Copyworkplan struct {
	// Name - Name of the copied work plan
	Name *string `json:"name,omitempty"`
}

Copyworkplan - Information associated with a work plan thats created as a copy

func (*Copyworkplan) String ¶

func (o *Copyworkplan) String() string

String returns a JSON representation of the model

type Copyworkplanrotationrequest ¶

type Copyworkplanrotationrequest struct {
	// Name - Name to apply to the new copy of the work plan rotation
	Name *string `json:"name,omitempty"`
}

Copyworkplanrotationrequest

func (*Copyworkplanrotationrequest) String ¶

func (o *Copyworkplanrotationrequest) String() string

String returns a JSON representation of the model

type Coretype ¶

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

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

	// Version - A positive integer denoting the core type's version
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the core type 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"`

	// Schema - The core type's built-in schema
	Schema *Schema `json:"schema,omitempty"`

	// Current - A boolean indicating if the core type's version is the current one in use by the system
	Current *bool `json:"current,omitempty"`

	// ValidationFields - An array of strings naming the fields of the core type subject to validation.  Validation constraints are specified by a schema author using the core type.
	ValidationFields *[]string `json:"validationFields,omitempty"`

	// ValidationLimits - A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types.  For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field.  Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.
	ValidationLimits *Validationlimits `json:"validationLimits,omitempty"`

	// ItemValidationFields - Specific to the \"tag\" core type, this is an array of strings naming the tag item fields of the core type subject to validation
	ItemValidationFields *[]string `json:"itemValidationFields,omitempty"`

	// ItemValidationLimits - A structure denoting the system-imposed minimum and maximum string length for string-array based core types such as \"tag\" and \"enum\".  Forexample, the validationLimits for a schema field using a tag core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schema author on individual tags.  Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field's tags.
	ItemValidationLimits *Itemvalidationlimits `json:"itemValidationLimits,omitempty"`

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

Coretype

func (*Coretype) String ¶

func (o *Coretype) String() string

String returns a JSON representation of the model

type Coretypelisting ¶

type Coretypelisting struct {
	// Total
	Total *int `json:"total,omitempty"`

	// Entities
	Entities *[]Coretype `json:"entities,omitempty"`

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

Coretypelisting

func (*Coretypelisting) String ¶

func (o *Coretypelisting) String() string

String returns a JSON representation of the model

type Coversheet ¶

type Coversheet struct {
	// Notes - Text to be added to the coversheet
	Notes *string `json:"notes,omitempty"`

	// Locale - Locale, e.g. = en-US
	Locale *string `json:"locale,omitempty"`
}

Coversheet

func (*Coversheet) String ¶

func (o *Coversheet) String() string

String returns a JSON representation of the model

type Createactivitycoderequest ¶

type Createactivitycoderequest struct {
	// Name - The name of the activity code
	Name *string `json:"name,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 work time
	CountsAsWorkTime *bool `json:"countsAsWorkTime,omitempty"`

	// AgentTimeOffSelectable - Whether an agent can select this activity code when creating or editing a time off request
	AgentTimeOffSelectable *bool `json:"agentTimeOffSelectable,omitempty"`
}

Createactivitycoderequest - Activity Code

func (*Createactivitycoderequest) String ¶

func (o *Createactivitycoderequest) String() string

String returns a JSON representation of the model

type Createadmintimeoffrequest ¶

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

	// Users - A set of IDs for users to associate with this time off request
	Users *[]Userreference `json:"users,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"`
}

Createadmintimeoffrequest

func (*Createadmintimeoffrequest) String ¶

func (o *Createadmintimeoffrequest) String() string

String returns a JSON representation of the model

type Createagenttimeoffrequest ¶

type Createagenttimeoffrequest struct {
	// 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"`
}

Createagenttimeoffrequest

func (*Createagenttimeoffrequest) String ¶

func (o *Createagenttimeoffrequest) String() string

String returns a JSON representation of the model

type Createbenefitassessmentjobrequest ¶

type Createbenefitassessmentjobrequest struct {
	// DivisionIds - The list of division ids for routing queues that are to be assessed for Predictive Routing benefit.
	DivisionIds *[]string `json:"divisionIds,omitempty"`
}

Createbenefitassessmentjobrequest

func (*Createbenefitassessmentjobrequest) String ¶

String returns a JSON representation of the model

type Createbenefitassessmentrequest ¶

type Createbenefitassessmentrequest struct {
	// QueueIds - The list of queue ids that are to be assessed for Predictive Routing benefit.
	QueueIds *[]string `json:"queueIds,omitempty"`
}

Createbenefitassessmentrequest

func (*Createbenefitassessmentrequest) String ¶

String returns a JSON representation of the model

type Createbusinessunitrequest ¶

type Createbusinessunitrequest struct {
	// Name - The name of the business unit
	Name *string `json:"name,omitempty"`

	// DivisionId - The ID of the division to which the business unit should be added
	DivisionId *string `json:"divisionId,omitempty"`

	// Settings - Configuration for the business unit
	Settings *Createbusinessunitsettings `json:"settings,omitempty"`
}

Createbusinessunitrequest

func (*Createbusinessunitrequest) String ¶

func (o *Createbusinessunitrequest) String() string

String returns a JSON representation of the model

type Createbusinessunitsettings ¶

type Createbusinessunitsettings 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"`
}

Createbusinessunitsettings

func (*Createbusinessunitsettings) String ¶

func (o *Createbusinessunitsettings) String() string

String returns a JSON representation of the model

type Createcallbackcommand ¶

type Createcallbackcommand struct {
	// ScriptId - The identifier of the script to be used for the callback
	ScriptId *string `json:"scriptId,omitempty"`

	// QueueId - The identifier of the queue to be used for the callback. Either queueId or routingData is required.
	QueueId *string `json:"queueId,omitempty"`

	// RoutingData - The routing data to be used for the callback. Either queueId or routingData is required.
	RoutingData *Routingdata `json:"routingData,omitempty"`

	// CallbackUserName - The name of the party to be called back.
	CallbackUserName *string `json:"callbackUserName,omitempty"`

	// CallbackNumbers - A list of phone numbers for the callback.
	CallbackNumbers *[]string `json:"callbackNumbers,omitempty"`

	// CallbackScheduledTime - The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
	CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"`

	// CountryCode - The country code to be associated with the callback numbers.
	CountryCode *string `json:"countryCode,omitempty"`

	// ValidateCallbackNumbers - Whether or not to validate the callback numbers for phone number format.
	ValidateCallbackNumbers *bool `json:"validateCallbackNumbers,omitempty"`

	// Data - A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }
	Data *map[string]string `json:"data,omitempty"`

	// CallerId - The phone number displayed to recipients when a phone call is placed as part of the callback. Must conform to the E.164 format. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerId\" varies.
	CallerId *string `json:"callerId,omitempty"`

	// CallerIdName - The name displayed to recipients when a phone call is placed as part of the callback. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerIdName\" varies.
	CallerIdName *string `json:"callerIdName,omitempty"`
}

Createcallbackcommand

func (*Createcallbackcommand) String ¶

func (o *Createcallbackcommand) String() string

String returns a JSON representation of the model

type Createcallbackonconversationcommand ¶

type Createcallbackonconversationcommand struct {
	// ScriptId - The identifier of the script to be used for the callback
	ScriptId *string `json:"scriptId,omitempty"`

	// QueueId - The identifier of the queue to be used for the callback. Either queueId or routingData is required.
	QueueId *string `json:"queueId,omitempty"`

	// RoutingData - The routing data to be used for the callback. Either queueId or routingData is required.
	RoutingData *Routingdata `json:"routingData,omitempty"`

	// CallbackUserName - The name of the party to be called back.
	CallbackUserName *string `json:"callbackUserName,omitempty"`

	// CallbackNumbers - A list of phone numbers for the callback.
	CallbackNumbers *[]string `json:"callbackNumbers,omitempty"`

	// CallbackScheduledTime - The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
	CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"`

	// CountryCode - The country code to be associated with the callback numbers.
	CountryCode *string `json:"countryCode,omitempty"`

	// ValidateCallbackNumbers - Whether or not to validate the callback numbers for phone number format.
	ValidateCallbackNumbers *bool `json:"validateCallbackNumbers,omitempty"`

	// Data - A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }
	Data *map[string]string `json:"data,omitempty"`

	// CallerId - The phone number displayed to recipients when a phone call is placed as part of the callback. Must conform to the E.164 format. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerId\" varies.
	CallerId *string `json:"callerId,omitempty"`

	// CallerIdName - The name displayed to recipients when a phone call is placed as part of the callback. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerIdName\" varies.
	CallerIdName *string `json:"callerIdName,omitempty"`
}

Createcallbackonconversationcommand

func (*Createcallbackonconversationcommand) String ¶

String returns a JSON representation of the model

type Createcallbackresponse ¶

type Createcallbackresponse struct {
	// Conversation - The conversation associated with the callback
	Conversation *Domainentityref `json:"conversation,omitempty"`

	// CallbackIdentifiers - The list of communication identifiers for the callback participants
	CallbackIdentifiers *[]Callbackidentifier `json:"callbackIdentifiers,omitempty"`
}

Createcallbackresponse

func (*Createcallbackresponse) String ¶

func (o *Createcallbackresponse) String() string

String returns a JSON representation of the model

type Createcallrequest ¶

type Createcallrequest struct {
	// PhoneNumber - The phone number to dial.
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// CallerId - The caller id phone number for this outbound call.
	CallerId *string `json:"callerId,omitempty"`

	// CallerIdName - The caller id name for this outbound call.
	CallerIdName *string `json:"callerIdName,omitempty"`

	// CallFromQueueId - The queue ID to call on behalf of.
	CallFromQueueId *string `json:"callFromQueueId,omitempty"`

	// CallQueueId - The queue ID to call.
	CallQueueId *string `json:"callQueueId,omitempty"`

	// CallUserId - The user ID to call.
	CallUserId *string `json:"callUserId,omitempty"`

	// Priority - The priority to assign to this call (if calling a queue).
	Priority *int `json:"priority,omitempty"`

	// LanguageId - The language skill ID to use for routing this call (if calling a queue).
	LanguageId *string `json:"languageId,omitempty"`

	// RoutingSkillsIds - The skill ID's to use for routing this call (if calling a queue).
	RoutingSkillsIds *[]string `json:"routingSkillsIds,omitempty"`

	// ConversationIds - The list of existing call conversations to merge into a new ad-hoc conference.
	ConversationIds *[]string `json:"conversationIds,omitempty"`

	// Participants - The list of participants to call to create a new ad-hoc conference.
	Participants *[]Destination `json:"participants,omitempty"`

	// UuiData - User to User Information (UUI) data managed by SIP session application.
	UuiData *string `json:"uuiData,omitempty"`
}

Createcallrequest

func (*Createcallrequest) String ¶

func (o *Createcallrequest) String() string

String returns a JSON representation of the model

type Createcallresponse ¶

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

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

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

Createcallresponse

func (*Createcallresponse) String ¶

func (o *Createcallresponse) String() string

String returns a JSON representation of the model

type Createcoachingappointmentrequest ¶

type Createcoachingappointmentrequest struct {
	// 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. Times will be rounded down to the minute. 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"`

	// FacilitatorId - The facilitator ID of coaching appointment.
	FacilitatorId *string `json:"facilitatorId,omitempty"`

	// AttendeeIds - IDs of attendees in the coaching appointment.
	AttendeeIds *[]string `json:"attendeeIds,omitempty"`

	// ConversationIds - IDs of conversations associated with this coaching appointment.
	ConversationIds *[]string `json:"conversationIds,omitempty"`

	// DocumentIds - IDs of documents associated with this coaching appointment.
	DocumentIds *[]string `json:"documentIds,omitempty"`
}

Createcoachingappointmentrequest - Create coaching appointment request

func (*Createcoachingappointmentrequest) String ¶

String returns a JSON representation of the model

type Createemailrequest ¶

type Createemailrequest struct {
	// QueueId - The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId
	QueueId *string `json:"queueId,omitempty"`

	// FlowId - The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId
	FlowId *string `json:"flowId,omitempty"`

	// Provider - The name of the provider that is sourcing the emails. The Provider \"PureCloud Email\" is reserved for native emails.
	Provider *string `json:"provider,omitempty"`

	// SkillIds - The list of skill ID's to use for routing.
	SkillIds *[]string `json:"skillIds,omitempty"`

	// LanguageId - The ID of the language to use for routing.
	LanguageId *string `json:"languageId,omitempty"`

	// Priority - The priority to assign to the conversation for routing.
	Priority *int `json:"priority,omitempty"`

	// Attributes - The list of attributes to associate with the customer participant.
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ToAddress - The email address of the recipient of the email.
	ToAddress *string `json:"toAddress,omitempty"`

	// ToName - The name of the recipient of the email.
	ToName *string `json:"toName,omitempty"`

	// FromAddress - The email address of the sender of the email.
	FromAddress *string `json:"fromAddress,omitempty"`

	// FromName - The name of the sender of the email.
	FromName *string `json:"fromName,omitempty"`

	// Subject - The subject of the email
	Subject *string `json:"subject,omitempty"`

	// Direction - Specify OUTBOUND to send an email on behalf of a queue, or INBOUND to create an external conversation. An external conversation is one where the provider is not PureCloud based.
	Direction *string `json:"direction,omitempty"`

	// HtmlBody - An HTML body content of the email.
	HtmlBody *string `json:"htmlBody,omitempty"`

	// TextBody - A text body content of the email.
	TextBody *string `json:"textBody,omitempty"`
}

Createemailrequest

func (*Createemailrequest) String ¶

func (o *Createemailrequest) String() string

String returns a JSON representation of the model

type Createintegrationrequest ¶

type Createintegrationrequest 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 to create.
	IntegrationType *Integrationtype `json:"integrationType,omitempty"`

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

Createintegrationrequest - Details for an Integration

func (*Createintegrationrequest) String ¶

func (o *Createintegrationrequest) String() string

String returns a JSON representation of the model

type Createmanagementunitapirequest ¶

type Createmanagementunitapirequest struct {
	// Name - The name of the management unit
	Name *string `json:"name,omitempty"`

	// TimeZone - The default time zone to use for this management unit.  Moving to Business Unit
	TimeZone *string `json:"timeZone,omitempty"`

	// StartDayOfWeek - The configured first day of the week for scheduling and forecasting purposes. Moving to Business Unit
	StartDayOfWeek *string `json:"startDayOfWeek,omitempty"`

	// Settings - The configuration for the management unit.  If omitted, reasonable defaults will be assigned
	Settings *Createmanagementunitsettingsrequest `json:"settings,omitempty"`

	// DivisionId - The id of the division to which this management unit belongs.  Defaults to home division ID
	DivisionId *string `json:"divisionId,omitempty"`

	// BusinessUnitId - The id of the business unit to which this management unit belongs
	BusinessUnitId *string `json:"businessUnitId,omitempty"`
}

Createmanagementunitapirequest - Create Management Unit

func (*Createmanagementunitapirequest) String ¶

String returns a JSON representation of the model

type Createmanagementunitsettingsrequest ¶

type Createmanagementunitsettingsrequest struct {
	// Adherence - Adherence settings for this management unit
	Adherence *Adherencesettings `json:"adherence,omitempty"`

	// ShortTermForecasting - Short term forecasting settings for this management unit.  Moving to Business Unit
	ShortTermForecasting *Shorttermforecastingsettings `json:"shortTermForecasting,omitempty"`

	// TimeOff - Time off request settings for this management unit
	TimeOff *Timeoffrequestsettings `json:"timeOff,omitempty"`

	// Scheduling - Scheduling settings for this management unit
	Scheduling *Schedulingsettingsrequest `json:"scheduling,omitempty"`

	// ShiftTrading - Shift trade settings for this management unit
	ShiftTrading *Shifttradesettings `json:"shiftTrading,omitempty"`
}

Createmanagementunitsettingsrequest - Management Unit Settings

func (*Createmanagementunitsettingsrequest) String ¶

String returns a JSON representation of the model

type Createoutboundmessagingconversationrequest ¶

type Createoutboundmessagingconversationrequest struct {
	// QueueId - The ID of the queue to be associated with the message. This will determine the fromAddress of the message.
	QueueId *string `json:"queueId,omitempty"`

	// ToAddress - The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234
	ToAddress *string `json:"toAddress,omitempty"`

	// ToAddressMessengerType - The messaging address messenger type.
	ToAddressMessengerType *string `json:"toAddressMessengerType,omitempty"`

	// UseExistingConversation - An override to use an existing conversation.  If set to true, an existing conversation will be used if there is one within the conversation window.  If set to false, create request fails if there is a conversation within the conversation window.
	UseExistingConversation *bool `json:"useExistingConversation,omitempty"`

	// ExternalContactId - The external contact Id of the recipient of the message.
	ExternalContactId *string `json:"externalContactId,omitempty"`

	// ExternalOrganizationId - The external organization Id of the recipient of the message.
	ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"`
}

Createoutboundmessagingconversationrequest

func (*Createoutboundmessagingconversationrequest) String ¶

String returns a JSON representation of the model

type Createplanninggrouprequest ¶

type Createplanninggrouprequest struct {
	// Name - The name of the planning group
	Name *string `json:"name,omitempty"`

	// RoutePaths - Set of route paths to associate with the planning group
	RoutePaths *[]Routepathrequest `json:"routePaths,omitempty"`

	// ServiceGoalTemplateId - The ID of the service goal template to associate with this planning group
	ServiceGoalTemplateId *string `json:"serviceGoalTemplateId,omitempty"`
}

Createplanninggrouprequest

func (*Createplanninggrouprequest) String ¶

func (o *Createplanninggrouprequest) String() string

String returns a JSON representation of the model

type Createpredictorrequest ¶

type Createpredictorrequest struct {
	// QueueIds - The queue IDs associated with the predictor.
	QueueIds *[]string `json:"queueIds,omitempty"`

	// Kpi - The KPI that the predictor attempts to maximize/minimize.
	Kpi *string `json:"kpi,omitempty"`

	// RoutingTimeoutSeconds - Number of seconds allocated to predictive routing before attempting a different routing method. This is a value between 12 and 900 seconds.
	RoutingTimeoutSeconds *int `json:"routingTimeoutSeconds,omitempty"`

	// Schedule - The predictor schedule that determines when the predictor is used for routing interactions.
	Schedule *Predictorschedule `json:"schedule,omitempty"`

	// WorkloadBalancingConfig - The predictor balancing configuration to enable workload balancing
	WorkloadBalancingConfig *Predictorworkloadbalancing `json:"workloadBalancingConfig,omitempty"`
}

Createpredictorrequest

func (*Createpredictorrequest) String ¶

func (o *Createpredictorrequest) String() string

String returns a JSON representation of the model

type Createqueuerequest ¶

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

	// Name - The queue name
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Writabledivision `json:"division,omitempty"`

	// Description - The queue description.
	Description *string `json:"description,omitempty"`

	// DateCreated - The date the queue 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"`

	// DateModified - The date of the last modification to the queue. 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 ID of the user that last modified the queue.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the queue.
	CreatedBy *string `json:"createdBy,omitempty"`

	// MemberCount - The total number of members (joined or unjoined) in the queue.
	MemberCount *int `json:"memberCount,omitempty"`

	// JoinedMemberCount - The number of joined members in the queue.
	JoinedMemberCount *int `json:"joinedMemberCount,omitempty"`

	// MediaSettings - The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM
	MediaSettings *map[string]Mediasetting `json:"mediaSettings,omitempty"`

	// RoutingRules - The routing rules for the queue, used for routing to known or preferred agents.
	RoutingRules *[]Routingrule `json:"routingRules,omitempty"`

	// Bullseye - The bulls-eye settings for the queue.
	Bullseye *Bullseye `json:"bullseye,omitempty"`

	// AcwSettings - The ACW settings for the queue.
	AcwSettings *Acwsettings `json:"acwSettings,omitempty"`

	// SkillEvaluationMethod - The skill evaluation method to use when routing conversations.
	SkillEvaluationMethod *string `json:"skillEvaluationMethod,omitempty"`

	// QueueFlow - The in-queue flow to use for conversations waiting in queue.
	QueueFlow *Domainentityref `json:"queueFlow,omitempty"`

	// WhisperPrompt - The prompt used for whisper on the queue, if configured.
	WhisperPrompt *Domainentityref `json:"whisperPrompt,omitempty"`

	// AutoAnswerOnly - Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered.
	AutoAnswerOnly *bool `json:"autoAnswerOnly,omitempty"`

	// EnableTranscription - Indicates whether voice transcription is enabled for this queue.
	EnableTranscription *bool `json:"enableTranscription,omitempty"`

	// EnableManualAssignment - Indicates whether manual assignment is enabled for this queue.
	EnableManualAssignment *bool `json:"enableManualAssignment,omitempty"`

	// CallingPartyName - The name to use for caller identification for outbound calls from this queue.
	CallingPartyName *string `json:"callingPartyName,omitempty"`

	// CallingPartyNumber - The phone number to use for caller identification for outbound calls from this queue.
	CallingPartyNumber *string `json:"callingPartyNumber,omitempty"`

	// DefaultScripts - The default script Ids for the communication types.
	DefaultScripts *map[string]Script `json:"defaultScripts,omitempty"`

	// OutboundMessagingAddresses - The messaging addresses for the queue.
	OutboundMessagingAddresses *Queuemessagingaddresses `json:"outboundMessagingAddresses,omitempty"`

	// OutboundEmailAddress
	OutboundEmailAddress *Queueemailaddress `json:"outboundEmailAddress,omitempty"`

	// SourceQueueId - The id of an existing queue to copy the settings from when creating a new queue.
	SourceQueueId *string `json:"sourceQueueId,omitempty"`

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

Createqueuerequest

func (*Createqueuerequest) String ¶

func (o *Createqueuerequest) String() string

String returns a JSON representation of the model

type Createsecuresession ¶

type Createsecuresession struct {
	// SourceParticipantId - requesting participant
	SourceParticipantId *string `json:"sourceParticipantId,omitempty"`

	// FlowId - the flow id to execute in the secure session
	FlowId *string `json:"flowId,omitempty"`

	// UserData - user data for the secure session
	UserData *string `json:"userData,omitempty"`

	// Disconnect - if true, disconnect the agent after creating the session
	Disconnect *bool `json:"disconnect,omitempty"`
}

Createsecuresession

func (*Createsecuresession) String ¶

func (o *Createsecuresession) String() string

String returns a JSON representation of the model

type Createservicegoaltemplate ¶

type Createservicegoaltemplate struct {
	// Name - The name of the service goal template.
	Name *string `json:"name,omitempty"`

	// ServiceLevel - Service level targets for this service goal template
	ServiceLevel *Buservicelevel `json:"serviceLevel,omitempty"`

	// AverageSpeedOfAnswer - Average speed of answer targets for this service goal template
	AverageSpeedOfAnswer *Buaveragespeedofanswer `json:"averageSpeedOfAnswer,omitempty"`

	// AbandonRate - Abandon rate targets for this service goal template
	AbandonRate *Buabandonrate `json:"abandonRate,omitempty"`
}

Createservicegoaltemplate

func (*Createservicegoaltemplate) String ¶

func (o *Createservicegoaltemplate) String() string

String returns a JSON representation of the model

type Createsharerequest ¶

type Createsharerequest struct {
	// SharedEntityType - The share entity type
	SharedEntityType *string `json:"sharedEntityType,omitempty"`

	// SharedEntity - The entity that will be shared
	SharedEntity *Sharedentity `json:"sharedEntity,omitempty"`

	// MemberType
	MemberType *string `json:"memberType,omitempty"`

	// Member - The member that will have access to this share. Only required if a list of members is not provided.
	Member *Sharedentity `json:"member,omitempty"`

	// Members
	Members *[]Createsharerequestmember `json:"members,omitempty"`
}

Createsharerequest

func (*Createsharerequest) String ¶

func (o *Createsharerequest) String() string

String returns a JSON representation of the model

type Createsharerequestmember ¶

type Createsharerequestmember struct {
	// MemberType
	MemberType *string `json:"memberType,omitempty"`

	// Member
	Member *Memberentity `json:"member,omitempty"`
}

Createsharerequestmember

func (*Createsharerequestmember) String ¶

func (o *Createsharerequestmember) String() string

String returns a JSON representation of the model

type Createshareresponse ¶

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

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

	// SharedEntityType
	SharedEntityType *string `json:"sharedEntityType,omitempty"`

	// SharedEntity
	SharedEntity *Domainentityref `json:"sharedEntity,omitempty"`

	// MemberType
	MemberType *string `json:"memberType,omitempty"`

	// Member
	Member *Domainentityref `json:"member,omitempty"`

	// SharedBy
	SharedBy *Domainentityref `json:"sharedBy,omitempty"`

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

	// Succeeded
	Succeeded *[]Share `json:"succeeded,omitempty"`

	// Failed
	Failed *[]Share `json:"failed,omitempty"`

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

Createshareresponse

func (*Createshareresponse) String ¶

func (o *Createshareresponse) String() string

String returns a JSON representation of the model

type Createuser ¶

type Createuser struct {
	// Name - User's full name
	Name *string `json:"name,omitempty"`

	// Department
	Department *string `json:"department,omitempty"`

	// Email - User's email and username
	Email *string `json:"email,omitempty"`

	// Addresses - Email addresses and phone numbers for this user
	Addresses *[]Contact `json:"addresses,omitempty"`

	// Title
	Title *string `json:"title,omitempty"`

	// Password - User's password
	Password *string `json:"password,omitempty"`

	// DivisionId - The division to which this user will belong
	DivisionId *string `json:"divisionId,omitempty"`

	// State - Optional initialized state of the user. If not specified, state will be Active if invites are sent, otherwise Inactive.
	State *string `json:"state,omitempty"`
}

Createuser

func (*Createuser) String ¶

func (o *Createuser) String() string

String returns a JSON representation of the model

type Createwebchatconversationrequest ¶

type Createwebchatconversationrequest struct {
	// OrganizationId - The organization identifier.
	OrganizationId *string `json:"organizationId,omitempty"`

	// DeploymentId - The web chat Deployment ID which contains the appropriate settings for this chat conversation.
	DeploymentId *string `json:"deploymentId,omitempty"`

	// RoutingTarget - The routing information to use for the new chat conversation.
	RoutingTarget *Webchatroutingtarget `json:"routingTarget,omitempty"`

	// MemberInfo - The guest member info to use for the new chat conversation.
	MemberInfo *Guestmemberinfo `json:"memberInfo,omitempty"`

	// MemberAuthToken - If the guest member is an authenticated member (ie, not anonymous) his JWT is provided here. The token will have been previously generated with the \"POST /api/v2/signeddata\" resource.
	MemberAuthToken *string `json:"memberAuthToken,omitempty"`

	// JourneyContext - A subset of the Journey System's data relevant to this conversation/session request (for external linkage and internal usage/context).
	JourneyContext *Journeycontext `json:"journeyContext,omitempty"`
}

Createwebchatconversationrequest

func (*Createwebchatconversationrequest) String ¶

String returns a JSON representation of the model

type Createwebchatconversationresponse ¶

type Createwebchatconversationresponse struct {
	// Id - Chat Conversation identifier
	Id *string `json:"id,omitempty"`

	// Jwt - The JWT that you can use to identify subsequent calls on this conversation
	Jwt *string `json:"jwt,omitempty"`

	// EventStreamUri - The URI which provides the conversation event stream.
	EventStreamUri *string `json:"eventStreamUri,omitempty"`

	// Member - Chat Member
	Member *Webchatmemberinfo `json:"member,omitempty"`
}

Createwebchatconversationresponse

func (*Createwebchatconversationresponse) String ¶

String returns a JSON representation of the model

type Createwebchatmessagerequest ¶

type Createwebchatmessagerequest struct {
	// Body - The message body. Note that message bodies are limited to 4,000 characters.
	Body *string `json:"body,omitempty"`

	// BodyType - The purpose of the message within the conversation, such as a standard text entry versus a greeting.
	BodyType *string `json:"bodyType,omitempty"`
}

Createwebchatmessagerequest

func (*Createwebchatmessagerequest) String ¶

func (o *Createwebchatmessagerequest) String() string

String returns a JSON representation of the model

type Createwebchatrequest ¶

type Createwebchatrequest struct {
	// QueueId - The ID of the queue to use for routing the chat conversation.
	QueueId *string `json:"queueId,omitempty"`

	// Provider - The name of the provider that is sourcing the web chat.
	Provider *string `json:"provider,omitempty"`

	// SkillIds - The list of skill ID's to use for routing.
	SkillIds *[]string `json:"skillIds,omitempty"`

	// LanguageId - The ID of the langauge to use for routing.
	LanguageId *string `json:"languageId,omitempty"`

	// Priority - The priority to assign to the conversation for routing.
	Priority *int `json:"priority,omitempty"`

	// Attributes - The list of attributes to associate with the customer participant.
	Attributes *map[string]string `json:"attributes,omitempty"`

	// CustomerName - The name of the customer participating in the web chat.
	CustomerName *string `json:"customerName,omitempty"`
}

Createwebchatrequest

func (*Createwebchatrequest) String ¶

func (o *Createwebchatrequest) String() string

String returns a JSON representation of the model

type Createworkplan ¶

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

	// Enabled - Whether the work plan is enabled for scheduling
	Enabled *bool `json:"enabled,omitempty"`

	// ConstrainWeeklyPaidTime - Whether the weekly paid time constraint is enabled for this work plan
	ConstrainWeeklyPaidTime *bool `json:"constrainWeeklyPaidTime,omitempty"`

	// FlexibleWeeklyPaidTime - Whether the weekly paid time constraint is flexible for this work plan
	FlexibleWeeklyPaidTime *bool `json:"flexibleWeeklyPaidTime,omitempty"`

	// WeeklyExactPaidMinutes - Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false
	WeeklyExactPaidMinutes *int `json:"weeklyExactPaidMinutes,omitempty"`

	// WeeklyMinimumPaidMinutes - Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true
	WeeklyMinimumPaidMinutes *int `json:"weeklyMinimumPaidMinutes,omitempty"`

	// WeeklyMaximumPaidMinutes - Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true
	WeeklyMaximumPaidMinutes *int `json:"weeklyMaximumPaidMinutes,omitempty"`

	// ConstrainPaidTimeGranularity - Whether paid time granularity should be constrained for this workplan
	ConstrainPaidTimeGranularity *bool `json:"constrainPaidTimeGranularity,omitempty"`

	// PaidTimeGranularityMinutes - Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true
	PaidTimeGranularityMinutes *int `json:"paidTimeGranularityMinutes,omitempty"`

	// ConstrainMinimumTimeBetweenShifts - Whether the minimum time between shifts constraint is enabled for this work plan
	ConstrainMinimumTimeBetweenShifts *bool `json:"constrainMinimumTimeBetweenShifts,omitempty"`

	// MinimumTimeBetweenShiftsMinutes - Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true
	MinimumTimeBetweenShiftsMinutes *int `json:"minimumTimeBetweenShiftsMinutes,omitempty"`

	// MaximumDays - Maximum number days in a week allowed to be scheduled for this work plan
	MaximumDays *int `json:"maximumDays,omitempty"`

	// MinimumConsecutiveNonWorkingMinutesPerWeek - Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off
	MinimumConsecutiveNonWorkingMinutesPerWeek *int `json:"minimumConsecutiveNonWorkingMinutesPerWeek,omitempty"`

	// ConstrainMaximumConsecutiveWorkingWeekends - Whether to constrain the maximum consecutive working weekends
	ConstrainMaximumConsecutiveWorkingWeekends *bool `json:"constrainMaximumConsecutiveWorkingWeekends,omitempty"`

	// MaximumConsecutiveWorkingWeekends - The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work
	MaximumConsecutiveWorkingWeekends *int `json:"maximumConsecutiveWorkingWeekends,omitempty"`

	// MinimumWorkingDaysPerWeek - The minimum number of days that agents assigned to a work plan must work per week
	MinimumWorkingDaysPerWeek *int `json:"minimumWorkingDaysPerWeek,omitempty"`

	// ConstrainMaximumConsecutiveWorkingDays - Whether to constrain the maximum consecutive working days
	ConstrainMaximumConsecutiveWorkingDays *bool `json:"constrainMaximumConsecutiveWorkingDays,omitempty"`

	// MaximumConsecutiveWorkingDays - The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true
	MaximumConsecutiveWorkingDays *int `json:"maximumConsecutiveWorkingDays,omitempty"`

	// MinimumShiftStartDistanceMinutes - The time period in minutes for the duration between the start times of two consecutive working days
	MinimumShiftStartDistanceMinutes *int `json:"minimumShiftStartDistanceMinutes,omitempty"`

	// MinimumDaysOffPerPlanningPeriod - Minimum days off in the planning period
	MinimumDaysOffPerPlanningPeriod *int `json:"minimumDaysOffPerPlanningPeriod,omitempty"`

	// MaximumDaysOffPerPlanningPeriod - Maximum days off in the planning period
	MaximumDaysOffPerPlanningPeriod *int `json:"maximumDaysOffPerPlanningPeriod,omitempty"`

	// MinimumPaidMinutesPerPlanningPeriod - Minimum paid minutes in the planning period
	MinimumPaidMinutesPerPlanningPeriod *int `json:"minimumPaidMinutesPerPlanningPeriod,omitempty"`

	// MaximumPaidMinutesPerPlanningPeriod - Maximum paid minutes in the planning period
	MaximumPaidMinutesPerPlanningPeriod *int `json:"maximumPaidMinutesPerPlanningPeriod,omitempty"`

	// OptionalDays - Optional days to schedule for this work plan
	OptionalDays *Setwrapperdayofweek `json:"optionalDays,omitempty"`

	// ShiftStartVarianceType - This constraint ensures that an agent starts each workday within a user-defined time threshold
	ShiftStartVarianceType *string `json:"shiftStartVarianceType,omitempty"`

	// ShiftStartVariances - Variance in minutes among start times of shifts in this work plan
	ShiftStartVariances *Listwrappershiftstartvariance `json:"shiftStartVariances,omitempty"`

	// Shifts - Shifts in this work plan
	Shifts *[]Createworkplanshift `json:"shifts,omitempty"`

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

Createworkplan - Work plan information

func (*Createworkplan) String ¶

func (o *Createworkplan) String() string

String returns a JSON representation of the model

type Createworkplanactivity ¶

type Createworkplanactivity struct {
	// ActivityCodeId - ID of the activity code associated with this activity
	ActivityCodeId *string `json:"activityCodeId,omitempty"`

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

	// LengthMinutes - Length of the activity in minutes
	LengthMinutes *int `json:"lengthMinutes,omitempty"`

	// StartTimeIsRelativeToShiftStart - Whether the start time of the activity is relative to the start time of the shift it belongs to
	StartTimeIsRelativeToShiftStart *bool `json:"startTimeIsRelativeToShiftStart,omitempty"`

	// FlexibleStartTime - Whether the start time of the activity is flexible
	FlexibleStartTime *bool `json:"flexibleStartTime,omitempty"`

	// EarliestStartTimeMinutes - Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true
	EarliestStartTimeMinutes *int `json:"earliestStartTimeMinutes,omitempty"`

	// LatestStartTimeMinutes - Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true
	LatestStartTimeMinutes *int `json:"latestStartTimeMinutes,omitempty"`

	// ExactStartTimeMinutes - Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false
	ExactStartTimeMinutes *int `json:"exactStartTimeMinutes,omitempty"`

	// StartTimeIncrementMinutes - Increment in offset minutes that would contribute to different possible start times for the activity
	StartTimeIncrementMinutes *int `json:"startTimeIncrementMinutes,omitempty"`

	// CountsAsPaidTime - Whether the activity is paid
	CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"`

	// CountsAsContiguousWorkTime - Whether the activity duration is counted towards contiguous work time
	CountsAsContiguousWorkTime *bool `json:"countsAsContiguousWorkTime,omitempty"`

	// MinimumLengthFromShiftStartMinutes - The minimum duration between shift start and shift item (e.g., break or meal) start in minutes
	MinimumLengthFromShiftStartMinutes *int `json:"minimumLengthFromShiftStartMinutes,omitempty"`

	// MinimumLengthFromShiftEndMinutes - The minimum duration between shift item (e.g., break or meal) end and shift end in minutes
	MinimumLengthFromShiftEndMinutes *int `json:"minimumLengthFromShiftEndMinutes,omitempty"`
}

Createworkplanactivity - Activity configured for shift in work plan

func (*Createworkplanactivity) String ¶

func (o *Createworkplanactivity) String() string

String returns a JSON representation of the model

type Createworkplanshift ¶

type Createworkplanshift struct {
	// Name - Name of the shift
	Name *string `json:"name,omitempty"`

	// Days - Days of the week applicable for this shift
	Days *Setwrapperdayofweek `json:"days,omitempty"`

	// FlexibleStartTime - Whether the start time of the shift is flexible
	FlexibleStartTime *bool `json:"flexibleStartTime,omitempty"`

	// ExactStartTimeMinutesFromMidnight - Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false
	ExactStartTimeMinutesFromMidnight *int `json:"exactStartTimeMinutesFromMidnight,omitempty"`

	// EarliestStartTimeMinutesFromMidnight - Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true
	EarliestStartTimeMinutesFromMidnight *int `json:"earliestStartTimeMinutesFromMidnight,omitempty"`

	// LatestStartTimeMinutesFromMidnight - Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true
	LatestStartTimeMinutesFromMidnight *int `json:"latestStartTimeMinutesFromMidnight,omitempty"`

	// ConstrainStopTime - Whether the latest stop time constraint for the shift is enabled.  Deprecated, use constrainLatestStopTime instead
	ConstrainStopTime *bool `json:"constrainStopTime,omitempty"`

	// ConstrainLatestStopTime - Whether the latest stop time constraint for the shift is enabled
	ConstrainLatestStopTime *bool `json:"constrainLatestStopTime,omitempty"`

	// LatestStopTimeMinutesFromMidnight - Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true
	LatestStopTimeMinutesFromMidnight *int `json:"latestStopTimeMinutesFromMidnight,omitempty"`

	// ConstrainEarliestStopTime - Whether the earliest stop time constraint for the shift is enabled
	ConstrainEarliestStopTime *bool `json:"constrainEarliestStopTime,omitempty"`

	// EarliestStopTimeMinutesFromMidnight - This is the earliest time a shift can end
	EarliestStopTimeMinutesFromMidnight *int `json:"earliestStopTimeMinutesFromMidnight,omitempty"`

	// StartIncrementMinutes - Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true
	StartIncrementMinutes *int `json:"startIncrementMinutes,omitempty"`

	// FlexiblePaidTime - Whether the paid time setting for the shift is flexible
	FlexiblePaidTime *bool `json:"flexiblePaidTime,omitempty"`

	// ExactPaidTimeMinutes - Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false
	ExactPaidTimeMinutes *int `json:"exactPaidTimeMinutes,omitempty"`

	// MinimumPaidTimeMinutes - Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true
	MinimumPaidTimeMinutes *int `json:"minimumPaidTimeMinutes,omitempty"`

	// MaximumPaidTimeMinutes - Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true
	MaximumPaidTimeMinutes *int `json:"maximumPaidTimeMinutes,omitempty"`

	// ConstrainContiguousWorkTime - Whether the contiguous time constraint for the shift is enabled
	ConstrainContiguousWorkTime *bool `json:"constrainContiguousWorkTime,omitempty"`

	// MinimumContiguousWorkTimeMinutes - Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true
	MinimumContiguousWorkTimeMinutes *int `json:"minimumContiguousWorkTimeMinutes,omitempty"`

	// MaximumContiguousWorkTimeMinutes - Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true
	MaximumContiguousWorkTimeMinutes *int `json:"maximumContiguousWorkTimeMinutes,omitempty"`

	// Activities - Activities configured for this shift
	Activities *[]Createworkplanactivity `json:"activities,omitempty"`
}

Createworkplanshift - Shift in a work plan

func (*Createworkplanshift) String ¶

func (o *Createworkplanshift) String() string

String returns a JSON representation of the model

type Credential ¶

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

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

	// VarType - The type of credential.
	VarType *Credentialtype `json:"type,omitempty"`

	// CredentialFields
	CredentialFields *map[string]string `json:"credentialFields,omitempty"`

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

Credential

func (*Credential) String ¶

func (o *Credential) String() string

String returns a JSON representation of the model

type Credentialinfo ¶

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

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

	// CreatedDate - Date the credentials were 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 - Date credentials were 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"`

	// VarType - Type of the credentials.
	VarType *Credentialtype `json:"type,omitempty"`

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

Credentialinfo

func (*Credentialinfo) String ¶

func (o *Credentialinfo) String() string

String returns a JSON representation of the model

type Credentialinfolisting ¶

type Credentialinfolisting struct {
	// Entities
	Entities *[]Credentialinfo `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"`

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

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

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

Credentialinfolisting

func (*Credentialinfolisting) String ¶

func (o *Credentialinfolisting) String() string

String returns a JSON representation of the model

type Credentialspecification ¶

type Credentialspecification struct {
	// Required - Indicates if the credential must be provided in order for the integration configuration to be valid.
	Required *bool `json:"required,omitempty"`

	// Title - Title describing the usage for this credential.
	Title *string `json:"title,omitempty"`

	// CredentialTypes - List of acceptable credential types that can be provided for this credential.
	CredentialTypes *[]string `json:"credentialTypes,omitempty"`
}

Credentialspecification - Specifies the requirements for a credential that can be provided for configuring an integration

func (*Credentialspecification) String ¶

func (o *Credentialspecification) String() string

String returns a JSON representation of the model

type Credentialtype ¶

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

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

	// Properties - Properties describing credentials of this type.
	Properties *interface{} `json:"properties,omitempty"`

	// DisplayOrder - Order in which properties should be displayed in the UI.
	DisplayOrder *[]string `json:"displayOrder,omitempty"`

	// Required - Properties that are required fields.
	Required *[]string `json:"required,omitempty"`
}

Credentialtype

func (*Credentialtype) String ¶

func (o *Credentialtype) String() string

String returns a JSON representation of the model

type Credentialtypelisting ¶

type Credentialtypelisting struct {
	// Entities
	Entities *[]Credentialtype `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"`

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

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

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

Credentialtypelisting

func (*Credentialtypelisting) String ¶

func (o *Credentialtypelisting) String() string

String returns a JSON representation of the model

type Criteria ¶

type Criteria struct {
	// Key - The criteria key.
	Key *string `json:"key,omitempty"`

	// Values - The criteria values.
	Values *[]string `json:"values,omitempty"`

	// ShouldIgnoreCase - Should criteria be case insensitive.
	ShouldIgnoreCase *bool `json:"shouldIgnoreCase,omitempty"`

	// Operator - The comparison operator.
	Operator *string `json:"operator,omitempty"`
}

Criteria

func (*Criteria) String ¶

func (o *Criteria) String() string

String returns a JSON representation of the model

type Crossplatformcallmediapolicy ¶

type Crossplatformcallmediapolicy struct {
	// Actions - Actions applied when specified conditions are met
	Actions *Crossplatformpolicyactions `json:"actions,omitempty"`

	// Conditions - Conditions for when actions should be applied
	Conditions *Callmediapolicyconditions `json:"conditions,omitempty"`
}

Crossplatformcallmediapolicy

func (*Crossplatformcallmediapolicy) String ¶

String returns a JSON representation of the model

type Crossplatformchatmediapolicy ¶

type Crossplatformchatmediapolicy struct {
	// Actions - Actions applied when specified conditions are met
	Actions *Crossplatformpolicyactions `json:"actions,omitempty"`

	// Conditions - Conditions for when actions should be applied
	Conditions *Chatmediapolicyconditions `json:"conditions,omitempty"`
}

Crossplatformchatmediapolicy

func (*Crossplatformchatmediapolicy) String ¶

String returns a JSON representation of the model

type Crossplatformemailmediapolicy ¶

type Crossplatformemailmediapolicy struct {
	// Actions - Actions applied when specified conditions are met
	Actions *Crossplatformpolicyactions `json:"actions,omitempty"`

	// Conditions - Conditions for when actions should be applied
	Conditions *Emailmediapolicyconditions `json:"conditions,omitempty"`
}

Crossplatformemailmediapolicy

func (*Crossplatformemailmediapolicy) String ¶

String returns a JSON representation of the model

type Crossplatformmediapolicies ¶

type Crossplatformmediapolicies struct {
	// CallPolicy - Conditions and actions for calls
	CallPolicy *Crossplatformcallmediapolicy `json:"callPolicy,omitempty"`

	// ChatPolicy - Conditions and actions for chats
	ChatPolicy *Crossplatformchatmediapolicy `json:"chatPolicy,omitempty"`

	// EmailPolicy - Conditions and actions for emails
	EmailPolicy *Crossplatformemailmediapolicy `json:"emailPolicy,omitempty"`

	// MessagePolicy - Conditions and actions for messages
	MessagePolicy *Crossplatformmessagemediapolicy `json:"messagePolicy,omitempty"`
}

Crossplatformmediapolicies

func (*Crossplatformmediapolicies) String ¶

func (o *Crossplatformmediapolicies) String() string

String returns a JSON representation of the model

type Crossplatformmessagemediapolicy ¶

type Crossplatformmessagemediapolicy struct {
	// Actions - Actions applied when specified conditions are met
	Actions *Crossplatformpolicyactions `json:"actions,omitempty"`

	// Conditions - Conditions for when actions should be applied
	Conditions *Messagemediapolicyconditions `json:"conditions,omitempty"`
}

Crossplatformmessagemediapolicy

func (*Crossplatformmessagemediapolicy) String ¶

String returns a JSON representation of the model

type Crossplatformpolicy ¶

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

	// Name
	Name *string `json:"name,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"`

	// 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"`

	// Order
	Order *int `json:"order,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// MediaPolicies - Conditions and actions per media type
	MediaPolicies *Crossplatformmediapolicies `json:"mediaPolicies,omitempty"`

	// Conditions - Conditions
	Conditions *Policyconditions `json:"conditions,omitempty"`

	// Actions - Actions
	Actions *Crossplatformpolicyactions `json:"actions,omitempty"`

	// PolicyErrors
	PolicyErrors *Policyerrors `json:"policyErrors,omitempty"`

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

Crossplatformpolicy

func (*Crossplatformpolicy) String ¶

func (o *Crossplatformpolicy) String() string

String returns a JSON representation of the model

type Crossplatformpolicyactions ¶

type Crossplatformpolicyactions struct {
	// RetainRecording - true to retain the recording associated with the conversation. Default = true
	RetainRecording *bool `json:"retainRecording,omitempty"`

	// DeleteRecording - true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false
	DeleteRecording *bool `json:"deleteRecording,omitempty"`

	// AlwaysDelete - true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false
	AlwaysDelete *bool `json:"alwaysDelete,omitempty"`

	// AssignEvaluations
	AssignEvaluations *[]Evaluationassignment `json:"assignEvaluations,omitempty"`

	// AssignMeteredEvaluations
	AssignMeteredEvaluations *[]Meteredevaluationassignment `json:"assignMeteredEvaluations,omitempty"`

	// AssignMeteredAssignmentByAgent
	AssignMeteredAssignmentByAgent *[]Meteredassignmentbyagent `json:"assignMeteredAssignmentByAgent,omitempty"`

	// AssignCalibrations
	AssignCalibrations *[]Calibrationassignment `json:"assignCalibrations,omitempty"`

	// RetentionDuration
	RetentionDuration *Retentionduration `json:"retentionDuration,omitempty"`

	// MediaTranscriptions
	MediaTranscriptions *[]Mediatranscription `json:"mediaTranscriptions,omitempty"`

	// IntegrationExport - Policy action for exporting recordings using an integration to 3rd party s3.
	IntegrationExport *Integrationexport `json:"integrationExport,omitempty"`
}

Crossplatformpolicyactions

func (*Crossplatformpolicyactions) String ¶

func (o *Crossplatformpolicyactions) String() string

String returns a JSON representation of the model

type Crossplatformpolicycreate ¶

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

	// Name - The policy name.
	Name *string `json:"name,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"`

	// 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"`

	// Order
	Order *int `json:"order,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// MediaPolicies - Conditions and actions per media type
	MediaPolicies *Crossplatformmediapolicies `json:"mediaPolicies,omitempty"`

	// Conditions - Conditions
	Conditions *Policyconditions `json:"conditions,omitempty"`

	// Actions - Actions
	Actions *Crossplatformpolicyactions `json:"actions,omitempty"`

	// PolicyErrors
	PolicyErrors *Policyerrors `json:"policyErrors,omitempty"`

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

Crossplatformpolicycreate

func (*Crossplatformpolicycreate) String ¶

func (o *Crossplatformpolicycreate) String() string

String returns a JSON representation of the model

type Crossplatformpolicyupdate ¶

type Crossplatformpolicyupdate struct {
	// Enabled
	Enabled *bool `json:"enabled,omitempty"`
}

Crossplatformpolicyupdate

func (*Crossplatformpolicyupdate) String ¶

func (o *Crossplatformpolicyupdate) String() string

String returns a JSON representation of the model

type Ctabuttonstyleproperties ¶

type Ctabuttonstyleproperties struct {
	// Color - Color of the text. (eg. #FFFFFF)
	Color *string `json:"color,omitempty"`

	// Font - Font of the text. (eg. Helvetica)
	Font *string `json:"font,omitempty"`

	// FontSize - Font size of the text. (eg. '12')
	FontSize *string `json:"fontSize,omitempty"`

	// TextAlign - Text alignment.
	TextAlign *string `json:"textAlign,omitempty"`

	// BackgroundColor - Background color of the CTA button. (eg. #FF0000)
	BackgroundColor *string `json:"backgroundColor,omitempty"`
}

Ctabuttonstyleproperties

func (*Ctabuttonstyleproperties) String ¶

func (o *Ctabuttonstyleproperties) String() string

String returns a JSON representation of the model

type Currentuserschedulerequestbody ¶

type Currentuserschedulerequestbody struct {
	// StartDate - Beginning of the range of schedules to fetch, in ISO-8601 format
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - End of the range of schedules to fetch, in ISO-8601 format
	EndDate *time.Time `json:"endDate,omitempty"`

	// LoadFullWeeks - Whether to load the full week's schedule (for the current user) of any week overlapping the start/end date query parameters, defaults to false
	LoadFullWeeks *bool `json:"loadFullWeeks,omitempty"`
}

Currentuserschedulerequestbody - POST request body for fetching the current user's schedule over a given range

func (*Currentuserschedulerequestbody) String ¶

String returns a JSON representation of the model

type Cursorcontactlisting ¶

type Cursorcontactlisting struct {
	// Entities
	Entities *[]Externalcontact `json:"entities,omitempty"`

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

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

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

Cursorcontactlisting

func (*Cursorcontactlisting) String ¶

func (o *Cursorcontactlisting) String() string

String returns a JSON representation of the model

type Cursornotelisting ¶

type Cursornotelisting struct {
	// Entities
	Entities *[]Note `json:"entities,omitempty"`

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

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

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

Cursornotelisting

func (*Cursornotelisting) String ¶

func (o *Cursornotelisting) String() string

String returns a JSON representation of the model

type Cursororganizationlisting ¶

type Cursororganizationlisting struct {
	// Entities
	Entities *[]Externalorganization `json:"entities,omitempty"`

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

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

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

Cursororganizationlisting

func (*Cursororganizationlisting) String ¶

func (o *Cursororganizationlisting) String() string

String returns a JSON representation of the model

type Cursorrelationshiplisting ¶

type Cursorrelationshiplisting struct {
	// Entities
	Entities *[]Relationship `json:"entities,omitempty"`

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

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

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

Cursorrelationshiplisting

func (*Cursorrelationshiplisting) String ¶

func (o *Cursorrelationshiplisting) String() string

String returns a JSON representation of the model

type Cursors ¶

type Cursors struct {
	// Before
	Before *string `json:"before,omitempty"`

	// After
	After *string `json:"after,omitempty"`
}

Cursors

func (*Cursors) String ¶

func (o *Cursors) String() string

String returns a JSON representation of the model

type Customerinteractioncenter ¶

type Customerinteractioncenter 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"`

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

Customerinteractioncenter

func (*Customerinteractioncenter) String ¶

func (o *Customerinteractioncenter) String() string

String returns a JSON representation of the model

type DataExtensionsApi ¶

type DataExtensionsApi struct {
	Configuration *Configuration
}

DataExtensionsApi provides functions for API endpoints

func NewDataExtensionsApi ¶

func NewDataExtensionsApi() *DataExtensionsApi

NewDataExtensionsApi creates an API instance using the default configuration

func NewDataExtensionsApiWithConfig ¶

func NewDataExtensionsApiWithConfig(config *Configuration) *DataExtensionsApi

NewDataExtensionsApiWithConfig creates an API instance using the provided configuration

func (DataExtensionsApi) GetDataextensionsCoretype ¶

func (a DataExtensionsApi) GetDataextensionsCoretype(coretypeName string) (*Coretype, *APIResponse, error)

GetDataextensionsCoretype invokes GET /api/v2/dataextensions/coretypes/{coretypeName}

Get a specific named core type.

func (DataExtensionsApi) GetDataextensionsCoretypes ¶

func (a DataExtensionsApi) GetDataextensionsCoretypes() (*Coretypelisting, *APIResponse, error)

GetDataextensionsCoretypes invokes GET /api/v2/dataextensions/coretypes

Get the core types from which all schemas are built.

func (DataExtensionsApi) GetDataextensionsLimits ¶

func (a DataExtensionsApi) GetDataextensionsLimits() (*Schemaquantitylimits, *APIResponse, error)

GetDataextensionsLimits invokes GET /api/v2/dataextensions/limits

Get quantitative limits on schemas

type Dataactionconditionpredicate ¶

type Dataactionconditionpredicate struct{}

Dataactionconditionpredicate

func (*Dataactionconditionpredicate) String ¶

String returns a JSON representation of the model

type Dataavailabilityresponse ¶

type Dataavailabilityresponse struct {
	// DataAvailabilityDate - Date and time before which data is guaranteed to be available in the datalake. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DataAvailabilityDate *time.Time `json:"dataAvailabilityDate,omitempty"`
}

Dataavailabilityresponse

func (*Dataavailabilityresponse) String ¶

func (o *Dataavailabilityresponse) String() string

String returns a JSON representation of the model

type Dataschema ¶

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

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

	// Version - The schema's version, a positive integer. Required for updates.
	Version *int `json:"version,omitempty"`

	// AppliesTo - One of \"CONTACT\" or \"EXTERNAL_ORGANIZATION\".  Indicates the built-in entity type to which this schema applies.
	AppliesTo *[]string `json:"appliesTo,omitempty"`

	// Enabled - The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists.
	Enabled *bool `json:"enabled,omitempty"`

	// CreatedBy - The URI of the user that created this schema.
	CreatedBy *Domainentityref `json:"createdBy,omitempty"`

	// DateCreated - The date and time this schema 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"`

	// JsonSchema - A JSON schema defining the extension to the built-in entity type.
	JsonSchema *Jsonschemadocument `json:"jsonSchema,omitempty"`

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

Dataschema

func (*Dataschema) String ¶

func (o *Dataschema) String() string

String returns a JSON representation of the model

type Dataschemalisting ¶

type Dataschemalisting struct {
	// Total
	Total *int `json:"total,omitempty"`

	// Entities
	Entities *[]Dataschema `json:"entities,omitempty"`

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

Dataschemalisting

func (*Dataschemalisting) String ¶

func (o *Dataschemalisting) String() string

String returns a JSON representation of the model

type Datatable ¶

type Datatable 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 *Writabledivision `json:"division,omitempty"`

	// Description - The description from the JSON schema (equates to the Description field on the JSON schema.)
	Description *string `json:"description,omitempty"`

	// Schema - the schema as stored in the system.
	Schema *Jsonschemadocument `json:"schema,omitempty"`

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

Datatable - Contains a metadata representation for a JSON schema stored in DataTables along with an optional field for the schema itself

func (*Datatable) String ¶

func (o *Datatable) String() string

String returns a JSON representation of the model

type Datatableexportjob ¶

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

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

	// Owner - The PureCloud user who started the export job
	Owner *Addressableentityref `json:"owner,omitempty"`

	// Status - The status of the export job
	Status *string `json:"status,omitempty"`

	// DateCreated - The timestamp of when the export began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateCompleted - The timestamp of when the export stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCompleted *time.Time `json:"dateCompleted,omitempty"`

	// DownloadURI - The URL of the location at which the caller can download the export file, when available
	DownloadURI *string `json:"downloadURI,omitempty"`

	// ErrorInformation - Any error information, or null of the processing is not in an error state
	ErrorInformation *Errorbody `json:"errorInformation,omitempty"`

	// CountRecordsProcessed - The current count of the number of records processed
	CountRecordsProcessed *int `json:"countRecordsProcessed,omitempty"`

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

Datatableexportjob - State information for an export job of rows from a datatable

func (*Datatableexportjob) String ¶

func (o *Datatableexportjob) String() string

String returns a JSON representation of the model

type Datatableimportjob ¶

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

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

	// Owner - The PureCloud user who started the import job
	Owner *Addressableentityref `json:"owner,omitempty"`

	// Status - The status of the import job
	Status *string `json:"status,omitempty"`

	// DateCreated - The timestamp of when the import began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateCompleted - The timestamp of when the import stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCompleted *time.Time `json:"dateCompleted,omitempty"`

	// UploadURI - The URL of the location at which the caller can upload the file to be imported
	UploadURI *string `json:"uploadURI,omitempty"`

	// ImportMode - The indication of whether the processing should remove rows that don't appear in the import file
	ImportMode *string `json:"importMode,omitempty"`

	// ErrorInformation - Any error information, or null of the processing is not in an error state
	ErrorInformation *Errorbody `json:"errorInformation,omitempty"`

	// CountRecordsUpdated - The current count of the number of records processed
	CountRecordsUpdated *int `json:"countRecordsUpdated,omitempty"`

	// CountRecordsDeleted - The current count of the number of records deleted
	CountRecordsDeleted *int `json:"countRecordsDeleted,omitempty"`

	// CountRecordsFailed - The current count of the number of records that failed to import
	CountRecordsFailed *int `json:"countRecordsFailed,omitempty"`

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

Datatableimportjob - State information for an import job of rows to a datatable

func (*Datatableimportjob) String ¶

func (o *Datatableimportjob) String() string

String returns a JSON representation of the model

type Datatablerowentitylisting ¶

type Datatablerowentitylisting struct {
	// Entities
	Entities *[]map[string]interface{} `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"`

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

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

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

Datatablerowentitylisting

func (*Datatablerowentitylisting) String ¶

func (o *Datatablerowentitylisting) String() string

String returns a JSON representation of the model

type Datatablesdomainentitylisting ¶

type Datatablesdomainentitylisting struct {
	// Entities
	Entities *[]Datatable `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"`

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

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

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

Datatablesdomainentitylisting

func (*Datatablesdomainentitylisting) String ¶

String returns a JSON representation of the model

type Daterange ¶

type Daterange struct {
	// StartDate - The inclusive start of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone.
	StartDate *string `json:"startDate,omitempty"`

	// EndDate - The inclusive end of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone.
	EndDate *string `json:"endDate,omitempty"`
}

Daterange

func (*Daterange) String ¶

func (o *Daterange) String() string

String returns a JSON representation of the model

type Daterangewithoptionalend ¶

type Daterangewithoptionalend struct {
	// StartBusinessUnitDate - The start date for work plan rotation or an agent, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	StartBusinessUnitDate *time.Time `json:"startBusinessUnitDate,omitempty"`

	// EndBusinessUnitDate - The end date for work plan rotation or an agent, interpreted in the business unit's time zone. Null denotes open ended date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	EndBusinessUnitDate *time.Time `json:"endBusinessUnitDate,omitempty"`
}

Daterangewithoptionalend

func (*Daterangewithoptionalend) String ¶

func (o *Daterangewithoptionalend) String() string

String returns a JSON representation of the model

type Defaultgreetinglist ¶

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

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

	// Owner
	Owner *Greetingowner `json:"owner,omitempty"`

	// OwnerType
	OwnerType *string `json:"ownerType,omitempty"`

	// Greetings
	Greetings *map[string]Greeting `json:"greetings,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"`

	// CreatedBy
	CreatedBy *string `json:"createdBy,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"`

	// ModifiedBy
	ModifiedBy *string `json:"modifiedBy,omitempty"`

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

Defaultgreetinglist

func (*Defaultgreetinglist) String ¶

func (o *Defaultgreetinglist) String() string

String returns a JSON representation of the model

type Defaultobjective ¶

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

	// TemplateId - The id of this objective's base template
	TemplateId *string `json:"templateId,omitempty"`

	// Zones - Objective zone specifies min,max points and values for the associated metric
	Zones *[]Objectivezone `json:"zones,omitempty"`

	// Enabled - A flag for whether this objective is enabled for the related metric
	Enabled *bool `json:"enabled,omitempty"`
}

Defaultobjective

func (*Defaultobjective) String ¶

func (o *Defaultobjective) String() string

String returns a JSON representation of the model

type Deletableuserreference ¶

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

	// Delete - If marked true, the user will be removed an associated entity
	Delete *bool `json:"delete,omitempty"`

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

Deletableuserreference - User reference with delete flag to remove the user from an associated entity

func (*Deletableuserreference) String ¶

func (o *Deletableuserreference) String() string

String returns a JSON representation of the model

type Deleteretention ¶

type Deleteretention struct {
	// Days
	Days *int `json:"days,omitempty"`
}

Deleteretention

func (*Deleteretention) String ¶

func (o *Deleteretention) String() string

String returns a JSON representation of the model

type Dependency ¶

type Dependency struct {
	// Id - The dependency identifier
	Id *string `json:"id,omitempty"`

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

	// Version
	Version *string `json:"version,omitempty"`

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

	// Deleted
	Deleted *bool `json:"deleted,omitempty"`

	// Updated
	Updated *bool `json:"updated,omitempty"`

	// StateUnknown
	StateUnknown *bool `json:"stateUnknown,omitempty"`

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

Dependency

func (*Dependency) String ¶

func (o *Dependency) String() string

String returns a JSON representation of the model

type Dependencyobject ¶

type Dependencyobject struct {
	// Id - The dependency identifier
	Id *string `json:"id,omitempty"`

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

	// Version
	Version *string `json:"version,omitempty"`

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

	// Deleted
	Deleted *bool `json:"deleted,omitempty"`

	// Updated
	Updated *bool `json:"updated,omitempty"`

	// StateUnknown
	StateUnknown *bool `json:"stateUnknown,omitempty"`

	// ConsumedResources
	ConsumedResources *[]Dependency `json:"consumedResources,omitempty"`

	// ConsumingResources
	ConsumingResources *[]Dependency `json:"consumingResources,omitempty"`

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

Dependencyobject

func (*Dependencyobject) String ¶

func (o *Dependencyobject) String() string

String returns a JSON representation of the model

type Dependencyobjectentitylisting ¶

type Dependencyobjectentitylisting struct {
	// Entities
	Entities *[]Dependencyobject `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"`

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

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

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

Dependencyobjectentitylisting

func (*Dependencyobjectentitylisting) String ¶

String returns a JSON representation of the model

type Dependencystatus ¶

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

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

	// User - User that initiated the build.
	User *User `json:"user,omitempty"`

	// Client - OAuth client that initiated the build.
	Client *Domainentityref `json:"client,omitempty"`

	// BuildId
	BuildId *string `json:"buildId,omitempty"`

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

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

	// Status
	Status *string `json:"status,omitempty"`

	// FailedObjects
	FailedObjects *[]Failedobject `json:"failedObjects,omitempty"`

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

Dependencystatus

func (*Dependencystatus) String ¶

func (o *Dependencystatus) String() string

String returns a JSON representation of the model

type Dependencytype ¶

type Dependencytype struct {
	// Id - The dependency type identifier
	Id *string `json:"id,omitempty"`

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

	// Versioned
	Versioned *bool `json:"versioned,omitempty"`

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

Dependencytype

func (*Dependencytype) String ¶

func (o *Dependencytype) String() string

String returns a JSON representation of the model

type Dependencytypeentitylisting ¶

type Dependencytypeentitylisting struct {
	// Entities
	Entities *[]Dependencytype `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"`

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

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

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

Dependencytypeentitylisting

func (*Dependencytypeentitylisting) String ¶

func (o *Dependencytypeentitylisting) String() string

String returns a JSON representation of the model

type Destination ¶

type Destination struct {
	// Address - Address or phone number.
	Address *string `json:"address,omitempty"`

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

	// UserId
	UserId *string `json:"userId,omitempty"`

	// QueueId
	QueueId *string `json:"queueId,omitempty"`
}

Destination

func (*Destination) String ¶

func (o *Destination) String() string

String returns a JSON representation of the model

type Detail ¶

type Detail 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"`
}

Detail

func (*Detail) String ¶

func (o *Detail) String() string

String returns a JSON representation of the model

type Detecteddialogact ¶

type Detecteddialogact struct {
	// Name - The name of the detected dialog act.
	Name *string `json:"name,omitempty"`

	// Probability - The probability of the detected dialog act.
	Probability *float64 `json:"probability,omitempty"`
}

Detecteddialogact

func (*Detecteddialogact) String ¶

func (o *Detecteddialogact) String() string

String returns a JSON representation of the model

type Detectedintent ¶

type Detectedintent struct {
	// Name - The name of the detected intent.
	Name *string `json:"name,omitempty"`

	// Probability - The probability of the detected intent.
	Probability *float64 `json:"probability,omitempty"`

	// Entities - The collection of named entities detected.
	Entities *[]Detectednamedentity `json:"entities,omitempty"`
}

Detectedintent

func (*Detectedintent) String ¶

func (o *Detectedintent) String() string

String returns a JSON representation of the model

type Detectednamedentity ¶

type Detectednamedentity struct {
	// Name - The name of the detected named entity.
	Name *string `json:"name,omitempty"`

	// EntityType - The type of the detected named entity.
	EntityType *string `json:"entityType,omitempty"`

	// Probability - The probability of the detected named entity.
	Probability *float64 `json:"probability,omitempty"`

	// Value - The value of the detected named entity.
	Value *Detectednamedentityvalue `json:"value,omitempty"`
}

Detectednamedentity

func (*Detectednamedentity) String ¶

func (o *Detectednamedentity) String() string

String returns a JSON representation of the model

type Detectednamedentityvalue ¶

type Detectednamedentityvalue struct {
	// Raw - The raw value of the detected named entity.
	Raw *string `json:"raw,omitempty"`

	// Resolved - The resolved value of the detected named entity.
	Resolved *string `json:"resolved,omitempty"`
}

Detectednamedentityvalue

func (*Detectednamedentityvalue) String ¶

func (o *Detectednamedentityvalue) String() string

String returns a JSON representation of the model

type Developmentactivity ¶

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

	// DateCompleted - Date that activity was completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCompleted *time.Time `json:"dateCompleted,omitempty"`

	// CreatedBy - User that created activity
	CreatedBy *Userreference `json:"createdBy,omitempty"`

	// DateCreated - Date activity 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"`

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

	// Name - The name of the activity
	Name *string `json:"name,omitempty"`

	// VarType - The type of activity
	VarType *string `json:"type,omitempty"`

	// Status - The status of the activity
	Status *string `json:"status,omitempty"`

	// DateDue - Due date for completion of the activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateDue *time.Time `json:"dateDue,omitempty"`

	// Facilitator - Facilitator of the activity
	Facilitator *Userreference `json:"facilitator,omitempty"`

	// Attendees - List of users attending the activity
	Attendees *[]Userreference `json:"attendees,omitempty"`

	// IsOverdue - Indicates if the activity is overdue
	IsOverdue *bool `json:"isOverdue,omitempty"`
}

Developmentactivity - Development Activity object

func (*Developmentactivity) String ¶

func (o *Developmentactivity) String() string

String returns a JSON representation of the model

type Developmentactivityaggregateparam ¶

type Developmentactivityaggregateparam struct {
	// Interval - Specifies the range of due dates to be used for filtering. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. 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 - The list of metrics to be returned. If omitted, all metrics are returned.
	Metrics *[]string `json:"metrics,omitempty"`

	// GroupBy - Specifies if the aggregated data is combined into a single set of metrics (groupBy is empty or not specified), or contains an element per attendeeId (groupBy is \"attendeeId\")
	GroupBy *[]string `json:"groupBy,omitempty"`

	// Filter - The filter applied to the data. This is ANDed with the interval parameter.
	Filter *Developmentactivityaggregatequeryrequestfilter `json:"filter,omitempty"`
}

Developmentactivityaggregateparam

func (*Developmentactivityaggregateparam) String ¶

String returns a JSON representation of the model

type Developmentactivityaggregatequeryrequestclause ¶

type Developmentactivityaggregatequeryrequestclause struct {
	// VarType - The logic used to combine the predicates
	VarType *string `json:"type,omitempty"`

	// Predicates - The list of predicates used to filter the data
	Predicates *[]Developmentactivityaggregatequeryrequestpredicate `json:"predicates,omitempty"`
}

Developmentactivityaggregatequeryrequestclause

func (*Developmentactivityaggregatequeryrequestclause) String ¶

String returns a JSON representation of the model

type Developmentactivityaggregatequeryrequestfilter ¶

type Developmentactivityaggregatequeryrequestfilter struct {
	// VarType - The logic used to combine the clauses
	VarType *string `json:"type,omitempty"`

	// Clauses - The list of clauses used to filter the data. Note that clauses must filter by attendeeId and a maximum of 100 user IDs are allowed
	Clauses *[]Developmentactivityaggregatequeryrequestclause `json:"clauses,omitempty"`
}

Developmentactivityaggregatequeryrequestfilter

func (*Developmentactivityaggregatequeryrequestfilter) String ¶

String returns a JSON representation of the model

type Developmentactivityaggregatequeryrequestpredicate ¶

type Developmentactivityaggregatequeryrequestpredicate struct {
	// Dimension - Each predicates specifies a dimension.
	Dimension *string `json:"dimension,omitempty"`

	// Value - Corresponding value for dimensions in predicates. If the dimensions is type, Valid Values: Informational, Coaching
	Value *string `json:"value,omitempty"`
}

Developmentactivityaggregatequeryrequestpredicate

func (*Developmentactivityaggregatequeryrequestpredicate) String ¶

String returns a JSON representation of the model

type Developmentactivityaggregatequeryresponsedata ¶

type Developmentactivityaggregatequeryresponsedata struct {
	// Interval - Specifies the range of due dates to be used for filtering. A maximum of 1 year can be specified in the range. 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 - The list of aggregated metrics
	Metrics *[]Developmentactivityaggregatequeryresponsemetric `json:"metrics,omitempty"`
}

Developmentactivityaggregatequeryresponsedata

func (*Developmentactivityaggregatequeryresponsedata) String ¶

String returns a JSON representation of the model

type Developmentactivityaggregatequeryresponsegroupeddata ¶

type Developmentactivityaggregatequeryresponsegroupeddata struct {
	// Group - The group values for this data
	Group *map[string]string `json:"group,omitempty"`

	// Data - The metrics in this group
	Data *[]Developmentactivityaggregatequeryresponsedata `json:"data,omitempty"`
}

Developmentactivityaggregatequeryresponsegroupeddata

func (*Developmentactivityaggregatequeryresponsegroupeddata) String ¶

String returns a JSON representation of the model

type Developmentactivityaggregatequeryresponsemetric ¶

type Developmentactivityaggregatequeryresponsemetric struct {
	// Metric - The metric this applies to
	Metric *string `json:"metric,omitempty"`

	// Stats - The aggregated values for this metric
	Stats *Developmentactivityaggregatequeryresponsestatistics `json:"stats,omitempty"`
}

Developmentactivityaggregatequeryresponsemetric

func (*Developmentactivityaggregatequeryresponsemetric) String ¶

String returns a JSON representation of the model

type Developmentactivityaggregatequeryresponsestatistics ¶

type Developmentactivityaggregatequeryresponsestatistics struct {
	// Count - The count for this metric
	Count *int `json:"count,omitempty"`
}

Developmentactivityaggregatequeryresponsestatistics

func (*Developmentactivityaggregatequeryresponsestatistics) String ¶

String returns a JSON representation of the model

type Developmentactivityaggregateresponse ¶

type Developmentactivityaggregateresponse struct {
	// Results - The results of the query
	Results *[]Developmentactivityaggregatequeryresponsegroupeddata `json:"results,omitempty"`
}

Developmentactivityaggregateresponse

func (*Developmentactivityaggregateresponse) String ¶

String returns a JSON representation of the model

type Developmentactivitylisting ¶

type Developmentactivitylisting struct {
	// Entities
	Entities *[]Developmentactivity `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"`

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

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

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

Developmentactivitylisting

func (*Developmentactivitylisting) String ¶

func (o *Developmentactivitylisting) String() string

String returns a JSON representation of the model

type Dialeraction ¶

type Dialeraction struct {
	// VarType - The type of this DialerAction.
	VarType *string `json:"type,omitempty"`

	// ActionTypeName - Additional type specification for this DialerAction.
	ActionTypeName *string `json:"actionTypeName,omitempty"`

	// UpdateOption - Specifies how a contact attribute should be updated. Required for MODIFY_CONTACT_ATTRIBUTE.
	UpdateOption *string `json:"updateOption,omitempty"`

	// Properties - A map of key-value pairs pertinent to the DialerAction. Different types of DialerActions require different properties. MODIFY_CONTACT_ATTRIBUTE with an updateOption of SET takes a contact column as the key and accepts any value. SCHEDULE_CALLBACK takes a key 'callbackOffset' that specifies how far in the future the callback should be scheduled, in minutes. SET_CALLER_ID takes two keys: 'callerAddress', which should be the caller id phone number, and 'callerName'. For either key, you can also specify a column on the contact to get the value from. To do this, specify 'contact.Column', where 'Column' is the name of the contact column from which to get the value. SET_SKILLS takes a key 'skills' with an array of skill ids wrapped into a string (Example: {'skills': '['skillIdHere']'} ).
	Properties *map[string]string `json:"properties,omitempty"`
}

Dialeraction

func (*Dialeraction) String ¶

func (o *Dialeraction) String() string

String returns a JSON representation of the model

type Dialerattemptlimitsconfigchangeattemptlimits ¶

type Dialerattemptlimitsconfigchangeattemptlimits 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"`

	// Version
	Version *int `json:"version,omitempty"`

	// MaxAttemptsPerContact
	MaxAttemptsPerContact *int `json:"maxAttemptsPerContact,omitempty"`

	// MaxAttemptsPerNumber
	MaxAttemptsPerNumber *int `json:"maxAttemptsPerNumber,omitempty"`

	// TimeZoneId
	TimeZoneId *string `json:"timeZoneId,omitempty"`

	// ResetPeriod
	ResetPeriod *string `json:"resetPeriod,omitempty"`

	// RecallEntries
	RecallEntries *map[string]Dialerattemptlimitsconfigchangerecallentry `json:"recallEntries,omitempty"`

	// BreadthFirstRecalls
	BreadthFirstRecalls *bool `json:"breadthFirstRecalls,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialerattemptlimitsconfigchangeattemptlimits

func (*Dialerattemptlimitsconfigchangeattemptlimits) String ¶

String returns a JSON representation of the model

type Dialerattemptlimitsconfigchangerecallentry ¶

type Dialerattemptlimitsconfigchangerecallentry struct {
	// NbrAttempts
	NbrAttempts *int `json:"nbrAttempts,omitempty"`

	// MinutesBetweenAttempts
	MinutesBetweenAttempts *int `json:"minutesBetweenAttempts,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialerattemptlimitsconfigchangerecallentry

func (*Dialerattemptlimitsconfigchangerecallentry) String ¶

String returns a JSON representation of the model

type Dialerauditrequest ¶

type Dialerauditrequest struct {
	// QueryPhrase - The word or words to search for.
	QueryPhrase *string `json:"queryPhrase,omitempty"`

	// QueryFields - The fields in which to search for the queryPhrase.
	QueryFields *[]string `json:"queryFields,omitempty"`

	// Facets - The fields to facet on.
	Facets *[]Auditfacet `json:"facets,omitempty"`

	// Filters - The fields to filter on.
	Filters *[]Auditfilter `json:"filters,omitempty"`
}

Dialerauditrequest

func (*Dialerauditrequest) String ¶

func (o *Dialerauditrequest) String() string

String returns a JSON representation of the model

type Dialercallabletimesetconfigchangecallabletime ¶

type Dialercallabletimesetconfigchangecallabletime struct {
	// TimeSlots
	TimeSlots *[]Dialercallabletimesetconfigchangetimeslot `json:"timeSlots,omitempty"`

	// TimeZoneId
	TimeZoneId *string `json:"timeZoneId,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercallabletimesetconfigchangecallabletime

func (*Dialercallabletimesetconfigchangecallabletime) String ¶

String returns a JSON representation of the model

type Dialercallabletimesetconfigchangecallabletimeset ¶

type Dialercallabletimesetconfigchangecallabletimeset 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"`

	// Version
	Version *int `json:"version,omitempty"`

	// CallableTimes
	CallableTimes *[]Dialercallabletimesetconfigchangecallabletime `json:"callableTimes,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercallabletimesetconfigchangecallabletimeset

func (*Dialercallabletimesetconfigchangecallabletimeset) String ¶

String returns a JSON representation of the model

type Dialercallabletimesetconfigchangetimeslot ¶

type Dialercallabletimesetconfigchangetimeslot struct {
	// StartTime
	StartTime *string `json:"startTime,omitempty"`

	// StopTime
	StopTime *string `json:"stopTime,omitempty"`

	// Day
	Day *int `json:"day,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercallabletimesetconfigchangetimeslot

func (*Dialercallabletimesetconfigchangetimeslot) String ¶

String returns a JSON representation of the model

type Dialercampaignconfigchangecampaign ¶

type Dialercampaignconfigchangecampaign 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"`

	// Version
	Version *int `json:"version,omitempty"`

	// ContactList
	ContactList *Dialercampaignconfigchangeurireference `json:"contactList,omitempty"`

	// Queue
	Queue *Dialercampaignconfigchangeurireference `json:"queue,omitempty"`

	// DialingMode
	DialingMode *string `json:"dialingMode,omitempty"`

	// Script
	Script *Dialercampaignconfigchangeurireference `json:"script,omitempty"`

	// EdgeGroup
	EdgeGroup *Dialercampaignconfigchangeurireference `json:"edgeGroup,omitempty"`

	// Site
	Site *Dialercampaignconfigchangeurireference `json:"site,omitempty"`

	// CampaignStatus
	CampaignStatus *string `json:"campaignStatus,omitempty"`

	// PhoneColumns
	PhoneColumns *[]Dialercampaignconfigchangephonecolumn `json:"phoneColumns,omitempty"`

	// AbandonRate
	AbandonRate *float32 `json:"abandonRate,omitempty"`

	// DncLists
	DncLists *[]Dialercampaignconfigchangeurireference `json:"dncLists,omitempty"`

	// CallableTimeSet
	CallableTimeSet *Dialercampaignconfigchangeurireference `json:"callableTimeSet,omitempty"`

	// CallAnalysisResponseSet
	CallAnalysisResponseSet *Dialercampaignconfigchangeurireference `json:"callAnalysisResponseSet,omitempty"`

	// CallerName
	CallerName *string `json:"callerName,omitempty"`

	// CallerAddress
	CallerAddress *string `json:"callerAddress,omitempty"`

	// OutboundLineCount
	OutboundLineCount *int `json:"outboundLineCount,omitempty"`

	// Errors
	Errors *[]Dialercampaignconfigchangeresterrordetail `json:"errors,omitempty"`

	// RuleSets
	RuleSets *[]Dialercampaignconfigchangeurireference `json:"ruleSets,omitempty"`

	// SkipPreviewDisabled
	SkipPreviewDisabled *bool `json:"skipPreviewDisabled,omitempty"`

	// PreviewTimeOutSeconds
	PreviewTimeOutSeconds *int `json:"previewTimeOutSeconds,omitempty"`

	// SingleNumberPreview
	SingleNumberPreview *bool `json:"singleNumberPreview,omitempty"`

	// ContactSort
	ContactSort *Dialercampaignconfigchangecontactsort `json:"contactSort,omitempty"`

	// ContactSorts
	ContactSorts *[]Dialercampaignconfigchangecontactsort `json:"contactSorts,omitempty"`

	// NoAnswerTimeout
	NoAnswerTimeout *int `json:"noAnswerTimeout,omitempty"`

	// CallAnalysisLanguage
	CallAnalysisLanguage *string `json:"callAnalysisLanguage,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// ContactListFilters
	ContactListFilters *[]Dialercampaignconfigchangeurireference `json:"contactListFilters,omitempty"`

	// Division
	Division *Dialercampaignconfigchangeurireference `json:"division,omitempty"`

	// AgentOwnedColumn
	AgentOwnedColumn *string `json:"agentOwnedColumn,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercampaignconfigchangecampaign

func (*Dialercampaignconfigchangecampaign) String ¶

String returns a JSON representation of the model

type Dialercampaignconfigchangecontactsort ¶

type Dialercampaignconfigchangecontactsort struct {
	// FieldName
	FieldName *string `json:"fieldName,omitempty"`

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

	// Numeric
	Numeric *bool `json:"numeric,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercampaignconfigchangecontactsort

func (*Dialercampaignconfigchangecontactsort) String ¶

String returns a JSON representation of the model

type Dialercampaignconfigchangephonecolumn ¶

type Dialercampaignconfigchangephonecolumn struct {
	// ColumnName
	ColumnName *string `json:"columnName,omitempty"`

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

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercampaignconfigchangephonecolumn

func (*Dialercampaignconfigchangephonecolumn) String ¶

String returns a JSON representation of the model

type Dialercampaignconfigchangeresterrordetail ¶

type Dialercampaignconfigchangeresterrordetail struct {
	// VarError
	VarError *string `json:"error,omitempty"`

	// Details
	Details *string `json:"details,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercampaignconfigchangeresterrordetail

func (*Dialercampaignconfigchangeresterrordetail) String ¶

String returns a JSON representation of the model

type Dialercampaignconfigchangeurireference ¶

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

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

Dialercampaignconfigchangeurireference

func (*Dialercampaignconfigchangeurireference) String ¶

String returns a JSON representation of the model

type Dialercampaignprogresseventcampaignprogress ¶

type Dialercampaignprogresseventcampaignprogress struct {
	// Campaign
	Campaign *Dialercampaignprogresseventurireference `json:"campaign,omitempty"`

	// NumberOfContactsCalled
	NumberOfContactsCalled *float32 `json:"numberOfContactsCalled,omitempty"`

	// NumberOfContactsMessaged
	NumberOfContactsMessaged *float32 `json:"numberOfContactsMessaged,omitempty"`

	// TotalNumberOfContacts
	TotalNumberOfContacts *float32 `json:"totalNumberOfContacts,omitempty"`

	// Percentage
	Percentage *int `json:"percentage,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercampaignprogresseventcampaignprogress

func (*Dialercampaignprogresseventcampaignprogress) String ¶

String returns a JSON representation of the model

type Dialercampaignprogresseventurireference ¶

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

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

Dialercampaignprogresseventurireference

func (*Dialercampaignprogresseventurireference) String ¶

String returns a JSON representation of the model

type Dialercampaignruleconfigchangecampaignrule ¶

type Dialercampaignruleconfigchangecampaignrule 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"`

	// Version
	Version *int `json:"version,omitempty"`

	// CampaignRuleEntities
	CampaignRuleEntities *Dialercampaignruleconfigchangecampaignruleentities `json:"campaignRuleEntities,omitempty"`

	// CampaignRuleConditions
	CampaignRuleConditions *[]Dialercampaignruleconfigchangecampaignrulecondition `json:"campaignRuleConditions,omitempty"`

	// CampaignRuleActions
	CampaignRuleActions *[]Dialercampaignruleconfigchangecampaignruleaction `json:"campaignRuleActions,omitempty"`

	// MatchAnyConditions
	MatchAnyConditions *bool `json:"matchAnyConditions,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercampaignruleconfigchangecampaignrule

func (*Dialercampaignruleconfigchangecampaignrule) String ¶

String returns a JSON representation of the model

type Dialercampaignruleconfigchangecampaignruleaction ¶

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

	// Parameters
	Parameters *map[string]string `json:"parameters,omitempty"`

	// ActionType
	ActionType *string `json:"actionType,omitempty"`

	// CampaignRuleActionEntities
	CampaignRuleActionEntities *Dialercampaignruleconfigchangecampaignruleactionentities `json:"campaignRuleActionEntities,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercampaignruleconfigchangecampaignruleaction

func (*Dialercampaignruleconfigchangecampaignruleaction) String ¶

String returns a JSON representation of the model

type Dialercampaignruleconfigchangecampaignruleactionentities ¶

type Dialercampaignruleconfigchangecampaignruleactionentities struct {
	// Campaigns
	Campaigns *[]Dialercampaignruleconfigchangeurireference `json:"campaigns,omitempty"`

	// Sequences
	Sequences *[]Dialercampaignruleconfigchangeurireference `json:"sequences,omitempty"`

	// UseTriggeringEntity
	UseTriggeringEntity *bool `json:"useTriggeringEntity,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercampaignruleconfigchangecampaignruleactionentities

func (*Dialercampaignruleconfigchangecampaignruleactionentities) String ¶

String returns a JSON representation of the model

type Dialercampaignruleconfigchangecampaignrulecondition ¶

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

	// Parameters
	Parameters *map[string]string `json:"parameters,omitempty"`

	// ConditionType
	ConditionType *string `json:"conditionType,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercampaignruleconfigchangecampaignrulecondition

func (*Dialercampaignruleconfigchangecampaignrulecondition) String ¶

String returns a JSON representation of the model

type Dialercampaignruleconfigchangecampaignruleentities ¶

type Dialercampaignruleconfigchangecampaignruleentities struct {
	// Campaigns
	Campaigns *[]Dialercampaignruleconfigchangeurireference `json:"campaigns,omitempty"`

	// Sequences
	Sequences *[]Dialercampaignruleconfigchangeurireference `json:"sequences,omitempty"`
}

Dialercampaignruleconfigchangecampaignruleentities

func (*Dialercampaignruleconfigchangecampaignruleentities) String ¶

String returns a JSON representation of the model

type Dialercampaignruleconfigchangeurireference ¶

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

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

Dialercampaignruleconfigchangeurireference

func (*Dialercampaignruleconfigchangeurireference) String ¶

String returns a JSON representation of the model

type Dialercampaignscheduleconfigchangecampaignschedule ¶

type Dialercampaignscheduleconfigchangecampaignschedule 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"`

	// Version
	Version *int `json:"version,omitempty"`

	// Intervals
	Intervals *[]Dialercampaignscheduleconfigchangescheduleinterval `json:"intervals,omitempty"`

	// TimeZone
	TimeZone *string `json:"timeZone,omitempty"`

	// Campaign
	Campaign *Dialercampaignscheduleconfigchangeurireference `json:"campaign,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercampaignscheduleconfigchangecampaignschedule

func (*Dialercampaignscheduleconfigchangecampaignschedule) String ¶

String returns a JSON representation of the model

type Dialercampaignscheduleconfigchangescheduleinterval ¶

type Dialercampaignscheduleconfigchangescheduleinterval struct {
	// Start
	Start *string `json:"start,omitempty"`

	// End
	End *string `json:"end,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercampaignscheduleconfigchangescheduleinterval

func (*Dialercampaignscheduleconfigchangescheduleinterval) String ¶

String returns a JSON representation of the model

type Dialercampaignscheduleconfigchangeurireference ¶

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

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

Dialercampaignscheduleconfigchangeurireference

func (*Dialercampaignscheduleconfigchangeurireference) String ¶

String returns a JSON representation of the model

type Dialercontact ¶

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

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

	// ContactListId - The identifier of the contact list containing this contact.
	ContactListId *string `json:"contactListId,omitempty"`

	// Data - An ordered map of the contact's columns and corresponding values.
	Data *map[string]interface{} `json:"data,omitempty"`

	// CallRecords - A map of call records for the contact phone columns.
	CallRecords *map[string]Callrecord `json:"callRecords,omitempty"`

	// Callable - Indicates whether or not the contact can be called.
	Callable *bool `json:"callable,omitempty"`

	// PhoneNumberStatus - A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not.
	PhoneNumberStatus *map[string]Phonenumberstatus `json:"phoneNumberStatus,omitempty"`

	// ContactColumnTimeZones - Map containing data about the timezone the contact is mapped to. This will only be populated if the contact list has automatic timezone mapping turned on. The key is the column name. The value is the timezone it mapped to and the type of column: Phone or Zip
	ContactColumnTimeZones *map[string]Contactcolumntimezone `json:"contactColumnTimeZones,omitempty"`

	// ConfigurationOverrides - the priority property within ConfigurationOverides indicates whether or not the contact to be placed in front of the queue or at the end of the queue
	ConfigurationOverrides *Configurationoverrides `json:"configurationOverrides,omitempty"`

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

Dialercontact

func (*Dialercontact) String ¶

func (o *Dialercontact) String() string

String returns a JSON representation of the model

type Dialercontactid ¶

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

	// ContactListId
	ContactListId *string `json:"contactListId,omitempty"`
}

Dialercontactid

func (*Dialercontactid) String ¶

func (o *Dialercontactid) String() string

String returns a JSON representation of the model

type Dialercontactlistconfigchangecontactlist ¶

type Dialercontactlistconfigchangecontactlist 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"`

	// Version
	Version *int `json:"version,omitempty"`

	// ColumnNames
	ColumnNames *[]string `json:"columnNames,omitempty"`

	// PhoneColumns
	PhoneColumns *[]Dialercontactlistconfigchangecontactphonenumbercolumn `json:"phoneColumns,omitempty"`

	// EmailColumns
	EmailColumns *[]Dialercontactlistconfigchangeemailcolumn `json:"emailColumns,omitempty"`

	// ImportStatus
	ImportStatus *Dialercontactlistconfigchangeimportstatus `json:"importStatus,omitempty"`

	// PreviewModeColumnName
	PreviewModeColumnName *string `json:"previewModeColumnName,omitempty"`

	// PreviewModeAcceptedValues
	PreviewModeAcceptedValues *[]string `json:"previewModeAcceptedValues,omitempty"`

	// Size
	Size *int `json:"size,omitempty"`

	// AttemptLimits
	AttemptLimits *Dialercontactlistconfigchangeurireference `json:"attemptLimits,omitempty"`

	// AutomaticTimeZoneMapping
	AutomaticTimeZoneMapping *bool `json:"automaticTimeZoneMapping,omitempty"`

	// ZipCodeColumnName
	ZipCodeColumnName *string `json:"zipCodeColumnName,omitempty"`

	// Division
	Division *Dialercontactlistconfigchangeurireference `json:"division,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercontactlistconfigchangecontactlist

func (*Dialercontactlistconfigchangecontactlist) String ¶

String returns a JSON representation of the model

type Dialercontactlistconfigchangecontactphonenumbercolumn ¶

type Dialercontactlistconfigchangecontactphonenumbercolumn struct {
	// ColumnName
	ColumnName *string `json:"columnName,omitempty"`

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

	// CallableTimeColumn
	CallableTimeColumn *string `json:"callableTimeColumn,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercontactlistconfigchangecontactphonenumbercolumn

func (*Dialercontactlistconfigchangecontactphonenumbercolumn) String ¶

String returns a JSON representation of the model

type Dialercontactlistconfigchangeemailcolumn ¶

type Dialercontactlistconfigchangeemailcolumn struct {
	// ColumnName
	ColumnName *string `json:"columnName,omitempty"`

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

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercontactlistconfigchangeemailcolumn

func (*Dialercontactlistconfigchangeemailcolumn) String ¶

String returns a JSON representation of the model

type Dialercontactlistconfigchangeimportstatus ¶

type Dialercontactlistconfigchangeimportstatus 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 *interface{} `json:"additionalProperties,omitempty"`
}

Dialercontactlistconfigchangeimportstatus

func (*Dialercontactlistconfigchangeimportstatus) String ¶

String returns a JSON representation of the model

type Dialercontactlistconfigchangeurireference ¶

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

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

Dialercontactlistconfigchangeurireference

func (*Dialercontactlistconfigchangeurireference) String ¶

String returns a JSON representation of the model

type Dialercontactlistfilterconfigchangecontactlistfilter ¶

type Dialercontactlistfilterconfigchangecontactlistfilter 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"`

	// Version
	Version *int `json:"version,omitempty"`

	// ContactList
	ContactList *Dialercontactlistfilterconfigchangeurireference `json:"contactList,omitempty"`

	// ContactListColumns
	ContactListColumns *[]string `json:"contactListColumns,omitempty"`

	// Clauses
	Clauses *[]Dialercontactlistfilterconfigchangefilterclause `json:"clauses,omitempty"`

	// FilterType
	FilterType *string `json:"filterType,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercontactlistfilterconfigchangecontactlistfilter

func (*Dialercontactlistfilterconfigchangecontactlistfilter) String ¶

String returns a JSON representation of the model

type Dialercontactlistfilterconfigchangefilterclause ¶

type Dialercontactlistfilterconfigchangefilterclause struct {
	// FilterType
	FilterType *string `json:"filterType,omitempty"`

	// Predicates
	Predicates *[]Dialercontactlistfilterconfigchangefilterpredicate `json:"predicates,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercontactlistfilterconfigchangefilterclause

func (*Dialercontactlistfilterconfigchangefilterclause) String ¶

String returns a JSON representation of the model

type Dialercontactlistfilterconfigchangefilterpredicate ¶

type Dialercontactlistfilterconfigchangefilterpredicate struct {
	// Column
	Column *string `json:"column,omitempty"`

	// ColumnType
	ColumnType *string `json:"columnType,omitempty"`

	// Operator
	Operator *string `json:"operator,omitempty"`

	// Value
	Value *string `json:"value,omitempty"`

	// VarRange
	VarRange *Dialercontactlistfilterconfigchangerange `json:"range,omitempty"`

	// Inverted
	Inverted *bool `json:"inverted,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercontactlistfilterconfigchangefilterpredicate

func (*Dialercontactlistfilterconfigchangefilterpredicate) String ¶

String returns a JSON representation of the model

type Dialercontactlistfilterconfigchangerange ¶

type Dialercontactlistfilterconfigchangerange struct {
	// Min
	Min *string `json:"min,omitempty"`

	// Max
	Max *string `json:"max,omitempty"`

	// MinInclusive
	MinInclusive *bool `json:"minInclusive,omitempty"`

	// MaxInclusive
	MaxInclusive *bool `json:"maxInclusive,omitempty"`

	// InSet
	InSet *[]string `json:"inSet,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialercontactlistfilterconfigchangerange

func (*Dialercontactlistfilterconfigchangerange) String ¶

String returns a JSON representation of the model

type Dialercontactlistfilterconfigchangeurireference ¶

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

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

Dialercontactlistfilterconfigchangeurireference

func (*Dialercontactlistfilterconfigchangeurireference) String ¶

String returns a JSON representation of the model

type Dialerdnclistconfigchangednclist ¶

type Dialerdnclistconfigchangednclist 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"`

	// Version
	Version *int `json:"version,omitempty"`

	// ImportStatus
	ImportStatus *Dialerdnclistconfigchangeimportstatus `json:"importStatus,omitempty"`

	// Size
	Size *int `json:"size,omitempty"`

	// DncSourceType
	DncSourceType *string `json:"dncSourceType,omitempty"`

	// LoginId
	LoginId *string `json:"loginId,omitempty"`

	// DncCodes
	DncCodes *[]string `json:"dncCodes,omitempty"`

	// LicenseId
	LicenseId *string `json:"licenseId,omitempty"`

	// ContactMethod
	ContactMethod *string `json:"contactMethod,omitempty"`

	// Division
	Division *Dialerdnclistconfigchangeurireference `json:"division,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialerdnclistconfigchangednclist

func (*Dialerdnclistconfigchangednclist) String ¶

String returns a JSON representation of the model

type Dialerdnclistconfigchangeimportstatus ¶

type Dialerdnclistconfigchangeimportstatus 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 *interface{} `json:"additionalProperties,omitempty"`
}

Dialerdnclistconfigchangeimportstatus

func (*Dialerdnclistconfigchangeimportstatus) String ¶

String returns a JSON representation of the model

type Dialerdnclistconfigchangeurireference ¶

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

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

Dialerdnclistconfigchangeurireference

func (*Dialerdnclistconfigchangeurireference) String ¶

String returns a JSON representation of the model

type Dialerevententitylisting ¶

type Dialerevententitylisting struct {
	// Entities
	Entities *[]Eventlog `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"`

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

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

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

Dialerevententitylisting

func (*Dialerevententitylisting) String ¶

func (o *Dialerevententitylisting) String() string

String returns a JSON representation of the model

type Dialeroutboundsettingsconfigchangeatzmtimeslot ¶

type Dialeroutboundsettingsconfigchangeatzmtimeslot struct {
	// EarliestCallableTime
	EarliestCallableTime *string `json:"earliestCallableTime,omitempty"`

	// LatestCallableTime
	LatestCallableTime *string `json:"latestCallableTime,omitempty"`
}

Dialeroutboundsettingsconfigchangeatzmtimeslot

func (*Dialeroutboundsettingsconfigchangeatzmtimeslot) String ¶

String returns a JSON representation of the model

type Dialeroutboundsettingsconfigchangeatzmtimeslotwithtimezone ¶

type Dialeroutboundsettingsconfigchangeatzmtimeslotwithtimezone struct {
	// EarliestCallableTime
	EarliestCallableTime *string `json:"earliestCallableTime,omitempty"`

	// LatestCallableTime
	LatestCallableTime *string `json:"latestCallableTime,omitempty"`

	// TimeZoneId
	TimeZoneId *string `json:"timeZoneId,omitempty"`
}

Dialeroutboundsettingsconfigchangeatzmtimeslotwithtimezone

func (*Dialeroutboundsettingsconfigchangeatzmtimeslotwithtimezone) String ¶

String returns a JSON representation of the model

type Dialeroutboundsettingsconfigchangeautomatictimezonemappingsettings ¶

type Dialeroutboundsettingsconfigchangeautomatictimezonemappingsettings struct {
	// CallableWindows
	CallableWindows *[]Dialeroutboundsettingsconfigchangecallablewindow `json:"callableWindows,omitempty"`
}

Dialeroutboundsettingsconfigchangeautomatictimezonemappingsettings

func (*Dialeroutboundsettingsconfigchangeautomatictimezonemappingsettings) String ¶

String returns a JSON representation of the model

type Dialeroutboundsettingsconfigchangecallablewindow ¶

type Dialeroutboundsettingsconfigchangecallablewindow struct {
	// Mapped
	Mapped *Dialeroutboundsettingsconfigchangeatzmtimeslot `json:"mapped,omitempty"`

	// Unmapped
	Unmapped *Dialeroutboundsettingsconfigchangeatzmtimeslotwithtimezone `json:"unmapped,omitempty"`
}

Dialeroutboundsettingsconfigchangecallablewindow

func (*Dialeroutboundsettingsconfigchangecallablewindow) String ¶

String returns a JSON representation of the model

type Dialeroutboundsettingsconfigchangeoutboundsettings ¶

type Dialeroutboundsettingsconfigchangeoutboundsettings 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"`

	// Version
	Version *int `json:"version,omitempty"`

	// MaxCallsPerAgent
	MaxCallsPerAgent *int `json:"maxCallsPerAgent,omitempty"`

	// MaxLineUtilization
	MaxLineUtilization *float32 `json:"maxLineUtilization,omitempty"`

	// AbandonSeconds
	AbandonSeconds *float32 `json:"abandonSeconds,omitempty"`

	// ComplianceAbandonRateDenominator
	ComplianceAbandonRateDenominator *string `json:"complianceAbandonRateDenominator,omitempty"`

	// AutomaticTimeZoneMapping
	AutomaticTimeZoneMapping *Dialeroutboundsettingsconfigchangeautomatictimezonemappingsettings `json:"automaticTimeZoneMapping,omitempty"`
}

Dialeroutboundsettingsconfigchangeoutboundsettings

func (*Dialeroutboundsettingsconfigchangeoutboundsettings) String ¶

String returns a JSON representation of the model

type Dialerpreview ¶

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

	// ContactId - The contact associated with this preview data pop
	ContactId *string `json:"contactId,omitempty"`

	// ContactListId - The contactList associated with this preview data pop.
	ContactListId *string `json:"contactListId,omitempty"`

	// CampaignId - The campaignId associated with this preview data pop.
	CampaignId *string `json:"campaignId,omitempty"`

	// PhoneNumberColumns - The phone number columns associated with this campaign
	PhoneNumberColumns *[]Phonenumbercolumn `json:"phoneNumberColumns,omitempty"`
}

Dialerpreview

func (*Dialerpreview) String ¶

func (o *Dialerpreview) String() string

String returns a JSON representation of the model

type Dialerresponsesetconfigchangereaction ¶

type Dialerresponsesetconfigchangereaction struct {
	// Data
	Data *string `json:"data,omitempty"`

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

	// ReactionType
	ReactionType *string `json:"reactionType,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialerresponsesetconfigchangereaction

func (*Dialerresponsesetconfigchangereaction) String ¶

String returns a JSON representation of the model

type Dialerresponsesetconfigchangeresponseset ¶

type Dialerresponsesetconfigchangeresponseset 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"`

	// Version
	Version *int `json:"version,omitempty"`

	// Responses
	Responses *map[string]Dialerresponsesetconfigchangereaction `json:"responses,omitempty"`

	// BeepDetectionEnabled
	BeepDetectionEnabled *bool `json:"beepDetectionEnabled,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialerresponsesetconfigchangeresponseset

func (*Dialerresponsesetconfigchangeresponseset) String ¶

String returns a JSON representation of the model

type Dialerrule ¶

type Dialerrule struct {
	// Id - The identifier of the rule.
	Id *string `json:"id,omitempty"`

	// Name - The name of the rule.
	Name *string `json:"name,omitempty"`

	// Order - The ranked order of the rule. Rules are processed from lowest number to highest.
	Order *int `json:"order,omitempty"`

	// Category - The category of the rule.
	Category *string `json:"category,omitempty"`

	// Conditions - A list of Conditions. All of the Conditions must evaluate to true to trigger the actions.
	Conditions *[]Condition `json:"conditions,omitempty"`

	// Actions - The list of actions to be taken if the conditions are true.
	Actions *[]Dialeraction `json:"actions,omitempty"`
}

Dialerrule

func (*Dialerrule) String ¶

func (o *Dialerrule) String() string

String returns a JSON representation of the model

type Dialerrulesetconfigchangeaction ¶

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

	// ActionTypeName
	ActionTypeName *string `json:"actionTypeName,omitempty"`

	// UpdateOption
	UpdateOption *string `json:"updateOption,omitempty"`

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

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialerrulesetconfigchangeaction

func (*Dialerrulesetconfigchangeaction) String ¶

String returns a JSON representation of the model

type Dialerrulesetconfigchangecondition ¶

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

	// Inverted
	Inverted *bool `json:"inverted,omitempty"`

	// AttributeName
	AttributeName *string `json:"attributeName,omitempty"`

	// Value
	Value *string `json:"value,omitempty"`

	// ValueType
	ValueType *string `json:"valueType,omitempty"`

	// Operator
	Operator *string `json:"operator,omitempty"`

	// Codes
	Codes *[]string `json:"codes,omitempty"`

	// PropertyType
	PropertyType *string `json:"propertyType,omitempty"`

	// Property
	Property *string `json:"property,omitempty"`

	// DataNotFoundResolution
	DataNotFoundResolution *bool `json:"dataNotFoundResolution,omitempty"`

	// ContactIdField
	ContactIdField *string `json:"contactIdField,omitempty"`

	// CallAnalysisResultField
	CallAnalysisResultField *string `json:"callAnalysisResultField,omitempty"`

	// AgentWrapupField
	AgentWrapupField *string `json:"agentWrapupField,omitempty"`

	// ContactColumnToDataActionFieldMappings
	ContactColumnToDataActionFieldMappings *[]Dialerrulesetconfigchangecontactcolumntodataactionfieldmapping `json:"contactColumnToDataActionFieldMappings,omitempty"`

	// Predicates
	Predicates *[]Dialerrulesetconfigchangedataactionconditionpredicate `json:"predicates,omitempty"`

	// DataAction
	DataAction *Dialerrulesetconfigchangeurireference `json:"dataAction,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialerrulesetconfigchangecondition

func (*Dialerrulesetconfigchangecondition) String ¶

String returns a JSON representation of the model

type Dialerrulesetconfigchangecontactcolumntodataactionfieldmapping ¶

type Dialerrulesetconfigchangecontactcolumntodataactionfieldmapping struct {
	// ContactColumnName
	ContactColumnName *string `json:"contactColumnName,omitempty"`

	// DataActionField
	DataActionField *string `json:"dataActionField,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialerrulesetconfigchangecontactcolumntodataactionfieldmapping

func (*Dialerrulesetconfigchangecontactcolumntodataactionfieldmapping) String ¶

String returns a JSON representation of the model

type Dialerrulesetconfigchangedataactionconditionpredicate ¶

type Dialerrulesetconfigchangedataactionconditionpredicate struct {
	// OutputField
	OutputField *string `json:"outputField,omitempty"`

	// OutputOperator
	OutputOperator *string `json:"outputOperator,omitempty"`

	// ComparisonValue
	ComparisonValue *string `json:"comparisonValue,omitempty"`

	// OutputFieldMissingResolution
	OutputFieldMissingResolution *bool `json:"outputFieldMissingResolution,omitempty"`

	// Inverted
	Inverted *bool `json:"inverted,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialerrulesetconfigchangedataactionconditionpredicate

func (*Dialerrulesetconfigchangedataactionconditionpredicate) String ¶

String returns a JSON representation of the model

type Dialerrulesetconfigchangerule ¶

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

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

	// Order
	Order *int `json:"order,omitempty"`

	// Category
	Category *string `json:"category,omitempty"`

	// Actions
	Actions *[]Dialerrulesetconfigchangeaction `json:"actions,omitempty"`

	// Conditions
	Conditions *[]Dialerrulesetconfigchangecondition `json:"conditions,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialerrulesetconfigchangerule

func (*Dialerrulesetconfigchangerule) String ¶

String returns a JSON representation of the model

type Dialerrulesetconfigchangeruleset ¶

type Dialerrulesetconfigchangeruleset 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"`

	// Version
	Version *int `json:"version,omitempty"`

	// ContactList
	ContactList *Dialerrulesetconfigchangeurireference `json:"contactList,omitempty"`

	// Queue
	Queue *Dialerrulesetconfigchangeurireference `json:"queue,omitempty"`

	// Rules
	Rules *[]Dialerrulesetconfigchangerule `json:"rules,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialerrulesetconfigchangeruleset

func (*Dialerrulesetconfigchangeruleset) String ¶

String returns a JSON representation of the model

type Dialerrulesetconfigchangeurireference ¶

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

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

Dialerrulesetconfigchangeurireference

func (*Dialerrulesetconfigchangeurireference) String ¶

String returns a JSON representation of the model

type Dialersequenceconfigchangecampaignsequence ¶

type Dialersequenceconfigchangecampaignsequence 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"`

	// Version
	Version *int `json:"version,omitempty"`

	// Campaigns
	Campaigns *[]Dialersequenceconfigchangeurireference `json:"campaigns,omitempty"`

	// CurrentCampaign
	CurrentCampaign *int `json:"currentCampaign,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`

	// StopMessage
	StopMessage *string `json:"stopMessage,omitempty"`

	// Repeat
	Repeat *bool `json:"repeat,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialersequenceconfigchangecampaignsequence

func (*Dialersequenceconfigchangecampaignsequence) String ¶

String returns a JSON representation of the model

type Dialersequenceconfigchangeurireference ¶

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

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

Dialersequenceconfigchangeurireference

func (*Dialersequenceconfigchangeurireference) String ¶

String returns a JSON representation of the model

type Dialersequencescheduleconfigchangescheduleinterval ¶

type Dialersequencescheduleconfigchangescheduleinterval struct {
	// Start
	Start *string `json:"start,omitempty"`

	// End
	End *string `json:"end,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialersequencescheduleconfigchangescheduleinterval

func (*Dialersequencescheduleconfigchangescheduleinterval) String ¶

String returns a JSON representation of the model

type Dialersequencescheduleconfigchangesequenceschedule ¶

type Dialersequencescheduleconfigchangesequenceschedule 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"`

	// Version
	Version *int `json:"version,omitempty"`

	// Intervals
	Intervals *[]Dialersequencescheduleconfigchangescheduleinterval `json:"intervals,omitempty"`

	// TimeZone
	TimeZone *string `json:"timeZone,omitempty"`

	// Sequence
	Sequence *Dialersequencescheduleconfigchangeurireference `json:"sequence,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dialersequencescheduleconfigchangesequenceschedule

func (*Dialersequencescheduleconfigchangesequenceschedule) String ¶

String returns a JSON representation of the model

type Dialersequencescheduleconfigchangeurireference ¶

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

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

Dialersequencescheduleconfigchangeurireference

func (*Dialersequencescheduleconfigchangeurireference) String ¶

String returns a JSON representation of the model

type Dialerwrapupcodemappingconfigchangewrapupcodemapping ¶

type Dialerwrapupcodemappingconfigchangewrapupcodemapping 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"`

	// Version
	Version *int `json:"version,omitempty"`

	// DefaultSet
	DefaultSet *[]string `json:"defaultSet,omitempty"`

	// Mapping
	Mapping *map[string][]string `json:"mapping,omitempty"`
}

Dialerwrapupcodemappingconfigchangewrapupcodemapping

func (*Dialerwrapupcodemappingconfigchangewrapupcodemapping) String ¶

String returns a JSON representation of the model

type Dialogflowagent ¶

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

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

	// Project - The project this Dialogflow agent belongs to
	Project *Dialogflowproject `json:"project,omitempty"`

	// Languages - The supported languages of the Dialogflow agent
	Languages *[]string `json:"languages,omitempty"`

	// Intents - An array of Intents associated with this agent
	Intents *[]Dialogflowintent `json:"intents,omitempty"`

	// Environments - Available environments for this agent
	Environments *[]string `json:"environments,omitempty"`

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

Dialogflowagent

func (*Dialogflowagent) String ¶

func (o *Dialogflowagent) String() string

String returns a JSON representation of the model

type Dialogflowagentsummary ¶

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

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

	// Project - The project this Dialogflow agent belongs to
	Project *Dialogflowproject `json:"project,omitempty"`

	// Description - A description of the Dialogflow agent
	Description *string `json:"description,omitempty"`

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

Dialogflowagentsummary

func (*Dialogflowagentsummary) String ¶

func (o *Dialogflowagentsummary) String() string

String returns a JSON representation of the model

type Dialogflowagentsummaryentitylisting ¶

type Dialogflowagentsummaryentitylisting struct {
	// Entities
	Entities *[]Dialogflowagentsummary `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"`

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

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

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

Dialogflowagentsummaryentitylisting

func (*Dialogflowagentsummaryentitylisting) String ¶

String returns a JSON representation of the model

type Dialogflowintent ¶

type Dialogflowintent struct {
	// Name - The intent name
	Name *string `json:"name,omitempty"`

	// Parameters - An object mapping parameter names to Parameter objects
	Parameters *map[string]Dialogflowparameter `json:"parameters,omitempty"`
}

Dialogflowintent

func (*Dialogflowintent) String ¶

func (o *Dialogflowintent) String() string

String returns a JSON representation of the model

type Dialogflowparameter ¶

type Dialogflowparameter struct {
	// Name - The parameter name
	Name *string `json:"name,omitempty"`

	// VarType - The parameter type
	VarType *string `json:"type,omitempty"`
}

Dialogflowparameter

func (*Dialogflowparameter) String ¶

func (o *Dialogflowparameter) String() string

String returns a JSON representation of the model

type Dialogflowproject ¶

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

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

Dialogflowproject

func (*Dialogflowproject) String ¶

func (o *Dialogflowproject) String() string

String returns a JSON representation of the model

type Did ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// PhoneNumber
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// DidPool
	DidPool *Domainentityref `json:"didPool,omitempty"`

	// Owner - A Uri reference to the owner of this DID, which is either a User or an IVR
	Owner *Domainentityref `json:"owner,omitempty"`

	// OwnerType
	OwnerType *string `json:"ownerType,omitempty"`

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

Did

func (*Did) String ¶

func (o *Did) String() string

String returns a JSON representation of the model

type Didentitylisting ¶

type Didentitylisting struct {
	// Entities
	Entities *[]Did `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"`

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

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

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

Didentitylisting

func (*Didentitylisting) String ¶

func (o *Didentitylisting) String() string

String returns a JSON representation of the model

type Didnumber ¶

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

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

	// Number - The number of the DID formatted as E164.
	Number *string `json:"number,omitempty"`

	// Assigned - True if this DID is assigned to an entity.  False otherwise.
	Assigned *bool `json:"assigned,omitempty"`

	// DidPool - A Uri reference to the DID Pool this DID is a part of.
	DidPool *Addressableentityref `json:"didPool,omitempty"`

	// Owner - A Uri reference to the owner of this DID.  The owner's type can be found in ownerType.  If the DID is unassigned, this will be NULL.
	Owner *Domainentityref `json:"owner,omitempty"`

	// OwnerType - The type of the entity that owns this DID.  If the DID is unassigned, this will be NULL.
	OwnerType *string `json:"ownerType,omitempty"`

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

Didnumber - Represents an unassigned or assigned DID in a DID Pool.

func (*Didnumber) String ¶

func (o *Didnumber) String() string

String returns a JSON representation of the model

type Didnumberentitylisting ¶

type Didnumberentitylisting struct {
	// Entities
	Entities *[]Didnumber `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"`

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

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

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

Didnumberentitylisting

func (*Didnumberentitylisting) String ¶

func (o *Didnumberentitylisting) String() string

String returns a JSON representation of the model

type Didpool ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// StartPhoneNumber - The starting phone number for the range of this DID pool. Must be in E.164 format
	StartPhoneNumber *string `json:"startPhoneNumber,omitempty"`

	// EndPhoneNumber - The ending phone number for the range of this DID pool. Must be in E.164 format
	EndPhoneNumber *string `json:"endPhoneNumber,omitempty"`

	// Comments
	Comments *string `json:"comments,omitempty"`

	// Provider - The provider for this DID pool
	Provider *string `json:"provider,omitempty"`

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

Didpool

func (*Didpool) String ¶

func (o *Didpool) String() string

String returns a JSON representation of the model

type Didpoolentitylisting ¶

type Didpoolentitylisting struct {
	// Entities
	Entities *[]Didpool `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"`

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

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

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

Didpoolentitylisting

func (*Didpoolentitylisting) String ¶

func (o *Didpoolentitylisting) String() string

String returns a JSON representation of the model

type Digitlength ¶

type Digitlength struct {
	// Start
	Start *string `json:"start,omitempty"`

	// End
	End *string `json:"end,omitempty"`
}

Digitlength

func (*Digitlength) String ¶

func (o *Digitlength) String() string

String returns a JSON representation of the model

type Digits ¶

type Digits struct {
	// Digits - A string representing the digits pressed on phone.
	Digits *string `json:"digits,omitempty"`
}

Digits

func (*Digits) String ¶

func (o *Digits) String() string

String returns a JSON representation of the model

type Directoryuserdeviceslisting ¶

type Directoryuserdeviceslisting struct {
	// Entities
	Entities *[]Userdevice `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"`

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

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

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

Directoryuserdeviceslisting

func (*Directoryuserdeviceslisting) String ¶

func (o *Directoryuserdeviceslisting) String() string

String returns a JSON representation of the model

type Disallowedentitylearningassignmentitem ¶

type Disallowedentitylearningassignmentitem struct {
	// ErrorCode - The error code associated with this disallowed entity
	ErrorCode *string `json:"errorCode,omitempty"`

	// Entity - The entity that was disallowed
	Entity *Learningassignmentitem `json:"entity,omitempty"`
}

Disallowedentitylearningassignmentitem

func (*Disallowedentitylearningassignmentitem) String ¶

String returns a JSON representation of the model

type Disallowedentitylearningassignmentreference ¶

type Disallowedentitylearningassignmentreference struct {
	// ErrorCode - The error code associated with this disallowed entity
	ErrorCode *string `json:"errorCode,omitempty"`

	// Entity - The entity that was disallowed
	Entity *Learningassignmentreference `json:"entity,omitempty"`
}

Disallowedentitylearningassignmentreference

func (*Disallowedentitylearningassignmentreference) String ¶

String returns a JSON representation of the model

type Disconnectreason ¶

type Disconnectreason struct {
	// VarType - Disconnect reason protocol type.
	VarType *string `json:"type,omitempty"`

	// Code - Protocol specific reason code. See the Q.850 and SIP specs.
	Code *int `json:"code,omitempty"`

	// Phrase - Human readable English description of the disconnect reason.
	Phrase *string `json:"phrase,omitempty"`
}

Disconnectreason

func (*Disconnectreason) String ¶

func (o *Disconnectreason) String() string

String returns a JSON representation of the model

type Division ¶

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

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

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

Division

func (*Division) String ¶

func (o *Division) String() string

String returns a JSON representation of the model

type Divisionreference ¶

type Divisionreference 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"`
}

Divisionreference

func (*Divisionreference) String ¶

func (o *Divisionreference) String() string

String returns a JSON representation of the model

type Divspermittedentitylisting ¶

type Divspermittedentitylisting 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"`

	// AllDivsPermitted
	AllDivsPermitted *bool `json:"allDivsPermitted,omitempty"`

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

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

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

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

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

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

Divspermittedentitylisting

func (*Divspermittedentitylisting) String ¶

func (o *Divspermittedentitylisting) String() string

String returns a JSON representation of the model

type Dnclist ¶

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

	// Name - The name of the DncList.
	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"`

	// ImportStatus - The status of the import process
	ImportStatus *Importstatus `json:"importStatus,omitempty"`

	// Size - The total number of phone numbers in the DncList.
	Size *int `json:"size,omitempty"`

	// DncSourceType - The type of the DncList.
	DncSourceType *string `json:"dncSourceType,omitempty"`

	// LoginId - A dnc.com loginId. Required if the dncSourceType is dnc.com.
	LoginId *string `json:"loginId,omitempty"`

	// DncCodes - The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com.
	DncCodes *[]string `json:"dncCodes,omitempty"`

	// LicenseId - A gryphon license number. Required if the dncSourceType is gryphon.
	LicenseId *string `json:"licenseId,omitempty"`

	// Division - The division this DncList belongs to.
	Division *Domainentityref `json:"division,omitempty"`

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

Dnclist

func (*Dnclist) String ¶

func (o *Dnclist) String() string

String returns a JSON representation of the model

type Dnclistcreate ¶

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

	// Name - The name of the DncList.
	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"`

	// ImportStatus - The status of the import process
	ImportStatus *Importstatus `json:"importStatus,omitempty"`

	// Size - The total number of phone numbers in the DncList.
	Size *int `json:"size,omitempty"`

	// DncSourceType - The type of the DncList.
	DncSourceType *string `json:"dncSourceType,omitempty"`

	// LoginId - A dnc.com loginId. Required if the dncSourceType is dnc.com.
	LoginId *string `json:"loginId,omitempty"`

	// DncCodes - The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com.
	DncCodes *[]string `json:"dncCodes,omitempty"`

	// LicenseId - A gryphon license number. Required if the dncSourceType is gryphon.
	LicenseId *string `json:"licenseId,omitempty"`

	// Division - The division this DncList belongs to.
	Division *Domainentityref `json:"division,omitempty"`

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

Dnclistcreate

func (*Dnclistcreate) String ¶

func (o *Dnclistcreate) String() string

String returns a JSON representation of the model

type Dnclistdivisionview ¶

type Dnclistdivisionview 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"`

	// ImportStatus - The status of the import process.
	ImportStatus *Importstatus `json:"importStatus,omitempty"`

	// Size - The number of contacts in the DncList.
	Size *int `json:"size,omitempty"`

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

Dnclistdivisionview

func (*Dnclistdivisionview) String ¶

func (o *Dnclistdivisionview) String() string

String returns a JSON representation of the model

type Dnclistdivisionviewlisting ¶

type Dnclistdivisionviewlisting struct {
	// Entities
	Entities *[]Dnclistdivisionview `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"`

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

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

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

Dnclistdivisionviewlisting

func (*Dnclistdivisionviewlisting) String ¶

func (o *Dnclistdivisionviewlisting) String() string

String returns a JSON representation of the model

type Dnclistdownloadreadyexporturi ¶

type Dnclistdownloadreadyexporturi struct {
	// Uri
	Uri *string `json:"uri,omitempty"`

	// ExportTimestamp
	ExportTimestamp *string `json:"exportTimestamp,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Dnclistdownloadreadyexporturi

func (*Dnclistdownloadreadyexporturi) String ¶

String returns a JSON representation of the model

type Dnclistentitylisting ¶

type Dnclistentitylisting struct {
	// Entities
	Entities *[]Dnclist `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"`

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

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

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

Dnclistentitylisting

func (*Dnclistentitylisting) String ¶

func (o *Dnclistentitylisting) String() string

String returns a JSON representation of the model

type Dnclistimportstatusimportstatus ¶

type Dnclistimportstatusimportstatus 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 *interface{} `json:"additionalProperties,omitempty"`
}

Dnclistimportstatusimportstatus

func (*Dnclistimportstatusimportstatus) String ¶

String returns a JSON representation of the model

type Document ¶

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

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

	// ChangeNumber
	ChangeNumber *int `json:"changeNumber,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"`

	// 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"`

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

	// ContentUri
	ContentUri *string `json:"contentUri,omitempty"`

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

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

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

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

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

	// SystemType
	SystemType *string `json:"systemType,omitempty"`

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

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

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

	// CallerAddress
	CallerAddress *string `json:"callerAddress,omitempty"`

	// ReceiverAddress
	ReceiverAddress *string `json:"receiverAddress,omitempty"`

	// Tags
	Tags *[]string `json:"tags,omitempty"`

	// TagValues
	TagValues *[]Tagvalue `json:"tagValues,omitempty"`

	// Attributes
	Attributes *[]Documentattribute `json:"attributes,omitempty"`

	// Thumbnails
	Thumbnails *[]Documentthumbnail `json:"thumbnails,omitempty"`

	// UploadStatus
	UploadStatus *Domainentityref `json:"uploadStatus,omitempty"`

	// UploadDestinationUri
	UploadDestinationUri *string `json:"uploadDestinationUri,omitempty"`

	// UploadMethod
	UploadMethod *string `json:"uploadMethod,omitempty"`

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

	// Acl - A list of permitted action rights for the user making the request
	Acl *[]string `json:"acl,omitempty"`

	// SharingStatus
	SharingStatus *string `json:"sharingStatus,omitempty"`

	// SharingUri
	SharingUri *string `json:"sharingUri,omitempty"`

	// DownloadSharingUri
	DownloadSharingUri *string `json:"downloadSharingUri,omitempty"`

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

Document

func (*Document) String ¶

func (o *Document) String() string

String returns a JSON representation of the model

type Documentarticle ¶

type Documentarticle struct {
	// Title - The title of the Article.
	Title *string `json:"title,omitempty"`

	// Content - The content of the Article.
	Content *Articlecontent `json:"content,omitempty"`

	// Alternatives - List of Alternative questions related to the title which helps in improving the likelihood of a match to user query.
	Alternatives *[]string `json:"alternatives,omitempty"`
}

Documentarticle

func (*Documentarticle) String ¶

func (o *Documentarticle) String() string

String returns a JSON representation of the model

type Documentationresult ¶

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

	// Categories - The category of the documentation entity. Will be returned in responses for certain entities.
	Categories *[]int `json:"categories,omitempty"`

	// Description - The description of the documentation entity. Will be returned in responses for certain entities.
	Description *string `json:"description,omitempty"`

	// Content - The text or html content for the documentation entity. Will be returned in responses for certain entities.
	Content *string `json:"content,omitempty"`

	// Excerpt - The excerpt of the documentation entity. Will be returned in responses for certain entities.
	Excerpt *string `json:"excerpt,omitempty"`

	// Link - URL link for the documentation entity. Will be returned in responses for certain entities.
	Link *string `json:"link,omitempty"`

	// Modified - The modified date for the documentation entity. Will be returned in responses for certain entities. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Modified *time.Time `json:"modified,omitempty"`

	// Name - The name of the documentation entity. Will be returned in responses for certain entities.
	Name *string `json:"name,omitempty"`

	// Service - The service of the documentation entity. Will be returned in responses for certain entities.
	Service *[]int `json:"service,omitempty"`

	// Slug - The slug of the documentation entity. Will be returned in responses for certain entities.
	Slug *string `json:"slug,omitempty"`

	// Title - The title of the documentation entity. Will be returned in responses for certain entities.
	Title *string `json:"title,omitempty"`

	// GetType - The search type. Will be returned in responses for certain entities.
	GetType *string `json:"get_type,omitempty"`

	// FacetFeature - The facet feature of the documentation entity. Will be returned in responses for certain entities.
	FacetFeature *[]int `json:"facet_feature,omitempty"`

	// FacetRole - The facet role of the documentation entity. Will be returned in responses for certain entities.
	FacetRole *[]int `json:"facet_role,omitempty"`

	// FacetService - The facet service of the documentation entity. Will be returned in responses for certain entities.
	FacetService *[]int `json:"facet_service,omitempty"`

	// FaqCategories - The faq categories of the documentation entity. Will be returned in responses for certain entities.
	FaqCategories *[]int `json:"faq_categories,omitempty"`

	// ReleasenoteCategory - The releasenote category of the documentation entity. Will be returned in responses for certain entities.
	ReleasenoteCategory *[]int `json:"releasenote_category,omitempty"`

	// ReleasenoteTag - The releasenote tag of the documentation entity. Will be returned in responses for certain entities.
	ReleasenoteTag *[]int `json:"releasenote_tag,omitempty"`

	// ServiceArea - The service area of the documentation entity. Will be returned in responses for certain entities.
	ServiceArea *[]int `json:"service-area,omitempty"`

	// VideoCategories - The video categories of the documentation entity. Will be returned in responses for certain entities.
	VideoCategories *[]int `json:"video_categories,omitempty"`
}

Documentationresult

func (*Documentationresult) String ¶

func (o *Documentationresult) String() string

String returns a JSON representation of the model

type Documentationsearchcriteria ¶

type Documentationsearchcriteria struct {
	// EndValue - The end value of the range. This field is used for range search types.
	EndValue *string `json:"endValue,omitempty"`

	// Values - A list of values for the search to match against
	Values *[]string `json:"values,omitempty"`

	// StartValue - The start value of the range. This field is used for range search types.
	StartValue *string `json:"startValue,omitempty"`

	// Fields - Field names to search against
	Fields *[]string `json:"fields,omitempty"`

	// Value - A value for the search to match against
	Value *string `json:"value,omitempty"`

	// Operator - How to apply this search criteria against other criteria
	Operator *string `json:"operator,omitempty"`

	// Group - Groups multiple conditions
	Group *[]Documentationsearchcriteria `json:"group,omitempty"`

	// DateFormat - Set date format for criteria values when using date range search type.  Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX.
	DateFormat *string `json:"dateFormat,omitempty"`

	// VarType - Search Type
	VarType *string `json:"type,omitempty"`
}

Documentationsearchcriteria

func (*Documentationsearchcriteria) String ¶

func (o *Documentationsearchcriteria) String() string

String returns a JSON representation of the model

type Documentationsearchrequest ¶

type Documentationsearchrequest struct {
	// SortOrder - The sort order for results
	SortOrder *string `json:"sortOrder,omitempty"`

	// SortBy - The field in the resource that you want to sort the results by
	SortBy *string `json:"sortBy,omitempty"`

	// PageSize - The number of results per page
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The page of resources you want to retrieve
	PageNumber *int `json:"pageNumber,omitempty"`

	// Sort - Multi-value sort order, list of multiple sort values
	Sort *[]Searchsort `json:"sort,omitempty"`

	// Query
	Query *[]Documentationsearchcriteria `json:"query,omitempty"`
}

Documentationsearchrequest

func (*Documentationsearchrequest) String ¶

func (o *Documentationsearchrequest) String() string

String returns a JSON representation of the model

type Documentationsearchresponse ¶

type Documentationsearchresponse struct {
	// Total - The total number of results found
	Total *int `json:"total,omitempty"`

	// PageCount - The total number of pages
	PageCount *int `json:"pageCount,omitempty"`

	// PageSize - The current page size
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The current page number
	PageNumber *int `json:"pageNumber,omitempty"`

	// PreviousPage - Q64 value for the previous page of results
	PreviousPage *string `json:"previousPage,omitempty"`

	// CurrentPage - Q64 value for the current page of results
	CurrentPage *string `json:"currentPage,omitempty"`

	// NextPage - Q64 value for the next page of results
	NextPage *string `json:"nextPage,omitempty"`

	// Types - Resource types the search was performed against
	Types *[]string `json:"types,omitempty"`

	// Results - Search results
	Results *[]Documentationresult `json:"results,omitempty"`
}

Documentationsearchresponse

func (*Documentationsearchresponse) String ¶

func (o *Documentationsearchresponse) String() string

String returns a JSON representation of the model

type Documentattribute ¶

type Documentattribute struct {
	// Attribute
	Attribute *Attribute `json:"attribute,omitempty"`

	// Values
	Values *[]string `json:"values,omitempty"`
}

Documentattribute

func (*Documentattribute) String ¶

func (o *Documentattribute) String() string

String returns a JSON representation of the model

type Documentaudit ¶

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

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

	// User
	User *Domainentityref `json:"user,omitempty"`

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

	// TransactionId
	TransactionId *string `json:"transactionId,omitempty"`

	// TransactionInitiator
	TransactionInitiator *bool `json:"transactionInitiator,omitempty"`

	// Application
	Application *string `json:"application,omitempty"`

	// ServiceName
	ServiceName *string `json:"serviceName,omitempty"`

	// Level
	Level *string `json:"level,omitempty"`

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

	// Status
	Status *string `json:"status,omitempty"`

	// ActionContext
	ActionContext *string `json:"actionContext,omitempty"`

	// Action
	Action *string `json:"action,omitempty"`

	// Entity
	Entity *Auditentityreference `json:"entity,omitempty"`

	// Changes
	Changes *[]Auditchange `json:"changes,omitempty"`

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

Documentaudit

func (*Documentaudit) String ¶

func (o *Documentaudit) String() string

String returns a JSON representation of the model

type Documentauditentitylisting ¶

type Documentauditentitylisting struct {
	// Entities
	Entities *[]Documentaudit `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"`

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

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

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

Documentauditentitylisting

func (*Documentauditentitylisting) String ¶

func (o *Documentauditentitylisting) String() string

String returns a JSON representation of the model

type Documentcategoryinput ¶

type Documentcategoryinput struct {
	// Id - KnowledgeBase Category ID
	Id *string `json:"id,omitempty"`
}

Documentcategoryinput

func (*Documentcategoryinput) String ¶

func (o *Documentcategoryinput) String() string

String returns a JSON representation of the model

type Documententitylisting ¶

type Documententitylisting struct {
	// Entities
	Entities *[]Document `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"`

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

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

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

Documententitylisting

func (*Documententitylisting) String ¶

func (o *Documententitylisting) String() string

String returns a JSON representation of the model

type Documentfaq ¶

type Documentfaq struct {
	// Question - The question for this FAQ
	Question *string `json:"question,omitempty"`

	// Answer - The answer for this FAQ
	Answer *string `json:"answer,omitempty"`

	// Alternatives - List of Alternative questions related to the answer which helps in improving the likelihood of a match to user query
	Alternatives *[]string `json:"alternatives,omitempty"`
}

Documentfaq

func (*Documentfaq) String ¶

func (o *Documentfaq) String() string

String returns a JSON representation of the model

type Documentlisting ¶

type Documentlisting struct {
	// Entities
	Entities *[]Knowledgedocument `json:"entities,omitempty"`

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

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

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

Documentlisting

func (*Documentlisting) String ¶

func (o *Documentlisting) String() string

String returns a JSON representation of the model

type Documentreference ¶

type Documentreference 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"`
}

Documentreference

func (*Documentreference) String ¶

func (o *Documentreference) String() string

String returns a JSON representation of the model

type Documentthumbnail ¶

type Documentthumbnail struct {
	// Resolution
	Resolution *string `json:"resolution,omitempty"`

	// ImageUri
	ImageUri *string `json:"imageUri,omitempty"`

	// Height
	Height *int `json:"height,omitempty"`

	// Width
	Width *int `json:"width,omitempty"`
}

Documentthumbnail

func (*Documentthumbnail) String ¶

func (o *Documentthumbnail) String() string

String returns a JSON representation of the model

type Documentupdate ¶

type Documentupdate struct {
	// ChangeNumber
	ChangeNumber *int `json:"changeNumber,omitempty"`

	// Name - The name of the document
	Name *string `json:"name,omitempty"`

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

	// AddTags
	AddTags *[]string `json:"addTags,omitempty"`

	// RemoveTags
	RemoveTags *[]string `json:"removeTags,omitempty"`

	// AddTagIds
	AddTagIds *[]string `json:"addTagIds,omitempty"`

	// RemoveTagIds
	RemoveTagIds *[]string `json:"removeTagIds,omitempty"`

	// UpdateAttributes
	UpdateAttributes *[]Documentattribute `json:"updateAttributes,omitempty"`

	// RemoveAttributes
	RemoveAttributes *[]string `json:"removeAttributes,omitempty"`
}

Documentupdate

func (*Documentupdate) String ¶

func (o *Documentupdate) String() string

String returns a JSON representation of the model

type Documentupload ¶

type Documentupload struct {
	// Name - The name of the document
	Name *string `json:"name,omitempty"`

	// Workspace - The workspace the document will be uploaded to
	Workspace *Domainentityref `json:"workspace,omitempty"`

	// Tags
	Tags *[]string `json:"tags,omitempty"`

	// TagIds
	TagIds *[]string `json:"tagIds,omitempty"`
}

Documentupload

func (*Documentupload) String ¶

func (o *Documentupload) String() string

String returns a JSON representation of the model

type Domaincapabilities ¶

type Domaincapabilities struct {
	// Enabled - True if this address family on the interface is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// Dhcp - True if this address family on the interface is using DHCP.
	Dhcp *bool `json:"dhcp,omitempty"`

	// Metric - The metric being used for the address family on this interface. Lower values will have a higher priority. If autoMetric is true, this value will be the automatically calculated metric. To set this value be sure autoMetric is false. If no value is returned, metric configuration is not supported on this Edge.
	Metric *int `json:"metric,omitempty"`

	// AutoMetric - True if the metric is being calculated automatically for the address family on this interface.
	AutoMetric *bool `json:"autoMetric,omitempty"`

	// SupportsMetric - True if metric configuration is supported.
	SupportsMetric *bool `json:"supportsMetric,omitempty"`

	// PingEnabled - Set to true to enable this address family on this interface to respond to ping requests.
	PingEnabled *bool `json:"pingEnabled,omitempty"`
}

Domaincapabilities

func (*Domaincapabilities) String ¶

func (o *Domaincapabilities) String() string

String returns a JSON representation of the model

type Domaincertificateauthority ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// Certificate - The authorities signed X509 PEM encoded certificate.
	Certificate *string `json:"certificate,omitempty"`

	// VarType - The certificate authorities type.  Managed certificate authorities are generated and maintained by Interactive Intelligence.  These are read-only and not modifiable by clients.  Remote authorities are customer managed.
	VarType *string `json:"type,omitempty"`

	// Services - The service(s) that the authority can be used to authenticate.
	Services *[]string `json:"services,omitempty"`

	// CertificateDetails - The details of the parsed certificate(s).
	CertificateDetails *[]Certificatedetails `json:"certificateDetails,omitempty"`

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

Domaincertificateauthority - A certificate authority represents an organization that has issued a digital certificate for making secure connections with an edge device.

func (*Domaincertificateauthority) String ¶

func (o *Domaincertificateauthority) String() string

String returns a JSON representation of the model

type Domainedgesoftwareupdatedto ¶

type Domainedgesoftwareupdatedto struct {
	// Version - Version
	Version *Domainedgesoftwareversiondto `json:"version,omitempty"`

	// MaxDownloadRate
	MaxDownloadRate *int `json:"maxDownloadRate,omitempty"`

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

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

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

	// ExecuteOnIdle
	ExecuteOnIdle *bool `json:"executeOnIdle,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`

	// EdgeUri
	EdgeUri *string `json:"edgeUri,omitempty"`

	// CallDrainingWaitTimeSeconds
	CallDrainingWaitTimeSeconds *int `json:"callDrainingWaitTimeSeconds,omitempty"`

	// Current
	Current *bool `json:"current,omitempty"`
}

Domainedgesoftwareupdatedto

func (*Domainedgesoftwareupdatedto) String ¶

func (o *Domainedgesoftwareupdatedto) String() string

String returns a JSON representation of the model

type Domainedgesoftwareversiondto ¶

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

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

	// EdgeVersion
	EdgeVersion *string `json:"edgeVersion,omitempty"`

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

	// EdgeUri
	EdgeUri *string `json:"edgeUri,omitempty"`

	// LatestRelease
	LatestRelease *bool `json:"latestRelease,omitempty"`

	// Current
	Current *bool `json:"current,omitempty"`

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

Domainedgesoftwareversiondto

func (*Domainedgesoftwareversiondto) String ¶

String returns a JSON representation of the model

type Domainedgesoftwareversiondtoentitylisting ¶

type Domainedgesoftwareversiondtoentitylisting struct {
	// Entities
	Entities *[]Domainedgesoftwareversiondto `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"`

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

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

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

Domainedgesoftwareversiondtoentitylisting

func (*Domainedgesoftwareversiondtoentitylisting) String ¶

String returns a JSON representation of the model

type Domainentity ¶

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

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

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

Domainentity

func (*Domainentity) String ¶

func (o *Domainentity) String() string

String returns a JSON representation of the model

type Domainentitylisting ¶

type Domainentitylisting struct {
	// Entities
	Entities *[]Domainentity `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"`

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

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

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

Domainentitylisting

func (*Domainentitylisting) String ¶

func (o *Domainentitylisting) String() string

String returns a JSON representation of the model

type Domainentitylistingevaluationform ¶

type Domainentitylistingevaluationform struct {
	// Entities
	Entities *[]Evaluationform `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"`

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

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

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

Domainentitylistingevaluationform

func (*Domainentitylistingevaluationform) String ¶

String returns a JSON representation of the model

type Domainentitylistingqueryresult ¶

type Domainentitylistingqueryresult struct {
	// Entities
	Entities *[]Queryresult `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"`

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

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

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

Domainentitylistingqueryresult

func (*Domainentitylistingqueryresult) String ¶

String returns a JSON representation of the model

type Domainentitylistingsurveyform ¶

type Domainentitylistingsurveyform struct {
	// Entities
	Entities *[]Surveyform `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"`

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

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

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

Domainentitylistingsurveyform

func (*Domainentitylistingsurveyform) String ¶

String returns a JSON representation of the model

type Domainentityref ¶

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

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

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

Domainentityref

func (*Domainentityref) String ¶

func (o *Domainentityref) String() string

String returns a JSON representation of the model

type Domainlogicalinterface ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// EdgeUri
	EdgeUri *string `json:"edgeUri,omitempty"`

	// EdgeAssignedId
	EdgeAssignedId *string `json:"edgeAssignedId,omitempty"`

	// FriendlyName - Friendly Name
	FriendlyName *string `json:"friendlyName,omitempty"`

	// VlanTagId
	VlanTagId *int `json:"vlanTagId,omitempty"`

	// HardwareAddress - Hardware Address
	HardwareAddress *string `json:"hardwareAddress,omitempty"`

	// PhysicalAdapterId - Physical Adapter Id
	PhysicalAdapterId *string `json:"physicalAdapterId,omitempty"`

	// IfStatus
	IfStatus *string `json:"ifStatus,omitempty"`

	// InterfaceType - The type of this network interface.
	InterfaceType *string `json:"interfaceType,omitempty"`

	// PublicNatAddressIpV4 - IPv4 NENT IP Address
	PublicNatAddressIpV4 *string `json:"publicNatAddressIpV4,omitempty"`

	// PublicNatAddressIpV6 - IPv6 NENT IP Address
	PublicNatAddressIpV6 *string `json:"publicNatAddressIpV6,omitempty"`

	// Routes - The list of routes assigned to this interface.
	Routes *[]Domainnetworkroute `json:"routes,omitempty"`

	// Addresses - The list of IP addresses on this interface.  Priority of dns addresses are based on order in the list.
	Addresses *[]Domainnetworkaddress `json:"addresses,omitempty"`

	// Ipv4Capabilities - IPv4 interface settings.
	Ipv4Capabilities *Domaincapabilities `json:"ipv4Capabilities,omitempty"`

	// Ipv6Capabilities - IPv6 interface settings.
	Ipv6Capabilities *Domaincapabilities `json:"ipv6Capabilities,omitempty"`

	// CurrentState
	CurrentState *string `json:"currentState,omitempty"`

	// LastModifiedUserId
	LastModifiedUserId *string `json:"lastModifiedUserId,omitempty"`

	// LastModifiedCorrelationId
	LastModifiedCorrelationId *string `json:"lastModifiedCorrelationId,omitempty"`

	// CommandResponses
	CommandResponses *[]Domainnetworkcommandresponse `json:"commandResponses,omitempty"`

	// InheritPhoneTrunkBasesIPv4 - The IPv4 phone trunk base assignment will be inherited from the Edge Group.
	InheritPhoneTrunkBasesIPv4 *bool `json:"inheritPhoneTrunkBasesIPv4,omitempty"`

	// InheritPhoneTrunkBasesIPv6 - The IPv6 phone trunk base assignment will be inherited from the Edge Group.
	InheritPhoneTrunkBasesIPv6 *bool `json:"inheritPhoneTrunkBasesIPv6,omitempty"`

	// UseForInternalEdgeCommunication - This interface will be used for all internal edge-to-edge communication using settings from the edgeTrunkBaseAssignment on the Edge Group.
	UseForInternalEdgeCommunication *bool `json:"useForInternalEdgeCommunication,omitempty"`

	// UseForIndirectEdgeCommunication - Site Interconnects using the \"Indirect\" method will communicate using the Public IP Address specified on the interface. Use this option when a NAT enabled firewall is between the Edge and the far end.
	UseForIndirectEdgeCommunication *bool `json:"useForIndirectEdgeCommunication,omitempty"`

	// UseForCloudProxyEdgeCommunication - Site Interconnects using the \"Cloud Proxy\" method will broker the connection between them with a Cloud Proxy. This method is required for connections between one or more Sites using Cloud Media, but can optionally be used between two premises Sites if Direct or Indirect are not an option.
	UseForCloudProxyEdgeCommunication *bool `json:"useForCloudProxyEdgeCommunication,omitempty"`

	// UseForWanInterface - This interface will be used for all communication with the internet.
	UseForWanInterface *bool `json:"useForWanInterface,omitempty"`

	// ExternalTrunkBaseAssignments - External trunk base settings to use for external communication from this interface.
	ExternalTrunkBaseAssignments *[]Trunkbaseassignment `json:"externalTrunkBaseAssignments,omitempty"`

	// PhoneTrunkBaseAssignments - Phone trunk base settings to use for phone communication from this interface.  These settings will be ignored when \"inheritPhoneTrunkBases\" is true.
	PhoneTrunkBaseAssignments *[]Trunkbaseassignment `json:"phoneTrunkBaseAssignments,omitempty"`

	// TraceEnabled
	TraceEnabled *bool `json:"traceEnabled,omitempty"`

	// StartDate - 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 - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndDate *time.Time `json:"endDate,omitempty"`

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

Domainlogicalinterface

func (*Domainlogicalinterface) String ¶

func (o *Domainlogicalinterface) String() string

String returns a JSON representation of the model

type Domainnetworkaddress ¶

type Domainnetworkaddress struct {
	// VarType - The type of address.
	VarType *string `json:"type,omitempty"`

	// Address - An IPv4 or IPv6 IP address. When specifying an address of type \"ip\", use CIDR format for the subnet mask.
	Address *string `json:"address,omitempty"`

	// Persistent - True if this address will persist on Edge restart.  Addresses assigned by DHCP will be returned as false.
	Persistent *bool `json:"persistent,omitempty"`

	// Family - The address family for this address.
	Family *int `json:"family,omitempty"`
}

Domainnetworkaddress

func (*Domainnetworkaddress) String ¶

func (o *Domainnetworkaddress) String() string

String returns a JSON representation of the model

type Domainnetworkcommandresponse ¶

type Domainnetworkcommandresponse struct {
	// CorrelationId
	CorrelationId *string `json:"correlationId,omitempty"`

	// CommandName
	CommandName *string `json:"commandName,omitempty"`

	// Acknowledged
	Acknowledged *bool `json:"acknowledged,omitempty"`

	// ErrorInfo
	ErrorInfo **Errordetails `json:"errorInfo,omitempty"`
}

Domainnetworkcommandresponse

func (*Domainnetworkcommandresponse) String ¶

String returns a JSON representation of the model

type Domainnetworkroute ¶

type Domainnetworkroute struct {
	// Prefix - The IPv4 or IPv6 route prefix in CIDR notation.
	Prefix *string `json:"prefix,omitempty"`

	// Nexthop - The IPv4 or IPv6 nexthop IP address.
	Nexthop *string `json:"nexthop,omitempty"`

	// Persistent - True if this route will persist on Edge restart.  Routes assigned by DHCP will be returned as false.
	Persistent *bool `json:"persistent,omitempty"`

	// Metric - The metric being used for route. Lower values will have a higher priority.
	Metric *int `json:"metric,omitempty"`

	// Family - The address family for this route.
	Family *int `json:"family,omitempty"`
}

Domainnetworkroute

func (*Domainnetworkroute) String ¶

func (o *Domainnetworkroute) String() string

String returns a JSON representation of the model

type Domainorganizationproduct ¶

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

Domainorganizationproduct

func (*Domainorganizationproduct) String ¶

func (o *Domainorganizationproduct) String() string

String returns a JSON representation of the model

type Domainorganizationrole ¶

type Domainorganizationrole 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"`

	// DefaultRoleId
	DefaultRoleId *string `json:"defaultRoleId,omitempty"`

	// Permissions
	Permissions *[]string `json:"permissions,omitempty"`

	// UnusedPermissions - A collection of the permissions the role is not using
	UnusedPermissions *[]string `json:"unusedPermissions,omitempty"`

	// PermissionPolicies
	PermissionPolicies *[]Domainpermissionpolicy `json:"permissionPolicies,omitempty"`

	// UserCount
	UserCount *int `json:"userCount,omitempty"`

	// RoleNeedsUpdate - Optional unless patch operation.
	RoleNeedsUpdate *bool `json:"roleNeedsUpdate,omitempty"`

	// VarDefault
	VarDefault *bool `json:"default,omitempty"`

	// Base
	Base *bool `json:"base,omitempty"`

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

Domainorganizationrole

func (*Domainorganizationrole) String ¶

func (o *Domainorganizationrole) String() string

String returns a JSON representation of the model

type Domainorganizationrolecreate ¶

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

	// Name - The role name
	Name *string `json:"name,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// DefaultRoleId
	DefaultRoleId *string `json:"defaultRoleId,omitempty"`

	// Permissions
	Permissions *[]string `json:"permissions,omitempty"`

	// UnusedPermissions - A collection of the permissions the role is not using
	UnusedPermissions *[]string `json:"unusedPermissions,omitempty"`

	// PermissionPolicies
	PermissionPolicies *[]Domainpermissionpolicy `json:"permissionPolicies,omitempty"`

	// UserCount
	UserCount *int `json:"userCount,omitempty"`

	// RoleNeedsUpdate - Optional unless patch operation.
	RoleNeedsUpdate *bool `json:"roleNeedsUpdate,omitempty"`

	// VarDefault
	VarDefault *bool `json:"default,omitempty"`

	// Base
	Base *bool `json:"base,omitempty"`

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

Domainorganizationrolecreate

func (*Domainorganizationrolecreate) String ¶

String returns a JSON representation of the model

type Domainorganizationroleupdate ¶

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

	// Name - The name of the role
	Name *string `json:"name,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// DefaultRoleId
	DefaultRoleId *string `json:"defaultRoleId,omitempty"`

	// Permissions
	Permissions *[]string `json:"permissions,omitempty"`

	// UnusedPermissions - A collection of the permissions the role is not using
	UnusedPermissions *[]string `json:"unusedPermissions,omitempty"`

	// PermissionPolicies
	PermissionPolicies *[]Domainpermissionpolicy `json:"permissionPolicies,omitempty"`

	// UserCount
	UserCount *int `json:"userCount,omitempty"`

	// RoleNeedsUpdate - Optional unless patch operation.
	RoleNeedsUpdate *bool `json:"roleNeedsUpdate,omitempty"`

	// VarDefault
	VarDefault *bool `json:"default,omitempty"`

	// Base
	Base *bool `json:"base,omitempty"`

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

Domainorganizationroleupdate

func (*Domainorganizationroleupdate) String ¶

String returns a JSON representation of the model

type Domainorgroledifference ¶

type Domainorgroledifference struct {
	// RemovedPermissionPolicies
	RemovedPermissionPolicies *[]Domainpermissionpolicy `json:"removedPermissionPolicies,omitempty"`

	// AddedPermissionPolicies
	AddedPermissionPolicies *[]Domainpermissionpolicy `json:"addedPermissionPolicies,omitempty"`

	// SamePermissionPolicies
	SamePermissionPolicies *[]Domainpermissionpolicy `json:"samePermissionPolicies,omitempty"`

	// UserOrgRole
	UserOrgRole *Domainorganizationrole `json:"userOrgRole,omitempty"`

	// RoleFromDefault
	RoleFromDefault *Domainorganizationrole `json:"roleFromDefault,omitempty"`
}

Domainorgroledifference

func (*Domainorgroledifference) String ¶

func (o *Domainorgroledifference) String() string

String returns a JSON representation of the model

type Domainpermission ¶

type Domainpermission struct {
	// Domain
	Domain *string `json:"domain,omitempty"`

	// EntityType
	EntityType *string `json:"entityType,omitempty"`

	// Action
	Action *string `json:"action,omitempty"`

	// Label
	Label *string `json:"label,omitempty"`

	// AllowsConditions
	AllowsConditions *bool `json:"allowsConditions,omitempty"`

	// DivisionAware
	DivisionAware *bool `json:"divisionAware,omitempty"`
}

Domainpermission

func (*Domainpermission) String ¶

func (o *Domainpermission) String() string

String returns a JSON representation of the model

type Domainpermissioncollection ¶

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

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

	// Domain
	Domain *string `json:"domain,omitempty"`

	// PermissionMap
	PermissionMap *map[string][]Domainpermission `json:"permissionMap,omitempty"`

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

Domainpermissioncollection

func (*Domainpermissioncollection) String ¶

func (o *Domainpermissioncollection) String() string

String returns a JSON representation of the model

type Domainpermissionpolicy ¶

type Domainpermissionpolicy struct {
	// Domain
	Domain *string `json:"domain,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// PolicyName
	PolicyName *string `json:"policyName,omitempty"`

	// PolicyDescription
	PolicyDescription *string `json:"policyDescription,omitempty"`

	// ActionSet
	ActionSet *[]string `json:"actionSet,omitempty"`

	// NamedResources
	NamedResources *[]string `json:"namedResources,omitempty"`

	// AllowConditions
	AllowConditions *bool `json:"allowConditions,omitempty"`

	// ResourceConditionNode
	ResourceConditionNode *Domainresourceconditionnode `json:"resourceConditionNode,omitempty"`
}

Domainpermissionpolicy

func (*Domainpermissionpolicy) String ¶

func (o *Domainpermissionpolicy) String() string

String returns a JSON representation of the model

type Domainphysicalcapabilities ¶

type Domainphysicalcapabilities struct {
	// Vlan
	Vlan *bool `json:"vlan,omitempty"`

	// Team
	Team *bool `json:"team,omitempty"`
}

Domainphysicalcapabilities

func (*Domainphysicalcapabilities) String ¶

func (o *Domainphysicalcapabilities) String() string

String returns a JSON representation of the model

type Domainphysicalinterface ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// EdgeUri
	EdgeUri *string `json:"edgeUri,omitempty"`

	// FriendlyName
	FriendlyName *string `json:"friendlyName,omitempty"`

	// HardwareAddress
	HardwareAddress *string `json:"hardwareAddress,omitempty"`

	// PortLabel
	PortLabel *string `json:"portLabel,omitempty"`

	// PhysicalCapabilities
	PhysicalCapabilities *Domainphysicalcapabilities `json:"physicalCapabilities,omitempty"`

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

Domainphysicalinterface

func (*Domainphysicalinterface) String ¶

func (o *Domainphysicalinterface) String() string

String returns a JSON representation of the model

type Domainresourceconditionnode ¶

type Domainresourceconditionnode struct {
	// VariableName
	VariableName *string `json:"variableName,omitempty"`

	// Operator
	Operator *string `json:"operator,omitempty"`

	// Operands
	Operands *[]Domainresourceconditionvalue `json:"operands,omitempty"`

	// Conjunction
	Conjunction *string `json:"conjunction,omitempty"`

	// Terms
	Terms *[]Domainresourceconditionnode `json:"terms,omitempty"`
}

Domainresourceconditionnode

func (*Domainresourceconditionnode) String ¶

func (o *Domainresourceconditionnode) String() string

String returns a JSON representation of the model

type Domainresourceconditionvalue ¶

type Domainresourceconditionvalue struct {
	// User
	User *User `json:"user,omitempty"`

	// Queue
	Queue *Queue `json:"queue,omitempty"`

	// Value
	Value *string `json:"value,omitempty"`

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

Domainresourceconditionvalue

func (*Domainresourceconditionvalue) String ¶

String returns a JSON representation of the model

type Domainrole ¶

type Domainrole struct {
	// Id - The ID of the role
	Id *string `json:"id,omitempty"`

	// Name - The name of the role
	Name *string `json:"name,omitempty"`
}

Domainrole

func (*Domainrole) String ¶

func (o *Domainrole) String() string

String returns a JSON representation of the model

type Domainschemareference ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

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

Domainschemareference

func (*Domainschemareference) String ¶

func (o *Domainschemareference) String() string

String returns a JSON representation of the model

type Downloadresponse ¶

type Downloadresponse struct {
	// ContentLocationUri
	ContentLocationUri *string `json:"contentLocationUri,omitempty"`

	// ImageUri
	ImageUri *string `json:"imageUri,omitempty"`

	// Thumbnails
	Thumbnails *[]Documentthumbnail `json:"thumbnails,omitempty"`
}

Downloadresponse

func (*Downloadresponse) String ¶

func (o *Downloadresponse) String() string

String returns a JSON representation of the model

type Draftvalidationresult ¶

type Draftvalidationresult struct {
	// Valid - Indicates if configuration is valid
	Valid *bool `json:"valid,omitempty"`

	// Errors - List of errors causing validation failure
	Errors *[]Errorbody `json:"errors,omitempty"`
}

Draftvalidationresult - Validation results

func (*Draftvalidationresult) String ¶

func (o *Draftvalidationresult) String() string

String returns a JSON representation of the model

type Durationcondition ¶

type Durationcondition struct {
	// DurationTarget
	DurationTarget *string `json:"durationTarget,omitempty"`

	// DurationOperator
	DurationOperator *string `json:"durationOperator,omitempty"`

	// DurationRange
	DurationRange *string `json:"durationRange,omitempty"`
}

Durationcondition

func (*Durationcondition) String ¶

func (o *Durationcondition) String() string

String returns a JSON representation of the model

type Edge ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// Interfaces - The list of interfaces for the edge. (Deprecated) Replaced by configuring trunks/ip info on the logical interface instead
	Interfaces *[]Edgeinterface `json:"interfaces,omitempty"`

	// Make
	Make *string `json:"make,omitempty"`

	// Model
	Model *string `json:"model,omitempty"`

	// ApiVersion
	ApiVersion *string `json:"apiVersion,omitempty"`

	// SoftwareVersion
	SoftwareVersion *string `json:"softwareVersion,omitempty"`

	// SoftwareVersionTimestamp
	SoftwareVersionTimestamp *string `json:"softwareVersionTimestamp,omitempty"`

	// SoftwareVersionPlatform
	SoftwareVersionPlatform *string `json:"softwareVersionPlatform,omitempty"`

	// SoftwareVersionConfiguration
	SoftwareVersionConfiguration *string `json:"softwareVersionConfiguration,omitempty"`

	// FullSoftwareVersion
	FullSoftwareVersion *string `json:"fullSoftwareVersion,omitempty"`

	// PairingId - The pairing Id for a hardware Edge in the format: 00000-00000-00000-00000-00000. This field is only required when creating an Edge with a deployment type of HARDWARE.
	PairingId *string `json:"pairingId,omitempty"`

	// Fingerprint
	Fingerprint *string `json:"fingerprint,omitempty"`

	// FingerprintHint
	FingerprintHint *string `json:"fingerprintHint,omitempty"`

	// CurrentVersion
	CurrentVersion *string `json:"currentVersion,omitempty"`

	// StagedVersion
	StagedVersion *string `json:"stagedVersion,omitempty"`

	// Patch
	Patch *string `json:"patch,omitempty"`

	// StatusCode - The current status of the Edge.
	StatusCode *string `json:"statusCode,omitempty"`

	// EdgeGroup
	EdgeGroup *Edgegroup `json:"edgeGroup,omitempty"`

	// Site - The Site to which the Edge is assigned.
	Site *Site `json:"site,omitempty"`

	// SoftwareStatus - Details about an in-progress or recently in-progress Edge software upgrade. This node appears only if a software upgrade was recently initiated for this Edge.
	SoftwareStatus *Domainedgesoftwareupdatedto `json:"softwareStatus,omitempty"`

	// OnlineStatus
	OnlineStatus *string `json:"onlineStatus,omitempty"`

	// SerialNumber
	SerialNumber *string `json:"serialNumber,omitempty"`

	// PhysicalEdge
	PhysicalEdge *bool `json:"physicalEdge,omitempty"`

	// Managed
	Managed *bool `json:"managed,omitempty"`

	// EdgeDeploymentType
	EdgeDeploymentType *string `json:"edgeDeploymentType,omitempty"`

	// CallDrainingState - The current state of the Edge's call draining process before it can be safely rebooted or updated.
	CallDrainingState *string `json:"callDrainingState,omitempty"`

	// ConversationCount - The remaining number of conversations the Edge has to drain before it can be safely rebooted or updated. When an Edge is not draining conversations, this will be NULL or 0.
	ConversationCount *int `json:"conversationCount,omitempty"`

	// Proxy - Edge HTTP proxy configuration for the WAN port. The field can be a hostname, FQDN, IPv4 or IPv6 address. If port is not included, port 80 is assumed.
	Proxy *string `json:"proxy,omitempty"`

	// OfflineConfigCalled - True if the offline edge configuration endpoint has been called for this edge.
	OfflineConfigCalled *bool `json:"offlineConfigCalled,omitempty"`

	// OsName - The name provided by the operating system of the Edge.
	OsName *string `json:"osName,omitempty"`

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

Edge

func (*Edge) String ¶

func (o *Edge) String() string

String returns a JSON representation of the model

type Edgeautoupdateconfig ¶

type Edgeautoupdateconfig struct {
	// TimeZone - The timezone of the window in which any updates to the edges assigned to the site can be applied. The minimum size of the window is 2 hours.
	TimeZone *string `json:"timeZone,omitempty"`

	// Rrule - The recurrence rule for updating the Edges assigned to the site. The only supported frequencies are daily and weekly. Weekly frequencies require a day list with at least oneday specified. All other configurations are not supported.
	Rrule *string `json:"rrule,omitempty"`

	// Start - Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS
	Start *time.Time `json:"start,omitempty"`

	// End - Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS
	End *time.Time `json:"end,omitempty"`
}

Edgeautoupdateconfig

func (*Edgeautoupdateconfig) String ¶

func (o *Edgeautoupdateconfig) String() string

String returns a JSON representation of the model

type Edgechangetopicedge ¶

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

	// OnlineStatus
	OnlineStatus *string `json:"onlineStatus,omitempty"`
}

Edgechangetopicedge

func (*Edgechangetopicedge) String ¶

func (o *Edgechangetopicedge) String() string

String returns a JSON representation of the model

type Edgeconnectioninfo ¶

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

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

	// InterfaceName - Interface used for the connection on the edge
	InterfaceName *string `json:"interfaceName,omitempty"`

	// InterfaceIpAddress - IP address of the interface
	InterfaceIpAddress *string `json:"interfaceIpAddress,omitempty"`

	// ConnectionErrors - Connection errors
	ConnectionErrors *[]string `json:"connectionErrors,omitempty"`

	// Site
	Site *Addressableentityref `json:"site,omitempty"`

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

Edgeconnectioninfo

func (*Edgeconnectioninfo) String ¶

func (o *Edgeconnectioninfo) String() string

String returns a JSON representation of the model

type Edgeentitylisting ¶

type Edgeentitylisting struct {
	// Entities
	Entities *[]Edge `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"`

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

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

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

Edgeentitylisting

func (*Edgeentitylisting) String ¶

func (o *Edgeentitylisting) String() string

String returns a JSON representation of the model

type Edgegroup ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// Managed - Is this edge group being managed remotely.
	Managed *bool `json:"managed,omitempty"`

	// Hybrid - Is this edge group hybrid.
	Hybrid *bool `json:"hybrid,omitempty"`

	// EdgeTrunkBaseAssignment - A trunk base settings assignment of trunkType \"EDGE\" to use for edge-to-edge communication.
	EdgeTrunkBaseAssignment *Trunkbaseassignment `json:"edgeTrunkBaseAssignment,omitempty"`

	// PhoneTrunkBases - Trunk base settings of trunkType \"PHONE\" to inherit to edge logical interface for phone communication.
	PhoneTrunkBases *[]Trunkbase `json:"phoneTrunkBases,omitempty"`

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

Edgegroup

func (*Edgegroup) String ¶

func (o *Edgegroup) String() string

String returns a JSON representation of the model

type Edgegroupentitylisting ¶

type Edgegroupentitylisting struct {
	// Entities
	Entities *[]Edgegroup `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"`

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

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

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

Edgegroupentitylisting

func (*Edgegroupentitylisting) String ¶

func (o *Edgegroupentitylisting) String() string

String returns a JSON representation of the model

type Edgeinterface ¶

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

	// IpAddress
	IpAddress *string `json:"ipAddress,omitempty"`

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

	// MacAddress
	MacAddress *string `json:"macAddress,omitempty"`

	// IfName
	IfName *string `json:"ifName,omitempty"`

	// Endpoints
	Endpoints *[]Domainentityref `json:"endpoints,omitempty"`

	// LineTypes
	LineTypes *[]string `json:"lineTypes,omitempty"`

	// AddressFamilyId
	AddressFamilyId *string `json:"addressFamilyId,omitempty"`
}

Edgeinterface

func (*Edgeinterface) String ¶

func (o *Edgeinterface) String() string

String returns a JSON representation of the model

type Edgeline ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// Schema
	Schema *Domainentityref `json:"schema,omitempty"`

	// Properties
	Properties *map[string]interface{} `json:"properties,omitempty"`

	// Edge
	Edge *Edge `json:"edge,omitempty"`

	// EdgeGroup
	EdgeGroup *Edgegroup `json:"edgeGroup,omitempty"`

	// LineType
	LineType *string `json:"lineType,omitempty"`

	// Endpoint
	Endpoint *Endpoint `json:"endpoint,omitempty"`

	// IpAddress
	IpAddress *string `json:"ipAddress,omitempty"`

	// LogicalInterfaceId
	LogicalInterfaceId *string `json:"logicalInterfaceId,omitempty"`

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

Edgeline

func (*Edgeline) String ¶

func (o *Edgeline) String() string

String returns a JSON representation of the model

type Edgelineentitylisting ¶

type Edgelineentitylisting struct {
	// Entities
	Entities *[]Edgeline `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"`

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

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

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

Edgelineentitylisting

func (*Edgelineentitylisting) String ¶

func (o *Edgelineentitylisting) String() string

String returns a JSON representation of the model

type Edgelogicalinterfaceschangetopicdomainlogicalinterfacechange ¶

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

	// ErrorInfo
	ErrorInfo *Edgelogicalinterfaceschangetopicerrorinfo `json:"errorInfo,omitempty"`
}

Edgelogicalinterfaceschangetopicdomainlogicalinterfacechange

func (*Edgelogicalinterfaceschangetopicdomainlogicalinterfacechange) String ¶

String returns a JSON representation of the model

type Edgelogicalinterfaceschangetopicerrorinfo ¶

type Edgelogicalinterfaceschangetopicerrorinfo struct {
	// Message
	Message *string `json:"message,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`
}

Edgelogicalinterfaceschangetopicerrorinfo

func (*Edgelogicalinterfaceschangetopicerrorinfo) String ¶

String returns a JSON representation of the model

type Edgelogsjob ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// Files - The files available to upload from the Edge to the cloud.
	Files *[]Edgelogsjobfile `json:"files,omitempty"`

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

Edgelogsjob

func (*Edgelogsjob) String ¶

func (o *Edgelogsjob) String() string

String returns a JSON representation of the model

type Edgelogsjobfile ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

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

	// TimeModified - The time this log file was last modified on the Edge. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	TimeModified *time.Time `json:"timeModified,omitempty"`

	// SizeBytes - The size of this file in bytes.
	SizeBytes *float64 `json:"sizeBytes,omitempty"`

	// UploadStatus - The status of the upload of this file from the Edge to the cloud.  Use /upload to start an upload.
	UploadStatus *string `json:"uploadStatus,omitempty"`

	// EdgePath - The path of this file on the Edge.
	EdgePath *string `json:"edgePath,omitempty"`

	// DownloadId - The download ID to use with the downloads API.
	DownloadId *string `json:"downloadId,omitempty"`

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

Edgelogsjobfile

func (*Edgelogsjobfile) String ¶

func (o *Edgelogsjobfile) String() string

String returns a JSON representation of the model

type Edgelogsjobrequest ¶

type Edgelogsjobrequest struct {
	// Path - A relative directory to the root Edge log folder to query from.
	Path *string `json:"path,omitempty"`

	// Query - The pattern to use when searching for logs, which may include the wildcards {*, ?}.  Multiple search patterns may be combined using a pipe '|' as a delimiter.
	Query *string `json:"query,omitempty"`

	// Recurse - Boolean whether or not to recurse into directories.
	Recurse *bool `json:"recurse,omitempty"`
}

Edgelogsjobrequest

func (*Edgelogsjobrequest) String ¶

func (o *Edgelogsjobrequest) String() string

String returns a JSON representation of the model

type Edgelogsjobresponse ¶

type Edgelogsjobresponse struct {
	// Id - The created job id.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

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

Edgelogsjobresponse

func (*Edgelogsjobresponse) String ¶

func (o *Edgelogsjobresponse) String() string

String returns a JSON representation of the model

type Edgelogsjobuploadrequest ¶

type Edgelogsjobuploadrequest struct {
	// FileIds - A list of file ids to upload.
	FileIds *[]string `json:"fileIds,omitempty"`
}

Edgelogsjobuploadrequest

func (*Edgelogsjobuploadrequest) String ¶

func (o *Edgelogsjobuploadrequest) String() string

String returns a JSON representation of the model

type Edgemetrics ¶

type Edgemetrics struct {
	// Edge
	Edge *Domainentityref `json:"edge,omitempty"`

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

	// UpTimeMsec
	UpTimeMsec *int `json:"upTimeMsec,omitempty"`

	// Processors
	Processors *[]Edgemetricsprocessor `json:"processors,omitempty"`

	// Memory
	Memory *[]Edgemetricsmemory `json:"memory,omitempty"`

	// Disks
	Disks *[]Edgemetricsdisk `json:"disks,omitempty"`

	// Subsystems
	Subsystems *[]Edgemetricssubsystem `json:"subsystems,omitempty"`

	// Networks
	Networks *[]Edgemetricsnetwork `json:"networks,omitempty"`
}

Edgemetrics

func (*Edgemetrics) String ¶

func (o *Edgemetrics) String() string

String returns a JSON representation of the model

type Edgemetricsdisk ¶

type Edgemetricsdisk struct {
	// AvailableBytes - Available memory in bytes.
	AvailableBytes *float64 `json:"availableBytes,omitempty"`

	// PartitionName - Disk partition name.
	PartitionName *string `json:"partitionName,omitempty"`

	// TotalBytes - Total memory in bytes.
	TotalBytes *float64 `json:"totalBytes,omitempty"`
}

Edgemetricsdisk

func (*Edgemetricsdisk) String ¶

func (o *Edgemetricsdisk) String() string

String returns a JSON representation of the model

type Edgemetricsmemory ¶

type Edgemetricsmemory struct {
	// AvailableBytes - Available memory in bytes.
	AvailableBytes *float64 `json:"availableBytes,omitempty"`

	// VarType - Type of memory. Virtual or physical.
	VarType *string `json:"type,omitempty"`

	// TotalBytes - Total memory in bytes.
	TotalBytes *float64 `json:"totalBytes,omitempty"`
}

Edgemetricsmemory

func (*Edgemetricsmemory) String ¶

func (o *Edgemetricsmemory) String() string

String returns a JSON representation of the model

type Edgemetricsnetwork ¶

type Edgemetricsnetwork struct {
	// Ifname - Identifier for the network adapter.
	Ifname *string `json:"ifname,omitempty"`

	// SentBytesPerSec - Number of byes sent per second.
	SentBytesPerSec *int `json:"sentBytesPerSec,omitempty"`

	// ReceivedBytesPerSec - Number of byes received per second.
	ReceivedBytesPerSec *int `json:"receivedBytesPerSec,omitempty"`

	// BandwidthBitsPerSec - Total bandwidth of the adapter in bits per second.
	BandwidthBitsPerSec *float64 `json:"bandwidthBitsPerSec,omitempty"`

	// UtilizationPct - Percent utilization of the network adapter.
	UtilizationPct *float64 `json:"utilizationPct,omitempty"`
}

Edgemetricsnetwork

func (*Edgemetricsnetwork) String ¶

func (o *Edgemetricsnetwork) String() string

String returns a JSON representation of the model

type Edgemetricsprocessor ¶

type Edgemetricsprocessor struct {
	// ActiveTimePct - Percent time processor was active.
	ActiveTimePct *float64 `json:"activeTimePct,omitempty"`

	// CpuId - Machine CPU identifier. 'total' will always be included in the array and is the total of all CPU resources.
	CpuId *string `json:"cpuId,omitempty"`

	// IdleTimePct - Percent time processor was idle.
	IdleTimePct *float64 `json:"idleTimePct,omitempty"`

	// PrivilegedTimePct - Percent time processor spent in privileged mode.
	PrivilegedTimePct *float64 `json:"privilegedTimePct,omitempty"`

	// UserTimePct - Percent time processor spent in user mode.
	UserTimePct *float64 `json:"userTimePct,omitempty"`
}

Edgemetricsprocessor

func (*Edgemetricsprocessor) String ¶

func (o *Edgemetricsprocessor) String() string

String returns a JSON representation of the model

type Edgemetricssubsystem ¶

type Edgemetricssubsystem struct {
	// DelayMs - Delay in milliseconds.
	DelayMs *int `json:"delayMs,omitempty"`

	// ProcessName - Name of the Edge process.
	ProcessName *string `json:"processName,omitempty"`

	// MediaSubsystem - Subsystem for an Edge device.
	MediaSubsystem **Edgemetricssubsystem `json:"mediaSubsystem,omitempty"`
}

Edgemetricssubsystem

func (*Edgemetricssubsystem) String ¶

func (o *Edgemetricssubsystem) String() string

String returns a JSON representation of the model

type Edgemetricstopicedgemetricdisk ¶

type Edgemetricstopicedgemetricdisk struct {
	// PartitionName
	PartitionName *string `json:"partitionName,omitempty"`

	// AvailableBytes
	AvailableBytes *int `json:"availableBytes,omitempty"`

	// TotalBytes
	TotalBytes *int `json:"totalBytes,omitempty"`
}

Edgemetricstopicedgemetricdisk

func (*Edgemetricstopicedgemetricdisk) String ¶

String returns a JSON representation of the model

type Edgemetricstopicedgemetricmemory ¶

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

	// AvailableBytes
	AvailableBytes *int `json:"availableBytes,omitempty"`

	// TotalBytes
	TotalBytes *int `json:"totalBytes,omitempty"`
}

Edgemetricstopicedgemetricmemory

func (*Edgemetricstopicedgemetricmemory) String ¶

String returns a JSON representation of the model

type Edgemetricstopicedgemetricnetworks ¶

type Edgemetricstopicedgemetricnetworks struct {
	// Ifname
	Ifname *string `json:"ifname,omitempty"`

	// SentBytesPerSec
	SentBytesPerSec *int `json:"sentBytesPerSec,omitempty"`

	// ReceivedBytesPerSec
	ReceivedBytesPerSec *int `json:"receivedBytesPerSec,omitempty"`

	// BandwidthBitsPerSec
	BandwidthBitsPerSec *int `json:"bandwidthBitsPerSec,omitempty"`

	// UtilizationPct
	UtilizationPct *float32 `json:"utilizationPct,omitempty"`
}

Edgemetricstopicedgemetricnetworks

func (*Edgemetricstopicedgemetricnetworks) String ¶

String returns a JSON representation of the model

type Edgemetricstopicedgemetricprocessor ¶

type Edgemetricstopicedgemetricprocessor struct {
	// CpuId
	CpuId *string `json:"cpuId,omitempty"`

	// IdleTimePct
	IdleTimePct *int `json:"idleTimePct,omitempty"`

	// ActiveTimePct
	ActiveTimePct *int `json:"activeTimePct,omitempty"`

	// PrivilegedTimePct
	PrivilegedTimePct *int `json:"privilegedTimePct,omitempty"`

	// UserTimePct
	UserTimePct *int `json:"userTimePct,omitempty"`
}

Edgemetricstopicedgemetricprocessor

func (*Edgemetricstopicedgemetricprocessor) String ¶

String returns a JSON representation of the model

type Edgemetricstopicedgemetrics ¶

type Edgemetricstopicedgemetrics struct {
	// Edge
	Edge *Edgemetricstopicurireference `json:"edge,omitempty"`

	// UpTimeMsec
	UpTimeMsec *int `json:"upTimeMsec,omitempty"`

	// Processors
	Processors *[]Edgemetricstopicedgemetricprocessor `json:"processors,omitempty"`

	// Memory
	Memory *[]Edgemetricstopicedgemetricmemory `json:"memory,omitempty"`

	// Disks
	Disks *[]Edgemetricstopicedgemetricdisk `json:"disks,omitempty"`

	// Subsystems
	Subsystems *[]Edgemetricstopicedgemetricsubsystem `json:"subsystems,omitempty"`

	// Networks
	Networks *[]Edgemetricstopicedgemetricnetworks `json:"networks,omitempty"`
}

Edgemetricstopicedgemetrics

func (*Edgemetricstopicedgemetrics) String ¶

func (o *Edgemetricstopicedgemetrics) String() string

String returns a JSON representation of the model

type Edgemetricstopicedgemetricsubsystem ¶

type Edgemetricstopicedgemetricsubsystem struct {
	// ProcessName
	ProcessName *string `json:"processName,omitempty"`

	// DelayMs
	DelayMs *int `json:"delayMs,omitempty"`

	// MediaSubsystem
	MediaSubsystem *Edgemetricstopicedgemetricsubsystemmedia `json:"mediaSubsystem,omitempty"`
}

Edgemetricstopicedgemetricsubsystem

func (*Edgemetricstopicedgemetricsubsystem) String ¶

String returns a JSON representation of the model

type Edgemetricstopicedgemetricsubsystemmedia ¶

type Edgemetricstopicedgemetricsubsystemmedia struct {
	// ProcessName
	ProcessName *string `json:"processName,omitempty"`

	// DelayMs
	DelayMs *int `json:"delayMs,omitempty"`
}

Edgemetricstopicedgemetricsubsystemmedia

func (*Edgemetricstopicedgemetricsubsystemmedia) String ¶

String returns a JSON representation of the model

type Edgemetricstopicurireference ¶

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

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

Edgemetricstopicurireference

func (*Edgemetricstopicurireference) String ¶

String returns a JSON representation of the model

type Edgenetworkdiagnostic ¶

type Edgenetworkdiagnostic 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"`
}

Edgenetworkdiagnostic

func (*Edgenetworkdiagnostic) String ¶

func (o *Edgenetworkdiagnostic) String() string

String returns a JSON representation of the model

type Edgenetworkdiagnosticrequest ¶

type Edgenetworkdiagnosticrequest struct {
	// Host - IPv4/6 address or host to be probed for connectivity. No port allowed.
	Host *string `json:"host,omitempty"`
}

Edgenetworkdiagnosticrequest

func (*Edgenetworkdiagnosticrequest) String ¶

String returns a JSON representation of the model

type Edgenetworkdiagnosticresponse ¶

type Edgenetworkdiagnosticresponse struct {
	// CommandCorrelationId - UUID of each executed command on edge
	CommandCorrelationId *string `json:"commandCorrelationId,omitempty"`

	// Diagnostics - Response string of executed command from edge
	Diagnostics *string `json:"diagnostics,omitempty"`
}

Edgenetworkdiagnosticresponse

func (*Edgenetworkdiagnosticresponse) String ¶

String returns a JSON representation of the model

type Edgerebootparameters ¶

type Edgerebootparameters struct {
	// CallDrainingWaitTimeSeconds - The number of seconds to wait for call draining to complete before initiating the reboot. A value of 0 will prevent call draining and all calls will disconnect immediately.
	CallDrainingWaitTimeSeconds *int `json:"callDrainingWaitTimeSeconds,omitempty"`
}

Edgerebootparameters

func (*Edgerebootparameters) String ¶

func (o *Edgerebootparameters) String() string

String returns a JSON representation of the model

type Edgeservicestaterequest ¶

type Edgeservicestaterequest struct {
	// InService - A boolean that sets the Edge in-service or out-of-service.
	InService *bool `json:"inService,omitempty"`

	// CallDrainingWaitTimeSeconds - The number of seconds to wait for call draining to complete before initiating the reboot. A value of 0 will prevent call draining and all calls will disconnect immediately.
	CallDrainingWaitTimeSeconds *int `json:"callDrainingWaitTimeSeconds,omitempty"`
}

Edgeservicestaterequest

func (*Edgeservicestaterequest) String ¶

func (o *Edgeservicestaterequest) String() string

String returns a JSON representation of the model

type Edgesoftwareupdatetopicdomainedgesoftwareupdate ¶

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

	// Status
	Status *string `json:"status,omitempty"`

	// DownloadStartTime
	DownloadStartTime *time.Time `json:"downloadStartTime,omitempty"`

	// ExecuteStartTime
	ExecuteStartTime *time.Time `json:"executeStartTime,omitempty"`

	// ExecuteStopTime
	ExecuteStopTime *time.Time `json:"executeStopTime,omitempty"`
}

Edgesoftwareupdatetopicdomainedgesoftwareupdate

func (*Edgesoftwareupdatetopicdomainedgesoftwareupdate) String ¶

String returns a JSON representation of the model

type Edgetrunkbase ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// TrunkMetabase - The meta-base this trunk is based on.
	TrunkMetabase *Domainentityref `json:"trunkMetabase,omitempty"`

	// Properties
	Properties *map[string]interface{} `json:"properties,omitempty"`

	// TrunkType - The type of this trunk base.
	TrunkType *string `json:"trunkType,omitempty"`

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

Edgetrunkbase

func (*Edgetrunkbase) String ¶

func (o *Edgetrunkbase) String() string

String returns a JSON representation of the model

type Edgeversioninformation ¶

type Edgeversioninformation struct {
	// SoftwareVersion
	SoftwareVersion *string `json:"softwareVersion,omitempty"`
}

Edgeversioninformation

func (*Edgeversioninformation) String ¶

func (o *Edgeversioninformation) String() string

String returns a JSON representation of the model

type Edgeversionreport ¶

type Edgeversionreport struct {
	// OldestVersion
	OldestVersion *Edgeversioninformation `json:"oldestVersion,omitempty"`

	// NewestVersion
	NewestVersion *Edgeversioninformation `json:"newestVersion,omitempty"`
}

Edgeversionreport

func (*Edgeversionreport) String ¶

func (o *Edgeversionreport) String() string

String returns a JSON representation of the model

type Education ¶

type Education struct {
	// School
	School *string `json:"school,omitempty"`

	// FieldOfStudy
	FieldOfStudy *string `json:"fieldOfStudy,omitempty"`

	// Notes - Notes about education has a 2000 character limit
	Notes *string `json:"notes,omitempty"`

	// DateStart - Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateStart *time.Time `json:"dateStart,omitempty"`

	// DateEnd - Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateEnd *time.Time `json:"dateEnd,omitempty"`
}

Education

func (*Education) String ¶

func (o *Education) String() string

String returns a JSON representation of the model

type Effectiveconfiguration ¶

type Effectiveconfiguration struct {
	// Properties - Key-value configuration settings described by the schema in the propertiesSchemaUri field.
	Properties *map[string]interface{} `json:"properties,omitempty"`

	// Advanced - Advanced configuration described by the schema in the advancedSchemaUri field.
	Advanced *map[string]interface{} `json:"advanced,omitempty"`

	// Name - The name of the integration, used to distinguish this integration from others of the same type.
	Name *string `json:"name,omitempty"`

	// Notes - Notes about the integration.
	Notes *string `json:"notes,omitempty"`

	// Credentials - Credentials required by the integration. The required keys are indicated in the credentials property of the Integration Type
	Credentials *map[string]Credentialinfo `json:"credentials,omitempty"`
}

Effectiveconfiguration - Effective Configuration for an ClientApp. This is comprised of the integration specific configuration along with overrides specified in the integration type.

func (*Effectiveconfiguration) String ¶

func (o *Effectiveconfiguration) String() string

String returns a JSON representation of the model

type Email ¶

type Email 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"`

	// Held - True if this call is held and the person on this side hears silence.
	Held *bool `json:"held,omitempty"`

	// Subject - The subject for the initial email that started this conversation.
	Subject *string `json:"subject,omitempty"`

	// MessagesSent - The number of email messages sent by this participant.
	MessagesSent *int `json:"messagesSent,omitempty"`

	// Segments - The time line of the participant's email, divided into activity segments.
	Segments *[]Segment `json:"segments,omitempty"`

	// Direction - The direction of the email
	Direction *string `json:"direction,omitempty"`

	// RecordingId - A globally unique identifier for the recording associated with this call.
	RecordingId *string `json:"recordingId,omitempty"`

	// ErrorInfo
	ErrorInfo *Errorbody `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 email was placed on hold in the cloud clock if the email 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"`

	// AutoGenerated - Indicates that the email was auto-generated like an Out of Office reply.
	AutoGenerated *bool `json:"autoGenerated,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"`

	// MessageId - A globally unique identifier for the stored content of this communication.
	MessageId *string `json:"messageId,omitempty"`

	// DraftAttachments - A list of uploaded attachments on the email draft.
	DraftAttachments *[]Attachment `json:"draftAttachments,omitempty"`

	// Spam - Indicates if the inbound email was marked as spam.
	Spam *bool `json:"spam,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"`
}

Email

func (*Email) String ¶

func (o *Email) String() string

String returns a JSON representation of the model

type Emailaddress ¶

type Emailaddress struct {
	// Email
	Email *string `json:"email,omitempty"`

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

Emailaddress

func (*Emailaddress) String ¶

func (o *Emailaddress) String() string

String returns a JSON representation of the model

type Emailattachment ¶

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

	// ContentPath
	ContentPath *string `json:"contentPath,omitempty"`

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

	// AttachmentId
	AttachmentId *string `json:"attachmentId,omitempty"`

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

Emailattachment

func (*Emailattachment) String ¶

func (o *Emailattachment) String() string

String returns a JSON representation of the model

type Emailcolumn ¶

type Emailcolumn struct {
	// ColumnName - The name of the email column.
	ColumnName *string `json:"columnName,omitempty"`

	// VarType - Indicates the type of the email column. For example, 'work' or 'personal'.
	VarType *string `json:"type,omitempty"`
}

Emailcolumn

func (*Emailcolumn) String ¶

func (o *Emailcolumn) String() string

String returns a JSON representation of the model

type Emailconversation ¶

type Emailconversation 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 *[]Emailmediaparticipant `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"`
}

Emailconversation

func (*Emailconversation) String ¶

func (o *Emailconversation) String() string

String returns a JSON representation of the model

type Emailconversationentitylisting ¶

type Emailconversationentitylisting struct {
	// Entities
	Entities *[]Emailconversation `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"`

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

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

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

Emailconversationentitylisting

func (*Emailconversationentitylisting) String ¶

String returns a JSON representation of the model

type Emailmediaparticipant ¶

type Emailmediaparticipant 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"`

	// Subject - The subject of the email.
	Subject *string `json:"subject,omitempty"`

	// MessagesSent - The number of messages that have been sent in this email conversation.
	MessagesSent *int `json:"messagesSent,omitempty"`

	// AutoGenerated - Indicates that the email was auto-generated like an Out of Office reply.
	AutoGenerated *bool `json:"autoGenerated,omitempty"`

	// DraftAttachments - A list of uploaded attachments on the email draft.
	DraftAttachments *[]Attachment `json:"draftAttachments,omitempty"`

	// Spam - Indicates if the inbound email was marked as spam.
	Spam *bool `json:"spam,omitempty"`

	// MessageId - A globally unique identifier for the stored content of this communication.
	MessageId *string `json:"messageId,omitempty"`
}

Emailmediaparticipant

func (*Emailmediaparticipant) String ¶

func (o *Emailmediaparticipant) String() string

String returns a JSON representation of the model

type Emailmediapolicy ¶

type Emailmediapolicy struct {
	// Actions - Actions applied when specified conditions are met
	Actions *Policyactions `json:"actions,omitempty"`

	// Conditions - Conditions for when actions should be applied
	Conditions *Emailmediapolicyconditions `json:"conditions,omitempty"`
}

Emailmediapolicy

func (*Emailmediapolicy) String ¶

func (o *Emailmediapolicy) String() string

String returns a JSON representation of the model

type Emailmediapolicyconditions ¶

type Emailmediapolicyconditions 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"`
}

Emailmediapolicyconditions

func (*Emailmediapolicyconditions) String ¶

func (o *Emailmediapolicyconditions) String() string

String returns a JSON representation of the model

type Emailmessage ¶

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

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

	// To - The recipients of the email message.
	To *[]Emailaddress `json:"to,omitempty"`

	// Cc - The recipients that were copied on the email message.
	Cc *[]Emailaddress `json:"cc,omitempty"`

	// Bcc - The recipients that were blind copied on the email message.
	Bcc *[]Emailaddress `json:"bcc,omitempty"`

	// From - The sender of the email message.
	From *Emailaddress `json:"from,omitempty"`

	// ReplyTo - The receiver of the reply email message.
	ReplyTo *Emailaddress `json:"replyTo,omitempty"`

	// Subject - The subject of the email message.
	Subject *string `json:"subject,omitempty"`

	// Attachments - The attachments of the email message.
	Attachments *[]Attachment `json:"attachments,omitempty"`

	// TextBody - The text body of the email message.
	TextBody *string `json:"textBody,omitempty"`

	// HtmlBody - The html body of the email message.
	HtmlBody *string `json:"htmlBody,omitempty"`

	// Time - The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Time *time.Time `json:"time,omitempty"`

	// HistoryIncluded - Indicates whether the history of previous emails of the conversation is included within the email bodies of this message.
	HistoryIncluded *bool `json:"historyIncluded,omitempty"`

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

Emailmessage

func (*Emailmessage) String ¶

func (o *Emailmessage) String() string

String returns a JSON representation of the model

type Emailmessagelisting ¶

type Emailmessagelisting struct {
	// Entities
	Entities *[]Emailmessage `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"`

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

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

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

Emailmessagelisting

func (*Emailmessagelisting) String ¶

func (o *Emailmessagelisting) String() string

String returns a JSON representation of the model

type Emailsetup ¶

type Emailsetup struct {
	// RootDomain - The root PureCloud domain that all sub-domains are created from.
	RootDomain *string `json:"rootDomain,omitempty"`
}

Emailsetup

func (*Emailsetup) String ¶

func (o *Emailsetup) String() string

String returns a JSON representation of the model

type Embeddedintegration ¶

type Embeddedintegration struct {
	// EnableWhitelist
	EnableWhitelist *bool `json:"enableWhitelist,omitempty"`

	// DomainWhitelist
	DomainWhitelist *[]string `json:"domainWhitelist,omitempty"`
}

Embeddedintegration

func (*Embeddedintegration) String ¶

func (o *Embeddedintegration) String() string

String returns a JSON representation of the model

type Emergencycallflow ¶

type Emergencycallflow struct {
	// EmergencyFlow - The call flow to execute in an emergency.
	EmergencyFlow *Domainentityref `json:"emergencyFlow,omitempty"`

	// Ivrs - The IVR(s) to route to the call flow during an emergency.
	Ivrs *[]Domainentityref `json:"ivrs,omitempty"`
}

Emergencycallflow - An emergency flow associates a call flow to use in an emergency with the ivr(s) to route to it.

func (*Emergencycallflow) String ¶

func (o *Emergencycallflow) String() string

String returns a JSON representation of the model

type Emergencygroup ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// Enabled - True if an emergency is occurring and the associated emergency call flow(s) should be used.  False otherwise.
	Enabled *bool `json:"enabled,omitempty"`

	// EmergencyCallFlows - The emergency call flow(s) to use during an emergency.
	EmergencyCallFlows *[]Emergencycallflow `json:"emergencyCallFlows,omitempty"`

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

Emergencygroup - A group of emergency call flows to use in an emergency.

func (*Emergencygroup) String ¶

func (o *Emergencygroup) String() string

String returns a JSON representation of the model

type Emergencygrouplisting ¶

type Emergencygrouplisting struct {
	// Entities
	Entities *[]Emergencygroup `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"`

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

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

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

Emergencygrouplisting

func (*Emergencygrouplisting) String ¶

func (o *Emergencygrouplisting) String() string

String returns a JSON representation of the model

type Employerinfo ¶

type Employerinfo struct {
	// OfficialName
	OfficialName *string `json:"officialName,omitempty"`

	// EmployeeId
	EmployeeId *string `json:"employeeId,omitempty"`

	// EmployeeType
	EmployeeType *string `json:"employeeType,omitempty"`

	// DateHire
	DateHire *string `json:"dateHire,omitempty"`
}

Employerinfo

func (*Employerinfo) String ¶

func (o *Employerinfo) String() string

String returns a JSON representation of the model

type Empty ¶

type Empty struct{}

Empty

func (*Empty) String ¶

func (o *Empty) String() string

String returns a JSON representation of the model

type Encryptionkey ¶

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

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

	// CreateDate - create date of the key pair. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CreateDate *time.Time `json:"createDate,omitempty"`

	// KeydataSummary - key data summary (base 64 encoded public key)
	KeydataSummary *string `json:"keydataSummary,omitempty"`

	// User - user that requested generation of public key
	User *User `json:"user,omitempty"`

	// LocalEncryptionConfiguration - Local configuration
	LocalEncryptionConfiguration *Localencryptionconfiguration `json:"localEncryptionConfiguration,omitempty"`

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

Encryptionkey

func (*Encryptionkey) String ¶

func (o *Encryptionkey) String() string

String returns a JSON representation of the model

type Encryptionkeyentitylisting ¶

type Encryptionkeyentitylisting struct {
	// Entities
	Entities *[]Encryptionkey `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"`

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

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

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

Encryptionkeyentitylisting

func (*Encryptionkeyentitylisting) String ¶

func (o *Encryptionkeyentitylisting) String() string

String returns a JSON representation of the model

type Endpoint ¶

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

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

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

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

	// Properties
	Properties *map[string]interface{} `json:"properties,omitempty"`

	// Schema - Schema
	Schema *Domainentityref `json:"schema,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// Site
	Site *Domainentityref `json:"site,omitempty"`

	// Dids
	Dids *[]string `json:"dids,omitempty"`

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

Endpoint

func (*Endpoint) String ¶

func (o *Endpoint) String() string

String returns a JSON representation of the model

type Entity ¶

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

Entity

func (*Entity) String ¶

func (o *Entity) String() string

String returns a JSON representation of the model

type Entitylisting ¶

type Entitylisting struct {
	// Entities
	Entities *[]interface{} `json:"entities,omitempty"`
}

Entitylisting

func (*Entitylisting) String ¶

func (o *Entitylisting) String() string

String returns a JSON representation of the model

type Entitytypecriteria ¶

type Entitytypecriteria struct {
	// Key - The criteria key.
	Key *string `json:"key,omitempty"`

	// Values - The criteria values.
	Values *[]string `json:"values,omitempty"`

	// ShouldIgnoreCase - Should criteria be case insensitive.
	ShouldIgnoreCase *bool `json:"shouldIgnoreCase,omitempty"`

	// Operator - The comparison operator.
	Operator *string `json:"operator,omitempty"`

	// EntityType - The entity to match the pattern against.
	EntityType *string `json:"entityType,omitempty"`
}

Entitytypecriteria

func (*Entitytypecriteria) String ¶

func (o *Entitytypecriteria) String() string

String returns a JSON representation of the model

type Entry ¶

type Entry struct {
	// Value - A value included in this facet.
	Value *string `json:"value,omitempty"`

	// Count - The number of results with this value.
	Count *int `json:"count,omitempty"`
}

Entry

func (*Entry) String ¶

func (o *Entry) String() string

String returns a JSON representation of the model

type Errorbody ¶

type Errorbody struct {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Detail `json:"details,omitempty"`

	// Errors
	Errors *[]Errorbody `json:"errors,omitempty"`
}

Errorbody

func (*Errorbody) String ¶

func (o *Errorbody) String() string

String returns a JSON representation of the model

type Errordetails ¶

type Errordetails struct {
	// Status
	Status *int `json:"status,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Nested
	Nested **Errordetails `json:"nested,omitempty"`

	// Details
	Details *string `json:"details,omitempty"`
}

Errordetails

func (*Errordetails) String ¶

func (o *Errordetails) String() string

String returns a JSON representation of the model

type Errorinfo ¶

type Errorinfo struct {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`
}

Errorinfo

func (*Errorinfo) String ¶

func (o *Errorinfo) String() string

String returns a JSON representation of the model

type Estimatedwaittimepredictions ¶

type Estimatedwaittimepredictions struct {
	// Results - Returned upon a successful estimated wait time request.
	Results *[]Predictionresults `json:"results,omitempty"`
}

Estimatedwaittimepredictions

func (*Estimatedwaittimepredictions) String ¶

String returns a JSON representation of the model

type Evaluation ¶

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

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

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

	// EvaluationForm - Evaluation form used for evaluation.
	EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"`

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

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

	// Calibration
	Calibration *Calibration `json:"calibration,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`

	// Answers
	Answers *Evaluationscoringset `json:"answers,omitempty"`

	// AgentHasRead
	AgentHasRead *bool `json:"agentHasRead,omitempty"`

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

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

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

	// Queue
	Queue *Queue `json:"queue,omitempty"`

	// MediaType - List of different communication types used in conversation.
	MediaType *[]string `json:"mediaType,omitempty"`

	// Rescore - Is only true when evaluation is re-scored.
	Rescore *bool `json:"rescore,omitempty"`

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

	// ConversationEndDate - End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConversationEndDate *time.Time `json:"conversationEndDate,omitempty"`

	// NeverRelease - Signifies if the evaluation is never to be released. This cannot be set true if release date is also set.
	NeverRelease *bool `json:"neverRelease,omitempty"`

	// ResourceId - Only used for email evaluations. Will be null for all other evaluations.
	ResourceId *string `json:"resourceId,omitempty"`

	// ResourceType - The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources.
	ResourceType *string `json:"resourceType,omitempty"`

	// Redacted - Is only true when the user making the request does not have sufficient permissions to see evaluation
	Redacted *bool `json:"redacted,omitempty"`

	// IsScoringIndex
	IsScoringIndex *bool `json:"isScoringIndex,omitempty"`

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

Evaluation

func (*Evaluation) String ¶

func (o *Evaluation) String() string

String returns a JSON representation of the model

type Evaluationaggregatedatacontainer ¶

type Evaluationaggregatedatacontainer struct {
	// Group - A mapping from dimension to value
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Statisticalresponse `json:"data,omitempty"`
}

Evaluationaggregatedatacontainer

func (*Evaluationaggregatedatacontainer) String ¶

String returns a JSON representation of the model

type Evaluationaggregatequeryclause ¶

type Evaluationaggregatequeryclause 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 *[]Evaluationaggregatequerypredicate `json:"predicates,omitempty"`
}

Evaluationaggregatequeryclause

func (*Evaluationaggregatequeryclause) String ¶

String returns a JSON representation of the model

type Evaluationaggregatequeryfilter ¶

type Evaluationaggregatequeryfilter 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 *[]Evaluationaggregatequeryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Evaluationaggregatequerypredicate `json:"predicates,omitempty"`
}

Evaluationaggregatequeryfilter

func (*Evaluationaggregatequeryfilter) String ¶

String returns a JSON representation of the model

type Evaluationaggregatequerypredicate ¶

type Evaluationaggregatequerypredicate 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"`
}

Evaluationaggregatequerypredicate

func (*Evaluationaggregatequerypredicate) String ¶

String returns a JSON representation of the model

type Evaluationaggregatequeryresponse ¶

type Evaluationaggregatequeryresponse struct {
	// Results
	Results *[]Evaluationaggregatedatacontainer `json:"results,omitempty"`
}

Evaluationaggregatequeryresponse

func (*Evaluationaggregatequeryresponse) String ¶

String returns a JSON representation of the model

type Evaluationaggregationquery ¶

type Evaluationaggregationquery 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 *Evaluationaggregatequeryfilter `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 *[]Evaluationaggregationview `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"`
}

Evaluationaggregationquery

func (*Evaluationaggregationquery) String ¶

func (o *Evaluationaggregationquery) String() string

String returns a JSON representation of the model

type Evaluationaggregationview ¶

type Evaluationaggregationview 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"`
}

Evaluationaggregationview

func (*Evaluationaggregationview) String ¶

func (o *Evaluationaggregationview) String() string

String returns a JSON representation of the model

type Evaluationassignment ¶

type Evaluationassignment struct {
	// EvaluationForm
	EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"`

	// User
	User *User `json:"user,omitempty"`
}

Evaluationassignment

func (*Evaluationassignment) String ¶

func (o *Evaluationassignment) String() string

String returns a JSON representation of the model

type Evaluationdetailqueryclause ¶

type Evaluationdetailqueryclause 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 *[]Evaluationdetailquerypredicate `json:"predicates,omitempty"`
}

Evaluationdetailqueryclause

func (*Evaluationdetailqueryclause) String ¶

func (o *Evaluationdetailqueryclause) String() string

String returns a JSON representation of the model

type Evaluationdetailqueryfilter ¶

type Evaluationdetailqueryfilter 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 *[]Evaluationdetailqueryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Evaluationdetailquerypredicate `json:"predicates,omitempty"`
}

Evaluationdetailqueryfilter

func (*Evaluationdetailqueryfilter) String ¶

func (o *Evaluationdetailqueryfilter) String() string

String returns a JSON representation of the model

type Evaluationdetailquerypredicate ¶

type Evaluationdetailquerypredicate 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"`
}

Evaluationdetailquerypredicate

func (*Evaluationdetailquerypredicate) String ¶

String returns a JSON representation of the model

type Evaluationentitylisting ¶

type Evaluationentitylisting struct {
	// Entities
	Entities *[]Evaluation `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"`

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

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

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

Evaluationentitylisting

func (*Evaluationentitylisting) String ¶

func (o *Evaluationentitylisting) String() string

String returns a JSON representation of the model

type Evaluationform ¶

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

	// Name - The evaluation form name
	Name *string `json:"name,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"`

	// Published
	Published *bool `json:"published,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// QuestionGroups - A list of question groups
	QuestionGroups *[]Evaluationquestiongroup `json:"questionGroups,omitempty"`

	// PublishedVersions
	PublishedVersions *Domainentitylistingevaluationform `json:"publishedVersions,omitempty"`

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

Evaluationform

func (*Evaluationform) String ¶

func (o *Evaluationform) String() string

String returns a JSON representation of the model

type Evaluationformandscoringset ¶

type Evaluationformandscoringset struct {
	// EvaluationForm
	EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"`

	// Answers
	Answers *Evaluationscoringset `json:"answers,omitempty"`
}

Evaluationformandscoringset

func (*Evaluationformandscoringset) String ¶

func (o *Evaluationformandscoringset) String() string

String returns a JSON representation of the model

type Evaluationformentitylisting ¶

type Evaluationformentitylisting struct {
	// Entities
	Entities *[]Evaluationform `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"`

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

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

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

Evaluationformentitylisting

func (*Evaluationformentitylisting) String ¶

func (o *Evaluationformentitylisting) String() string

String returns a JSON representation of the model

type Evaluationqualityv2topiccalibration ¶

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

Evaluationqualityv2topiccalibration

func (*Evaluationqualityv2topiccalibration) String ¶

String returns a JSON representation of the model

type Evaluationqualityv2topicevaluationscoringset ¶

type Evaluationqualityv2topicevaluationscoringset struct {
	// TotalScore
	TotalScore *int `json:"totalScore,omitempty"`

	// TotalCriticalScore
	TotalCriticalScore *int `json:"totalCriticalScore,omitempty"`
}

Evaluationqualityv2topicevaluationscoringset

func (*Evaluationqualityv2topicevaluationscoringset) String ¶

String returns a JSON representation of the model

type Evaluationqualityv2topicevaluationv2 ¶

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

	// ConversationId
	ConversationId *string `json:"conversationId,omitempty"`

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

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

	// EventTime
	EventTime *time.Time `json:"eventTime,omitempty"`

	// EvaluationFormId
	EvaluationFormId *string `json:"evaluationFormId,omitempty"`

	// FormName
	FormName *string `json:"formName,omitempty"`

	// ScoringSet
	ScoringSet *Evaluationqualityv2topicevaluationscoringset `json:"scoringSet,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`

	// AgentHasRead
	AgentHasRead *bool `json:"agentHasRead,omitempty"`

	// ReleaseDate
	ReleaseDate *time.Time `json:"releaseDate,omitempty"`

	// AssignedDate
	AssignedDate *time.Time `json:"assignedDate,omitempty"`

	// ChangedDate
	ChangedDate *time.Time `json:"changedDate,omitempty"`

	// EventType
	EventType *string `json:"eventType,omitempty"`

	// ResourceId
	ResourceId *string `json:"resourceId,omitempty"`

	// ResourceType
	ResourceType *string `json:"resourceType,omitempty"`

	// DivisionIds
	DivisionIds *[]string `json:"divisionIds,omitempty"`

	// Rescore
	Rescore *bool `json:"rescore,omitempty"`

	// ConversationDate
	ConversationDate *time.Time `json:"conversationDate,omitempty"`

	// MediaType
	MediaType *[]string `json:"mediaType,omitempty"`

	// Calibration
	Calibration *Evaluationqualityv2topiccalibration `json:"calibration,omitempty"`
}

Evaluationqualityv2topicevaluationv2

func (*Evaluationqualityv2topicevaluationv2) String ¶

String returns a JSON representation of the model

type Evaluationqualityv2topicuser ¶

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

	// DisplayName
	DisplayName *string `json:"displayName,omitempty"`
}

Evaluationqualityv2topicuser

func (*Evaluationqualityv2topicuser) String ¶

String returns a JSON representation of the model

type Evaluationquestion ¶

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

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

	// HelpText
	HelpText *string `json:"helpText,omitempty"`

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

	// NaEnabled
	NaEnabled *bool `json:"naEnabled,omitempty"`

	// CommentsRequired
	CommentsRequired *bool `json:"commentsRequired,omitempty"`

	// VisibilityCondition
	VisibilityCondition *Visibilitycondition `json:"visibilityCondition,omitempty"`

	// AnswerOptions - Options from which to choose an answer for this question. Only used by Multiple Choice type questions.
	AnswerOptions *[]Answeroption `json:"answerOptions,omitempty"`

	// IsKill
	IsKill *bool `json:"isKill,omitempty"`

	// IsCritical
	IsCritical *bool `json:"isCritical,omitempty"`
}

Evaluationquestion

func (*Evaluationquestion) String ¶

func (o *Evaluationquestion) String() string

String returns a JSON representation of the model

type Evaluationquestiongroup ¶

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

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

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

	// DefaultAnswersToHighest
	DefaultAnswersToHighest *bool `json:"defaultAnswersToHighest,omitempty"`

	// DefaultAnswersToNA
	DefaultAnswersToNA *bool `json:"defaultAnswersToNA,omitempty"`

	// NaEnabled
	NaEnabled *bool `json:"naEnabled,omitempty"`

	// Weight
	Weight *float32 `json:"weight,omitempty"`

	// ManualWeight
	ManualWeight *bool `json:"manualWeight,omitempty"`

	// Questions
	Questions *[]Evaluationquestion `json:"questions,omitempty"`

	// VisibilityCondition
	VisibilityCondition *Visibilitycondition `json:"visibilityCondition,omitempty"`
}

Evaluationquestiongroup

func (*Evaluationquestiongroup) String ¶

func (o *Evaluationquestiongroup) String() string

String returns a JSON representation of the model

type Evaluationquestiongroupscore ¶

type Evaluationquestiongroupscore struct {
	// QuestionGroupId
	QuestionGroupId *string `json:"questionGroupId,omitempty"`

	// TotalScore - Score of all questions in the group
	TotalScore *float32 `json:"totalScore,omitempty"`

	// MaxTotalScore - Maximum possible score of all questions in the group
	MaxTotalScore *float32 `json:"maxTotalScore,omitempty"`

	// MarkedNA
	MarkedNA *bool `json:"markedNA,omitempty"`

	// TotalCriticalScore - Score of only the critical questions in the group
	TotalCriticalScore *float32 `json:"totalCriticalScore,omitempty"`

	// MaxTotalCriticalScore - Maximum possible score of only the critical questions in the group
	MaxTotalCriticalScore *float32 `json:"maxTotalCriticalScore,omitempty"`

	// TotalNonCriticalScore - Score of only the non critical questions in the group
	TotalNonCriticalScore *float32 `json:"totalNonCriticalScore,omitempty"`

	// MaxTotalNonCriticalScore - Maximum possible score of only the non critical questions in the group
	MaxTotalNonCriticalScore *float32 `json:"maxTotalNonCriticalScore,omitempty"`

	// TotalScoreUnweighted - Unweighted score of all questions in the group
	TotalScoreUnweighted *float32 `json:"totalScoreUnweighted,omitempty"`

	// MaxTotalScoreUnweighted - Maximum possible unweighted score of all questions in the group
	MaxTotalScoreUnweighted *float32 `json:"maxTotalScoreUnweighted,omitempty"`

	// TotalCriticalScoreUnweighted - Unweighted score of only the critical questions in the group
	TotalCriticalScoreUnweighted *float32 `json:"totalCriticalScoreUnweighted,omitempty"`

	// MaxTotalCriticalScoreUnweighted - Maximum possible unweighted score of only the critical questions in the group
	MaxTotalCriticalScoreUnweighted *float32 `json:"maxTotalCriticalScoreUnweighted,omitempty"`

	// TotalNonCriticalScoreUnweighted - Unweighted score of only the non critical questions in the group
	TotalNonCriticalScoreUnweighted *float32 `json:"totalNonCriticalScoreUnweighted,omitempty"`

	// MaxTotalNonCriticalScoreUnweighted - Maximum possible unweighted score of only the non critical questions in the group
	MaxTotalNonCriticalScoreUnweighted *float32 `json:"maxTotalNonCriticalScoreUnweighted,omitempty"`

	// QuestionScores
	QuestionScores *[]Evaluationquestionscore `json:"questionScores,omitempty"`
}

Evaluationquestiongroupscore

func (*Evaluationquestiongroupscore) String ¶

String returns a JSON representation of the model

type Evaluationquestionscore ¶

type Evaluationquestionscore struct {
	// QuestionId
	QuestionId *string `json:"questionId,omitempty"`

	// AnswerId
	AnswerId *string `json:"answerId,omitempty"`

	// Score - Unweighted score of the question
	Score *int `json:"score,omitempty"`

	// MarkedNA
	MarkedNA *bool `json:"markedNA,omitempty"`

	// FailedKillQuestion - Applicable only on fatal questions. Indicates that the answer selected was not the highest score available for the question
	FailedKillQuestion *bool `json:"failedKillQuestion,omitempty"`

	// Comments - Comments from the evaluator specific to this question
	Comments *string `json:"comments,omitempty"`
}

Evaluationquestionscore

func (*Evaluationquestionscore) String ¶

func (o *Evaluationquestionscore) String() string

String returns a JSON representation of the model

type Evaluationscoringset ¶

type Evaluationscoringset struct {
	// TotalScore - Score of all questions
	TotalScore *float32 `json:"totalScore,omitempty"`

	// TotalCriticalScore - Score of only the critical questions
	TotalCriticalScore *float32 `json:"totalCriticalScore,omitempty"`

	// TotalNonCriticalScore - Score of only the non-critical questions
	TotalNonCriticalScore *float32 `json:"totalNonCriticalScore,omitempty"`

	// QuestionGroupScores
	QuestionGroupScores *[]Evaluationquestiongroupscore `json:"questionGroupScores,omitempty"`

	// AnyFailedKillQuestions - Indicates that at least one fatal question was answered without having the highest score available for the question
	AnyFailedKillQuestions *bool `json:"anyFailedKillQuestions,omitempty"`

	// Comments - Overall comments from the evaluator
	Comments *string `json:"comments,omitempty"`

	// AgentComments - Comments from the agent while reviewing evaluation results
	AgentComments *string `json:"agentComments,omitempty"`
}

Evaluationscoringset

func (*Evaluationscoringset) String ¶

func (o *Evaluationscoringset) String() string

String returns a JSON representation of the model

type Evaluatoractivity ¶

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

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

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

	// NumEvaluationsAssigned
	NumEvaluationsAssigned *int `json:"numEvaluationsAssigned,omitempty"`

	// NumEvaluationsStarted
	NumEvaluationsStarted *int `json:"numEvaluationsStarted,omitempty"`

	// NumEvaluationsCompleted
	NumEvaluationsCompleted *int `json:"numEvaluationsCompleted,omitempty"`

	// NumCalibrationsAssigned
	NumCalibrationsAssigned *int `json:"numCalibrationsAssigned,omitempty"`

	// NumCalibrationsStarted
	NumCalibrationsStarted *int `json:"numCalibrationsStarted,omitempty"`

	// NumCalibrationsCompleted
	NumCalibrationsCompleted *int `json:"numCalibrationsCompleted,omitempty"`

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

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

Evaluatoractivity

func (*Evaluatoractivity) String ¶

func (o *Evaluatoractivity) String() string

String returns a JSON representation of the model

type Evaluatoractivityentitylisting ¶

type Evaluatoractivityentitylisting struct {
	// Entities
	Entities *[]Evaluatoractivity `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"`

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

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

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

Evaluatoractivityentitylisting

func (*Evaluatoractivityentitylisting) String ¶

String returns a JSON representation of the model

type Eventcondition ¶

type Eventcondition struct {
	// Key - The event key.
	Key *string `json:"key,omitempty"`

	// Values - The event values.
	Values *[]string `json:"values,omitempty"`

	// Operator - The comparison operator.
	Operator *string `json:"operator,omitempty"`

	// StreamType - The stream type for which this condition can be satisfied.
	StreamType *string `json:"streamType,omitempty"`

	// SessionType - The session type for which this condition can be satisfied.
	SessionType *string `json:"sessionType,omitempty"`

	// EventName - The name of the event for which this condition can be satisfied.
	EventName *string `json:"eventName,omitempty"`
}

Eventcondition

func (*Eventcondition) String ¶

func (o *Eventcondition) String() string

String returns a JSON representation of the model

type Evententity ¶

type Evententity struct {
	// EntityType - Type of entity the event pertains to. e.g. integration
	EntityType *string `json:"entityType,omitempty"`

	// Id - ID of the entity the event pertains to.
	Id *string `json:"id,omitempty"`
}

Evententity

func (*Evententity) String ¶

func (o *Evententity) String() string

String returns a JSON representation of the model

type Eventlog ¶

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

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

	// ErrorEntity
	ErrorEntity *Domainentityref `json:"errorEntity,omitempty"`

	// RelatedEntity
	RelatedEntity *Domainentityref `json:"relatedEntity,omitempty"`

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

	// Level
	Level *string `json:"level,omitempty"`

	// Category
	Category *string `json:"category,omitempty"`

	// CorrelationId
	CorrelationId *string `json:"correlationId,omitempty"`

	// EventMessage
	EventMessage *Eventmessage `json:"eventMessage,omitempty"`

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

Eventlog

func (*Eventlog) String ¶

func (o *Eventlog) String() string

String returns a JSON representation of the model

type Eventmessage ¶

type Eventmessage struct {
	// Code
	Code *string `json:"code,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]interface{} `json:"messageParams,omitempty"`

	// DocumentationUri
	DocumentationUri *string `json:"documentationUri,omitempty"`

	// ResourceURIs
	ResourceURIs *[]string `json:"resourceURIs,omitempty"`
}

Eventmessage

func (*Eventmessage) String ¶

func (o *Eventmessage) String() string

String returns a JSON representation of the model

type Executerecordingjobsquery ¶

type Executerecordingjobsquery struct {
	// State - The desired state for the job to be set to.
	State *string `json:"state,omitempty"`
}

Executerecordingjobsquery

func (*Executerecordingjobsquery) String ¶

func (o *Executerecordingjobsquery) String() string

String returns a JSON representation of the model

type Expansioncriterium ¶

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

	// Threshold
	Threshold *float64 `json:"threshold,omitempty"`
}

Expansioncriterium

func (*Expansioncriterium) String ¶

func (o *Expansioncriterium) String() string

String returns a JSON representation of the model

type Exportscriptrequest ¶

type Exportscriptrequest struct {
	// FileName - The final file name (no extension) of the script download: <fileName>.script
	FileName *string `json:"fileName,omitempty"`

	// VersionId - The UUID version of the script to be exported.  Defaults to the current editable version.
	VersionId *string `json:"versionId,omitempty"`
}

Exportscriptrequest - Creating an exported script via Download Service

func (*Exportscriptrequest) String ¶

func (o *Exportscriptrequest) String() string

String returns a JSON representation of the model

type Exportscriptresponse ¶

type Exportscriptresponse struct {
	// Url
	Url *string `json:"url,omitempty"`
}

Exportscriptresponse

func (*Exportscriptresponse) String ¶

func (o *Exportscriptresponse) String() string

String returns a JSON representation of the model

type Exporturi ¶

type Exporturi struct {
	// Uri
	Uri *string `json:"uri,omitempty"`

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

Exporturi

func (*Exporturi) String ¶

func (o *Exporturi) String() string

String returns a JSON representation of the model

type Extension ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// Number
	Number *string `json:"number,omitempty"`

	// Owner - A Uri reference to the owner of this extension, which is either a User or an IVR
	Owner *Domainentityref `json:"owner,omitempty"`

	// ExtensionPool
	ExtensionPool *Domainentityref `json:"extensionPool,omitempty"`

	// OwnerType
	OwnerType *string `json:"ownerType,omitempty"`

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

Extension

func (*Extension) String ¶

func (o *Extension) String() string

String returns a JSON representation of the model

type Extensionentitylisting ¶

type Extensionentitylisting struct {
	// Entities
	Entities *[]Extension `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"`

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

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

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

Extensionentitylisting

func (*Extensionentitylisting) String ¶

func (o *Extensionentitylisting) String() string

String returns a JSON representation of the model

type Extensionpool ¶

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

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

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

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// StartNumber - The starting phone number for the range of this Extension pool. Must be in E.164 format
	StartNumber *string `json:"startNumber,omitempty"`

	// EndNumber - The ending phone number for the range of this Extension pool. Must be in E.164 format
	EndNumber *string `json:"endNumber,omitempty"`

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

Extensionpool

func (*Extensionpool) String ¶

func (o *Extensionpool) String() string

String returns a JSON representation of the model

type Extensionpoolentitylisting ¶

type Extensionpoolentitylisting struct {
	// Entities
	Entities *[]Extensionpool `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"`

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

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

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

Extensionpoolentitylisting

func (*Extensionpoolentitylisting) String ¶

func (o *Extensionpoolentitylisting) String() string

String returns a JSON representation of the model

type ExternalContactsApi ¶

type ExternalContactsApi struct {
	Configuration *Configuration
}

ExternalContactsApi provides functions for API endpoints

func NewExternalContactsApi ¶

func NewExternalContactsApi() *ExternalContactsApi

NewExternalContactsApi creates an API instance using the default configuration

func NewExternalContactsApiWithConfig ¶

func NewExternalContactsApiWithConfig(config *Configuration) *ExternalContactsApi

NewExternalContactsApiWithConfig creates an API instance using the provided configuration

func (ExternalContactsApi) DeleteExternalcontactsContact ¶

func (a ExternalContactsApi) DeleteExternalcontactsContact(contactId string) (*Empty, *APIResponse, error)

DeleteExternalcontactsContact invokes DELETE /api/v2/externalcontacts/contacts/{contactId}

Delete an external contact

func (ExternalContactsApi) DeleteExternalcontactsContactNote ¶

func (a ExternalContactsApi) DeleteExternalcontactsContactNote(contactId string, noteId string) (*Empty, *APIResponse, error)

DeleteExternalcontactsContactNote invokes DELETE /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}

Delete a note for an external contact

func (ExternalContactsApi) DeleteExternalcontactsContactsSchema ¶

func (a ExternalContactsApi) DeleteExternalcontactsContactsSchema(schemaId string) (*APIResponse, error)

DeleteExternalcontactsContactsSchema invokes DELETE /api/v2/externalcontacts/contacts/schemas/{schemaId}

Delete a schema

func (ExternalContactsApi) DeleteExternalcontactsOrganization ¶

func (a ExternalContactsApi) DeleteExternalcontactsOrganization(externalOrganizationId string) (*Empty, *APIResponse, error)

DeleteExternalcontactsOrganization invokes DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}

Delete an external organization

func (ExternalContactsApi) DeleteExternalcontactsOrganizationNote ¶

func (a ExternalContactsApi) DeleteExternalcontactsOrganizationNote(externalOrganizationId string, noteId string) (*Empty, *APIResponse, error)

DeleteExternalcontactsOrganizationNote invokes DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}

Delete a note for an external organization

func (ExternalContactsApi) DeleteExternalcontactsOrganizationTrustor ¶

func (a ExternalContactsApi) DeleteExternalcontactsOrganizationTrustor(externalOrganizationId string) (*APIResponse, error)

DeleteExternalcontactsOrganizationTrustor invokes DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor

Unlink the Trustor for this External Organization

func (ExternalContactsApi) DeleteExternalcontactsRelationship ¶

func (a ExternalContactsApi) DeleteExternalcontactsRelationship(relationshipId string) (*Empty, *APIResponse, error)

DeleteExternalcontactsRelationship invokes DELETE /api/v2/externalcontacts/relationships/{relationshipId}

Delete a relationship

func (ExternalContactsApi) GetExternalcontactsContact ¶

func (a ExternalContactsApi) GetExternalcontactsContact(contactId string, expand []string) (*Externalcontact, *APIResponse, error)

GetExternalcontactsContact invokes GET /api/v2/externalcontacts/contacts/{contactId}

Fetch an external contact

func (ExternalContactsApi) GetExternalcontactsContactNote ¶

func (a ExternalContactsApi) GetExternalcontactsContactNote(contactId string, noteId string, expand []string) (*Note, *APIResponse, error)

GetExternalcontactsContactNote invokes GET /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}

Fetch a note for an external contact

func (ExternalContactsApi) GetExternalcontactsContactNotes ¶

func (a ExternalContactsApi) GetExternalcontactsContactNotes(contactId string, pageSize int, pageNumber int, sortOrder string, expand []string) (*Notelisting, *APIResponse, error)

GetExternalcontactsContactNotes invokes GET /api/v2/externalcontacts/contacts/{contactId}/notes

List notes for an external contact

func (ExternalContactsApi) GetExternalcontactsContacts ¶

func (a ExternalContactsApi) GetExternalcontactsContacts(pageSize int, pageNumber int, q string, sortOrder string, expand []string) (*Contactlisting, *APIResponse, error)

GetExternalcontactsContacts invokes GET /api/v2/externalcontacts/contacts

Search for external contacts

func (ExternalContactsApi) GetExternalcontactsContactsSchema ¶

func (a ExternalContactsApi) GetExternalcontactsContactsSchema(schemaId string) (*Dataschema, *APIResponse, error)

GetExternalcontactsContactsSchema invokes GET /api/v2/externalcontacts/contacts/schemas/{schemaId}

Get a schema

func (ExternalContactsApi) GetExternalcontactsContactsSchemaVersion ¶

func (a ExternalContactsApi) GetExternalcontactsContactsSchemaVersion(schemaId string, versionId string) (*Dataschema, *APIResponse, error)

GetExternalcontactsContactsSchemaVersion invokes GET /api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId}

Get a specific version of a schema

func (ExternalContactsApi) GetExternalcontactsContactsSchemaVersions ¶

func (a ExternalContactsApi) GetExternalcontactsContactsSchemaVersions(schemaId string) (*Dataschema, *APIResponse, error)

GetExternalcontactsContactsSchemaVersions invokes GET /api/v2/externalcontacts/contacts/schemas/{schemaId}/versions

Get all versions of an external contact&#39;s schema

func (ExternalContactsApi) GetExternalcontactsContactsSchemas ¶

func (a ExternalContactsApi) GetExternalcontactsContactsSchemas() (*Dataschemalisting, *APIResponse, error)

GetExternalcontactsContactsSchemas invokes GET /api/v2/externalcontacts/contacts/schemas

Get a list of schemas.

func (ExternalContactsApi) GetExternalcontactsOrganization ¶

func (a ExternalContactsApi) GetExternalcontactsOrganization(externalOrganizationId string, expand string, includeTrustors bool) (*Externalorganization, *APIResponse, error)

GetExternalcontactsOrganization invokes GET /api/v2/externalcontacts/organizations/{externalOrganizationId}

Fetch an external organization

func (ExternalContactsApi) GetExternalcontactsOrganizationContacts ¶

func (a ExternalContactsApi) GetExternalcontactsOrganizationContacts(externalOrganizationId string, pageSize int, pageNumber int, q string, sortOrder string, expand []string) (*Contactlisting, *APIResponse, error)

GetExternalcontactsOrganizationContacts invokes GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts

Search for external contacts in an external organization

func (ExternalContactsApi) GetExternalcontactsOrganizationNote ¶

func (a ExternalContactsApi) GetExternalcontactsOrganizationNote(externalOrganizationId string, noteId string, expand []string) (*Note, *APIResponse, error)

GetExternalcontactsOrganizationNote invokes GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}

Fetch a note for an external organization

func (ExternalContactsApi) GetExternalcontactsOrganizationNotes ¶

func (a ExternalContactsApi) GetExternalcontactsOrganizationNotes(externalOrganizationId string, pageSize int, pageNumber int, sortOrder string, expand []string) (*Notelisting, *APIResponse, error)

GetExternalcontactsOrganizationNotes invokes GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes

List notes for an external organization

func (ExternalContactsApi) GetExternalcontactsOrganizationRelationships ¶

func (a ExternalContactsApi) GetExternalcontactsOrganizationRelationships(externalOrganizationId string, pageSize int, pageNumber int, expand string, sortOrder string) (*Relationshiplisting, *APIResponse, error)

GetExternalcontactsOrganizationRelationships invokes GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships

Fetch a relationship for an external organization

func (ExternalContactsApi) GetExternalcontactsOrganizations ¶

func (a ExternalContactsApi) GetExternalcontactsOrganizations(pageSize int, pageNumber int, q string, trustorId []string, sortOrder string, expand []string, includeTrustors bool) (*Externalorganizationlisting, *APIResponse, error)

GetExternalcontactsOrganizations invokes GET /api/v2/externalcontacts/organizations

Search for external organizations

func (ExternalContactsApi) GetExternalcontactsOrganizationsSchema ¶

func (a ExternalContactsApi) GetExternalcontactsOrganizationsSchema(schemaId string) (*Dataschema, *APIResponse, error)

GetExternalcontactsOrganizationsSchema invokes GET /api/v2/externalcontacts/organizations/schemas/{schemaId}

Get a schema

func (ExternalContactsApi) GetExternalcontactsOrganizationsSchemaVersion ¶

func (a ExternalContactsApi) GetExternalcontactsOrganizationsSchemaVersion(schemaId string, versionId string) (*Dataschema, *APIResponse, error)

GetExternalcontactsOrganizationsSchemaVersion invokes GET /api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId}

Get a specific version of a schema

func (ExternalContactsApi) GetExternalcontactsOrganizationsSchemaVersions ¶

func (a ExternalContactsApi) GetExternalcontactsOrganizationsSchemaVersions(schemaId string) (*Dataschema, *APIResponse, error)

GetExternalcontactsOrganizationsSchemaVersions invokes GET /api/v2/externalcontacts/organizations/schemas/{schemaId}/versions

Get all versions of an external organization&#39;s schema

func (ExternalContactsApi) GetExternalcontactsOrganizationsSchemas ¶

func (a ExternalContactsApi) GetExternalcontactsOrganizationsSchemas() (*Dataschemalisting, *APIResponse, error)

GetExternalcontactsOrganizationsSchemas invokes GET /api/v2/externalcontacts/organizations/schemas

Get a list of schemas.

func (ExternalContactsApi) GetExternalcontactsRelationship ¶

func (a ExternalContactsApi) GetExternalcontactsRelationship(relationshipId string, expand string) (*Relationship, *APIResponse, error)

GetExternalcontactsRelationship invokes GET /api/v2/externalcontacts/relationships/{relationshipId}

Fetch a relationship

func (ExternalContactsApi) GetExternalcontactsReversewhitepageslookup ¶

func (a ExternalContactsApi) GetExternalcontactsReversewhitepageslookup(lookupVal string, expand []string) (*Reversewhitepageslookupresult, *APIResponse, error)

GetExternalcontactsReversewhitepageslookup invokes GET /api/v2/externalcontacts/reversewhitepageslookup

Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.

func (ExternalContactsApi) GetExternalcontactsScanContacts ¶

func (a ExternalContactsApi) GetExternalcontactsScanContacts(limit int, cursor string) (*Cursorcontactlisting, *APIResponse, error)

GetExternalcontactsScanContacts invokes GET /api/v2/externalcontacts/scan/contacts

Scan for external contacts using paging

func (ExternalContactsApi) GetExternalcontactsScanNotes ¶

func (a ExternalContactsApi) GetExternalcontactsScanNotes(limit int, cursor string) (*Cursornotelisting, *APIResponse, error)

GetExternalcontactsScanNotes invokes GET /api/v2/externalcontacts/scan/notes

Scan for notes using paging

func (ExternalContactsApi) GetExternalcontactsScanOrganizations ¶

func (a ExternalContactsApi) GetExternalcontactsScanOrganizations(limit int, cursor string) (*Cursororganizationlisting, *APIResponse, error)

GetExternalcontactsScanOrganizations invokes GET /api/v2/externalcontacts/scan/organizations

Scan for external organizations using paging

func (ExternalContactsApi) GetExternalcontactsScanRelationships ¶

func (a ExternalContactsApi) GetExternalcontactsScanRelationships(limit int, cursor string) (*Cursorrelationshiplisting, *APIResponse, error)

GetExternalcontactsScanRelationships invokes GET /api/v2/externalcontacts/scan/relationships

Scan for relationships

func (ExternalContactsApi) PostExternalcontactsBulkContacts ¶

func (a ExternalContactsApi) PostExternalcontactsBulkContacts(body Bulkidsrequest) (*Bulkfetchcontactsresponse, *APIResponse, error)

PostExternalcontactsBulkContacts invokes POST /api/v2/externalcontacts/bulk/contacts

Bulk fetch contacts

func (ExternalContactsApi) PostExternalcontactsBulkContactsAdd ¶

func (a ExternalContactsApi) PostExternalcontactsBulkContactsAdd(body Bulkcontactsrequest) (*Bulkcontactsresponse, *APIResponse, error)

PostExternalcontactsBulkContactsAdd invokes POST /api/v2/externalcontacts/bulk/contacts/add

Bulk add contacts

func (ExternalContactsApi) PostExternalcontactsBulkContactsRemove ¶

func (a ExternalContactsApi) PostExternalcontactsBulkContactsRemove(body Bulkidsrequest) (*Bulkdeleteresponse, *APIResponse, error)

PostExternalcontactsBulkContactsRemove invokes POST /api/v2/externalcontacts/bulk/contacts/remove

Bulk remove contacts

func (ExternalContactsApi) PostExternalcontactsBulkContactsUpdate ¶

func (a ExternalContactsApi) PostExternalcontactsBulkContactsUpdate(body Bulkcontactsrequest) (*Bulkcontactsresponse, *APIResponse, error)

PostExternalcontactsBulkContactsUpdate invokes POST /api/v2/externalcontacts/bulk/contacts/update

Bulk update contacts

func (ExternalContactsApi) PostExternalcontactsBulkNotes ¶

func (a ExternalContactsApi) PostExternalcontactsBulkNotes(body Bulkidsrequest) (*Bulkfetchnotesresponse, *APIResponse, error)

PostExternalcontactsBulkNotes invokes POST /api/v2/externalcontacts/bulk/notes

Bulk fetch notes

func (ExternalContactsApi) PostExternalcontactsBulkNotesAdd ¶

func (a ExternalContactsApi) PostExternalcontactsBulkNotesAdd(body Bulknotesrequest) (*Bulknotesresponse, *APIResponse, error)

PostExternalcontactsBulkNotesAdd invokes POST /api/v2/externalcontacts/bulk/notes/add

Bulk add notes

func (ExternalContactsApi) PostExternalcontactsBulkNotesRemove ¶

func (a ExternalContactsApi) PostExternalcontactsBulkNotesRemove(body Bulkidsrequest) (*Bulkdeleteresponse, *APIResponse, error)

PostExternalcontactsBulkNotesRemove invokes POST /api/v2/externalcontacts/bulk/notes/remove

Bulk remove notes

func (ExternalContactsApi) PostExternalcontactsBulkNotesUpdate ¶

func (a ExternalContactsApi) PostExternalcontactsBulkNotesUpdate(body Bulknotesrequest) (*Bulknotesresponse, *APIResponse, error)

PostExternalcontactsBulkNotesUpdate invokes POST /api/v2/externalcontacts/bulk/notes/update

Bulk update notes

func (ExternalContactsApi) PostExternalcontactsBulkOrganizations ¶

func (a ExternalContactsApi) PostExternalcontactsBulkOrganizations(body Bulkidsrequest) (*Bulkfetchorganizationsresponse, *APIResponse, error)

PostExternalcontactsBulkOrganizations invokes POST /api/v2/externalcontacts/bulk/organizations

Bulk fetch organizations

func (ExternalContactsApi) PostExternalcontactsBulkOrganizationsAdd ¶

func (a ExternalContactsApi) PostExternalcontactsBulkOrganizationsAdd(body Bulkorganizationsrequest) (*Bulkorganizationsresponse, *APIResponse, error)

PostExternalcontactsBulkOrganizationsAdd invokes POST /api/v2/externalcontacts/bulk/organizations/add

Bulk add organizations

func (ExternalContactsApi) PostExternalcontactsBulkOrganizationsRemove ¶

func (a ExternalContactsApi) PostExternalcontactsBulkOrganizationsRemove(body Bulkidsrequest) (*Bulkdeleteresponse, *APIResponse, error)

PostExternalcontactsBulkOrganizationsRemove invokes POST /api/v2/externalcontacts/bulk/organizations/remove

Bulk remove organizations

func (ExternalContactsApi) PostExternalcontactsBulkOrganizationsUpdate ¶

func (a ExternalContactsApi) PostExternalcontactsBulkOrganizationsUpdate(body Bulkorganizationsrequest) (*Bulkorganizationsresponse, *APIResponse, error)

PostExternalcontactsBulkOrganizationsUpdate invokes POST /api/v2/externalcontacts/bulk/organizations/update

Bulk update organizations

func (ExternalContactsApi) PostExternalcontactsBulkRelationships ¶

func (a ExternalContactsApi) PostExternalcontactsBulkRelationships(body Bulkidsrequest) (*Bulkfetchrelationshipsresponse, *APIResponse, error)

PostExternalcontactsBulkRelationships invokes POST /api/v2/externalcontacts/bulk/relationships

Bulk fetch relationships

func (ExternalContactsApi) PostExternalcontactsBulkRelationshipsAdd ¶

func (a ExternalContactsApi) PostExternalcontactsBulkRelationshipsAdd(body Bulkrelationshipsrequest) (*Bulkrelationshipsresponse, *APIResponse, error)

PostExternalcontactsBulkRelationshipsAdd invokes POST /api/v2/externalcontacts/bulk/relationships/add

Bulk add relationships

func (ExternalContactsApi) PostExternalcontactsBulkRelationshipsRemove ¶

func (a ExternalContactsApi) PostExternalcontactsBulkRelationshipsRemove(body Bulkidsrequest) (*Bulkdeleteresponse, *APIResponse, error)

PostExternalcontactsBulkRelationshipsRemove invokes POST /api/v2/externalcontacts/bulk/relationships/remove

Bulk remove relationships

func (ExternalContactsApi) PostExternalcontactsBulkRelationshipsUpdate ¶

func (a ExternalContactsApi) PostExternalcontactsBulkRelationshipsUpdate(body Bulkrelationshipsrequest) (*Bulkrelationshipsresponse, *APIResponse, error)

PostExternalcontactsBulkRelationshipsUpdate invokes POST /api/v2/externalcontacts/bulk/relationships/update

Bulk update relationships

func (ExternalContactsApi) PostExternalcontactsContactNotes ¶

func (a ExternalContactsApi) PostExternalcontactsContactNotes(contactId string, body Note) (*Note, *APIResponse, error)

PostExternalcontactsContactNotes invokes POST /api/v2/externalcontacts/contacts/{contactId}/notes

Create a note for an external contact

func (ExternalContactsApi) PostExternalcontactsContacts ¶

func (a ExternalContactsApi) PostExternalcontactsContacts(body Externalcontact) (*Externalcontact, *APIResponse, error)

PostExternalcontactsContacts invokes POST /api/v2/externalcontacts/contacts

Create an external contact

func (ExternalContactsApi) PostExternalcontactsContactsSchemas ¶

func (a ExternalContactsApi) PostExternalcontactsContactsSchemas(body Dataschema) (*Dataschema, *APIResponse, error)

PostExternalcontactsContactsSchemas invokes POST /api/v2/externalcontacts/contacts/schemas

Create a schema

func (ExternalContactsApi) PostExternalcontactsOrganizationNotes ¶

func (a ExternalContactsApi) PostExternalcontactsOrganizationNotes(externalOrganizationId string, body Note) (*Note, *APIResponse, error)

PostExternalcontactsOrganizationNotes invokes POST /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes

Create a note for an external organization

func (ExternalContactsApi) PostExternalcontactsOrganizations ¶

func (a ExternalContactsApi) PostExternalcontactsOrganizations(body Externalorganization) (*Externalorganization, *APIResponse, error)

PostExternalcontactsOrganizations invokes POST /api/v2/externalcontacts/organizations

Create an external organization

func (ExternalContactsApi) PostExternalcontactsOrganizationsSchemas ¶

func (a ExternalContactsApi) PostExternalcontactsOrganizationsSchemas(body Dataschema) (*Dataschema, *APIResponse, error)

PostExternalcontactsOrganizationsSchemas invokes POST /api/v2/externalcontacts/organizations/schemas

Create a schema

func (ExternalContactsApi) PostExternalcontactsRelationships ¶

func (a ExternalContactsApi) PostExternalcontactsRelationships(body Relationship) (*Relationship, *APIResponse, error)

PostExternalcontactsRelationships invokes POST /api/v2/externalcontacts/relationships

Create a relationship

func (ExternalContactsApi) PutExternalcontactsContact ¶

func (a ExternalContactsApi) PutExternalcontactsContact(contactId string, body Externalcontact) (*Externalcontact, *APIResponse, error)

PutExternalcontactsContact invokes PUT /api/v2/externalcontacts/contacts/{contactId}

Update an external contact

func (ExternalContactsApi) PutExternalcontactsContactNote ¶

func (a ExternalContactsApi) PutExternalcontactsContactNote(contactId string, noteId string, body Note) (*Note, *APIResponse, error)

PutExternalcontactsContactNote invokes PUT /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}

Update a note for an external contact

func (ExternalContactsApi) PutExternalcontactsContactsSchema ¶

func (a ExternalContactsApi) PutExternalcontactsContactsSchema(schemaId string, body Dataschema) (*Dataschema, *APIResponse, error)

PutExternalcontactsContactsSchema invokes PUT /api/v2/externalcontacts/contacts/schemas/{schemaId}

Update a schema

func (ExternalContactsApi) PutExternalcontactsConversation ¶

func (a ExternalContactsApi) PutExternalcontactsConversation(body Conversationassociation, conversationId string) (*APIResponse, error)

PutExternalcontactsConversation invokes PUT /api/v2/externalcontacts/conversations/{conversationId}

Associate/disassociate an external contact with a conversation

To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.

func (ExternalContactsApi) PutExternalcontactsOrganization ¶

func (a ExternalContactsApi) PutExternalcontactsOrganization(externalOrganizationId string, body Externalorganization) (*Externalorganization, *APIResponse, error)

PutExternalcontactsOrganization invokes PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}

Update an external organization

func (ExternalContactsApi) PutExternalcontactsOrganizationNote ¶

func (a ExternalContactsApi) PutExternalcontactsOrganizationNote(externalOrganizationId string, noteId string, body Note) (*Note, *APIResponse, error)

PutExternalcontactsOrganizationNote invokes PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}

Update a note for an external organization

func (ExternalContactsApi) PutExternalcontactsOrganizationTrustorTrustorId ¶

func (a ExternalContactsApi) PutExternalcontactsOrganizationTrustorTrustorId(externalOrganizationId string, trustorId string) (*Externalorganizationtrustorlink, *APIResponse, error)

PutExternalcontactsOrganizationTrustorTrustorId invokes PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}

Links a Trustor with an External Organization

func (ExternalContactsApi) PutExternalcontactsOrganizationsSchema ¶

func (a ExternalContactsApi) PutExternalcontactsOrganizationsSchema(schemaId string, body Dataschema) (*Dataschema, *APIResponse, error)

PutExternalcontactsOrganizationsSchema invokes PUT /api/v2/externalcontacts/organizations/schemas/{schemaId}

Update a schema

func (ExternalContactsApi) PutExternalcontactsRelationship ¶

func (a ExternalContactsApi) PutExternalcontactsRelationship(relationshipId string, body Relationship) (*Relationship, *APIResponse, error)

PutExternalcontactsRelationship invokes PUT /api/v2/externalcontacts/relationships/{relationshipId}

Update a relationship

type Externalcontact ¶

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

	// FirstName - The first name of the contact.
	FirstName *string `json:"firstName,omitempty"`

	// MiddleName
	MiddleName *string `json:"middleName,omitempty"`

	// LastName - The last name of the contact.
	LastName *string `json:"lastName,omitempty"`

	// Salutation
	Salutation *string `json:"salutation,omitempty"`

	// Title
	Title *string `json:"title,omitempty"`

	// WorkPhone
	WorkPhone *Phonenumber `json:"workPhone,omitempty"`

	// CellPhone
	CellPhone *Phonenumber `json:"cellPhone,omitempty"`

	// HomePhone
	HomePhone *Phonenumber `json:"homePhone,omitempty"`

	// OtherPhone
	OtherPhone *Phonenumber `json:"otherPhone,omitempty"`

	// WorkEmail
	WorkEmail *string `json:"workEmail,omitempty"`

	// PersonalEmail
	PersonalEmail *string `json:"personalEmail,omitempty"`

	// OtherEmail
	OtherEmail *string `json:"otherEmail,omitempty"`

	// Address
	Address *Contactaddress `json:"address,omitempty"`

	// TwitterId
	TwitterId *Twitterid `json:"twitterId,omitempty"`

	// LineId
	LineId *Lineid `json:"lineId,omitempty"`

	// WhatsAppId
	WhatsAppId *Whatsappid `json:"whatsAppId,omitempty"`

	// FacebookId
	FacebookId *Facebookid `json:"facebookId,omitempty"`

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

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

	// ExternalOrganization
	ExternalOrganization *Externalorganization `json:"externalOrganization,omitempty"`

	// SurveyOptOut
	SurveyOptOut *bool `json:"surveyOptOut,omitempty"`

	// ExternalSystemUrl - A string that identifies an external system-of-record resource that may have more detailed information on the contact. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace.
	ExternalSystemUrl *string `json:"externalSystemUrl,omitempty"`

	// Schema - The schema defining custom fields for this contact
	Schema *Dataschema `json:"schema,omitempty"`

	// CustomFields - Custom fields defined in the schema referenced by schemaId and schemaVersion.
	CustomFields *map[string]interface{} `json:"customFields,omitempty"`

	// ExternalDataSources - Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record.  Read-only, and only populated when requested via expand param.
	ExternalDataSources *[]Externaldatasource `json:"externalDataSources,omitempty"`

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

Externalcontact

func (*Externalcontact) String ¶

func (o *Externalcontact) String() string

String returns a JSON representation of the model

type Externaldatasource ¶

type Externaldatasource struct {
	// Platform - The platform that was the source of the data.  Example: a CRM like SALESFORCE.
	Platform *string `json:"platform,omitempty"`

	// Url - An URL that links to the source record that contributed data to the associated entity.
	Url *string `json:"url,omitempty"`
}

Externaldatasource - Describes a link to a record in an external system that contributed data to a Relate record

func (*Externaldatasource) String ¶

func (o *Externaldatasource) String() string

String returns a JSON representation of the model

type Externalorganization ¶

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

	// Name - The name of the company.
	Name *string `json:"name,omitempty"`

	// CompanyType
	CompanyType *string `json:"companyType,omitempty"`

	// Industry
	Industry *string `json:"industry,omitempty"`

	// PrimaryContactId
	PrimaryContactId *string `json:"primaryContactId,omitempty"`

	// Address
	Address *Contactaddress `json:"address,omitempty"`

	// PhoneNumber
	PhoneNumber *Phonenumber `json:"phoneNumber,omitempty"`

	// FaxNumber
	FaxNumber *Phonenumber `json:"faxNumber,omitempty"`

	// EmployeeCount
	EmployeeCount *int `json:"employeeCount,omitempty"`

	// Revenue
	Revenue *int `json:"revenue,omitempty"`

	// Tags
	Tags *[]string `json:"tags,omitempty"`

	// Websites
	Websites *[]string `json:"websites,omitempty"`

	// Tickers
	Tickers *[]Ticker `json:"tickers,omitempty"`

	// TwitterId
	TwitterId *Twitterid `json:"twitterId,omitempty"`

	// ExternalSystemUrl - A string that identifies an external system-of-record resource that may have more detailed information on the organization. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace.
	ExternalSystemUrl *string `json:"externalSystemUrl,omitempty"`

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

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

	// Trustor
	Trustor *Trustor `json:"trustor,omitempty"`

	// Schema - The schema defining custom fields for this contact
	Schema *Dataschema `json:"schema,omitempty"`

	// CustomFields - Custom fields defined in the schema referenced by schemaId and schemaVersion.
	CustomFields *map[string]interface{} `json:"customFields,omitempty"`

	// ExternalDataSources - Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record.  Read-only, and only populated when requested via expand param.
	ExternalDataSources *[]Externaldatasource `json:"externalDataSources,omitempty"`

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

Externalorganization

func (*Externalorganization) String ¶

func (o *Externalorganization) String() string

String returns a JSON representation of the model

type Externalorganizationlisting ¶

type Externalorganizationlisting struct {
	// Entities
	Entities *[]Externalorganization `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"`

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

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

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

Externalorganizationlisting

func (*Externalorganizationlisting) String ¶

func (o *Externalorganizationlisting) String() string

String returns a JSON representation of the model

type Externalorganizationtrustorlink struct {
	// ExternalOrganizationId - The id of a PureCloud External Organization entity in the External Contacts system that will be used to represent the trustor org
	ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"`

	// TrustorOrgId - The id of a PureCloud organization that has granted trust to this PureCloud organization
	TrustorOrgId *string `json:"trustorOrgId,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"`

	// ExternalOrganizationUri - The URI for the External Organization that is linked to the trustor org
	ExternalOrganizationUri *string `json:"externalOrganizationUri,omitempty"`
}

Externalorganizationtrustorlink

func (*Externalorganizationtrustorlink) String ¶

String returns a JSON representation of the model

type Externalsegment ¶

type Externalsegment struct {
	// Id - Identifier for the external segment in the system where it originates from.
	Id *string `json:"id,omitempty"`

	// Name - Name for the external segment in the system where it originates from.
	Name *string `json:"name,omitempty"`

	// Source - The external system where the segment originates from.
	Source *string `json:"source,omitempty"`
}

Externalsegment

func (*Externalsegment) String ¶

func (o *Externalsegment) String() string

String returns a JSON representation of the model

type Facebookappcredentials ¶

type Facebookappcredentials struct {
	// Id - Genesys Cloud Facebook App Id
	Id *string `json:"id,omitempty"`
}

Facebookappcredentials

func (*Facebookappcredentials) String ¶

func (o *Facebookappcredentials) String() string

String returns a JSON representation of the model

type Facebookid ¶

type Facebookid struct {
	// Ids - The set of scopedIds that this person has. Each scopedId is specific to a page or app that the user interacts with.
	Ids *[]Facebookscopedid `json:"ids,omitempty"`

	// DisplayName - The displayName of this person's Facebook account. Roughly translates to user.first_name + ' ' + user.last_name in the Facebook API.
	DisplayName *string `json:"displayName,omitempty"`
}

Facebookid - User information for a Facebook user interacting with a page or app

func (*Facebookid) String ¶

func (o *Facebookid) String() string

String returns a JSON representation of the model

type Facebookintegration ¶

type Facebookintegration struct {
	// Id - A unique Integration Id.
	Id *string `json:"id,omitempty"`

	// Name - The name of the Facebook Integration
	Name *string `json:"name,omitempty"`

	// AppId - The App Id from Facebook messenger
	AppId *string `json:"appId,omitempty"`

	// PageId - The Page Id from Facebook messenger
	PageId *string `json:"pageId,omitempty"`

	// Status - The status of the Facebook Integration
	Status *string `json:"status,omitempty"`

	// Recipient - The recipient reference associated to the Facebook Integration. This recipient is used to associate a flow to an integration
	Recipient *Domainentityref `json:"recipient,omitempty"`

	// DateCreated - Date this Integration 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"`

	// DateModified - Date this Integration was 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"`

	// CreatedBy - User reference that created this Integration
	CreatedBy *Domainentityref `json:"createdBy,omitempty"`

	// ModifiedBy - User reference that last modified this Integration
	ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"`

	// Version - Version number required for updates.
	Version *int `json:"version,omitempty"`

	// CreateStatus - Status of asynchronous create operation
	CreateStatus *string `json:"createStatus,omitempty"`

	// CreateError - Error information returned, if createStatus is set to Error
	CreateError *Errorbody `json:"createError,omitempty"`

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

Facebookintegration

func (*Facebookintegration) String ¶

func (o *Facebookintegration) String() string

String returns a JSON representation of the model

type Facebookintegrationentitylisting ¶

type Facebookintegrationentitylisting struct {
	// Entities
	Entities *[]Facebookintegration `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"`

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

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

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

Facebookintegrationentitylisting

func (*Facebookintegrationentitylisting) String ¶

String returns a JSON representation of the model

type Facebookintegrationrequest ¶

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

	// Name - The name of the Facebook Integration
	Name *string `json:"name,omitempty"`

	// PageAccessToken - The long-lived Page Access Token of a facebook page.  See https://developers.facebook.com/docs/facebook-login/access-tokens.  When a pageAccessToken is provided, pageId and userAccessToken are not required.
	PageAccessToken *string `json:"pageAccessToken,omitempty"`

	// UserAccessToken - The short-lived User Access Token of the facebook user logged into the facebook app.  See https://developers.facebook.com/docs/facebook-login/access-tokens.  When userAccessToken is provided, pageId is mandatory.  When userAccessToken/pageId combination is provided, pageAccessToken is not required.
	UserAccessToken *string `json:"userAccessToken,omitempty"`

	// PageId - The page Id of a facebook page. The pageId is required when userAccessToken is provided.
	PageId *string `json:"pageId,omitempty"`

	// AppId - The app Id of a facebook app. The appId is required when a customer wants to use their own approved facebook app.
	AppId *string `json:"appId,omitempty"`

	// AppSecret - The app Secret of a facebook app. The appSecret is required when appId is provided.
	AppSecret *string `json:"appSecret,omitempty"`

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

Facebookintegrationrequest

func (*Facebookintegrationrequest) String ¶

func (o *Facebookintegrationrequest) String() string

String returns a JSON representation of the model

type Facebookintegrationupdaterequest ¶

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

	// Name - The name of the Facebook Integration
	Name *string `json:"name,omitempty"`

	// PageAccessToken - The long-lived Page Access Token of a facebook page.  See https://developers.facebook.com/docs/facebook-login/access-tokens.  Either pageAccessToken or userAccessToken should be provided.
	PageAccessToken *string `json:"pageAccessToken,omitempty"`

	// UserAccessToken - The short-lived User Access Token of the facebook user logged into the facebook app.  See https://developers.facebook.com/docs/facebook-login/access-tokens.  Either pageAccessToken or userAccessToken should be provided.
	UserAccessToken *string `json:"userAccessToken,omitempty"`

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

Facebookintegrationupdaterequest

func (*Facebookintegrationupdaterequest) String ¶

String returns a JSON representation of the model

type Facebookscopedid ¶

type Facebookscopedid struct {
	// ScopedId - The unique page/app-specific scopedId for the user
	ScopedId *string `json:"scopedId,omitempty"`
}

Facebookscopedid - Scoped ID for a Facebook user interacting with a page or app

func (*Facebookscopedid) String ¶

func (o *Facebookscopedid) String() string

String returns a JSON representation of the model

type Facet ¶

type Facet 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"`
}

Facet

func (*Facet) String ¶

func (o *Facet) String() string

String returns a JSON representation of the model

type Facetentry ¶

type Facetentry struct {
	// Attribute
	Attribute *Termattribute `json:"attribute,omitempty"`

	// Statistics
	Statistics *Facetstatistics `json:"statistics,omitempty"`

	// Other
	Other *int `json:"other,omitempty"`

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

	// Missing
	Missing *int `json:"missing,omitempty"`

	// TermCount
	TermCount *int `json:"termCount,omitempty"`

	// TermType
	TermType *string `json:"termType,omitempty"`

	// Terms
	Terms *[]Facetterm `json:"terms,omitempty"`
}

Facetentry

func (*Facetentry) String ¶

func (o *Facetentry) String() string

String returns a JSON representation of the model

type Facetinfo ¶

type Facetinfo struct {
	// Name - The name of the field that was faceted on.
	Name *string `json:"name,omitempty"`

	// Entries - The entries resulting from this facet.
	Entries *[]Entry `json:"entries,omitempty"`
}

Facetinfo

func (*Facetinfo) String ¶

func (o *Facetinfo) String() string

String returns a JSON representation of the model

type Facetkeyattribute ¶

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

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

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

Facetkeyattribute

func (*Facetkeyattribute) String ¶

func (o *Facetkeyattribute) String() string

String returns a JSON representation of the model

type Facetstatistics ¶

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

	// Min
	Min *float64 `json:"min,omitempty"`

	// Max
	Max *float64 `json:"max,omitempty"`

	// Mean
	Mean *float64 `json:"mean,omitempty"`

	// StdDeviation
	StdDeviation *float64 `json:"stdDeviation,omitempty"`

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

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

Facetstatistics

func (*Facetstatistics) String ¶

func (o *Facetstatistics) String() string

String returns a JSON representation of the model

type Facetterm ¶

type Facetterm struct {
	// Term
	Term *string `json:"term,omitempty"`

	// Key
	Key *int `json:"key,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

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

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

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

Facetterm

func (*Facetterm) String ¶

func (o *Facetterm) String() string

String returns a JSON representation of the model

type Failedobject ¶

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

	// Version
	Version *string `json:"version,omitempty"`

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

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

Failedobject

func (*Failedobject) String ¶

func (o *Failedobject) String() string

String returns a JSON representation of the model

type FaxApi ¶

type FaxApi struct {
	Configuration *Configuration
}

FaxApi provides functions for API endpoints

func NewFaxApi ¶

func NewFaxApi() *FaxApi

NewFaxApi creates an API instance using the default configuration

func NewFaxApiWithConfig ¶

func NewFaxApiWithConfig(config *Configuration) *FaxApi

NewFaxApiWithConfig creates an API instance using the provided configuration

func (FaxApi) DeleteFaxDocument ¶

func (a FaxApi) DeleteFaxDocument(documentId string) (*APIResponse, error)

DeleteFaxDocument invokes DELETE /api/v2/fax/documents/{documentId}

Delete a fax document.

func (FaxApi) GetFaxDocument ¶

func (a FaxApi) GetFaxDocument(documentId string) (*Faxdocument, *APIResponse, error)

GetFaxDocument invokes GET /api/v2/fax/documents/{documentId}

Get a document.

func (FaxApi) GetFaxDocumentContent ¶

func (a FaxApi) GetFaxDocumentContent(documentId string) (*Downloadresponse, *APIResponse, error)

GetFaxDocumentContent invokes GET /api/v2/fax/documents/{documentId}/content

Download a fax document.

func (FaxApi) GetFaxDocuments ¶

func (a FaxApi) GetFaxDocuments(pageSize int, pageNumber int) (*Faxdocumententitylisting, *APIResponse, error)

GetFaxDocuments invokes GET /api/v2/fax/documents

Get a list of fax documents.

func (FaxApi) GetFaxSummary ¶

func (a FaxApi) GetFaxSummary() (*Faxsummary, *APIResponse, error)

GetFaxSummary invokes GET /api/v2/fax/summary

Get fax summary

func (FaxApi) PutFaxDocument ¶

func (a FaxApi) PutFaxDocument(documentId string, body Faxdocument) (*Faxdocument, *APIResponse, error)

PutFaxDocument invokes PUT /api/v2/fax/documents/{documentId}

Update a fax document.

type Faxdocument ¶

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

	// Name
	Name *string `json:"name,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"`

	// 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"`

	// ContentUri
	ContentUri *string `json:"contentUri,omitempty"`

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

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

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

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

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

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

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

	// CallerAddress
	CallerAddress *string `json:"callerAddress,omitempty"`

	// ReceiverAddress
	ReceiverAddress *string `json:"receiverAddress,omitempty"`

	// Thumbnails
	Thumbnails *[]Documentthumbnail `json:"thumbnails,omitempty"`

	// SharingUri
	SharingUri *string `json:"sharingUri,omitempty"`

	// DownloadSharingUri
	DownloadSharingUri *string `json:"downloadSharingUri,omitempty"`

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

Faxdocument

func (*Faxdocument) String ¶

func (o *Faxdocument) String() string

String returns a JSON representation of the model

type Faxdocumententitylisting ¶

type Faxdocumententitylisting struct {
	// Entities
	Entities *[]Faxdocument `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"`

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

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

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

Faxdocumententitylisting

func (*Faxdocumententitylisting) String ¶

func (o *Faxdocumententitylisting) String() string

String returns a JSON representation of the model

type Faxsendrequest ¶

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

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

	// Addresses - A list of outbound fax dialing addresses. E.g. +13175555555 or 3175555555
	Addresses *[]string `json:"addresses,omitempty"`

	// DocumentId - DocumentId of Content Management artifact. If Content Management document is not used for faxing, documentId should be null
	DocumentId *string `json:"documentId,omitempty"`

	// ContentType - The content type that is going to be uploaded. If Content Management document is used for faxing, contentType will be ignored
	ContentType *string `json:"contentType,omitempty"`

	// Workspace - Workspace in which the document should be stored. If Content Management document is used for faxing, workspace will be ignored
	Workspace *Workspace `json:"workspace,omitempty"`

	// CoverSheet - Data for coversheet generation.
	CoverSheet *Coversheet `json:"coverSheet,omitempty"`

	// TimeZoneOffsetMinutes - Time zone offset minutes from GMT
	TimeZoneOffsetMinutes *int `json:"timeZoneOffsetMinutes,omitempty"`

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

Faxsendrequest

func (*Faxsendrequest) String ¶

func (o *Faxsendrequest) String() string

String returns a JSON representation of the model

type Faxsendresponse ¶

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

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

	// UploadDestinationUri
	UploadDestinationUri *string `json:"uploadDestinationUri,omitempty"`

	// UploadMethodType
	UploadMethodType *string `json:"uploadMethodType,omitempty"`

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

Faxsendresponse

func (*Faxsendresponse) String ¶

func (o *Faxsendresponse) String() string

String returns a JSON representation of the model

type Faxstatus ¶

type Faxstatus struct {
	// Direction - The fax direction, either \"send\" or \"receive\".
	Direction *string `json:"direction,omitempty"`

	// ExpectedPages - Total number of expected pages, if known.
	ExpectedPages *int `json:"expectedPages,omitempty"`

	// ActivePage - Active page of the transmission.
	ActivePage *int `json:"activePage,omitempty"`

	// LinesTransmitted - Number of lines that have completed transmission.
	LinesTransmitted *int `json:"linesTransmitted,omitempty"`

	// BytesTransmitted - Number of bytes that have competed transmission.
	BytesTransmitted *int `json:"bytesTransmitted,omitempty"`

	// BaudRate - Current signaling rate of transmission, baud rate.
	BaudRate *int `json:"baudRate,omitempty"`

	// PageErrors - Number of page errors.
	PageErrors *int `json:"pageErrors,omitempty"`

	// LineErrors - Number of line errors.
	LineErrors *int `json:"lineErrors,omitempty"`
}

Faxstatus

func (*Faxstatus) String ¶

func (o *Faxstatus) String() string

String returns a JSON representation of the model

type Faxsummary ¶

type Faxsummary struct {
	// ReadCount
	ReadCount *int `json:"readCount,omitempty"`

	// UnreadCount
	UnreadCount *int `json:"unreadCount,omitempty"`

	// TotalCount
	TotalCount *int `json:"totalCount,omitempty"`
}

Faxsummary

func (*Faxsummary) String ¶

func (o *Faxsummary) String() string

String returns a JSON representation of the model

type Faxtopicfaxdatav2 ¶

type Faxtopicfaxdatav2 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 *Faxtopicworkspacedata `json:"workspace,omitempty"`

	// CreatedBy
	CreatedBy *Faxtopicuserdata `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 *Faxtopicuserdata `json:"uploadedBy,omitempty"`

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

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

	// CallerAddress
	CallerAddress *string `json:"callerAddress,omitempty"`

	// ReceiverAddress
	ReceiverAddress *string `json:"receiverAddress,omitempty"`

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

Faxtopicfaxdatav2

func (*Faxtopicfaxdatav2) String ¶

func (o *Faxtopicfaxdatav2) String() string

String returns a JSON representation of the model

type Faxtopiclockdata ¶

type Faxtopiclockdata struct {
	// LockedBy
	LockedBy *Faxtopicuserdata `json:"lockedBy,omitempty"`

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

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

Faxtopiclockdata

func (*Faxtopiclockdata) String ¶

func (o *Faxtopiclockdata) String() string

String returns a JSON representation of the model

type Faxtopicuserdata ¶

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

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

Faxtopicuserdata

func (*Faxtopicuserdata) String ¶

func (o *Faxtopicuserdata) String() string

String returns a JSON representation of the model

type Faxtopicworkspacedata ¶

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

Faxtopicworkspacedata

func (*Faxtopicworkspacedata) String ¶

func (o *Faxtopicworkspacedata) String() string

String returns a JSON representation of the model

type Featurestate ¶

type Featurestate struct {
	// Enabled
	Enabled *bool `json:"enabled,omitempty"`
}

Featurestate

func (*Featurestate) String ¶

func (o *Featurestate) String() string

String returns a JSON representation of the model

type Fieldconfig ¶

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

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

	// EntityType
	EntityType *string `json:"entityType,omitempty"`

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

	// Sections
	Sections *[]Section `json:"sections,omitempty"`

	// Version
	Version *string `json:"version,omitempty"`

	// SchemaVersion
	SchemaVersion *string `json:"schemaVersion,omitempty"`

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

Fieldconfig

func (*Fieldconfig) String ¶

func (o *Fieldconfig) String() string

String returns a JSON representation of the model

type Fieldconfigs ¶

type Fieldconfigs struct {
	// Org
	Org *Fieldconfig `json:"org,omitempty"`

	// Person
	Person *Fieldconfig `json:"person,omitempty"`

	// Group
	Group *Fieldconfig `json:"group,omitempty"`

	// ExternalContact
	ExternalContact *Fieldconfig `json:"externalContact,omitempty"`
}

Fieldconfigs

func (*Fieldconfigs) String ¶

func (o *Fieldconfigs) String() string

String returns a JSON representation of the model

type Fieldlist ¶

type Fieldlist struct {
	// CustomLabels
	CustomLabels *bool `json:"customLabels,omitempty"`

	// InstructionText
	InstructionText *string `json:"instructionText,omitempty"`

	// Key
	Key *string `json:"key,omitempty"`

	// LabelKeys
	LabelKeys *[]string `json:"labelKeys,omitempty"`

	// Params
	Params *map[string]interface{} `json:"params,omitempty"`

	// Repeatable
	Repeatable *bool `json:"repeatable,omitempty"`

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

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

	// Required
	Required *bool `json:"required,omitempty"`
}

Fieldlist

func (*Fieldlist) String ¶

func (o *Fieldlist) String() string

String returns a JSON representation of the model

type Filter ¶

type Filter 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"`
}

Filter

func (*Filter) String ¶

func (o *Filter) String() string

String returns a JSON representation of the model

type Filterpreviewresponse ¶

type Filterpreviewresponse struct {
	// FilteredContacts
	FilteredContacts *int `json:"filteredContacts,omitempty"`

	// TotalContacts
	TotalContacts *int `json:"totalContacts,omitempty"`

	// Preview
	Preview *[]Dialercontact `json:"preview,omitempty"`
}

Filterpreviewresponse

func (*Filterpreviewresponse) String ¶

func (o *Filterpreviewresponse) String() string

String returns a JSON representation of the model

type Flow ¶

type Flow struct {
	// Id - The flow identifier
	Id *string `json:"id,omitempty"`

	// Name - The flow name
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Writabledivision `json:"division,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

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

	// LockedUser - User that has the flow locked.
	LockedUser *User `json:"lockedUser,omitempty"`

	// LockedClient - OAuth client that has the flow locked.
	LockedClient *Domainentityref `json:"lockedClient,omitempty"`

	// Active
	Active *bool `json:"active,omitempty"`

	// System
	System *bool `json:"system,omitempty"`

	// Deleted
	Deleted *bool `json:"deleted,omitempty"`

	// PublishedVersion
	PublishedVersion *Flowversion `json:"publishedVersion,omitempty"`

	// SavedVersion
	SavedVersion *Flowversion `json:"savedVersion,omitempty"`

	// InputSchema - json schema describing the inputs for the flow
	InputSchema *interface{} `json:"inputSchema,omitempty"`

	// OutputSchema - json schema describing the outputs for the flow
	OutputSchema *interface{} `json:"outputSchema,omitempty"`

	// CheckedInVersion
	CheckedInVersion *Flowversion `json:"checkedInVersion,omitempty"`

	// DebugVersion
	DebugVersion *Flowversion `json:"debugVersion,omitempty"`

	// PublishedBy
	PublishedBy *User `json:"publishedBy,omitempty"`

	// CurrentOperation
	CurrentOperation *Operation `json:"currentOperation,omitempty"`

	// NluInfo - Information about the natural language understanding configuration for the published version of the flow
	NluInfo *Nluinfo `json:"nluInfo,omitempty"`

	// SupportedLanguages - List of supported languages for the published version of the flow.
	SupportedLanguages *[]Supportedlanguage `json:"supportedLanguages,omitempty"`

	// CompatibleFlowTypes - Compatible flow types designate which flow types are allowed to embed a flow’s configuration within their own flow configuration.  Currently the only flows that can be embedded are Common Module flows and the embedding flow can invoke them using the Call Common Module action.
	CompatibleFlowTypes *[]string `json:"compatibleFlowTypes,omitempty"`

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

Flow

func (*Flow) String ¶

func (o *Flow) String() string

String returns a JSON representation of the model

type Flowaggregatedatacontainer ¶

type Flowaggregatedatacontainer struct {
	// Group - A mapping from dimension to value
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Statisticalresponse `json:"data,omitempty"`
}

Flowaggregatedatacontainer

func (*Flowaggregatedatacontainer) String ¶

func (o *Flowaggregatedatacontainer) String() string

String returns a JSON representation of the model

type Flowaggregatequeryclause ¶

type Flowaggregatequeryclause 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 *[]Flowaggregatequerypredicate `json:"predicates,omitempty"`
}

Flowaggregatequeryclause

func (*Flowaggregatequeryclause) String ¶

func (o *Flowaggregatequeryclause) String() string

String returns a JSON representation of the model

type Flowaggregatequeryfilter ¶

type Flowaggregatequeryfilter 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 *[]Flowaggregatequeryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Flowaggregatequerypredicate `json:"predicates,omitempty"`
}

Flowaggregatequeryfilter

func (*Flowaggregatequeryfilter) String ¶

func (o *Flowaggregatequeryfilter) String() string

String returns a JSON representation of the model

type Flowaggregatequerypredicate ¶

type Flowaggregatequerypredicate 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"`
}

Flowaggregatequerypredicate

func (*Flowaggregatequerypredicate) String ¶

func (o *Flowaggregatequerypredicate) String() string

String returns a JSON representation of the model

type Flowaggregatequeryresponse ¶

type Flowaggregatequeryresponse struct {
	// Results
	Results *[]Flowaggregatedatacontainer `json:"results,omitempty"`
}

Flowaggregatequeryresponse

func (*Flowaggregatequeryresponse) String ¶

func (o *Flowaggregatequeryresponse) String() string

String returns a JSON representation of the model

type Flowaggregationquery ¶

type Flowaggregationquery 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 *Flowaggregatequeryfilter `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 *[]Flowaggregationview `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"`
}

Flowaggregationquery

func (*Flowaggregationquery) String ¶

func (o *Flowaggregationquery) String() string

String returns a JSON representation of the model

type Flowaggregationview ¶

type Flowaggregationview 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"`
}

Flowaggregationview

func (*Flowaggregationview) String ¶

func (o *Flowaggregationview) String() string

String returns a JSON representation of the model

type Flowdiagnosticinfo ¶

type Flowdiagnosticinfo struct {
	// LastActionId - The step number of the survey invite flow where the error occurred.
	LastActionId *int `json:"lastActionId,omitempty"`
}

Flowdiagnosticinfo

func (*Flowdiagnosticinfo) String ¶

func (o *Flowdiagnosticinfo) String() string

String returns a JSON representation of the model

type Flowdivisionview ¶

type Flowdivisionview struct {
	// Id - The flow identifier
	Id *string `json:"id,omitempty"`

	// Name - The flow name
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Writabledivision `json:"division,omitempty"`

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

	// InputSchema - json schema describing the inputs for the flow
	InputSchema *Jsonschemadocument `json:"inputSchema,omitempty"`

	// OutputSchema - json schema describing the outputs for the flow
	OutputSchema *Jsonschemadocument `json:"outputSchema,omitempty"`

	// PublishedVersion - published version information if there is a published version
	PublishedVersion *Flowversion `json:"publishedVersion,omitempty"`

	// DebugVersion - debug version information if there is a debug version
	DebugVersion *Flowversion `json:"debugVersion,omitempty"`

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

Flowdivisionview

func (*Flowdivisionview) String ¶

func (o *Flowdivisionview) String() string

String returns a JSON representation of the model

type Flowdivisionviewentitylisting ¶

type Flowdivisionviewentitylisting struct {
	// Entities
	Entities *[]Flowdivisionview `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"`

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

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

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

Flowdivisionviewentitylisting

func (*Flowdivisionviewentitylisting) String ¶

String returns a JSON representation of the model

type Flowentitylisting ¶

type Flowentitylisting struct {
	// Entities
	Entities *[]Flow `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"`

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

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

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

Flowentitylisting

func (*Flowentitylisting) String ¶

func (o *Flowentitylisting) String() string

String returns a JSON representation of the model

type Flowexecutionlaunchrequest ¶

type Flowexecutionlaunchrequest struct {
	// FlowId - ID of the flow to launch.
	FlowId *string `json:"flowId,omitempty"`

	// FlowVersion - The version of the flow to launch. Omit this value (or supply null/empty) to use the latest published version.
	FlowVersion *string `json:"flowVersion,omitempty"`

	// InputData - Input values to the flow. Valid values are defined by a flow's input JSON schema.
	InputData *map[string]interface{} `json:"inputData,omitempty"`

	// Name - A displayable name to assign to the new flow execution
	Name *string `json:"name,omitempty"`
}

Flowexecutionlaunchrequest - Parameters for launching a flow.

func (*Flowexecutionlaunchrequest) String ¶

func (o *Flowexecutionlaunchrequest) String() string

String returns a JSON representation of the model

type Flowexecutionlaunchresponse ¶

type Flowexecutionlaunchresponse struct {
	// Id - The flow execution ID
	Id *string `json:"id,omitempty"`

	// Name - The flow execution name.
	Name *string `json:"name,omitempty"`

	// FlowVersion - The version of the flow that launched
	FlowVersion *Domainentityref `json:"flowVersion,omitempty"`

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

Flowexecutionlaunchresponse - Response object from launching a flow.

func (*Flowexecutionlaunchresponse) String ¶

func (o *Flowexecutionlaunchresponse) String() string

String returns a JSON representation of the model

type Flowmilestone ¶

type Flowmilestone struct {
	// Id - The flow milestone identifier
	Id *string `json:"id,omitempty"`

	// Name - The flow milestone name.
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Writabledivision `json:"division,omitempty"`

	// Description - The flow milestone description.
	Description *string `json:"description,omitempty"`

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

Flowmilestone

func (*Flowmilestone) String ¶

func (o *Flowmilestone) String() string

String returns a JSON representation of the model

type Flowmilestonedivisionview ¶

type Flowmilestonedivisionview struct {
	// Id - The flow milestone identifier
	Id *string `json:"id,omitempty"`

	// Name - The flow milestone name
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Writabledivision `json:"division,omitempty"`

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

Flowmilestonedivisionview

func (*Flowmilestonedivisionview) String ¶

func (o *Flowmilestonedivisionview) String() string

String returns a JSON representation of the model

type Flowmilestonedivisionviewentitylisting ¶

type Flowmilestonedivisionviewentitylisting struct {
	// Entities
	Entities *[]Flowmilestonedivisionview `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"`

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

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

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

Flowmilestonedivisionviewentitylisting

func (*Flowmilestonedivisionviewentitylisting) String ¶

String returns a JSON representation of the model

type Flowmilestonelisting ¶

type Flowmilestonelisting struct {
	// Entities
	Entities *[]Flowmilestone `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"`

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

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

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

Flowmilestonelisting

func (*Flowmilestonelisting) String ¶

func (o *Flowmilestonelisting) String() string

String returns a JSON representation of the model

type Flowobservationdatacontainer ¶

type Flowobservationdatacontainer struct {
	// Group - A mapping from dimension to value
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Observationmetricdata `json:"data,omitempty"`
}

Flowobservationdatacontainer

func (*Flowobservationdatacontainer) String ¶

String returns a JSON representation of the model

type Flowobservationquery ¶

type Flowobservationquery struct {
	// Filter - Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters
	Filter *Flowobservationqueryfilter `json:"filter,omitempty"`

	// Metrics - Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
	Metrics *[]string `json:"metrics,omitempty"`

	// DetailMetrics - Metrics for which to include additional detailed observations
	DetailMetrics *[]string `json:"detailMetrics,omitempty"`
}

Flowobservationquery

func (*Flowobservationquery) String ¶

func (o *Flowobservationquery) String() string

String returns a JSON representation of the model

type Flowobservationqueryclause ¶

type Flowobservationqueryclause 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 *[]Flowobservationquerypredicate `json:"predicates,omitempty"`
}

Flowobservationqueryclause

func (*Flowobservationqueryclause) String ¶

func (o *Flowobservationqueryclause) String() string

String returns a JSON representation of the model

type Flowobservationqueryfilter ¶

type Flowobservationqueryfilter 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 *[]Flowobservationqueryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Flowobservationquerypredicate `json:"predicates,omitempty"`
}

Flowobservationqueryfilter

func (*Flowobservationqueryfilter) String ¶

func (o *Flowobservationqueryfilter) String() string

String returns a JSON representation of the model

type Flowobservationquerypredicate ¶

type Flowobservationquerypredicate 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"`
}

Flowobservationquerypredicate

func (*Flowobservationquerypredicate) String ¶

String returns a JSON representation of the model

type Flowobservationqueryresponse ¶

type Flowobservationqueryresponse struct {
	// Results
	Results *[]Flowobservationdatacontainer `json:"results,omitempty"`
}

Flowobservationqueryresponse

func (*Flowobservationqueryresponse) String ¶

String returns a JSON representation of the model

type Flowoutcome ¶

type Flowoutcome struct {
	// Id - The flow outcome identifier
	Id *string `json:"id,omitempty"`

	// Name - The flow outcome name.
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Writabledivision `json:"division,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// CurrentOperation
	CurrentOperation *Operation `json:"currentOperation,omitempty"`

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

Flowoutcome

func (*Flowoutcome) String ¶

func (o *Flowoutcome) String() string

String returns a JSON representation of the model

type Flowoutcomedivisionview ¶

type Flowoutcomedivisionview struct {
	// Id - The flow outcome identifier
	Id *string `json:"id,omitempty"`

	// Name - The flow outcome name
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Writabledivision `json:"division,omitempty"`

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

Flowoutcomedivisionview

func (*Flowoutcomedivisionview) String ¶

func (o *Flowoutcomedivisionview) String() string

String returns a JSON representation of the model

type Flowoutcomedivisionviewentitylisting ¶

type Flowoutcomedivisionviewentitylisting struct {
	// Entities
	Entities *[]Flowoutcomedivisionview `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"`

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

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

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

Flowoutcomedivisionviewentitylisting

func (*Flowoutcomedivisionviewentitylisting) String ¶

String returns a JSON representation of the model

type Flowoutcomelisting ¶

type Flowoutcomelisting struct {
	// Entities
	Entities *[]Flowoutcome `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"`

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

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

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

Flowoutcomelisting

func (*Flowoutcomelisting) String ¶

func (o *Flowoutcomelisting) String() string

String returns a JSON representation of the model

type Flowruntimeexecution ¶

type Flowruntimeexecution struct {
	// Id - The flow execution ID
	Id *string `json:"id,omitempty"`

	// Name - The flow execution name.
	Name *string `json:"name,omitempty"`

	// FlowVersion - The Version of the flow definition of the flow execution.
	FlowVersion *Flowversion `json:"flowVersion,omitempty"`

	// DateLaunched - The time the flow was launched. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateLaunched *time.Time `json:"dateLaunched,omitempty"`

	// Status - The flow's running status, which indicates whether the flow is running normally or completed, etc.
	Status *string `json:"status,omitempty"`

	// DateCompleted - The time the flow completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCompleted *time.Time `json:"dateCompleted,omitempty"`

	// CompletionReason - The completion reason set at the flow completion time, if applicable.
	CompletionReason *string `json:"completionReason,omitempty"`

	// FlowErrorInfo - Additional information if the flow is in error
	FlowErrorInfo *Errorbody `json:"flowErrorInfo,omitempty"`

	// OutputData - List of the flow's output variables, if any. Output variables are only supplied for Completed flows.
	OutputData *map[string]interface{} `json:"outputData,omitempty"`

	// Conversation - The conversation to which this Flow execution is related
	Conversation *Domainentityref `json:"conversation,omitempty"`

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

Flowruntimeexecution - Details about the current state of a Flow execution

func (*Flowruntimeexecution) String ¶

func (o *Flowruntimeexecution) String() string

String returns a JSON representation of the model

type FlowsApi ¶

type FlowsApi struct {
	Configuration *Configuration
}

FlowsApi provides functions for API endpoints

func NewFlowsApi ¶

func NewFlowsApi() *FlowsApi

NewFlowsApi creates an API instance using the default configuration

func NewFlowsApiWithConfig ¶

func NewFlowsApiWithConfig(config *Configuration) *FlowsApi

NewFlowsApiWithConfig creates an API instance using the provided configuration

func (FlowsApi) PostAnalyticsFlowsAggregatesQuery ¶

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

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

Query for flow aggregates

func (FlowsApi) PostAnalyticsFlowsObservationsQuery ¶

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

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

Query for flow observations

type Flowversion ¶

type Flowversion struct {
	// Id - The flow version identifier
	Id *string `json:"id,omitempty"`

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

	// CommitVersion
	CommitVersion *string `json:"commitVersion,omitempty"`

	// ConfigurationVersion
	ConfigurationVersion *string `json:"configurationVersion,omitempty"`

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

	// Secure
	Secure *bool `json:"secure,omitempty"`

	// Debug
	Debug *bool `json:"debug,omitempty"`

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

	// CreatedByClient
	CreatedByClient *Domainentityref `json:"createdByClient,omitempty"`

	// ConfigurationUri
	ConfigurationUri *string `json:"configurationUri,omitempty"`

	// DateCreated
	DateCreated *int `json:"dateCreated,omitempty"`

	// GenerationId
	GenerationId *string `json:"generationId,omitempty"`

	// PublishResultUri
	PublishResultUri *string `json:"publishResultUri,omitempty"`

	// InputSchema
	InputSchema *Jsonschemadocument `json:"inputSchema,omitempty"`

	// OutputSchema
	OutputSchema *Jsonschemadocument `json:"outputSchema,omitempty"`

	// NluInfo - Information about the natural language understanding configuration for the flow version
	NluInfo *Nluinfo `json:"nluInfo,omitempty"`

	// SupportedLanguages - List of supported languages for this version of the flow
	SupportedLanguages *[]Supportedlanguage `json:"supportedLanguages,omitempty"`

	// CompatibleFlowTypes - Compatible flow types designate which flow types are allowed to embed a flow’s configuration within their own flow configuration.  Currently the only flows that can be embedded are Common Module flows and the embedding flow can invoke them using the Call Common Module action.
	CompatibleFlowTypes *[]string `json:"compatibleFlowTypes,omitempty"`

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

Flowversion

func (*Flowversion) String ¶

func (o *Flowversion) String() string

String returns a JSON representation of the model

type Flowversionentitylisting ¶

type Flowversionentitylisting struct {
	// Entities
	Entities *[]Flowversion `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"`

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

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

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

Flowversionentitylisting

func (*Flowversionentitylisting) String ¶

func (o *Flowversionentitylisting) String() string

String returns a JSON representation of the model

type Forecastabandonrateresponse ¶

type Forecastabandonrateresponse struct {
	// Percent - The target percent abandon rate goal
	Percent *int `json:"percent,omitempty"`
}

Forecastabandonrateresponse

func (*Forecastabandonrateresponse) String ¶

func (o *Forecastabandonrateresponse) String() string

String returns a JSON representation of the model

type Forecastaveragespeedofanswerresponse ¶

type Forecastaveragespeedofanswerresponse struct {
	// Seconds - the average speed of answer goal in seconds
	Seconds *int `json:"seconds,omitempty"`
}

Forecastaveragespeedofanswerresponse

func (*Forecastaveragespeedofanswerresponse) String ¶

String returns a JSON representation of the model

type Forecastplanninggroupdata ¶

type Forecastplanninggroupdata struct {
	// PlanningGroupId - The ID of the planning group to which this data applies. Note this is a snapshot of the planning group at the time of forecast creation and may not correspond to the current configuration
	PlanningGroupId *string `json:"planningGroupId,omitempty"`

	// OfferedPerInterval - Forecast offered counts per interval for this week of the forecast
	OfferedPerInterval *[]float64 `json:"offeredPerInterval,omitempty"`

	// AverageHandleTimeSecondsPerInterval - Forecast average handle time per interval in seconds
	AverageHandleTimeSecondsPerInterval *[]float64 `json:"averageHandleTimeSecondsPerInterval,omitempty"`
}

Forecastplanninggroupdata

func (*Forecastplanninggroupdata) String ¶

func (o *Forecastplanninggroupdata) String() string

String returns a JSON representation of the model

type Forecastplanninggroupresponse ¶

type Forecastplanninggroupresponse struct {
	// Id - The ID of the planning group
	Id *string `json:"id,omitempty"`

	// Name - The name of the planning group
	Name *string `json:"name,omitempty"`

	// RoutePaths - Route path configuration for this planning group
	RoutePaths *[]Routepathresponse `json:"routePaths,omitempty"`

	// ServiceGoalTemplate - Service goals for this planning group
	ServiceGoalTemplate *Forecastservicegoaltemplateresponse `json:"serviceGoalTemplate,omitempty"`
}

Forecastplanninggroupresponse

func (*Forecastplanninggroupresponse) String ¶

String returns a JSON representation of the model

type Forecastplanninggroupsresponse ¶

type Forecastplanninggroupsresponse struct {
	// Entities
	Entities *[]Forecastplanninggroupresponse `json:"entities,omitempty"`
}

Forecastplanninggroupsresponse

func (*Forecastplanninggroupsresponse) String ¶

String returns a JSON representation of the model

type Forecastservicegoaltemplateresponse ¶

type Forecastservicegoaltemplateresponse struct {
	// ServiceLevel - The service level goal for this forecast
	ServiceLevel *Forecastservicelevelresponse `json:"serviceLevel,omitempty"`

	// AverageSpeedOfAnswer - The average speed of answer goal for this forecast
	AverageSpeedOfAnswer *Forecastaveragespeedofanswerresponse `json:"averageSpeedOfAnswer,omitempty"`

	// AbandonRate - The abandon rate goal for this forecast
	AbandonRate *Forecastabandonrateresponse `json:"abandonRate,omitempty"`
}

Forecastservicegoaltemplateresponse

func (*Forecastservicegoaltemplateresponse) String ¶

String returns a JSON representation of the model

type Forecastservicelevelresponse ¶

type Forecastservicelevelresponse struct {
	// Percent - The percent of calls to answer in the number of seconds defined
	Percent *int `json:"percent,omitempty"`

	// Seconds - The number of seconds to define for the percent of calls to be answered
	Seconds *int `json:"seconds,omitempty"`
}

Forecastservicelevelresponse

func (*Forecastservicelevelresponse) String ¶

String returns a JSON representation of the model

type Forecastsourcedaypointer ¶

type Forecastsourcedaypointer struct {
	// DayOfWeek - The forecast day of week for this source data
	DayOfWeek *string `json:"dayOfWeek,omitempty"`

	// Weight - The relative weight to apply to this source data item for weighted averages
	Weight *int `json:"weight,omitempty"`

	// Date - The date this source data represents, in yyyy-MM-dd format
	Date *string `json:"date,omitempty"`

	// FileName - The name of the source file this data came from if it originated from a data import
	FileName *string `json:"fileName,omitempty"`

	// DataKey - The key to look up the forecast source data for this source day
	DataKey *string `json:"dataKey,omitempty"`
}

Forecastsourcedaypointer - Pointer to look up source data for a short term forecast

func (*Forecastsourcedaypointer) String ¶

func (o *Forecastsourcedaypointer) String() string

String returns a JSON representation of the model

type Freeseatingconfiguration ¶

type Freeseatingconfiguration struct {
	// FreeSeatingState - The FreeSeatingState for FreeSeatingConfiguration. Can be ON, OFF, or PARTIAL. ON meaning disassociate the user after the ttl expires, OFF meaning never disassociate the user, and PARTIAL meaning only disassociate when a user explicitly clicks log out.
	FreeSeatingState *string `json:"freeSeatingState,omitempty"`

	// TtlMinutes - The amount of time in minutes until an offline user is disassociated from their station
	TtlMinutes *int `json:"ttlMinutes,omitempty"`
}

Freeseatingconfiguration

func (*Freeseatingconfiguration) String ¶

func (o *Freeseatingconfiguration) String() string

String returns a JSON representation of the model

type GamificationApi ¶

type GamificationApi struct {
	Configuration *Configuration
}

GamificationApi provides functions for API endpoints

func NewGamificationApi ¶

func NewGamificationApi() *GamificationApi

NewGamificationApi creates an API instance using the default configuration

func NewGamificationApiWithConfig ¶

func NewGamificationApiWithConfig(config *Configuration) *GamificationApi

NewGamificationApiWithConfig creates an API instance using the provided configuration

func (GamificationApi) GetGamificationLeaderboard ¶

func (a GamificationApi) GetGamificationLeaderboard(startWorkday time.Time, endWorkday time.Time, metricId string) (*Leaderboard, *APIResponse, error)

GetGamificationLeaderboard invokes GET /api/v2/gamification/leaderboard

Leaderboard of the requesting user&#39;s division or performance profile

func (GamificationApi) GetGamificationLeaderboardAll ¶

func (a GamificationApi) GetGamificationLeaderboardAll(filterType string, filterId string, startWorkday time.Time, endWorkday time.Time, metricId string) (*Leaderboard, *APIResponse, error)

GetGamificationLeaderboardAll invokes GET /api/v2/gamification/leaderboard/all

Leaderboard by filter type

func (GamificationApi) GetGamificationLeaderboardAllBestpoints ¶

func (a GamificationApi) GetGamificationLeaderboardAllBestpoints(filterType string, filterId string) (*Overallbestpoints, *APIResponse, error)

GetGamificationLeaderboardAllBestpoints invokes GET /api/v2/gamification/leaderboard/all/bestpoints

Best Points by division

func (GamificationApi) GetGamificationLeaderboardBestpoints ¶

func (a GamificationApi) GetGamificationLeaderboardBestpoints() (*Overallbestpoints, *APIResponse, error)

GetGamificationLeaderboardBestpoints invokes GET /api/v2/gamification/leaderboard/bestpoints

Best Points of the requesting user&#39;s division

func (GamificationApi) GetGamificationMetric ¶

func (a GamificationApi) GetGamificationMetric(metricId string, performanceProfileId string) (*Metric, *APIResponse, error)

GetGamificationMetric invokes GET /api/v2/gamification/metrics/{metricId}

Gamified metric by id

func (GamificationApi) GetGamificationMetricdefinition ¶

func (a GamificationApi) GetGamificationMetricdefinition(metricDefinitionId string) (*Metricdefinition, *APIResponse, error)

GetGamificationMetricdefinition invokes GET /api/v2/gamification/metricdefinitions/{metricDefinitionId}

Metric definition by id

func (GamificationApi) GetGamificationMetricdefinitions ¶

func (a GamificationApi) GetGamificationMetricdefinitions() (*Getmetricdefinitionsresponse, *APIResponse, error)

GetGamificationMetricdefinitions invokes GET /api/v2/gamification/metricdefinitions

All metric definitions ¶

Retrieves the metric definitions and their corresponding default objectives used to create a gamified metric

func (GamificationApi) GetGamificationMetrics ¶

func (a GamificationApi) GetGamificationMetrics(performanceProfileId string) (*Getmetricsresponse, *APIResponse, error)

GetGamificationMetrics invokes GET /api/v2/gamification/metrics

All gamified metrics for a given profile

func (GamificationApi) GetGamificationProfile ¶

func (a GamificationApi) GetGamificationProfile(performanceProfileId string) (*Performanceprofile, *APIResponse, error)

GetGamificationProfile invokes GET /api/v2/gamification/profiles/{performanceProfileId}

Performance profile by id

func (GamificationApi) GetGamificationProfiles ¶

func (a GamificationApi) GetGamificationProfiles() (*Getprofilesresponse, *APIResponse, error)

GetGamificationProfiles invokes GET /api/v2/gamification/profiles

All performance profiles

func (GamificationApi) GetGamificationScorecards ¶

func (a GamificationApi) GetGamificationScorecards(workday time.Time, expand []string) (*Workdaymetriclisting, *APIResponse, error)

GetGamificationScorecards invokes GET /api/v2/gamification/scorecards

Workday performance metrics of the requesting user

func (GamificationApi) GetGamificationScorecardsAttendance ¶

func (a GamificationApi) GetGamificationScorecardsAttendance(startWorkday time.Time, endWorkday time.Time) (*Attendancestatuslisting, *APIResponse, error)

GetGamificationScorecardsAttendance invokes GET /api/v2/gamification/scorecards/attendance

Attendance status metrics of the requesting user

func (GamificationApi) GetGamificationScorecardsBestpoints ¶

func (a GamificationApi) GetGamificationScorecardsBestpoints() (*Userbestpoints, *APIResponse, error)

GetGamificationScorecardsBestpoints invokes GET /api/v2/gamification/scorecards/bestpoints

Best points of the requesting user

func (GamificationApi) GetGamificationScorecardsPointsAlltime ¶

func (a GamificationApi) GetGamificationScorecardsPointsAlltime(endWorkday time.Time) (*Alltimepoints, *APIResponse, error)

GetGamificationScorecardsPointsAlltime invokes GET /api/v2/gamification/scorecards/points/alltime

All-time points of the requesting user

func (GamificationApi) GetGamificationScorecardsPointsAverage ¶

func (a GamificationApi) GetGamificationScorecardsPointsAverage(workday time.Time) (*Singleworkdayaveragepoints, *APIResponse, error)

GetGamificationScorecardsPointsAverage invokes GET /api/v2/gamification/scorecards/points/average

Average points of the requesting user&#39;s division

func (GamificationApi) GetGamificationScorecardsPointsTrends ¶

func (a GamificationApi) GetGamificationScorecardsPointsTrends(startWorkday time.Time, endWorkday time.Time, dayOfWeek string) (*Workdaypointstrend, *APIResponse, error)

GetGamificationScorecardsPointsTrends invokes GET /api/v2/gamification/scorecards/points/trends

Points trends of the requesting user

func (GamificationApi) GetGamificationScorecardsUser ¶

func (a GamificationApi) GetGamificationScorecardsUser(userId string, workday time.Time, expand []string) (*Workdaymetriclisting, *APIResponse, error)

GetGamificationScorecardsUser invokes GET /api/v2/gamification/scorecards/users/{userId}

Workday performance metrics for a user

func (GamificationApi) GetGamificationScorecardsUserAttendance ¶

func (a GamificationApi) GetGamificationScorecardsUserAttendance(userId string, startWorkday time.Time, endWorkday time.Time) (*Attendancestatuslisting, *APIResponse, error)

GetGamificationScorecardsUserAttendance invokes GET /api/v2/gamification/scorecards/users/{userId}/attendance

Attendance status metrics for a user

func (GamificationApi) GetGamificationScorecardsUserBestpoints ¶

func (a GamificationApi) GetGamificationScorecardsUserBestpoints(userId string) (*Userbestpoints, *APIResponse, error)

GetGamificationScorecardsUserBestpoints invokes GET /api/v2/gamification/scorecards/users/{userId}/bestpoints

Best points of a user

func (GamificationApi) GetGamificationScorecardsUserPointsAlltime ¶

func (a GamificationApi) GetGamificationScorecardsUserPointsAlltime(userId string, endWorkday time.Time) (*Alltimepoints, *APIResponse, error)

GetGamificationScorecardsUserPointsAlltime invokes GET /api/v2/gamification/scorecards/users/{userId}/points/alltime

All-time points for a user

func (GamificationApi) GetGamificationScorecardsUserPointsTrends ¶

func (a GamificationApi) GetGamificationScorecardsUserPointsTrends(userId string, startWorkday time.Time, endWorkday time.Time, dayOfWeek string) (*Workdaypointstrend, *APIResponse, error)

GetGamificationScorecardsUserPointsTrends invokes GET /api/v2/gamification/scorecards/users/{userId}/points/trends

Points trend for a user

func (GamificationApi) GetGamificationScorecardsUserValuesTrends ¶

func (a GamificationApi) GetGamificationScorecardsUserValuesTrends(userId string, startWorkday time.Time, endWorkday time.Time, timeZone string) (*Workdayvaluestrend, *APIResponse, error)

GetGamificationScorecardsUserValuesTrends invokes GET /api/v2/gamification/scorecards/users/{userId}/values/trends

Values Trends of a user

func (GamificationApi) GetGamificationScorecardsUsersPointsAverage ¶

func (a GamificationApi) GetGamificationScorecardsUsersPointsAverage(filterType string, filterId string, workday time.Time) (*Singleworkdayaveragepoints, *APIResponse, error)

GetGamificationScorecardsUsersPointsAverage invokes GET /api/v2/gamification/scorecards/users/points/average

Workday average points by target group

func (GamificationApi) GetGamificationScorecardsUsersValuesAverage ¶

func (a GamificationApi) GetGamificationScorecardsUsersValuesAverage(filterType string, filterId string, workday time.Time, timeZone string) (*Singleworkdayaveragevalues, *APIResponse, error)

GetGamificationScorecardsUsersValuesAverage invokes GET /api/v2/gamification/scorecards/users/values/average

Workday average values by target group

func (GamificationApi) GetGamificationScorecardsUsersValuesTrends ¶

func (a GamificationApi) GetGamificationScorecardsUsersValuesTrends(filterType string, filterId string, startWorkday time.Time, endWorkday time.Time, timeZone string) (*Workdayvaluestrend, *APIResponse, error)

GetGamificationScorecardsUsersValuesTrends invokes GET /api/v2/gamification/scorecards/users/values/trends

Values trend by target group

func (GamificationApi) GetGamificationScorecardsValuesAverage ¶

func (a GamificationApi) GetGamificationScorecardsValuesAverage(workday time.Time, timeZone string) (*Singleworkdayaveragevalues, *APIResponse, error)

GetGamificationScorecardsValuesAverage invokes GET /api/v2/gamification/scorecards/values/average

Average values of the requesting user&#39;s division

func (GamificationApi) GetGamificationScorecardsValuesTrends ¶

func (a GamificationApi) GetGamificationScorecardsValuesTrends(startWorkday time.Time, endWorkday time.Time, filterType string, timeZone string) (*Workdayvaluestrend, *APIResponse, error)

GetGamificationScorecardsValuesTrends invokes GET /api/v2/gamification/scorecards/values/trends

Values trends of the requesting user or group

func (GamificationApi) GetGamificationStatus ¶

func (a GamificationApi) GetGamificationStatus() (*Gamificationstatus, *APIResponse, error)

GetGamificationStatus invokes GET /api/v2/gamification/status

Gamification activation status

func (GamificationApi) GetGamificationTemplate ¶

func (a GamificationApi) GetGamificationTemplate(templateId string) (*Objectivetemplate, *APIResponse, error)

GetGamificationTemplate invokes GET /api/v2/gamification/templates/{templateId}

Objective template by id

func (GamificationApi) GetGamificationTemplates ¶

func (a GamificationApi) GetGamificationTemplates() (*Gettemplatesresponse, *APIResponse, error)

GetGamificationTemplates invokes GET /api/v2/gamification/templates

All objective templates

func (GamificationApi) PostGamificationMetrics ¶

func (a GamificationApi) PostGamificationMetrics(body Metric) (*Metric, *APIResponse, error)

PostGamificationMetrics invokes POST /api/v2/gamification/metrics

Creates a gamified metric with a given metric definition and metric objective

func (GamificationApi) PutGamificationMetric ¶

func (a GamificationApi) PutGamificationMetric(metricId string, body Metric, performanceProfileId string) (*Metric, *APIResponse, error)

PutGamificationMetric invokes PUT /api/v2/gamification/metrics/{metricId}

Updates a metric

func (GamificationApi) PutGamificationProfile ¶

func (a GamificationApi) PutGamificationProfile(performanceProfileId string, body Performanceprofile) (*Performanceprofile, *APIResponse, error)

PutGamificationProfile invokes PUT /api/v2/gamification/profiles/{performanceProfileId}

Updates a performance profile

func (GamificationApi) PutGamificationStatus ¶

func (a GamificationApi) PutGamificationStatus(status Gamificationstatus) (*Gamificationstatus, *APIResponse, error)

PutGamificationStatus invokes PUT /api/v2/gamification/status

Update gamification activation status

type Gamificationstatus ¶

type Gamificationstatus struct {
	// IsActive - Gamification status of the organization.
	IsActive *bool `json:"isActive,omitempty"`

	// DateStart - Gamification start date. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateStart *time.Time `json:"dateStart,omitempty"`
}

Gamificationstatus

func (*Gamificationstatus) String ¶

func (o *Gamificationstatus) String() string

String returns a JSON representation of the model

type Gdprjourneycustomer ¶

type Gdprjourneycustomer struct {
	// VarType - The type of the customerId within the Journey System (e.g. cookie). Required if `id` is defined.
	VarType *string `json:"type,omitempty"`

	// Id - An ID of a customer within the Journey System at a point-in-time. Required if `type` is defined.
	Id *string `json:"id,omitempty"`
}

Gdprjourneycustomer

func (*Gdprjourneycustomer) String ¶

func (o *Gdprjourneycustomer) String() string

String returns a JSON representation of the model

type Gdprrequest ¶

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

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

	// CreatedBy - The user that created this request
	CreatedBy *Domainentityref `json:"createdBy,omitempty"`

	// ReplacementTerms - The replacement terms for the provided search terms, in the case of a GDPR_UPDATE request
	ReplacementTerms *[]Replacementterm `json:"replacementTerms,omitempty"`

	// RequestType - The type of GDPR request
	RequestType *string `json:"requestType,omitempty"`

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

	// Status - The status of the request
	Status *string `json:"status,omitempty"`

	// Subject - The subject of the GDPR request
	Subject *Gdprsubject `json:"subject,omitempty"`

	// ResultsUrl - The location where the results of the request can be retrieved
	ResultsUrl *string `json:"resultsUrl,omitempty"`

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

Gdprrequest

func (*Gdprrequest) String ¶

func (o *Gdprrequest) String() string

String returns a JSON representation of the model

type Gdprrequestentitylisting ¶

type Gdprrequestentitylisting struct {
	// Entities
	Entities *[]Gdprrequest `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"`

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

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

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

Gdprrequestentitylisting

func (*Gdprrequestentitylisting) String ¶

func (o *Gdprrequestentitylisting) String() string

String returns a JSON representation of the model

type Gdprsubject ¶

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

	// UserId
	UserId *string `json:"userId,omitempty"`

	// ExternalContactId
	ExternalContactId *string `json:"externalContactId,omitempty"`

	// DialerContactId
	DialerContactId *Dialercontactid `json:"dialerContactId,omitempty"`

	// JourneyCustomer
	JourneyCustomer *Gdprjourneycustomer `json:"journeyCustomer,omitempty"`

	// SocialHandle
	SocialHandle *Socialhandle `json:"socialHandle,omitempty"`

	// ExternalId
	ExternalId *string `json:"externalId,omitempty"`

	// Addresses
	Addresses *[]string `json:"addresses,omitempty"`

	// PhoneNumbers
	PhoneNumbers *[]string `json:"phoneNumbers,omitempty"`

	// EmailAddresses
	EmailAddresses *[]string `json:"emailAddresses,omitempty"`
}

Gdprsubject

func (*Gdprsubject) String ¶

func (o *Gdprsubject) String() string

String returns a JSON representation of the model

type Gdprsubjectentitylisting ¶

type Gdprsubjectentitylisting struct {
	// Entities
	Entities *[]Gdprsubject `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"`

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

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

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

Gdprsubjectentitylisting

func (*Gdprsubjectentitylisting) String ¶

func (o *Gdprsubjectentitylisting) String() string

String returns a JSON representation of the model

type GeneralDataProtectionRegulationApi ¶

type GeneralDataProtectionRegulationApi struct {
	Configuration *Configuration
}

GeneralDataProtectionRegulationApi provides functions for API endpoints

func NewGeneralDataProtectionRegulationApi ¶

func NewGeneralDataProtectionRegulationApi() *GeneralDataProtectionRegulationApi

NewGeneralDataProtectionRegulationApi creates an API instance using the default configuration

func NewGeneralDataProtectionRegulationApiWithConfig ¶

func NewGeneralDataProtectionRegulationApiWithConfig(config *Configuration) *GeneralDataProtectionRegulationApi

NewGeneralDataProtectionRegulationApiWithConfig creates an API instance using the provided configuration

func (GeneralDataProtectionRegulationApi) GetGdprRequest ¶

func (a GeneralDataProtectionRegulationApi) GetGdprRequest(requestId string) (*Gdprrequest, *APIResponse, error)

GetGdprRequest invokes GET /api/v2/gdpr/requests/{requestId}

Get an existing GDPR request

func (GeneralDataProtectionRegulationApi) GetGdprRequests ¶

func (a GeneralDataProtectionRegulationApi) GetGdprRequests(pageSize int, pageNumber int) (*Gdprrequestentitylisting, *APIResponse, error)

GetGdprRequests invokes GET /api/v2/gdpr/requests

Get all GDPR requests

func (GeneralDataProtectionRegulationApi) GetGdprSubjects ¶

func (a GeneralDataProtectionRegulationApi) GetGdprSubjects(searchType string, searchValue string) (*Gdprsubjectentitylisting, *APIResponse, error)

GetGdprSubjects invokes GET /api/v2/gdpr/subjects

Get GDPR subjects

func (GeneralDataProtectionRegulationApi) PostGdprRequests ¶

func (a GeneralDataProtectionRegulationApi) PostGdprRequests(body Gdprrequest, deleteConfirmed bool) (*Gdprrequest, *APIResponse, error)

PostGdprRequests invokes POST /api/v2/gdpr/requests

Submit a new GDPR request

type Generalprogramjob ¶

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

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

	// CreatedBy
	CreatedBy *Addressableentityref `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"`

	// 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"`
}

Generalprogramjob

func (*Generalprogramjob) String ¶

func (o *Generalprogramjob) String() string

String returns a JSON representation of the model

type Generalprogramjobrequest ¶

type Generalprogramjobrequest struct {
	// Dialect - The dialect of the topics to link with the general program, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard
	Dialect *string `json:"dialect,omitempty"`

	// Mode - The mode to use for the general program job, default value is Skip
	Mode *string `json:"mode,omitempty"`
}

Generalprogramjobrequest

func (*Generalprogramjobrequest) String ¶

func (o *Generalprogramjobrequest) String() string

String returns a JSON representation of the model

type Generaltopic ¶

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

Generaltopic

func (*Generaltopic) String ¶

func (o *Generaltopic) String() string

String returns a JSON representation of the model

type Generaltopicsentitylisting ¶

type Generaltopicsentitylisting struct {
	// Entities
	Entities *[]Generaltopic `json:"entities,omitempty"`
}

Generaltopicsentitylisting

func (*Generaltopicsentitylisting) String ¶

func (o *Generaltopicsentitylisting) String() string

String returns a JSON representation of the model

type Generatebuforecastrequest ¶

type Generatebuforecastrequest struct {
	// Description - The description for the forecast
	Description *string `json:"description,omitempty"`

	// WeekCount - The number of weeks this forecast covers
	WeekCount *int `json:"weekCount,omitempty"`

	// CanUseForScheduling - Whether this forecast can be used for scheduling
	CanUseForScheduling *bool `json:"canUseForScheduling,omitempty"`
}

Generatebuforecastrequest

func (*Generatebuforecastrequest) String ¶

func (o *Generatebuforecastrequest) String() string

String returns a JSON representation of the model

type Genericsaml ¶

type Genericsaml 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"`

	// LogoImageData
	LogoImageData *string `json:"logoImageData,omitempty"`

	// EndpointCompression
	EndpointCompression *bool `json:"endpointCompression,omitempty"`

	// NameIdentifierFormat
	NameIdentifierFormat *string `json:"nameIdentifierFormat,omitempty"`

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

Genericsaml

func (*Genericsaml) String ¶

func (o *Genericsaml) String() string

String returns a JSON representation of the model

type Genesysbotconnector ¶

type Genesysbotconnector struct {
	// QueryParameters - User defined name/value parameters passed to the BotConnector bot.
	QueryParameters *map[string]string `json:"queryParameters,omitempty"`
}

Genesysbotconnector

func (*Genesysbotconnector) String ¶

func (o *Genesysbotconnector) String() string

String returns a JSON representation of the model

type Geolocation ¶

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

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

	// VarType - A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc.
	VarType *string `json:"type,omitempty"`

	// Primary - A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH
	Primary *bool `json:"primary,omitempty"`

	// Latitude
	Latitude *float64 `json:"latitude,omitempty"`

	// Longitude
	Longitude *float64 `json:"longitude,omitempty"`

	// Country
	Country *string `json:"country,omitempty"`

	// Region
	Region *string `json:"region,omitempty"`

	// City
	City *string `json:"city,omitempty"`

	// Locations
	Locations *[]Locationdefinition `json:"locations,omitempty"`

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

Geolocation

func (*Geolocation) String ¶

func (o *Geolocation) String() string

String returns a JSON representation of the model

type GeolocationApi ¶

type GeolocationApi struct {
	Configuration *Configuration
}

GeolocationApi provides functions for API endpoints

func NewGeolocationApi ¶

func NewGeolocationApi() *GeolocationApi

NewGeolocationApi creates an API instance using the default configuration

func NewGeolocationApiWithConfig ¶

func NewGeolocationApiWithConfig(config *Configuration) *GeolocationApi

NewGeolocationApiWithConfig creates an API instance using the provided configuration

func (GeolocationApi) GetGeolocationsSettings ¶

func (a GeolocationApi) GetGeolocationsSettings() (*Geolocationsettings, *APIResponse, error)

GetGeolocationsSettings invokes GET /api/v2/geolocations/settings

Get a organization&#39;s GeolocationSettings

func (GeolocationApi) GetUserGeolocation ¶

func (a GeolocationApi) GetUserGeolocation(userId string, clientId string) (*Geolocation, *APIResponse, error)

GetUserGeolocation invokes GET /api/v2/users/{userId}/geolocations/{clientId}

Get a user&#39;s Geolocation

func (GeolocationApi) PatchGeolocationsSettings ¶

func (a GeolocationApi) PatchGeolocationsSettings(body Geolocationsettings) (*Geolocationsettings, *APIResponse, error)

PatchGeolocationsSettings invokes PATCH /api/v2/geolocations/settings

Patch a organization&#39;s GeolocationSettings

func (GeolocationApi) PatchUserGeolocation ¶

func (a GeolocationApi) PatchUserGeolocation(userId string, clientId string, body Geolocation) (*Geolocation, *APIResponse, error)

PatchUserGeolocation invokes PATCH /api/v2/users/{userId}/geolocations/{clientId}

Patch a user&#39;s Geolocation

The geolocation object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the client as the user&#39;s primary geolocation source. Option 2: Provide the &#39;latitude&#39; and &#39;longitude&#39; values. This will enqueue an asynchronous update of the &#39;city&#39;, &#39;region&#39;, and &#39;country&#39;, generating a notification. A subsequent GET operation will include the new values for &#39;city&#39;, &#39;region&#39; and &#39;country&#39;. Option 3: Provide the &#39;city&#39;, &#39;region&#39;, &#39;country&#39; values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.

type Geolocationeventgeolocation ¶

type Geolocationeventgeolocation struct {
	// UserId
	UserId *string `json:"userId,omitempty"`

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

	// Country
	Country *string `json:"country,omitempty"`

	// Region
	Region *string `json:"region,omitempty"`

	// City
	City *string `json:"city,omitempty"`
}

Geolocationeventgeolocation

func (*Geolocationeventgeolocation) String ¶

func (o *Geolocationeventgeolocation) String() string

String returns a JSON representation of the model

type Geolocationsettings ¶

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

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

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// MapboxKey
	MapboxKey *string `json:"mapboxKey,omitempty"`

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

Geolocationsettings

func (*Geolocationsettings) String ¶

func (o *Geolocationsettings) String() string

String returns a JSON representation of the model

type Getmetricdefinitionsresponse ¶

type Getmetricdefinitionsresponse struct {
	// Total
	Total *int `json:"total,omitempty"`

	// Entities
	Entities *[]Metricdefinition `json:"entities,omitempty"`

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

Getmetricdefinitionsresponse

func (*Getmetricdefinitionsresponse) String ¶

String returns a JSON representation of the model

type Getmetricsresponse ¶

type Getmetricsresponse struct {
	// Total
	Total *int `json:"total,omitempty"`

	// Entities
	Entities *[]Metrics `json:"entities,omitempty"`

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

Getmetricsresponse

func (*Getmetricsresponse) String ¶

func (o *Getmetricsresponse) String() string

String returns a JSON representation of the model

type Getprofilesresponse ¶

type Getprofilesresponse struct {
	// Total
	Total *int `json:"total,omitempty"`

	// Entities
	Entities *[]Performanceprofile `json:"entities,omitempty"`

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

Getprofilesresponse

func (*Getprofilesresponse) String ¶

func (o *Getprofilesresponse) String() string

String returns a JSON representation of the model

type Gettemplatesresponse ¶

type Gettemplatesresponse struct {
	// Total
	Total *int `json:"total,omitempty"`

	// Entities
	Entities *[]Objectivetemplate `json:"entities,omitempty"`

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

Gettemplatesresponse

func (*Gettemplatesresponse) String ¶

func (o *Gettemplatesresponse) String() string

String returns a JSON representation of the model

type Gkndocumentationresult ¶

type Gkndocumentationresult struct {
	// Content - The text or html content for the documentation entity. Will be returned in responses for certain entities.
	Content *string `json:"content,omitempty"`

	// Link - URL link for the documentation entity. Will be returned in responses for certain entities.
	Link *string `json:"link,omitempty"`

	// Title - The title of the documentation entity. Will be returned in responses for certain entities.
	Title *string `json:"title,omitempty"`

	// VarType - The search type. Will be returned in responses for certain entities.
	VarType *string `json:"_type,omitempty"`
}

Gkndocumentationresult

func (*Gkndocumentationresult) String ¶

func (o *Gkndocumentationresult) String() string

String returns a JSON representation of the model

type Gkndocumentationsearchcriteria ¶

type Gkndocumentationsearchcriteria struct {
	// EndValue - The end value of the range. This field is used for range search types.
	EndValue *string `json:"endValue,omitempty"`

	// Values - A list of values for the search to match against
	Values *[]string `json:"values,omitempty"`

	// StartValue - The start value of the range. This field is used for range search types.
	StartValue *string `json:"startValue,omitempty"`

	// Fields - Field names to search against
	Fields *[]string `json:"fields,omitempty"`

	// Value - A value for the search to match against
	Value *string `json:"value,omitempty"`

	// Operator - How to apply this search criteria against other criteria
	Operator *string `json:"operator,omitempty"`

	// Group - Groups multiple conditions
	Group *[]Gkndocumentationsearchcriteria `json:"group,omitempty"`

	// DateFormat - Set date format for criteria values when using date range search type.  Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX.
	DateFormat *string `json:"dateFormat,omitempty"`

	// VarType - Search Type
	VarType *string `json:"type,omitempty"`
}

Gkndocumentationsearchcriteria

func (*Gkndocumentationsearchcriteria) String ¶

String returns a JSON representation of the model

type Gkndocumentationsearchrequest ¶

type Gkndocumentationsearchrequest struct {
	// SortOrder - The sort order for results
	SortOrder *string `json:"sortOrder,omitempty"`

	// SortBy - The field in the resource that you want to sort the results by
	SortBy *string `json:"sortBy,omitempty"`

	// PageSize - The number of results per page
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The page of resources you want to retrieve
	PageNumber *int `json:"pageNumber,omitempty"`

	// Sort - Multi-value sort order, list of multiple sort values
	Sort *[]Searchsort `json:"sort,omitempty"`

	// Query
	Query *[]Gkndocumentationsearchcriteria `json:"query,omitempty"`
}

Gkndocumentationsearchrequest

func (*Gkndocumentationsearchrequest) String ¶

String returns a JSON representation of the model

type Gkndocumentationsearchresponse ¶

type Gkndocumentationsearchresponse struct {
	// Total - The total number of results found
	Total *int `json:"total,omitempty"`

	// PageCount - The total number of pages
	PageCount *int `json:"pageCount,omitempty"`

	// PageSize - The current page size
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The current page number
	PageNumber *int `json:"pageNumber,omitempty"`

	// PreviousPage - Q64 value for the previous page of results
	PreviousPage *string `json:"previousPage,omitempty"`

	// CurrentPage - Q64 value for the current page of results
	CurrentPage *string `json:"currentPage,omitempty"`

	// NextPage - Q64 value for the next page of results
	NextPage *string `json:"nextPage,omitempty"`

	// Types - Resource types the search was performed against
	Types *[]string `json:"types,omitempty"`

	// Results - Search results
	Results *[]Gkndocumentationresult `json:"results,omitempty"`
}

Gkndocumentationsearchresponse

func (*Gkndocumentationsearchresponse) String ¶

String returns a JSON representation of the model

type Googledialogflowcustomsettings ¶

type Googledialogflowcustomsettings struct {
	// Environment - If set this environment will be used to initiate the dialogflow bot, otherwise the default configuration will be used.  See https://cloud.google.com/dialogflow/docs/agents-versions
	Environment *string `json:"environment,omitempty"`

	// EventName - If set this eventName will be used to initiate the dialogflow bot rather than language processing on the input text.  See https://cloud.google.com/dialogflow/es/docs/events-overview
	EventName *string `json:"eventName,omitempty"`

	// WebhookQueryParameters - Parameters passed to the fulfillment webhook of the bot (if any).
	WebhookQueryParameters *map[string]string `json:"webhookQueryParameters,omitempty"`

	// EventInputParameters - Parameters passed to the event input of the bot.
	EventInputParameters *map[string]string `json:"eventInputParameters,omitempty"`
}

Googledialogflowcustomsettings

func (*Googledialogflowcustomsettings) String ¶

String returns a JSON representation of the model

type Greeting ¶

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

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

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

	// OwnerType - Greeting owner type
	OwnerType *string `json:"ownerType,omitempty"`

	// Owner - Greeting owner
	Owner *Domainentity `json:"owner,omitempty"`

	// AudioFile
	AudioFile *Greetingaudiofile `json:"audioFile,omitempty"`

	// AudioTTS
	AudioTTS *string `json:"audioTTS,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"`

	// CreatedBy
	CreatedBy *string `json:"createdBy,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"`

	// ModifiedBy
	ModifiedBy *string `json:"modifiedBy,omitempty"`

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

Greeting

func (*Greeting) String ¶

func (o *Greeting) String() string

String returns a JSON representation of the model

type Greetingaudiofile ¶

type Greetingaudiofile struct {
	// DurationMilliseconds
	DurationMilliseconds *int `json:"durationMilliseconds,omitempty"`

	// SizeBytes
	SizeBytes *int `json:"sizeBytes,omitempty"`

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

Greetingaudiofile

func (*Greetingaudiofile) String ¶

func (o *Greetingaudiofile) String() string

String returns a JSON representation of the model

type Greetinglisting ¶

type Greetinglisting struct {
	// Entities
	Entities *[]Greeting `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"`

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

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

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

Greetinglisting

func (*Greetinglisting) String ¶

func (o *Greetinglisting) String() string

String returns a JSON representation of the model

type Greetingmediainfo ¶

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

	// MediaFileUri
	MediaFileUri *string `json:"mediaFileUri,omitempty"`

	// MediaImageUri
	MediaImageUri *string `json:"mediaImageUri,omitempty"`
}

Greetingmediainfo

func (*Greetingmediainfo) String ¶

func (o *Greetingmediainfo) String() string

String returns a JSON representation of the model

type Greetingowner ¶

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

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

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

Greetingowner

func (*Greetingowner) String ¶

func (o *Greetingowner) String() string

String returns a JSON representation of the model

type GreetingsApi ¶

type GreetingsApi struct {
	Configuration *Configuration
}

GreetingsApi provides functions for API endpoints

func NewGreetingsApi ¶

func NewGreetingsApi() *GreetingsApi

NewGreetingsApi creates an API instance using the default configuration

func NewGreetingsApiWithConfig ¶

func NewGreetingsApiWithConfig(config *Configuration) *GreetingsApi

NewGreetingsApiWithConfig creates an API instance using the provided configuration

func (GreetingsApi) DeleteGreeting ¶

func (a GreetingsApi) DeleteGreeting(greetingId string) (*APIResponse, error)

DeleteGreeting invokes DELETE /api/v2/greetings/{greetingId}

Deletes a Greeting with the given GreetingId

func (GreetingsApi) GetGreeting ¶

func (a GreetingsApi) GetGreeting(greetingId string) (*Greeting, *APIResponse, error)

GetGreeting invokes GET /api/v2/greetings/{greetingId}

Get a Greeting with the given GreetingId

func (GreetingsApi) GetGreetingMedia ¶

func (a GreetingsApi) GetGreetingMedia(greetingId string, formatId string) (*Greetingmediainfo, *APIResponse, error)

GetGreetingMedia invokes GET /api/v2/greetings/{greetingId}/media

Get media playback URI for this greeting

func (GreetingsApi) GetGreetings ¶

func (a GreetingsApi) GetGreetings(pageSize int, pageNumber int) (*Domainentitylisting, *APIResponse, error)

GetGreetings invokes GET /api/v2/greetings

Gets an Organization&#39;s Greetings

func (GreetingsApi) GetGreetingsDefaults ¶

func (a GreetingsApi) GetGreetingsDefaults() (*Defaultgreetinglist, *APIResponse, error)

GetGreetingsDefaults invokes GET /api/v2/greetings/defaults

Get an Organization&#39;s DefaultGreetingList

func (GreetingsApi) GetGroupGreetings ¶

func (a GreetingsApi) GetGroupGreetings(groupId string, pageSize int, pageNumber int) (*Greetinglisting, *APIResponse, error)

GetGroupGreetings invokes GET /api/v2/groups/{groupId}/greetings

Get a list of the Group&#39;s Greetings

func (GreetingsApi) GetGroupGreetingsDefaults ¶

func (a GreetingsApi) GetGroupGreetingsDefaults(groupId string) (*Defaultgreetinglist, *APIResponse, error)

GetGroupGreetingsDefaults invokes GET /api/v2/groups/{groupId}/greetings/defaults

Grabs the list of Default Greetings given a Group&#39;s ID

func (GreetingsApi) GetUserGreetings ¶

func (a GreetingsApi) GetUserGreetings(userId string, pageSize int, pageNumber int) (*Domainentitylisting, *APIResponse, error)

GetUserGreetings invokes GET /api/v2/users/{userId}/greetings

Get a list of the User&#39;s Greetings

func (GreetingsApi) GetUserGreetingsDefaults ¶

func (a GreetingsApi) GetUserGreetingsDefaults(userId string) (*Defaultgreetinglist, *APIResponse, error)

GetUserGreetingsDefaults invokes GET /api/v2/users/{userId}/greetings/defaults

Grabs the list of Default Greetings given a User&#39;s ID

func (GreetingsApi) PostGreetings ¶

func (a GreetingsApi) PostGreetings(body Greeting) (*Greeting, *APIResponse, error)

PostGreetings invokes POST /api/v2/greetings

Create a Greeting for an Organization

func (GreetingsApi) PostGroupGreetings ¶

func (a GreetingsApi) PostGroupGreetings(groupId string, body Greeting) (*Greeting, *APIResponse, error)

PostGroupGreetings invokes POST /api/v2/groups/{groupId}/greetings

Creates a Greeting for a Group

func (GreetingsApi) PostUserGreetings ¶

func (a GreetingsApi) PostUserGreetings(userId string, body Greeting) (*Greeting, *APIResponse, error)

PostUserGreetings invokes POST /api/v2/users/{userId}/greetings

Creates a Greeting for a User

func (GreetingsApi) PutGreeting ¶

func (a GreetingsApi) PutGreeting(greetingId string, body Greeting) (*Greeting, *APIResponse, error)

PutGreeting invokes PUT /api/v2/greetings/{greetingId}

Updates the Greeting with the given GreetingId

func (GreetingsApi) PutGreetingsDefaults ¶

func (a GreetingsApi) PutGreetingsDefaults(body Defaultgreetinglist) (*Defaultgreetinglist, *APIResponse, error)

PutGreetingsDefaults invokes PUT /api/v2/greetings/defaults

Update an Organization&#39;s DefaultGreetingList

func (GreetingsApi) PutGroupGreetingsDefaults ¶

func (a GreetingsApi) PutGroupGreetingsDefaults(groupId string, body Defaultgreetinglist) (*Defaultgreetinglist, *APIResponse, error)

PutGroupGreetingsDefaults invokes PUT /api/v2/groups/{groupId}/greetings/defaults

Updates the DefaultGreetingList of the specified Group

func (GreetingsApi) PutUserGreetingsDefaults ¶

func (a GreetingsApi) PutUserGreetingsDefaults(userId string, body Defaultgreetinglist) (*Defaultgreetinglist, *APIResponse, error)

PutUserGreetingsDefaults invokes PUT /api/v2/users/{userId}/greetings/defaults

Updates the DefaultGreetingList of the specified User

type Group ¶

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

	// Name - The group name.
	Name *string `json:"name,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

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

	// MemberCount - Number of members.
	MemberCount *int `json:"memberCount,omitempty"`

	// State - Active, inactive, or deleted state.
	State *string `json:"state,omitempty"`

	// Version - Current version for this resource.
	Version *int `json:"version,omitempty"`

	// VarType - Type of group.
	VarType *string `json:"type,omitempty"`

	// Images
	Images *[]Userimage `json:"images,omitempty"`

	// Addresses
	Addresses *[]Groupcontact `json:"addresses,omitempty"`

	// RulesVisible - Are membership rules visible to the person requesting to view the group
	RulesVisible *bool `json:"rulesVisible,omitempty"`

	// Visibility - Who can view this group
	Visibility *string `json:"visibility,omitempty"`

	// Owners - Owners of the group
	Owners *[]User `json:"owners,omitempty"`

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

Group

func (*Group) String ¶

func (o *Group) String() string

String returns a JSON representation of the model

type Groupcontact ¶

type Groupcontact struct {
	// Address - Phone number for this contact type
	Address *string `json:"address,omitempty"`

	// Extension - Extension is set if the number is e164 valid
	Extension *string `json:"extension,omitempty"`

	// Display - Formatted version of the address property
	Display *string `json:"display,omitempty"`

	// VarType - Contact type of the address
	VarType *string `json:"type,omitempty"`

	// MediaType - Media type of the address
	MediaType *string `json:"mediaType,omitempty"`
}

Groupcontact

func (*Groupcontact) String ¶

func (o *Groupcontact) String() string

String returns a JSON representation of the model

type Groupcreate ¶

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

	// Name - The group name.
	Name *string `json:"name,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

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

	// MemberCount - Number of members.
	MemberCount *int `json:"memberCount,omitempty"`

	// State - Active, inactive, or deleted state.
	State *string `json:"state,omitempty"`

	// Version - Current version for this resource.
	Version *int `json:"version,omitempty"`

	// VarType - Type of group.
	VarType *string `json:"type,omitempty"`

	// Images
	Images *[]Userimage `json:"images,omitempty"`

	// Addresses
	Addresses *[]Groupcontact `json:"addresses,omitempty"`

	// RulesVisible - Are membership rules visible to the person requesting to view the group
	RulesVisible *bool `json:"rulesVisible,omitempty"`

	// Visibility - Who can view this group
	Visibility *string `json:"visibility,omitempty"`

	// OwnerIds - Owners of the group
	OwnerIds *[]string `json:"ownerIds,omitempty"`

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

Groupcreate

func (*Groupcreate) String ¶

func (o *Groupcreate) String() string

String returns a JSON representation of the model

type Groupentitylisting ¶

type Groupentitylisting struct {
	// Entities
	Entities *[]Group `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"`

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

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

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

Groupentitylisting

func (*Groupentitylisting) String ¶

func (o *Groupentitylisting) String() string

String returns a JSON representation of the model

type Groupgreetingeventgreeting ¶

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

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

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

	// OwnerType
	OwnerType *string `json:"ownerType,omitempty"`

	// Owner
	Owner *Groupgreetingeventgreetingowner `json:"owner,omitempty"`

	// GreetingAudioFile
	GreetingAudioFile *Groupgreetingeventgreetingaudiofile `json:"greetingAudioFile,omitempty"`

	// AudioTTS
	AudioTTS *string `json:"audioTTS,omitempty"`
}

Groupgreetingeventgreeting

func (*Groupgreetingeventgreeting) String ¶

func (o *Groupgreetingeventgreeting) String() string

String returns a JSON representation of the model

type Groupgreetingeventgreetingaudiofile ¶

type Groupgreetingeventgreetingaudiofile struct {
	// DurationMilliseconds
	DurationMilliseconds *int `json:"durationMilliseconds,omitempty"`

	// SizeBytes
	SizeBytes *int `json:"sizeBytes,omitempty"`
}

Groupgreetingeventgreetingaudiofile

func (*Groupgreetingeventgreetingaudiofile) String ¶

String returns a JSON representation of the model

type Groupgreetingeventgreetingowner ¶

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

Groupgreetingeventgreetingowner

func (*Groupgreetingeventgreetingowner) String ¶

String returns a JSON representation of the model

type Groupmembersupdate ¶

type Groupmembersupdate struct {
	// MemberIds - A list of the ids of the members to add.
	MemberIds *[]string `json:"memberIds,omitempty"`

	// Version - The current group version.
	Version *int `json:"version,omitempty"`
}

Groupmembersupdate

func (*Groupmembersupdate) String ¶

func (o *Groupmembersupdate) String() string

String returns a JSON representation of the model

type Groupprofile ¶

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

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

	// State - The state of the user resource
	State *string `json:"state,omitempty"`

	// DateModified - Datetime of the last modification. 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 - The version of the group resource
	Version *int `json:"version,omitempty"`

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

Groupprofile

func (*Groupprofile) String ¶

func (o *Groupprofile) String() string

String returns a JSON representation of the model

type Groupprofileentitylisting ¶

type Groupprofileentitylisting struct {
	// Entities
	Entities *[]Groupprofile `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"`

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

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

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

Groupprofileentitylisting

func (*Groupprofileentitylisting) String ¶

func (o *Groupprofileentitylisting) String() string

String returns a JSON representation of the model

type GroupsApi ¶

type GroupsApi struct {
	Configuration *Configuration
}

GroupsApi provides functions for API endpoints

func NewGroupsApi ¶

func NewGroupsApi() *GroupsApi

NewGroupsApi creates an API instance using the default configuration

func NewGroupsApiWithConfig ¶

func NewGroupsApiWithConfig(config *Configuration) *GroupsApi

NewGroupsApiWithConfig creates an API instance using the provided configuration

func (GroupsApi) DeleteGroup ¶

func (a GroupsApi) DeleteGroup(groupId string) (*APIResponse, error)

DeleteGroup invokes DELETE /api/v2/groups/{groupId}

Delete group

func (GroupsApi) DeleteGroupMembers ¶

func (a GroupsApi) DeleteGroupMembers(groupId string, ids string) (*Empty, *APIResponse, error)

DeleteGroupMembers invokes DELETE /api/v2/groups/{groupId}/members

Remove members

func (GroupsApi) GetFieldconfig ¶

func (a GroupsApi) GetFieldconfig(varType string) (*Fieldconfig, *APIResponse, error)

GetFieldconfig invokes GET /api/v2/fieldconfig

Fetch field config for an entity type

func (GroupsApi) GetGroup ¶

func (a GroupsApi) GetGroup(groupId string) (*Group, *APIResponse, error)

GetGroup invokes GET /api/v2/groups/{groupId}

Get group

func (GroupsApi) GetGroupIndividuals ¶

func (a GroupsApi) GetGroupIndividuals(groupId string) (*Userentitylisting, *APIResponse, error)

GetGroupIndividuals invokes GET /api/v2/groups/{groupId}/individuals

Get all individuals associated with the group

func (GroupsApi) GetGroupMembers ¶

func (a GroupsApi) GetGroupMembers(groupId string, pageSize int, pageNumber int, sortOrder string, expand []string) (*Userentitylisting, *APIResponse, error)

GetGroupMembers invokes GET /api/v2/groups/{groupId}/members

Get group members, includes individuals, owners, and dynamically included people

func (GroupsApi) GetGroupProfile ¶

func (a GroupsApi) GetGroupProfile(groupId string, fields string) (*Groupprofile, *APIResponse, error)

GetGroupProfile invokes GET /api/v2/groups/{groupId}/profile

Get group profile ¶

This api is deprecated. Use /api/v2/groups instead

func (GroupsApi) GetGroups ¶

func (a GroupsApi) GetGroups(pageSize int, pageNumber int, id []string, jabberId []string, sortOrder string) (*Groupentitylisting, *APIResponse, error)

GetGroups invokes GET /api/v2/groups

Get a group list

func (GroupsApi) GetGroupsSearch ¶

func (a GroupsApi) GetGroupsSearch(q64 string, expand []string) (*Groupssearchresponse, *APIResponse, error)

GetGroupsSearch invokes GET /api/v2/groups/search

Search groups using the q64 value returned from a previous search

func (GroupsApi) GetProfilesGroups ¶

func (a GroupsApi) GetProfilesGroups(pageSize int, pageNumber int, id []string, sortOrder string) (*Groupprofileentitylisting, *APIResponse, error)

GetProfilesGroups invokes GET /api/v2/profiles/groups

Get group profile listing ¶

This api is deprecated. Use /api/v2/groups instead.

func (GroupsApi) PostGroupMembers ¶

func (a GroupsApi) PostGroupMembers(groupId string, body Groupmembersupdate) (*Empty, *APIResponse, error)

PostGroupMembers invokes POST /api/v2/groups/{groupId}/members

Add members

func (GroupsApi) PostGroups ¶

func (a GroupsApi) PostGroups(body Groupcreate) (*Group, *APIResponse, error)

PostGroups invokes POST /api/v2/groups

Create a group

func (GroupsApi) PostGroupsSearch ¶

func (a GroupsApi) PostGroupsSearch(body Groupsearchrequest) (*Groupssearchresponse, *APIResponse, error)

PostGroupsSearch invokes POST /api/v2/groups/search

Search groups

func (GroupsApi) PutGroup ¶

func (a GroupsApi) PutGroup(groupId string, body Groupupdate) (*Group, *APIResponse, error)

PutGroup invokes PUT /api/v2/groups/{groupId}

Update group

type Groupsearchcriteria ¶

type Groupsearchcriteria struct {
	// EndValue - The end value of the range. This field is used for range search types.
	EndValue *string `json:"endValue,omitempty"`

	// Values - A list of values for the search to match against
	Values *[]string `json:"values,omitempty"`

	// StartValue - The start value of the range. This field is used for range search types.
	StartValue *string `json:"startValue,omitempty"`

	// Fields - Field names to search against
	Fields *[]string `json:"fields,omitempty"`

	// Value - A value for the search to match against
	Value *string `json:"value,omitempty"`

	// Operator - How to apply this search criteria against other criteria
	Operator *string `json:"operator,omitempty"`

	// Group - Groups multiple conditions
	Group *[]Groupsearchcriteria `json:"group,omitempty"`

	// DateFormat - Set date format for criteria values when using date range search type.  Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX.
	DateFormat *string `json:"dateFormat,omitempty"`

	// VarType - Search Type
	VarType *string `json:"type,omitempty"`
}

Groupsearchcriteria

func (*Groupsearchcriteria) String ¶

func (o *Groupsearchcriteria) String() string

String returns a JSON representation of the model

type Groupsearchrequest ¶

type Groupsearchrequest struct {
	// SortOrder - The sort order for results
	SortOrder *string `json:"sortOrder,omitempty"`

	// SortBy - The field in the resource that you want to sort the results by
	SortBy *string `json:"sortBy,omitempty"`

	// PageSize - The number of results per page
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The page of resources you want to retrieve
	PageNumber *int `json:"pageNumber,omitempty"`

	// Sort - Multi-value sort order, list of multiple sort values
	Sort *[]Searchsort `json:"sort,omitempty"`

	// Query
	Query *[]Groupsearchcriteria `json:"query,omitempty"`
}

Groupsearchrequest

func (*Groupsearchrequest) String ¶

func (o *Groupsearchrequest) String() string

String returns a JSON representation of the model

type Groupssearchresponse ¶

type Groupssearchresponse struct {
	// Total - The total number of results found
	Total *int `json:"total,omitempty"`

	// PageCount - The total number of pages
	PageCount *int `json:"pageCount,omitempty"`

	// PageSize - The current page size
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The current page number
	PageNumber *int `json:"pageNumber,omitempty"`

	// PreviousPage - Q64 value for the previous page of results
	PreviousPage *string `json:"previousPage,omitempty"`

	// CurrentPage - Q64 value for the current page of results
	CurrentPage *string `json:"currentPage,omitempty"`

	// NextPage - Q64 value for the next page of results
	NextPage *string `json:"nextPage,omitempty"`

	// Types - Resource types the search was performed against
	Types *[]string `json:"types,omitempty"`

	// Results - Search results
	Results *[]Group `json:"results,omitempty"`
}

Groupssearchresponse

func (*Groupssearchresponse) String ¶

func (o *Groupssearchresponse) String() string

String returns a JSON representation of the model

type Groupupdate ¶

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

	// Name - The group name.
	Name *string `json:"name,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

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

	// Version - Current version for this resource.
	Version *int `json:"version,omitempty"`

	// Images
	Images *[]Userimage `json:"images,omitempty"`

	// Addresses
	Addresses *[]Groupcontact `json:"addresses,omitempty"`

	// RulesVisible - Are membership rules visible to the person requesting to view the group
	RulesVisible *bool `json:"rulesVisible,omitempty"`

	// Visibility - Who can view this group
	Visibility *string `json:"visibility,omitempty"`

	// OwnerIds - Owners of the group
	OwnerIds *[]string `json:"ownerIds,omitempty"`

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

Groupupdate

func (*Groupupdate) String ¶

func (o *Groupupdate) String() string

String returns a JSON representation of the model

type Gsuite ¶

type Gsuite 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"`
}

Gsuite

func (*Gsuite) String ¶

func (o *Gsuite) String() string

String returns a JSON representation of the model

type Guestmemberinfo ¶

type Guestmemberinfo struct {
	// DisplayName - The display name to use for the guest member in the conversation.
	DisplayName *string `json:"displayName,omitempty"`

	// FirstName - The first name to use for the guest member in the conversation.
	FirstName *string `json:"firstName,omitempty"`

	// LastName - The last name to use for the guest member in the conversation.
	LastName *string `json:"lastName,omitempty"`

	// Email - The email address to use for the guest member in the conversation.
	Email *string `json:"email,omitempty"`

	// PhoneNumber - The phone number to use for the guest member in the conversation.
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// AvatarImageUrl - The URL to the avatar image to use for the guest member in the conversation, if any.
	AvatarImageUrl *string `json:"avatarImageUrl,omitempty"`

	// CustomFields - Any custom fields of information, in key-value format, to attach to the guest member in the conversation.
	CustomFields *map[string]string `json:"customFields,omitempty"`
}

Guestmemberinfo

func (*Guestmemberinfo) String ¶

func (o *Guestmemberinfo) String() string

String returns a JSON representation of the model

type Headcountforecast ¶

type Headcountforecast struct {
	// Required - Headcount information with shrinkage
	Required *[]Headcountinterval `json:"required,omitempty"`

	// RequiredWithoutShrinkage - Headcount information without shrinkage
	RequiredWithoutShrinkage *[]Headcountinterval `json:"requiredWithoutShrinkage,omitempty"`
}

Headcountforecast - Headcount interval information for schedule

func (*Headcountforecast) String ¶

func (o *Headcountforecast) String() string

String returns a JSON representation of the model

type Headcountinterval ¶

type Headcountinterval struct {
	// Interval - The start date-time for this headcount interval in ISO-8601 format, must be within the 8 day schedule
	Interval *time.Time `json:"interval,omitempty"`

	// Value - Headcount value for this interval
	Value *float64 `json:"value,omitempty"`
}

Headcountinterval - Headcount interval information for schedule

func (*Headcountinterval) String ¶

func (o *Headcountinterval) String() string

String returns a JSON representation of the model

type Helplink struct {
	// Uri - URI of the help resource
	Uri *string `json:"uri,omitempty"`

	// Title - Link text of the resource
	Title *string `json:"title,omitempty"`

	// Description - Description of the document or resource
	Description *string `json:"description,omitempty"`
}

Helplink - Link to a help or support resource

func (*Helplink) String ¶

func (o *Helplink) String() string

String returns a JSON representation of the model

type Historicaladherenceactuals ¶

type Historicaladherenceactuals struct {
	// ActualActivityCategory - Activity in which the user is actually engaged
	ActualActivityCategory *string `json:"actualActivityCategory,omitempty"`

	// StartOffsetSeconds - Actual start offset in seconds relative to query start time
	StartOffsetSeconds *int `json:"startOffsetSeconds,omitempty"`

	// EndOffsetSeconds - Actual end offset in seconds relative to query start time
	EndOffsetSeconds *int `json:"endOffsetSeconds,omitempty"`
}

Historicaladherenceactuals

func (*Historicaladherenceactuals) String ¶

func (o *Historicaladherenceactuals) String() string

String returns a JSON representation of the model

type Historicaladherencedaymetrics ¶

type Historicaladherencedaymetrics struct {
	// DayStartOffsetSecs - Start of day offset in seconds relative to query start time
	DayStartOffsetSecs *int `json:"dayStartOffsetSecs,omitempty"`

	// AdherenceScheduleSecs - Duration of schedule in seconds included for adherence percentage calculation
	AdherenceScheduleSecs *int `json:"adherenceScheduleSecs,omitempty"`

	// ConformanceScheduleSecs - Total scheduled duration in seconds for OnQueue activities
	ConformanceScheduleSecs *int `json:"conformanceScheduleSecs,omitempty"`

	// ConformanceActualSecs - Total actually worked duration in seconds for OnQueue activities
	ConformanceActualSecs *int `json:"conformanceActualSecs,omitempty"`

	// ExceptionCount - Total number of adherence exceptions for this user
	ExceptionCount *int `json:"exceptionCount,omitempty"`

	// ExceptionDurationSecs - Total duration in seconds of adherence exceptions for this user
	ExceptionDurationSecs *int `json:"exceptionDurationSecs,omitempty"`

	// ImpactSeconds - The impact duration in seconds of current adherence state for this user
	ImpactSeconds *int `json:"impactSeconds,omitempty"`

	// ScheduleLengthSecs - Total duration in seconds for all scheduled activities
	ScheduleLengthSecs *int `json:"scheduleLengthSecs,omitempty"`

	// ActualLengthSecs - Total duration in seconds for all actually worked activities
	ActualLengthSecs *int `json:"actualLengthSecs,omitempty"`

	// AdherencePercentage - Total adherence percentage for this user, in the scale of 0 - 100
	AdherencePercentage *float64 `json:"adherencePercentage,omitempty"`

	// ConformancePercentage - Total conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period.
	ConformancePercentage *float64 `json:"conformancePercentage,omitempty"`
}

Historicaladherencedaymetrics

func (*Historicaladherencedaymetrics) String ¶

String returns a JSON representation of the model

type Historicaladherenceexceptioninfo ¶

type Historicaladherenceexceptioninfo struct {
	// StartOffsetSeconds - Exception start offset in seconds relative to query start time
	StartOffsetSeconds *int `json:"startOffsetSeconds,omitempty"`

	// EndOffsetSeconds - Exception end offset in seconds relative to query start time
	EndOffsetSeconds *int `json:"endOffsetSeconds,omitempty"`

	// ScheduledActivityCodeId - The ID of the scheduled activity for this user
	ScheduledActivityCodeId *string `json:"scheduledActivityCodeId,omitempty"`

	// ScheduledActivityCategory - Activity for which the user is scheduled
	ScheduledActivityCategory *string `json:"scheduledActivityCategory,omitempty"`

	// ActualActivityCategory - Activity for which the user is actually engaged
	ActualActivityCategory *string `json:"actualActivityCategory,omitempty"`

	// SystemPresence - Actual underlying system presence value
	SystemPresence *string `json:"systemPresence,omitempty"`

	// RoutingStatus - Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue
	RoutingStatus *Routingstatus `json:"routingStatus,omitempty"`

	// Impact - The impact of the current adherence state for this user
	Impact *string `json:"impact,omitempty"`

	// SecondaryPresenceLookupId - The lookup ID used to retrieve secondary status from map of lookup ID to corresponding secondary presence ID
	SecondaryPresenceLookupId *string `json:"secondaryPresenceLookupId,omitempty"`
}

Historicaladherenceexceptioninfo

func (*Historicaladherenceexceptioninfo) String ¶

String returns a JSON representation of the model

type Historicaladherencequeryresult ¶

type Historicaladherencequeryresult struct {
	// UserId - The ID of the user for whom the adherence is queried
	UserId *string `json:"userId,omitempty"`

	// StartDate - Beginning of the date range that was queried, in ISO-8601 format
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - End of the date range that was queried, in ISO-8601 format. If it was not set, end date will be set to the queried time
	EndDate *time.Time `json:"endDate,omitempty"`

	// AdherencePercentage - Adherence percentage for this user, in the scale of 0 - 100
	AdherencePercentage *float64 `json:"adherencePercentage,omitempty"`

	// ConformancePercentage - Conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period.
	ConformancePercentage *float64 `json:"conformancePercentage,omitempty"`

	// Impact - The impact of the current adherence state for this user
	Impact *string `json:"impact,omitempty"`

	// ExceptionInfo - List of adherence exceptions for this user
	ExceptionInfo *[]Historicaladherenceexceptioninfo `json:"exceptionInfo,omitempty"`

	// DayMetrics - Adherence and conformance metrics for days in query range
	DayMetrics *[]Historicaladherencedaymetrics `json:"dayMetrics,omitempty"`

	// Actuals - List of actual activity with offset for this user
	Actuals *[]Historicaladherenceactuals `json:"actuals,omitempty"`
}

Historicaladherencequeryresult

func (*Historicaladherencequeryresult) String ¶

String returns a JSON representation of the model

type Historicalimportdeletejobresponse ¶

type Historicalimportdeletejobresponse struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Status - Property denoting the status of the delete.
	Status *string `json:"status,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Historicalimportdeletejobresponse

func (*Historicalimportdeletejobresponse) String ¶

String returns a JSON representation of the model

type Historicalimportstatus ¶

type Historicalimportstatus struct {
	// RequestId - Request id of the historical import in the organization
	RequestId *string `json:"requestId,omitempty"`

	// DateImportEnded - The last day of the data you are importing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateImportEnded *time.Time `json:"dateImportEnded,omitempty"`

	// DateImportStarted - The first day of the data you are importing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateImportStarted *time.Time `json:"dateImportStarted,omitempty"`

	// Status - Status of the historical import in the organization.
	Status *string `json:"status,omitempty"`

	// VarError - Error occured if the status of the import is failed
	VarError *string `json:"error,omitempty"`

	// DateCreated - Date in which the historical import is initiated. 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 - Date in which the historical import is 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"`

	// Active - Whether this historical import is active or not
	Active *bool `json:"active,omitempty"`

	// VarType - Whether this historical import is of type csv or json
	VarType *string `json:"type,omitempty"`
}

Historicalimportstatus

func (*Historicalimportstatus) String ¶

func (o *Historicalimportstatus) String() string

String returns a JSON representation of the model

type Historicalimportstatuslisting ¶

type Historicalimportstatuslisting struct {
	// Entities
	Entities *[]Historicalimportstatus `json:"entities,omitempty"`
}

Historicalimportstatuslisting

func (*Historicalimportstatuslisting) String ¶

String returns a JSON representation of the model

type Historyentry ¶

type Historyentry struct {
	// Action - The action performed
	Action *string `json:"action,omitempty"`

	// Resource - For actions performed not on the item itself, but on a sub-item, this field identifies the sub-item by name.  For example, for actions performed on prompt resources, this will be the prompt resource name.
	Resource *string `json:"resource,omitempty"`

	// Timestamp - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Timestamp *time.Time `json:"timestamp,omitempty"`

	// User - User associated with this entry.
	User *User `json:"user,omitempty"`

	// Client - OAuth client associated with this entry.
	Client *Domainentityref `json:"client,omitempty"`

	// Version
	Version *string `json:"version,omitempty"`

	// Secure
	Secure *bool `json:"secure,omitempty"`
}

Historyentry

func (*Historyentry) String ¶

func (o *Historyentry) String() string

String returns a JSON representation of the model

type Historylisting ¶

type Historylisting struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Complete
	Complete *bool `json:"complete,omitempty"`

	// User
	User *User `json:"user,omitempty"`

	// Client
	Client *Domainentityref `json:"client,omitempty"`

	// ErrorMessage
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// ErrorDetails
	ErrorDetails *[]Detail `json:"errorDetails,omitempty"`

	// ErrorMessageParams
	ErrorMessageParams *map[string]string `json:"errorMessageParams,omitempty"`

	// ActionName - Action name
	ActionName *string `json:"actionName,omitempty"`

	// ActionStatus - Action status
	ActionStatus *string `json:"actionStatus,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// System
	System *bool `json:"system,omitempty"`

	// Started - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Started *time.Time `json:"started,omitempty"`

	// Completed - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Completed *time.Time `json:"completed,omitempty"`

	// Entities
	Entities *[]Historyentry `json:"entities,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Historylisting

func (*Historylisting) String ¶

func (o *Historylisting) String() string

String returns a JSON representation of the model

type Homerrecord ¶

type Homerrecord struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Date - metadata associated to the SIP calls. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Date *time.Time `json:"date,omitempty"`

	// MilliTs - metadata associated to the SIP calls
	MilliTs *string `json:"milliTs,omitempty"`

	// MicroTs - metadata associated to the SIP calls
	MicroTs *string `json:"microTs,omitempty"`

	// Method - metadata associated to the SIP calls
	Method *string `json:"method,omitempty"`

	// ReplyReason - metadata associated to the SIP calls
	ReplyReason *string `json:"replyReason,omitempty"`

	// Ruri - metadata associated to the SIP calls
	Ruri *string `json:"ruri,omitempty"`

	// RuriUser - metadata associated to the SIP calls
	RuriUser *string `json:"ruriUser,omitempty"`

	// RuriDomain - metadata associated to the SIP calls
	RuriDomain *string `json:"ruriDomain,omitempty"`

	// FromUser - metadata associated to the SIP calls
	FromUser *string `json:"fromUser,omitempty"`

	// FromDomain - metadata associated to the SIP calls
	FromDomain *string `json:"fromDomain,omitempty"`

	// FromTag - metadata associated to the SIP calls
	FromTag *string `json:"fromTag,omitempty"`

	// ToUser - metadata associated to the SIP calls
	ToUser *string `json:"toUser,omitempty"`

	// ToDomain - metadata associated to the SIP calls
	ToDomain *string `json:"toDomain,omitempty"`

	// ToTag - metadata associated to the SIP calls
	ToTag *string `json:"toTag,omitempty"`

	// PidUser - metadata associated to the SIP calls
	PidUser *string `json:"pidUser,omitempty"`

	// ContactUser - metadata associated to the SIP calls
	ContactUser *string `json:"contactUser,omitempty"`

	// AuthUser - metadata associated to the SIP calls
	AuthUser *string `json:"authUser,omitempty"`

	// Callid - metadata associated to the SIP calls
	Callid *string `json:"callid,omitempty"`

	// CallidAleg - metadata associated to the SIP calls
	CallidAleg *string `json:"callidAleg,omitempty"`

	// Via1 - metadata associated to the SIP calls
	Via1 *string `json:"via1,omitempty"`

	// Via1Branch - metadata associated to the SIP calls
	Via1Branch *string `json:"via1Branch,omitempty"`

	// Cseq - metadata associated to the SIP calls
	Cseq *string `json:"cseq,omitempty"`

	// Diversion - metadata associated to the SIP calls
	Diversion *string `json:"diversion,omitempty"`

	// Reason - metadata associated to the SIP calls
	Reason *string `json:"reason,omitempty"`

	// ContentType - metadata associated to the SIP calls
	ContentType *string `json:"contentType,omitempty"`

	// Auth - metadata associated to the SIP calls
	Auth *string `json:"auth,omitempty"`

	// UserAgent - metadata associated to the SIP calls
	UserAgent *string `json:"userAgent,omitempty"`

	// SourceIp - metadata associated to the SIP calls
	SourceIp *string `json:"sourceIp,omitempty"`

	// SourcePort - metadata associated to the SIP calls
	SourcePort *string `json:"sourcePort,omitempty"`

	// DestinationIp - metadata associated to the SIP calls
	DestinationIp *string `json:"destinationIp,omitempty"`

	// DestinationPort - metadata associated to the SIP calls
	DestinationPort *string `json:"destinationPort,omitempty"`

	// ContactIp - metadata associated to the SIP calls
	ContactIp *string `json:"contactIp,omitempty"`

	// ContactPort - metadata associated to the SIP calls
	ContactPort *string `json:"contactPort,omitempty"`

	// OriginatorIp - metadata associated to the SIP calls
	OriginatorIp *string `json:"originatorIp,omitempty"`

	// OriginatorPort - metadata associated to the SIP calls
	OriginatorPort *string `json:"originatorPort,omitempty"`

	// CorrelationId - metadata associated to the SIP calls
	CorrelationId *string `json:"correlationId,omitempty"`

	// Proto - metadata associated to the SIP calls
	Proto *string `json:"proto,omitempty"`

	// Family - metadata associated to the SIP calls
	Family *string `json:"family,omitempty"`

	// RtpStat - metadata associated to the SIP calls
	RtpStat *string `json:"rtpStat,omitempty"`

	// VarType - metadata associated to the SIP calls
	VarType *string `json:"type,omitempty"`

	// Node - metadata associated to the SIP calls
	Node *string `json:"node,omitempty"`

	// Trans - metadata associated to the SIP calls
	Trans *string `json:"trans,omitempty"`

	// Dbnode - metadata associated to the SIP calls
	Dbnode *string `json:"dbnode,omitempty"`

	// Msg - metadata associated to the SIP calls
	Msg *string `json:"msg,omitempty"`

	// SourceAlias - metadata associated to the SIP calls
	SourceAlias *string `json:"sourceAlias,omitempty"`

	// DestinationAlias - metadata associated to the SIP calls
	DestinationAlias *string `json:"destinationAlias,omitempty"`

	// ConversationId - metadata associated to the SIP calls
	ConversationId *string `json:"conversationId,omitempty"`

	// ParticipantId - metadata associated to the SIP calls
	ParticipantId *string `json:"participantId,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Homerrecord

func (*Homerrecord) String ¶

func (o *Homerrecord) String() string

String returns a JSON representation of the model

type IdentityProviderApi ¶

type IdentityProviderApi struct {
	Configuration *Configuration
}

IdentityProviderApi provides functions for API endpoints

func NewIdentityProviderApi ¶

func NewIdentityProviderApi() *IdentityProviderApi

NewIdentityProviderApi creates an API instance using the default configuration

func NewIdentityProviderApiWithConfig ¶

func NewIdentityProviderApiWithConfig(config *Configuration) *IdentityProviderApi

NewIdentityProviderApiWithConfig creates an API instance using the provided configuration

func (IdentityProviderApi) DeleteIdentityprovidersAdfs ¶

func (a IdentityProviderApi) DeleteIdentityprovidersAdfs() (*Empty, *APIResponse, error)

DeleteIdentityprovidersAdfs invokes DELETE /api/v2/identityproviders/adfs

Delete ADFS Identity Provider

func (IdentityProviderApi) DeleteIdentityprovidersCic ¶

func (a IdentityProviderApi) DeleteIdentityprovidersCic() (*Empty, *APIResponse, error)

DeleteIdentityprovidersCic invokes DELETE /api/v2/identityproviders/cic

Delete Customer Interaction Center (CIC) Identity Provider

func (IdentityProviderApi) DeleteIdentityprovidersGeneric ¶

func (a IdentityProviderApi) DeleteIdentityprovidersGeneric() (*Empty, *APIResponse, error)

DeleteIdentityprovidersGeneric invokes DELETE /api/v2/identityproviders/generic

Delete Generic SAML Identity Provider

func (IdentityProviderApi) DeleteIdentityprovidersGsuite ¶

func (a IdentityProviderApi) DeleteIdentityprovidersGsuite() (*Empty, *APIResponse, error)

DeleteIdentityprovidersGsuite invokes DELETE /api/v2/identityproviders/gsuite

Delete G Suite Identity Provider

func (IdentityProviderApi) DeleteIdentityprovidersIdentitynow ¶

func (a IdentityProviderApi) DeleteIdentityprovidersIdentitynow() (*Empty, *APIResponse, error)

DeleteIdentityprovidersIdentitynow invokes DELETE /api/v2/identityproviders/identitynow

Delete IdentityNow Provider

func (IdentityProviderApi) DeleteIdentityprovidersOkta ¶

func (a IdentityProviderApi) DeleteIdentityprovidersOkta() (*Empty, *APIResponse, error)

DeleteIdentityprovidersOkta invokes DELETE /api/v2/identityproviders/okta

Delete Okta Identity Provider

func (IdentityProviderApi) DeleteIdentityprovidersOnelogin ¶

func (a IdentityProviderApi) DeleteIdentityprovidersOnelogin() (*Empty, *APIResponse, error)

DeleteIdentityprovidersOnelogin invokes DELETE /api/v2/identityproviders/onelogin

Delete OneLogin Identity Provider

func (IdentityProviderApi) DeleteIdentityprovidersPing ¶

func (a IdentityProviderApi) DeleteIdentityprovidersPing() (*Empty, *APIResponse, error)

DeleteIdentityprovidersPing invokes DELETE /api/v2/identityproviders/ping

Delete Ping Identity Provider

func (IdentityProviderApi) DeleteIdentityprovidersPurecloud ¶

func (a IdentityProviderApi) DeleteIdentityprovidersPurecloud() (*Empty, *APIResponse, error)

DeleteIdentityprovidersPurecloud invokes DELETE /api/v2/identityproviders/purecloud

Delete PureCloud Identity Provider

func (IdentityProviderApi) DeleteIdentityprovidersPureengage ¶

func (a IdentityProviderApi) DeleteIdentityprovidersPureengage() (*Empty, *APIResponse, error)

DeleteIdentityprovidersPureengage invokes DELETE /api/v2/identityproviders/pureengage

Delete PureEngage Identity Provider

func (IdentityProviderApi) DeleteIdentityprovidersSalesforce ¶

func (a IdentityProviderApi) DeleteIdentityprovidersSalesforce() (*Empty, *APIResponse, error)

DeleteIdentityprovidersSalesforce invokes DELETE /api/v2/identityproviders/salesforce

Delete Salesforce Identity Provider

func (IdentityProviderApi) GetIdentityproviders ¶

func (a IdentityProviderApi) GetIdentityproviders() (*Oauthproviderentitylisting, *APIResponse, error)

GetIdentityproviders invokes GET /api/v2/identityproviders

The list of identity providers

func (IdentityProviderApi) GetIdentityprovidersAdfs ¶

func (a IdentityProviderApi) GetIdentityprovidersAdfs() (*Adfs, *APIResponse, error)

GetIdentityprovidersAdfs invokes GET /api/v2/identityproviders/adfs

Get ADFS Identity Provider

func (IdentityProviderApi) GetIdentityprovidersCic ¶

func (a IdentityProviderApi) GetIdentityprovidersCic() (*Customerinteractioncenter, *APIResponse, error)

GetIdentityprovidersCic invokes GET /api/v2/identityproviders/cic

Get Customer Interaction Center (CIC) Identity Provider

func (IdentityProviderApi) GetIdentityprovidersGeneric ¶

func (a IdentityProviderApi) GetIdentityprovidersGeneric() (*Genericsaml, *APIResponse, error)

GetIdentityprovidersGeneric invokes GET /api/v2/identityproviders/generic

Get Generic SAML Identity Provider

func (IdentityProviderApi) GetIdentityprovidersGsuite ¶

func (a IdentityProviderApi) GetIdentityprovidersGsuite() (*Gsuite, *APIResponse, error)

GetIdentityprovidersGsuite invokes GET /api/v2/identityproviders/gsuite

Get G Suite Identity Provider

func (IdentityProviderApi) GetIdentityprovidersIdentitynow ¶

func (a IdentityProviderApi) GetIdentityprovidersIdentitynow() (*Identitynow, *APIResponse, error)

GetIdentityprovidersIdentitynow invokes GET /api/v2/identityproviders/identitynow

Get IdentityNow Provider

func (IdentityProviderApi) GetIdentityprovidersOkta ¶

func (a IdentityProviderApi) GetIdentityprovidersOkta() (*Okta, *APIResponse, error)

GetIdentityprovidersOkta invokes GET /api/v2/identityproviders/okta

Get Okta Identity Provider

func (IdentityProviderApi) GetIdentityprovidersOnelogin ¶

func (a IdentityProviderApi) GetIdentityprovidersOnelogin() (*Onelogin, *APIResponse, error)

GetIdentityprovidersOnelogin invokes GET /api/v2/identityproviders/onelogin

Get OneLogin Identity Provider

func (IdentityProviderApi) GetIdentityprovidersPing ¶

func (a IdentityProviderApi) GetIdentityprovidersPing() (*Pingidentity, *APIResponse, error)

GetIdentityprovidersPing invokes GET /api/v2/identityproviders/ping

Get Ping Identity Provider

func (IdentityProviderApi) GetIdentityprovidersPurecloud ¶

func (a IdentityProviderApi) GetIdentityprovidersPurecloud() (*Purecloud, *APIResponse, error)

GetIdentityprovidersPurecloud invokes GET /api/v2/identityproviders/purecloud

Get PureCloud Identity Provider

func (IdentityProviderApi) GetIdentityprovidersPureengage ¶

func (a IdentityProviderApi) GetIdentityprovidersPureengage() (*Pureengage, *APIResponse, error)

GetIdentityprovidersPureengage invokes GET /api/v2/identityproviders/pureengage

Get PureEngage Identity Provider

func (IdentityProviderApi) GetIdentityprovidersSalesforce ¶

func (a IdentityProviderApi) GetIdentityprovidersSalesforce() (*Salesforce, *APIResponse, error)

GetIdentityprovidersSalesforce invokes GET /api/v2/identityproviders/salesforce

Get Salesforce Identity Provider

func (IdentityProviderApi) PutIdentityprovidersAdfs ¶

func (a IdentityProviderApi) PutIdentityprovidersAdfs(body Adfs) (*Oauthprovider, *APIResponse, error)

PutIdentityprovidersAdfs invokes PUT /api/v2/identityproviders/adfs

Update/Create ADFS Identity Provider

func (IdentityProviderApi) PutIdentityprovidersCic ¶

func (a IdentityProviderApi) PutIdentityprovidersCic(body Customerinteractioncenter) (*Oauthprovider, *APIResponse, error)

PutIdentityprovidersCic invokes PUT /api/v2/identityproviders/cic

Update/Create Customer Interaction Center (CIC) Identity Provider

func (IdentityProviderApi) PutIdentityprovidersGeneric ¶

func (a IdentityProviderApi) PutIdentityprovidersGeneric(body Genericsaml) (*Oauthprovider, *APIResponse, error)

PutIdentityprovidersGeneric invokes PUT /api/v2/identityproviders/generic

Update/Create Generic SAML Identity Provider

func (IdentityProviderApi) PutIdentityprovidersGsuite ¶

func (a IdentityProviderApi) PutIdentityprovidersGsuite(body Gsuite) (*Oauthprovider, *APIResponse, error)

PutIdentityprovidersGsuite invokes PUT /api/v2/identityproviders/gsuite

Update/Create G Suite Identity Provider

func (IdentityProviderApi) PutIdentityprovidersIdentitynow ¶

func (a IdentityProviderApi) PutIdentityprovidersIdentitynow(body Identitynow) (*Identitynow, *APIResponse, error)

PutIdentityprovidersIdentitynow invokes PUT /api/v2/identityproviders/identitynow

Update/Create IdentityNow Provider

func (IdentityProviderApi) PutIdentityprovidersOkta ¶

func (a IdentityProviderApi) PutIdentityprovidersOkta(body Okta) (*Oauthprovider, *APIResponse, error)

PutIdentityprovidersOkta invokes PUT /api/v2/identityproviders/okta

Update/Create Okta Identity Provider

func (IdentityProviderApi) PutIdentityprovidersOnelogin ¶

func (a IdentityProviderApi) PutIdentityprovidersOnelogin(body Onelogin) (*Oauthprovider, *APIResponse, error)

PutIdentityprovidersOnelogin invokes PUT /api/v2/identityproviders/onelogin

Update/Create OneLogin Identity Provider

func (IdentityProviderApi) PutIdentityprovidersPing ¶

func (a IdentityProviderApi) PutIdentityprovidersPing(body Pingidentity) (*Oauthprovider, *APIResponse, error)

PutIdentityprovidersPing invokes PUT /api/v2/identityproviders/ping

Update/Create Ping Identity Provider

func (IdentityProviderApi) PutIdentityprovidersPurecloud ¶

func (a IdentityProviderApi) PutIdentityprovidersPurecloud(body Purecloud) (*Oauthprovider, *APIResponse, error)

PutIdentityprovidersPurecloud invokes PUT /api/v2/identityproviders/purecloud

Update/Create PureCloud Identity Provider

func (IdentityProviderApi) PutIdentityprovidersPureengage ¶

func (a IdentityProviderApi) PutIdentityprovidersPureengage(body Pureengage) (*Oauthprovider, *APIResponse, error)

PutIdentityprovidersPureengage invokes PUT /api/v2/identityproviders/pureengage

Update/Create PureEngage Identity Provider

func (IdentityProviderApi) PutIdentityprovidersSalesforce ¶

func (a IdentityProviderApi) PutIdentityprovidersSalesforce(body Salesforce) (*Oauthprovider, *APIResponse, error)

PutIdentityprovidersSalesforce invokes PUT /api/v2/identityproviders/salesforce

Update/Create Salesforce Identity Provider

type Identitynow ¶

type Identitynow 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"`
}

Identitynow

func (*Identitynow) String ¶

func (o *Identitynow) String() string

String returns a JSON representation of the model

type Ignoredactivitycategories ¶

type Ignoredactivitycategories struct {
	// Values - Activity categories list
	Values *[]string `json:"values,omitempty"`
}

Ignoredactivitycategories

func (*Ignoredactivitycategories) String ¶

func (o *Ignoredactivitycategories) String() string

String returns a JSON representation of the model

type Importscriptstatusresponse ¶

type Importscriptstatusresponse struct {
	// Url
	Url *string `json:"url,omitempty"`

	// Succeeded
	Succeeded *bool `json:"succeeded,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`
}

Importscriptstatusresponse

func (*Importscriptstatusresponse) String ¶

func (o *Importscriptstatusresponse) String() string

String returns a JSON representation of the model

type Importstatus ¶

type Importstatus struct {
	// State - current status of the import
	State *string `json:"state,omitempty"`

	// TotalRecords - total number of records to be imported
	TotalRecords *int `json:"totalRecords,omitempty"`

	// CompletedRecords - number of records finished importing
	CompletedRecords *int `json:"completedRecords,omitempty"`

	// PercentComplete - percentage of records finished importing
	PercentComplete *int `json:"percentComplete,omitempty"`

	// FailureReason - if the import has failed, the reason for the failure
	FailureReason *string `json:"failureReason,omitempty"`
}

Importstatus

func (*Importstatus) String ¶

func (o *Importstatus) String() string

String returns a JSON representation of the model

type Inbounddomain ¶

type Inbounddomain struct {
	// Id - Unique Id of the domain such as: example.com
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// MxRecordStatus - Mx Record Status
	MxRecordStatus *string `json:"mxRecordStatus,omitempty"`

	// SubDomain - Indicates if this a PureCloud sub-domain.  If true, then the appropriate DNS records are created for sending/receiving email.
	SubDomain *bool `json:"subDomain,omitempty"`

	// MailFromSettings - The DNS settings if the inbound domain is using a custom Mail From. These settings can only be used on InboundDomains where subDomain is false.
	MailFromSettings *Mailfromresult `json:"mailFromSettings,omitempty"`

	// CustomSMTPServer - The custom SMTP server integration to use when sending outbound emails from this domain.
	CustomSMTPServer *Domainentityref `json:"customSMTPServer,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Inbounddomain

func (*Inbounddomain) String ¶

func (o *Inbounddomain) String() string

String returns a JSON representation of the model

type Inbounddomainentitylisting ¶

type Inbounddomainentitylisting struct {
	// Entities
	Entities *[]Inbounddomain `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Inbounddomainentitylisting

func (*Inbounddomainentitylisting) String ¶

func (o *Inbounddomainentitylisting) String() string

String returns a JSON representation of the model

type Inbounddomainpatchrequest ¶

type Inbounddomainpatchrequest struct {
	// MailFromSettings - The DNS settings if the inbound domain is using a custom Mail From. These settings can only be used on InboundDomains where subDomain is false.
	MailFromSettings *Mailfromresult `json:"mailFromSettings,omitempty"`

	// CustomSMTPServer - The custom SMTP server integration to use when sending outbound emails from this domain.
	CustomSMTPServer *Domainentityref `json:"customSMTPServer,omitempty"`
}

Inbounddomainpatchrequest

func (*Inbounddomainpatchrequest) String ¶

func (o *Inbounddomainpatchrequest) String() string

String returns a JSON representation of the model

type Inboundmessagerequest ¶

type Inboundmessagerequest struct {
	// QueueId - The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId
	QueueId *string `json:"queueId,omitempty"`

	// FlowId - The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId
	FlowId *string `json:"flowId,omitempty"`

	// Provider - The name of the provider that is sourcing the email such as Oracle, Salesforce, etc.
	Provider *string `json:"provider,omitempty"`

	// SkillIds - The list of skill ID's to use for routing.
	SkillIds *[]string `json:"skillIds,omitempty"`

	// LanguageId - The ID of the language to use for routing.
	LanguageId *string `json:"languageId,omitempty"`

	// Priority - The priority to assign to the conversation for routing.
	Priority *int `json:"priority,omitempty"`

	// Attributes - The list of attributes to associate with the customer participant.
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ToAddress - The email address of the recipient of the email.
	ToAddress *string `json:"toAddress,omitempty"`

	// ToName - The name of the recipient of the email.
	ToName *string `json:"toName,omitempty"`

	// FromAddress - The email address of the sender of the email.
	FromAddress *string `json:"fromAddress,omitempty"`

	// FromName - The name of the sender of the email.
	FromName *string `json:"fromName,omitempty"`

	// Subject - The subject of the email
	Subject *string `json:"subject,omitempty"`
}

Inboundmessagerequest

func (*Inboundmessagerequest) String ¶

func (o *Inboundmessagerequest) String() string

String returns a JSON representation of the model

type Inboundroute ¶

type Inboundroute struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Pattern - The search pattern that the mailbox name should match.
	Pattern *string `json:"pattern,omitempty"`

	// Queue - The queue to route the emails to.
	Queue *Domainentityref `json:"queue,omitempty"`

	// Priority - The priority to use for routing.
	Priority *int `json:"priority,omitempty"`

	// Skills - The skills to use for routing.
	Skills *[]Domainentityref `json:"skills,omitempty"`

	// Language - The language to use for routing.
	Language *Domainentityref `json:"language,omitempty"`

	// FromName - The sender name to use for outgoing replies.
	FromName *string `json:"fromName,omitempty"`

	// FromEmail - The sender email to use for outgoing replies.
	FromEmail *string `json:"fromEmail,omitempty"`

	// Flow - The flow to use for processing the email.
	Flow *Domainentityref `json:"flow,omitempty"`

	// ReplyEmailAddress - The route to use for email replies.
	ReplyEmailAddress **Queueemailaddress `json:"replyEmailAddress,omitempty"`

	// AutoBcc - The recipients that should be  automatically blind copied on outbound emails associated with this InboundRoute.
	AutoBcc *[]Emailaddress `json:"autoBcc,omitempty"`

	// SpamFlow - The flow to use for processing inbound emails that have been marked as spam.
	SpamFlow *Domainentityref `json:"spamFlow,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Inboundroute

func (*Inboundroute) String ¶

func (o *Inboundroute) String() string

String returns a JSON representation of the model

type Inboundrouteentitylisting ¶

type Inboundrouteentitylisting struct {
	// Entities
	Entities *[]Inboundroute `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Inboundrouteentitylisting

func (*Inboundrouteentitylisting) String ¶

func (o *Inboundrouteentitylisting) String() string

String returns a JSON representation of the model

type Initiatescreenrecording ¶

type Initiatescreenrecording struct {
	// RecordACW
	RecordACW *bool `json:"recordACW,omitempty"`

	// ArchiveRetention
	ArchiveRetention *Archiveretention `json:"archiveRetention,omitempty"`

	// DeleteRetention
	DeleteRetention *Deleteretention `json:"deleteRetention,omitempty"`
}

Initiatescreenrecording

func (*Initiatescreenrecording) String ¶

func (o *Initiatescreenrecording) String() string

String returns a JSON representation of the model

type Integration ¶

type Integration 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 *Integrationconfigurationinfo `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"`
}

Integration - Details for an Integration

func (*Integration) String ¶

func (o *Integration) String() string

String returns a JSON representation of the model

type Integrationaction ¶

type Integrationaction 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"`
}

Integrationaction

func (*Integrationaction) String ¶

func (o *Integrationaction) String() string

String returns a JSON representation of the model

type Integrationactionfields ¶

type Integrationactionfields struct {
	// IntegrationAction - Reference to the Integration Action to be used when integrationAction type is qualified
	IntegrationAction *Integrationaction `json:"integrationAction,omitempty"`

	// RequestMappings - Collection of Request Mappings to use
	RequestMappings *[]Requestmapping `json:"requestMappings,omitempty"`
}

Integrationactionfields

func (*Integrationactionfields) String ¶

func (o *Integrationactionfields) String() string

String returns a JSON representation of the model

type Integrationconfiguration ¶

type Integrationconfiguration 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"`

	// Version - Version number required for updates.
	Version *int `json:"version,omitempty"`

	// Properties - Key-value configuration settings described by the schema in the propertiesSchemaUri field.
	Properties *interface{} `json:"properties,omitempty"`

	// Advanced - Advanced configuration described by the schema in the advancedSchemaUri field.
	Advanced *interface{} `json:"advanced,omitempty"`

	// Notes - Notes about the integration.
	Notes *string `json:"notes,omitempty"`

	// Credentials - Credentials required by the integration. The required keys are indicated in the credentials property of the Integration Type
	Credentials *map[string]Credentialinfo `json:"credentials,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Integrationconfiguration - Configuration for an Integration

func (*Integrationconfiguration) String ¶

func (o *Integrationconfiguration) String() string

String returns a JSON representation of the model

type Integrationconfigurationinfo ¶

type Integrationconfigurationinfo struct {
	// Current - The current, active configuration for the integration.
	Current *Integrationconfiguration `json:"current,omitempty"`
}

Integrationconfigurationinfo - Configuration information for the integration

func (*Integrationconfigurationinfo) String ¶

String returns a JSON representation of the model

type Integrationentitylisting ¶

type Integrationentitylisting struct {
	// Entities
	Entities *[]Integration `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Integrationentitylisting

func (*Integrationentitylisting) String ¶

func (o *Integrationentitylisting) String() string

String returns a JSON representation of the model

type Integrationevent ¶

type Integrationevent struct {
	// Id - Unique ID for this event
	Id *string `json:"id,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// CorrelationId - Correlation ID for the event
	CorrelationId *string `json:"correlationId,omitempty"`

	// Timestamp - Time the event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Timestamp *time.Time `json:"timestamp,omitempty"`

	// Level - Indicates the severity of the event.
	Level *string `json:"level,omitempty"`

	// EventCode - A classification for the event. Suitable for programmatic searching, sorting, or filtering
	EventCode *string `json:"eventCode,omitempty"`

	// Message - Message indicating what happened
	Message *Messageinfo `json:"message,omitempty"`

	// Entities - Collection of entities affected by or pertaining to the event (e.g. a list of Integrations or Bridge connectors)
	Entities *[]Evententity `json:"entities,omitempty"`

	// ContextAttributes - Map of context attributes specific to this event.
	ContextAttributes *map[string]string `json:"contextAttributes,omitempty"`

	// DetailMessage - Message with additional details about the event. (e.g. an exception cause.)
	DetailMessage *Messageinfo `json:"detailMessage,omitempty"`

	// User - User that took an action that resulted in the event.
	User *User `json:"user,omitempty"`
}

Integrationevent - Describes an event that has happened related to an integration

func (*Integrationevent) String ¶

func (o *Integrationevent) String() string

String returns a JSON representation of the model

type Integrationevententitylisting ¶

type Integrationevententitylisting struct {
	// Entities
	Entities *[]Integrationevent `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Integrationevententitylisting

func (*Integrationevententitylisting) String ¶

String returns a JSON representation of the model

type Integrationexport ¶

type Integrationexport struct {
	// Integration - The aws-s3-recording-bulk-actions-integration that the policy uses for exports.
	Integration *Domainentityref `json:"integration,omitempty"`

	// ShouldExportScreenRecordings - True if the policy should export screen recordings in addition to the other conversation media. Default = true
	ShouldExportScreenRecordings *bool `json:"shouldExportScreenRecordings,omitempty"`
}

Integrationexport

func (*Integrationexport) String ¶

func (o *Integrationexport) String() string

String returns a JSON representation of the model

type IntegrationsApi ¶

type IntegrationsApi struct {
	Configuration *Configuration
}

IntegrationsApi provides functions for API endpoints

func NewIntegrationsApi ¶

func NewIntegrationsApi() *IntegrationsApi

NewIntegrationsApi creates an API instance using the default configuration

func NewIntegrationsApiWithConfig ¶

func NewIntegrationsApiWithConfig(config *Configuration) *IntegrationsApi

NewIntegrationsApiWithConfig creates an API instance using the provided configuration

func (IntegrationsApi) DeleteIntegration ¶

func (a IntegrationsApi) DeleteIntegration(integrationId string) (*Integration, *APIResponse, error)

DeleteIntegration invokes DELETE /api/v2/integrations/{integrationId}

Delete integration.

func (IntegrationsApi) DeleteIntegrationsAction ¶

func (a IntegrationsApi) DeleteIntegrationsAction(actionId string) (*APIResponse, error)

DeleteIntegrationsAction invokes DELETE /api/v2/integrations/actions/{actionId}

Delete an Action

func (IntegrationsApi) DeleteIntegrationsActionDraft ¶

func (a IntegrationsApi) DeleteIntegrationsActionDraft(actionId string) (*APIResponse, error)

DeleteIntegrationsActionDraft invokes DELETE /api/v2/integrations/actions/{actionId}/draft

Delete a Draft

func (IntegrationsApi) DeleteIntegrationsCredential ¶

func (a IntegrationsApi) DeleteIntegrationsCredential(credentialId string) (*APIResponse, error)

DeleteIntegrationsCredential invokes DELETE /api/v2/integrations/credentials/{credentialId}

Delete a set of credentials

func (IntegrationsApi) GetIntegration ¶

func (a IntegrationsApi) GetIntegration(integrationId string, pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string) (*Integration, *APIResponse, error)

GetIntegration invokes GET /api/v2/integrations/{integrationId}

Get integration.

func (IntegrationsApi) GetIntegrationConfigCurrent ¶

func (a IntegrationsApi) GetIntegrationConfigCurrent(integrationId string) (*Integrationconfiguration, *APIResponse, error)

GetIntegrationConfigCurrent invokes GET /api/v2/integrations/{integrationId}/config/current

Get integration configuration.

func (IntegrationsApi) GetIntegrations ¶

func (a IntegrationsApi) GetIntegrations(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string) (*Integrationentitylisting, *APIResponse, error)

GetIntegrations invokes GET /api/v2/integrations

List integrations

func (IntegrationsApi) GetIntegrationsAction ¶

func (a IntegrationsApi) GetIntegrationsAction(actionId string, expand string, includeConfig bool) (*Action, *APIResponse, error)

GetIntegrationsAction invokes GET /api/v2/integrations/actions/{actionId}

Retrieves a single Action matching id.

func (IntegrationsApi) GetIntegrationsActionDraft ¶

func (a IntegrationsApi) GetIntegrationsActionDraft(actionId string, expand string, includeConfig bool) (*Action, *APIResponse, error)

GetIntegrationsActionDraft invokes GET /api/v2/integrations/actions/{actionId}/draft

Retrieve a Draft

func (IntegrationsApi) GetIntegrationsActionDraftSchema ¶

func (a IntegrationsApi) GetIntegrationsActionDraftSchema(actionId string, fileName string) (*Jsonschemadocument, *APIResponse, error)

GetIntegrationsActionDraftSchema invokes GET /api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}

Retrieve schema for a Draft based on filename.

func (IntegrationsApi) GetIntegrationsActionDraftTemplate ¶

func (a IntegrationsApi) GetIntegrationsActionDraftTemplate(actionId string, fileName string) (*string, *APIResponse, error)

GetIntegrationsActionDraftTemplate invokes GET /api/v2/integrations/actions/{actionId}/draft/templates/{fileName}

Retrieve templates for a Draft based on filename.

func (IntegrationsApi) GetIntegrationsActionDraftValidation ¶

func (a IntegrationsApi) GetIntegrationsActionDraftValidation(actionId string) (*Draftvalidationresult, *APIResponse, error)

GetIntegrationsActionDraftValidation invokes GET /api/v2/integrations/actions/{actionId}/draft/validation

Validate current Draft configuration.

func (IntegrationsApi) GetIntegrationsActionSchema ¶

func (a IntegrationsApi) GetIntegrationsActionSchema(actionId string, fileName string) (*Jsonschemadocument, *APIResponse, error)

GetIntegrationsActionSchema invokes GET /api/v2/integrations/actions/{actionId}/schemas/{fileName}

Retrieve schema for an action based on filename.

func (IntegrationsApi) GetIntegrationsActionTemplate ¶

func (a IntegrationsApi) GetIntegrationsActionTemplate(actionId string, fileName string) (*string, *APIResponse, error)

GetIntegrationsActionTemplate invokes GET /api/v2/integrations/actions/{actionId}/templates/{fileName}

Retrieve text of templates for an action based on filename.

func (IntegrationsApi) GetIntegrationsActions ¶

func (a IntegrationsApi) GetIntegrationsActions(pageSize int, pageNumber int, nextPage string, previousPage string, sortBy string, sortOrder string, category string, name string, secure string, includeAuthActions string) (*Actionentitylisting, *APIResponse, error)

GetIntegrationsActions invokes GET /api/v2/integrations/actions

Retrieves all actions associated with filters passed in via query param.

func (IntegrationsApi) GetIntegrationsActionsCategories ¶

func (a IntegrationsApi) GetIntegrationsActionsCategories(pageSize int, pageNumber int, nextPage string, previousPage string, sortBy string, sortOrder string, secure string) (*Categoryentitylisting, *APIResponse, error)

GetIntegrationsActionsCategories invokes GET /api/v2/integrations/actions/categories

Retrieves all categories of available Actions

func (IntegrationsApi) GetIntegrationsActionsDrafts ¶

func (a IntegrationsApi) GetIntegrationsActionsDrafts(pageSize int, pageNumber int, nextPage string, previousPage string, sortBy string, sortOrder string, category string, name string, secure string, includeAuthActions string) (*Actionentitylisting, *APIResponse, error)

GetIntegrationsActionsDrafts invokes GET /api/v2/integrations/actions/drafts

Retrieves all action drafts associated with the filters passed in via query param.

func (IntegrationsApi) GetIntegrationsClientapps ¶

func (a IntegrationsApi) GetIntegrationsClientapps(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string) (*Clientappentitylisting, *APIResponse, error)

GetIntegrationsClientapps invokes GET /api/v2/integrations/clientapps

List permitted client app integrations for the logged in user

func (IntegrationsApi) GetIntegrationsCredential ¶

func (a IntegrationsApi) GetIntegrationsCredential(credentialId string) (*Credential, *APIResponse, error)

GetIntegrationsCredential invokes GET /api/v2/integrations/credentials/{credentialId}

Get a single credential with sensitive fields redacted

func (IntegrationsApi) GetIntegrationsCredentials ¶

func (a IntegrationsApi) GetIntegrationsCredentials(pageNumber int, pageSize int) (*Credentialinfolisting, *APIResponse, error)

GetIntegrationsCredentials invokes GET /api/v2/integrations/credentials

List multiple sets of credentials

func (IntegrationsApi) GetIntegrationsCredentialsTypes ¶

func (a IntegrationsApi) GetIntegrationsCredentialsTypes() (*Credentialtypelisting, *APIResponse, error)

GetIntegrationsCredentialsTypes invokes GET /api/v2/integrations/credentials/types

List all credential types

func (IntegrationsApi) GetIntegrationsEventlog ¶

func (a IntegrationsApi) GetIntegrationsEventlog(pageSize int, pageNumber int, sortBy string, sortOrder string, entityId string) (*Integrationevententitylisting, *APIResponse, error)

GetIntegrationsEventlog invokes GET /api/v2/integrations/eventlog

List all events

func (IntegrationsApi) GetIntegrationsEventlogEventId ¶

func (a IntegrationsApi) GetIntegrationsEventlogEventId(eventId string) (*Integrationevent, *APIResponse, error)

GetIntegrationsEventlogEventId invokes GET /api/v2/integrations/eventlog/{eventId}

Get a single event

func (IntegrationsApi) GetIntegrationsSpeechDialogflowAgent ¶

func (a IntegrationsApi) GetIntegrationsSpeechDialogflowAgent(agentId string) (*Dialogflowagent, *APIResponse, error)

GetIntegrationsSpeechDialogflowAgent invokes GET /api/v2/integrations/speech/dialogflow/agents/{agentId}

Get details about a Dialogflow agent

func (IntegrationsApi) GetIntegrationsSpeechDialogflowAgents ¶

func (a IntegrationsApi) GetIntegrationsSpeechDialogflowAgents(pageNumber int, pageSize int, name string) (*Dialogflowagentsummaryentitylisting, *APIResponse, error)

GetIntegrationsSpeechDialogflowAgents invokes GET /api/v2/integrations/speech/dialogflow/agents

Get a list of Dialogflow agents in the customers&#39; Google accounts

func (IntegrationsApi) GetIntegrationsSpeechLexBotAlias ¶

func (a IntegrationsApi) GetIntegrationsSpeechLexBotAlias(aliasId string) (*Lexbotalias, *APIResponse, error)

GetIntegrationsSpeechLexBotAlias invokes GET /api/v2/integrations/speech/lex/bot/alias/{aliasId}

Get details about a Lex bot alias

func (IntegrationsApi) GetIntegrationsSpeechLexBotBotIdAliases ¶

func (a IntegrationsApi) GetIntegrationsSpeechLexBotBotIdAliases(botId string, pageNumber int, pageSize int, status string, name string) (*Lexbotaliasentitylisting, *APIResponse, error)

GetIntegrationsSpeechLexBotBotIdAliases invokes GET /api/v2/integrations/speech/lex/bot/{botId}/aliases

Get a list of aliases for a bot in the customer&#39;s AWS accounts

func (IntegrationsApi) GetIntegrationsSpeechLexBots ¶

func (a IntegrationsApi) GetIntegrationsSpeechLexBots(pageNumber int, pageSize int, name string) (*Lexbotentitylisting, *APIResponse, error)

GetIntegrationsSpeechLexBots invokes GET /api/v2/integrations/speech/lex/bots

Get a list of Lex bots in the customers&#39; AWS accounts

func (IntegrationsApi) GetIntegrationsSpeechTtsEngine ¶

func (a IntegrationsApi) GetIntegrationsSpeechTtsEngine(engineId string, includeVoices bool) (*Ttsengineentity, *APIResponse, error)

GetIntegrationsSpeechTtsEngine invokes GET /api/v2/integrations/speech/tts/engines/{engineId}

Get details about a TTS engine

func (IntegrationsApi) GetIntegrationsSpeechTtsEngineVoice ¶

func (a IntegrationsApi) GetIntegrationsSpeechTtsEngineVoice(engineId string, voiceId string) (*Ttsvoiceentity, *APIResponse, error)

GetIntegrationsSpeechTtsEngineVoice invokes GET /api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId}

Get details about a specific voice for a TTS engine

func (IntegrationsApi) GetIntegrationsSpeechTtsEngineVoices ¶

func (a IntegrationsApi) GetIntegrationsSpeechTtsEngineVoices(engineId string, pageNumber int, pageSize int) (*Ttsvoiceentitylisting, *APIResponse, error)

GetIntegrationsSpeechTtsEngineVoices invokes GET /api/v2/integrations/speech/tts/engines/{engineId}/voices

Get a list of voices for a TTS engine

func (IntegrationsApi) GetIntegrationsSpeechTtsEngines ¶

func (a IntegrationsApi) GetIntegrationsSpeechTtsEngines(pageNumber int, pageSize int, includeVoices bool, name string, language string) (*Ttsengineentitylisting, *APIResponse, error)

GetIntegrationsSpeechTtsEngines invokes GET /api/v2/integrations/speech/tts/engines

Get a list of TTS engines enabled for org

func (IntegrationsApi) GetIntegrationsSpeechTtsSettings ¶

func (a IntegrationsApi) GetIntegrationsSpeechTtsSettings() (*Ttssettings, *APIResponse, error)

GetIntegrationsSpeechTtsSettings invokes GET /api/v2/integrations/speech/tts/settings

Get TTS settings for an org

func (IntegrationsApi) GetIntegrationsType ¶

func (a IntegrationsApi) GetIntegrationsType(typeId string) (*Integrationtype, *APIResponse, error)

GetIntegrationsType invokes GET /api/v2/integrations/types/{typeId}

Get integration type.

func (IntegrationsApi) GetIntegrationsTypeConfigschema ¶

func (a IntegrationsApi) GetIntegrationsTypeConfigschema(typeId string, configType string) (*Jsonschemadocument, *APIResponse, error)

GetIntegrationsTypeConfigschema invokes GET /api/v2/integrations/types/{typeId}/configschemas/{configType}

Get properties config schema for an integration type.

func (IntegrationsApi) GetIntegrationsTypes ¶

func (a IntegrationsApi) GetIntegrationsTypes(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string) (*Integrationtypeentitylisting, *APIResponse, error)

GetIntegrationsTypes invokes GET /api/v2/integrations/types

List integration types

func (IntegrationsApi) GetIntegrationsUserapps ¶

func (a IntegrationsApi) GetIntegrationsUserapps(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, appHost string) (*Userappentitylisting, *APIResponse, error)

GetIntegrationsUserapps invokes GET /api/v2/integrations/userapps

List permitted user app integrations for the logged in user

func (IntegrationsApi) PatchIntegration ¶

func (a IntegrationsApi) PatchIntegration(integrationId string, body Integration, pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string) (*Integration, *APIResponse, error)

PatchIntegration invokes PATCH /api/v2/integrations/{integrationId}

Update an integration.

func (IntegrationsApi) PatchIntegrationsAction ¶

func (a IntegrationsApi) PatchIntegrationsAction(actionId string, body Updateactioninput) (*Action, *APIResponse, error)

PatchIntegrationsAction invokes PATCH /api/v2/integrations/actions/{actionId}

Patch an Action

func (IntegrationsApi) PatchIntegrationsActionDraft ¶

func (a IntegrationsApi) PatchIntegrationsActionDraft(actionId string, body Updatedraftinput) (*Action, *APIResponse, error)

PatchIntegrationsActionDraft invokes PATCH /api/v2/integrations/actions/{actionId}/draft

Update an existing Draft

func (IntegrationsApi) PostIntegrations ¶

func (a IntegrationsApi) PostIntegrations(body Createintegrationrequest) (*Integration, *APIResponse, error)

PostIntegrations invokes POST /api/v2/integrations

Create an integration.

func (IntegrationsApi) PostIntegrationsActionDraft ¶

func (a IntegrationsApi) PostIntegrationsActionDraft(actionId string) (*Action, *APIResponse, error)

PostIntegrationsActionDraft invokes POST /api/v2/integrations/actions/{actionId}/draft

Create a new Draft from existing Action

func (IntegrationsApi) PostIntegrationsActionDraftPublish ¶

func (a IntegrationsApi) PostIntegrationsActionDraftPublish(actionId string, body Publishdraftinput) (*Action, *APIResponse, error)

PostIntegrationsActionDraftPublish invokes POST /api/v2/integrations/actions/{actionId}/draft/publish

Publish a Draft and make it the active Action configuration

func (IntegrationsApi) PostIntegrationsActionDraftTest ¶

func (a IntegrationsApi) PostIntegrationsActionDraftTest(actionId string, body interface{}) (*Testexecutionresult, *APIResponse, error)

PostIntegrationsActionDraftTest invokes POST /api/v2/integrations/actions/{actionId}/draft/test

Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.

func (IntegrationsApi) PostIntegrationsActionExecute ¶

func (a IntegrationsApi) PostIntegrationsActionExecute(actionId string, body interface{}) (*interface{}, *APIResponse, error)

PostIntegrationsActionExecute invokes POST /api/v2/integrations/actions/{actionId}/execute

Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.

func (IntegrationsApi) PostIntegrationsActionTest ¶

func (a IntegrationsApi) PostIntegrationsActionTest(actionId string, body interface{}) (*Testexecutionresult, *APIResponse, error)

PostIntegrationsActionTest invokes POST /api/v2/integrations/actions/{actionId}/test

Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.

func (IntegrationsApi) PostIntegrationsActions ¶

func (a IntegrationsApi) PostIntegrationsActions(body Postactioninput) (*Action, *APIResponse, error)

PostIntegrationsActions invokes POST /api/v2/integrations/actions

Create a new Action

func (IntegrationsApi) PostIntegrationsActionsDrafts ¶

func (a IntegrationsApi) PostIntegrationsActionsDrafts(body Postactioninput) (*Action, *APIResponse, error)

PostIntegrationsActionsDrafts invokes POST /api/v2/integrations/actions/drafts

Create a new Draft

func (IntegrationsApi) PostIntegrationsCredentials ¶

func (a IntegrationsApi) PostIntegrationsCredentials(body Credential) (*Credentialinfo, *APIResponse, error)

PostIntegrationsCredentials invokes POST /api/v2/integrations/credentials

Create a set of credentials

func (IntegrationsApi) PostIntegrationsWorkforcemanagementVendorconnection ¶

func (a IntegrationsApi) PostIntegrationsWorkforcemanagementVendorconnection(body Vendorconnectionrequest) (*Useractioncategoryentitylisting, *APIResponse, error)

PostIntegrationsWorkforcemanagementVendorconnection invokes POST /api/v2/integrations/workforcemanagement/vendorconnection

Add a vendor connection

func (IntegrationsApi) PutIntegrationConfigCurrent ¶

func (a IntegrationsApi) PutIntegrationConfigCurrent(integrationId string, body Integrationconfiguration) (*Integrationconfiguration, *APIResponse, error)

PutIntegrationConfigCurrent invokes PUT /api/v2/integrations/{integrationId}/config/current

Update integration configuration.

func (IntegrationsApi) PutIntegrationsCredential ¶

func (a IntegrationsApi) PutIntegrationsCredential(credentialId string, body Credential) (*Credentialinfo, *APIResponse, error)

PutIntegrationsCredential invokes PUT /api/v2/integrations/credentials/{credentialId}

Update a set of credentials

func (IntegrationsApi) PutIntegrationsSpeechTtsSettings ¶

func (a IntegrationsApi) PutIntegrationsSpeechTtsSettings(body Ttssettings) (*Ttssettings, *APIResponse, error)

PutIntegrationsSpeechTtsSettings invokes PUT /api/v2/integrations/speech/tts/settings

Update TTS settings for an org

type Integrationstatusinfo ¶

type Integrationstatusinfo struct {
	// Code - Machine-readable status as reported by the integration.
	Code *string `json:"code,omitempty"`

	// Effective - Localized, human-readable, effective status of the integration.
	Effective *string `json:"effective,omitempty"`

	// Detail - Localizable status details for the integration.
	Detail *Messageinfo `json:"detail,omitempty"`

	// LastUpdated - Date and time (in UTC) when the integration status (i.e. the code field) was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	LastUpdated *time.Time `json:"lastUpdated,omitempty"`
}

Integrationstatusinfo - Status information for an Integration.

func (*Integrationstatusinfo) String ¶

func (o *Integrationstatusinfo) String() string

String returns a JSON representation of the model

type Integrationtype ¶

type Integrationtype struct {
	// Id - The ID of the integration type.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Description - Description of the integration type.
	Description *string `json:"description,omitempty"`

	// Provider - PureCloud provider of the integration type.
	Provider *string `json:"provider,omitempty"`

	// Category - Category describing the integration type.
	Category *string `json:"category,omitempty"`

	// Images - Collection of logos.
	Images *[]Userimage `json:"images,omitempty"`

	// ConfigPropertiesSchemaUri - URI of the schema describing the key-value properties needed to configure an integration of this type.
	ConfigPropertiesSchemaUri *string `json:"configPropertiesSchemaUri,omitempty"`

	// ConfigAdvancedSchemaUri - URI of the schema describing the advanced JSON document needed to configure an integration of this type.
	ConfigAdvancedSchemaUri *string `json:"configAdvancedSchemaUri,omitempty"`

	// HelpUri - URI of a page with more information about the integration type
	HelpUri *string `json:"helpUri,omitempty"`

	// TermsOfServiceUri - URI of a page with terms and conditions for the integration type
	TermsOfServiceUri *string `json:"termsOfServiceUri,omitempty"`

	// VendorName - Name of the vendor of this integration type
	VendorName *string `json:"vendorName,omitempty"`

	// VendorWebsiteUri - URI of the vendor's website
	VendorWebsiteUri *string `json:"vendorWebsiteUri,omitempty"`

	// MarketplaceUri - URI of the marketplace listing for this integration type
	MarketplaceUri *string `json:"marketplaceUri,omitempty"`

	// FaqUri - URI of frequently asked questions about the integration type
	FaqUri *string `json:"faqUri,omitempty"`

	// PrivacyPolicyUri - URI of a privacy policy for users of the integration type
	PrivacyPolicyUri *string `json:"privacyPolicyUri,omitempty"`

	// SupportContactUri - URI for vendor support
	SupportContactUri *string `json:"supportContactUri,omitempty"`

	// SalesContactUri - URI for vendor sales information
	SalesContactUri *string `json:"salesContactUri,omitempty"`

	// HelpLinks - List of links to additional help resources
	HelpLinks *[]Helplink `json:"helpLinks,omitempty"`

	// Credentials - Map of credentials for integrations of this type. The key is the name of a credential that can be provided in the credentials property of the integration configuration.
	Credentials *map[string]Credentialspecification `json:"credentials,omitempty"`

	// NonInstallable - Indicates if the integration type is installable or not.
	NonInstallable *bool `json:"nonInstallable,omitempty"`

	// MaxInstances - The maximum number of integration instances allowable for this integration type
	MaxInstances *int `json:"maxInstances,omitempty"`

	// UserPermissions - List of permissions required to permit user access to the integration type.
	UserPermissions *[]string `json:"userPermissions,omitempty"`

	// VendorOAuthClientIds - List of OAuth Client IDs that must be authorized when the integration is created.
	VendorOAuthClientIds *[]string `json:"vendorOAuthClientIds,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Integrationtype - Descriptor for a type of Integration.

func (*Integrationtype) String ¶

func (o *Integrationtype) String() string

String returns a JSON representation of the model

type Integrationtypeentitylisting ¶

type Integrationtypeentitylisting struct {
	// Entities
	Entities *[]Integrationtype `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Integrationtypeentitylisting

func (*Integrationtypeentitylisting) String ¶

String returns a JSON representation of the model

type Intent ¶

type Intent struct {
	// Name
	Name *string `json:"name,omitempty"`
}

Intent

func (*Intent) String ¶

func (o *Intent) String() string

String returns a JSON representation of the model

type Intentdefinition ¶

type Intentdefinition struct {
	// Name - The name of the intent.
	Name *string `json:"name,omitempty"`

	// EntityTypeBindings - The bindings for the named entity types used in this intent.This field is mutually exclusive with entityNameReferences and entities
	EntityTypeBindings *[]Namedentitytypebinding `json:"entityTypeBindings,omitempty"`

	// EntityNameReferences - The references for the named entity used in this intent.This field is mutually exclusive with entityTypeBindings
	EntityNameReferences *[]string `json:"entityNameReferences,omitempty"`

	// Utterances - The utterances that act as training phrases for the intent.
	Utterances *[]Nluutterance `json:"utterances,omitempty"`
}

Intentdefinition

func (*Intentdefinition) String ¶

func (o *Intentdefinition) String() string

String returns a JSON representation of the model

type Intentfeedback ¶

type Intentfeedback struct {
	// Name - The name of the detected intent.
	Name *string `json:"name,omitempty"`

	// Probability - The probability of the detected intent.
	Probability *float64 `json:"probability,omitempty"`

	// Entities - The collection of named entities detected.
	Entities *[]Detectednamedentity `json:"entities,omitempty"`

	// Assessment - The assessment on the detection for feedback text.
	Assessment *string `json:"assessment,omitempty"`
}

Intentfeedback

func (*Intentfeedback) String ¶

func (o *Intentfeedback) String() string

String returns a JSON representation of the model

type Interactionstatsalert ¶

type Interactionstatsalert struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - Name of the rule that generated the alert
	Name *string `json:"name,omitempty"`

	// Dimension - The dimension of concern.
	Dimension *string `json:"dimension,omitempty"`

	// DimensionValue - The value of the dimension.
	DimensionValue *string `json:"dimensionValue,omitempty"`

	// Metric - The metric to be assessed.
	Metric *string `json:"metric,omitempty"`

	// MediaType - The media type.
	MediaType *string `json:"mediaType,omitempty"`

	// NumericRange - The comparison descriptor used against the metric's value.
	NumericRange *string `json:"numericRange,omitempty"`

	// Statistic - The statistic of concern for the metric.
	Statistic *string `json:"statistic,omitempty"`

	// Value - The threshold value.
	Value *float64 `json:"value,omitempty"`

	// RuleId - The id of the rule.
	RuleId *string `json:"ruleId,omitempty"`

	// Unread - Indicates if the alert has been read.
	Unread *bool `json:"unread,omitempty"`

	// StartDate - The date/time the alert was created. 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 date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndDate *time.Time `json:"endDate,omitempty"`

	// NotificationUsers - The ids of users who were notified of alarm state change.
	NotificationUsers *[]User `json:"notificationUsers,omitempty"`

	// AlertTypes - A collection of notification methods.
	AlertTypes *[]string `json:"alertTypes,omitempty"`

	// RuleUri
	RuleUri *string `json:"ruleUri,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Interactionstatsalert

func (*Interactionstatsalert) String ¶

func (o *Interactionstatsalert) String() string

String returns a JSON representation of the model

type Interactionstatsalertcontainer ¶

type Interactionstatsalertcontainer struct {
	// Entities
	Entities *[]Interactionstatsalert `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Interactionstatsalertcontainer

func (*Interactionstatsalertcontainer) String ¶

String returns a JSON representation of the model

type Interactionstatsrule ¶

type Interactionstatsrule struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - Name of the rule
	Name *string `json:"name,omitempty"`

	// Dimension - The dimension of concern.
	Dimension *string `json:"dimension,omitempty"`

	// DimensionValue - The value of the dimension.
	DimensionValue *string `json:"dimensionValue,omitempty"`

	// Metric - The metric to be assessed.
	Metric *string `json:"metric,omitempty"`

	// MediaType - The media type.
	MediaType *string `json:"mediaType,omitempty"`

	// NumericRange - The comparison descriptor used against the metric's value.
	NumericRange *string `json:"numericRange,omitempty"`

	// Statistic - The statistic of concern for the metric.
	Statistic *string `json:"statistic,omitempty"`

	// Value - The threshold value.
	Value *float64 `json:"value,omitempty"`

	// Enabled - Indicates if the rule is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// InAlarm - Indicates if the rule is in alarm state.
	InAlarm *bool `json:"inAlarm,omitempty"`

	// NotificationUsers - The ids of users who will be notified of alarm state change.
	NotificationUsers *[]User `json:"notificationUsers,omitempty"`

	// AlertTypes - A collection of notification methods.
	AlertTypes *[]string `json:"alertTypes,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Interactionstatsrule

func (*Interactionstatsrule) String ¶

func (o *Interactionstatsrule) String() string

String returns a JSON representation of the model

type Interactionstatsrulecontainer ¶

type Interactionstatsrulecontainer struct {
	// Entities
	Entities *[]Interactionstatsrule `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Interactionstatsrulecontainer

func (*Interactionstatsrulecontainer) String ¶

String returns a JSON representation of the model

type Intradayperformancepredictiondata ¶

type Intradayperformancepredictiondata struct {
	// ServiceLevelPercent - Percentage of interactions that meets service level target as defined in the matching service goal templates
	ServiceLevelPercent *float64 `json:"serviceLevelPercent,omitempty"`

	// AverageSpeedOfAnswerSeconds - Predicted average time in seconds it takes to answer an interaction once the interaction becomes available to be routed
	AverageSpeedOfAnswerSeconds *float64 `json:"averageSpeedOfAnswerSeconds,omitempty"`

	// OccupancyPercent - Percentage of on-queue time for all agents in this group that are occupied handling interactions
	OccupancyPercent *float64 `json:"occupancyPercent,omitempty"`
}

Intradayperformancepredictiondata

func (*Intradayperformancepredictiondata) String ¶

String returns a JSON representation of the model

type Intradayplanninggrouprequest ¶

type Intradayplanninggrouprequest struct {
	// BusinessUnitDate - Requested date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	BusinessUnitDate *time.Time `json:"businessUnitDate,omitempty"`

	// Categories - The metric categories
	Categories *[]string `json:"categories,omitempty"`

	// PlanningGroupIds - The IDs of the planning groups for which to fetch data.  Omitting or passing an empty list will return all available planning groups
	PlanningGroupIds *[]string `json:"planningGroupIds,omitempty"`

	// IntervalLengthMinutes - The period/interval in minutes for which to aggregate the data. Required, defaults to 15
	IntervalLengthMinutes *int `json:"intervalLengthMinutes,omitempty"`
}

Intradayplanninggrouprequest

func (*Intradayplanninggrouprequest) String ¶

String returns a JSON representation of the model

type Ipaddressauthentication ¶

type Ipaddressauthentication struct {
	// NetworkWhitelist
	NetworkWhitelist *[]string `json:"networkWhitelist,omitempty"`
}

Ipaddressauthentication

func (*Ipaddressauthentication) String ¶

func (o *Ipaddressauthentication) String() string

String returns a JSON representation of the model

type Ipaddressrange ¶

type Ipaddressrange struct {
	// Cidr
	Cidr *string `json:"cidr,omitempty"`

	// Service
	Service *string `json:"service,omitempty"`

	// Region
	Region *string `json:"region,omitempty"`
}

Ipaddressrange

func (*Ipaddressrange) String ¶

func (o *Ipaddressrange) String() string

String returns a JSON representation of the model

type Ipaddressrangelisting ¶

type Ipaddressrangelisting struct {
	// Entities
	Entities *[]Ipaddressrange `json:"entities,omitempty"`
}

Ipaddressrangelisting

func (*Ipaddressrangelisting) String ¶

func (o *Ipaddressrangelisting) String() string

String returns a JSON representation of the model

type Items ¶

type Items struct {
	// VarType
	VarType *string `json:"type,omitempty"`

	// Pattern
	Pattern *string `json:"pattern,omitempty"`
}

Items

func (*Items) String ¶

func (o *Items) String() string

String returns a JSON representation of the model

type Itemvalidationlimits ¶

type Itemvalidationlimits struct {
	// MinLength - A structure denoting the system-imposed minimum string length (for text-based core types) or numeric values (for number-based) core types.  For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field.  Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.
	MinLength *Minlength `json:"minLength,omitempty"`

	// MaxLength - A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types.  For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field.  Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.
	MaxLength *Maxlength `json:"maxLength,omitempty"`
}

Itemvalidationlimits

func (*Itemvalidationlimits) String ¶

func (o *Itemvalidationlimits) String() string

String returns a JSON representation of the model

type Ivr ¶

type Ivr struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// Dnis - The phone number(s) to contact the IVR by.  Each phone number must be unique and not in use by another resource.  For example, a user and an iVR cannot have the same phone number.
	Dnis *[]string `json:"dnis,omitempty"`

	// OpenHoursFlow - The Architect flow to execute during the hours an organization is open.
	OpenHoursFlow *Domainentityref `json:"openHoursFlow,omitempty"`

	// ClosedHoursFlow - The Architect flow to execute during the hours an organization is closed.
	ClosedHoursFlow *Domainentityref `json:"closedHoursFlow,omitempty"`

	// HolidayHoursFlow - The Architect flow to execute during an organization's holiday hours.
	HolidayHoursFlow *Domainentityref `json:"holidayHoursFlow,omitempty"`

	// ScheduleGroup - The schedule group defining the open and closed hours for an organization.  If this is provided, an open flow and a closed flow must be specified as well.
	ScheduleGroup *Domainentityref `json:"scheduleGroup,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Ivr - Defines the phone numbers, operating hours, and the Architect flows to execute for an IVR.

func (*Ivr) String ¶

func (o *Ivr) String() string

String returns a JSON representation of the model

type Ivrentitylisting ¶

type Ivrentitylisting struct {
	// Entities
	Entities *[]Ivr `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Ivrentitylisting

func (*Ivrentitylisting) String ¶

func (o *Ivrentitylisting) String() string

String returns a JSON representation of the model

type Journey ¶

type Journey struct {
	// Patterns - A list of zero or more patterns to match.
	Patterns *[]Journeypattern `json:"patterns,omitempty"`
}

Journey

func (*Journey) String ¶

func (o *Journey) String() string

String returns a JSON representation of the model

type JourneyApi ¶

type JourneyApi struct {
	Configuration *Configuration
}

JourneyApi provides functions for API endpoints

func NewJourneyApi ¶

func NewJourneyApi() *JourneyApi

NewJourneyApi creates an API instance using the default configuration

func NewJourneyApiWithConfig ¶

func NewJourneyApiWithConfig(config *Configuration) *JourneyApi

NewJourneyApiWithConfig creates an API instance using the provided configuration

func (JourneyApi) DeleteJourneyActionmap ¶

func (a JourneyApi) DeleteJourneyActionmap(actionMapId string) (*APIResponse, error)

DeleteJourneyActionmap invokes DELETE /api/v2/journey/actionmaps/{actionMapId}

Delete single action map.

func (JourneyApi) DeleteJourneyActiontemplate ¶

func (a JourneyApi) DeleteJourneyActiontemplate(actionTemplateId string, hardDelete bool) (*APIResponse, error)

DeleteJourneyActiontemplate invokes DELETE /api/v2/journey/actiontemplates/{actionTemplateId}

Delete a single action template.

func (JourneyApi) DeleteJourneyOutcome ¶

func (a JourneyApi) DeleteJourneyOutcome(outcomeId string) (*APIResponse, error)

DeleteJourneyOutcome invokes DELETE /api/v2/journey/outcomes/{outcomeId}

Delete an outcome.

func (JourneyApi) DeleteJourneySegment ¶

func (a JourneyApi) DeleteJourneySegment(segmentId string) (*APIResponse, error)

DeleteJourneySegment invokes DELETE /api/v2/journey/segments/{segmentId}

Delete a segment.

func (JourneyApi) GetJourneyActionmap ¶

func (a JourneyApi) GetJourneyActionmap(actionMapId string) (*Actionmap, *APIResponse, error)

GetJourneyActionmap invokes GET /api/v2/journey/actionmaps/{actionMapId}

Retrieve a single action map.

func (JourneyApi) GetJourneyActionmaps ¶

func (a JourneyApi) GetJourneyActionmaps(pageNumber int, pageSize int, sortBy string, filterField string, filterValue string, actionMapIds []string, queryFields []string, queryValue string) (*Actionmaplisting, *APIResponse, error)

GetJourneyActionmaps invokes GET /api/v2/journey/actionmaps

Retrieve all action maps.

func (JourneyApi) GetJourneyActiontarget ¶

func (a JourneyApi) GetJourneyActiontarget(actionTargetId string) (*Actiontarget, *APIResponse, error)

GetJourneyActiontarget invokes GET /api/v2/journey/actiontargets/{actionTargetId}

Retrieve a single action target.

func (JourneyApi) GetJourneyActiontargets ¶

func (a JourneyApi) GetJourneyActiontargets(pageNumber int, pageSize int) (*Actiontargetlisting, *APIResponse, error)

GetJourneyActiontargets invokes GET /api/v2/journey/actiontargets

Retrieve all action targets.

func (JourneyApi) GetJourneyActiontemplate ¶

func (a JourneyApi) GetJourneyActiontemplate(actionTemplateId string) (*Actiontemplate, *APIResponse, error)

GetJourneyActiontemplate invokes GET /api/v2/journey/actiontemplates/{actionTemplateId}

Retrieve a single action template.

func (JourneyApi) GetJourneyActiontemplates ¶

func (a JourneyApi) GetJourneyActiontemplates(pageNumber int, pageSize int, sortBy string, mediaType string, state string, queryFields []string, queryValue string) (*Actiontemplatelisting, *APIResponse, error)

GetJourneyActiontemplates invokes GET /api/v2/journey/actiontemplates

Retrieve all action templates.

func (JourneyApi) GetJourneyOutcome ¶

func (a JourneyApi) GetJourneyOutcome(outcomeId string) (*Outcome, *APIResponse, error)

GetJourneyOutcome invokes GET /api/v2/journey/outcomes/{outcomeId}

Retrieve a single outcome.

func (JourneyApi) GetJourneyOutcomes ¶

func (a JourneyApi) GetJourneyOutcomes(pageNumber int, pageSize int, sortBy string, outcomeIds []string, queryFields []string, queryValue string) (*Outcomelisting, *APIResponse, error)

GetJourneyOutcomes invokes GET /api/v2/journey/outcomes

Retrieve all outcomes.

func (JourneyApi) GetJourneySegment ¶

func (a JourneyApi) GetJourneySegment(segmentId string) (*Journeysegment, *APIResponse, error)

GetJourneySegment invokes GET /api/v2/journey/segments/{segmentId}

Retrieve a single segment.

func (JourneyApi) GetJourneySegments ¶

func (a JourneyApi) GetJourneySegments(sortBy string, pageSize int, pageNumber int, isActive bool, segmentIds []string, queryFields []string, queryValue string) (*Segmentlisting, *APIResponse, error)

GetJourneySegments invokes GET /api/v2/journey/segments

Retrieve all segments.

func (JourneyApi) PatchJourneyActionmap ¶

func (a JourneyApi) PatchJourneyActionmap(actionMapId string, body Patchactionmap) (*Actionmap, *APIResponse, error)

PatchJourneyActionmap invokes PATCH /api/v2/journey/actionmaps/{actionMapId}

Update single action map.

func (JourneyApi) PatchJourneyActiontarget ¶

func (a JourneyApi) PatchJourneyActiontarget(actionTargetId string, body Patchactiontarget) (*Actiontarget, *APIResponse, error)

PatchJourneyActiontarget invokes PATCH /api/v2/journey/actiontargets/{actionTargetId}

Update a single action target.

func (JourneyApi) PatchJourneyActiontemplate ¶

func (a JourneyApi) PatchJourneyActiontemplate(actionTemplateId string, body Patchactiontemplate) (*Actiontemplate, *APIResponse, error)

PatchJourneyActiontemplate invokes PATCH /api/v2/journey/actiontemplates/{actionTemplateId}

Update a single action template.

func (JourneyApi) PatchJourneyOutcome ¶

func (a JourneyApi) PatchJourneyOutcome(outcomeId string, body Patchoutcome) (*Outcome, *APIResponse, error)

PatchJourneyOutcome invokes PATCH /api/v2/journey/outcomes/{outcomeId}

Update an outcome.

func (JourneyApi) PatchJourneySegment ¶

func (a JourneyApi) PatchJourneySegment(segmentId string, body Patchsegment) (*Journeysegment, *APIResponse, error)

PatchJourneySegment invokes PATCH /api/v2/journey/segments/{segmentId}

Update a segment.

func (JourneyApi) PostAnalyticsJourneysAggregatesQuery ¶

func (a JourneyApi) PostAnalyticsJourneysAggregatesQuery(body Journeyaggregationquery) (*Journeyaggregatequeryresponse, *APIResponse, error)

PostAnalyticsJourneysAggregatesQuery invokes POST /api/v2/analytics/journeys/aggregates/query

Query for journey aggregates

func (JourneyApi) PostJourneyActionmaps ¶

func (a JourneyApi) PostJourneyActionmaps(body Actionmap) (*Actionmap, *APIResponse, error)

PostJourneyActionmaps invokes POST /api/v2/journey/actionmaps

Create an action map.

func (JourneyApi) PostJourneyActiontemplates ¶

func (a JourneyApi) PostJourneyActiontemplates(body Actiontemplate) (*Actiontemplate, *APIResponse, error)

PostJourneyActiontemplates invokes POST /api/v2/journey/actiontemplates

Create a single action template.

func (JourneyApi) PostJourneyOutcomes ¶

func (a JourneyApi) PostJourneyOutcomes(body Outcome) (*Outcome, *APIResponse, error)

PostJourneyOutcomes invokes POST /api/v2/journey/outcomes

Create an outcome.

func (JourneyApi) PostJourneySegments ¶

func (a JourneyApi) PostJourneySegments(body Journeysegment) (*Journeysegment, *APIResponse, error)

PostJourneySegments invokes POST /api/v2/journey/segments

Create a segment.

type Journeyaction ¶

type Journeyaction struct {
	// Id - The ID of an action from the Journey System (an action is spawned from an actionMap)
	Id *string `json:"id,omitempty"`

	// ActionMap - Details about the action map from the Journey System which triggered this action
	ActionMap *Journeyactionmap `json:"actionMap,omitempty"`
}

Journeyaction

func (*Journeyaction) String ¶

func (o *Journeyaction) String() string

String returns a JSON representation of the model

type Journeyactionmap ¶

type Journeyactionmap struct {
	// Id - The ID of the actionMap in the Journey System which triggered this action
	Id *string `json:"id,omitempty"`

	// Version - The version number of the actionMap in the Journey System at the time this action was triggered
	Version *int `json:"version,omitempty"`
}

Journeyactionmap

func (*Journeyactionmap) String ¶

func (o *Journeyactionmap) String() string

String returns a JSON representation of the model

type Journeyaggregatedatacontainer ¶

type Journeyaggregatedatacontainer struct {
	// Group - A mapping from dimension to value
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Statisticalresponse `json:"data,omitempty"`
}

Journeyaggregatedatacontainer

func (*Journeyaggregatedatacontainer) String ¶

String returns a JSON representation of the model

type Journeyaggregatequeryclause ¶

type Journeyaggregatequeryclause 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 *[]Journeyaggregatequerypredicate `json:"predicates,omitempty"`
}

Journeyaggregatequeryclause

func (*Journeyaggregatequeryclause) String ¶

func (o *Journeyaggregatequeryclause) String() string

String returns a JSON representation of the model

type Journeyaggregatequeryfilter ¶

type Journeyaggregatequeryfilter 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 *[]Journeyaggregatequeryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Journeyaggregatequerypredicate `json:"predicates,omitempty"`
}

Journeyaggregatequeryfilter

func (*Journeyaggregatequeryfilter) String ¶

func (o *Journeyaggregatequeryfilter) String() string

String returns a JSON representation of the model

type Journeyaggregatequerypredicate ¶

type Journeyaggregatequerypredicate 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"`
}

Journeyaggregatequerypredicate

func (*Journeyaggregatequerypredicate) String ¶

String returns a JSON representation of the model

type Journeyaggregatequeryresponse ¶

type Journeyaggregatequeryresponse struct {
	// Results
	Results *[]Journeyaggregatedatacontainer `json:"results,omitempty"`
}

Journeyaggregatequeryresponse

func (*Journeyaggregatequeryresponse) String ¶

String returns a JSON representation of the model

type Journeyaggregationquery ¶

type Journeyaggregationquery 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 *Journeyaggregatequeryfilter `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 *[]Journeyaggregationview `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"`
}

Journeyaggregationquery

func (*Journeyaggregationquery) String ¶

func (o *Journeyaggregationquery) String() string

String returns a JSON representation of the model

type Journeyaggregationview ¶

type Journeyaggregationview 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"`
}

Journeyaggregationview

func (*Journeyaggregationview) String ¶

func (o *Journeyaggregationview) String() string

String returns a JSON representation of the model

type Journeycontext ¶

type Journeycontext struct {
	// Customer - A subset of the Journey System's customer data at a point-in-time (for external linkage and internal usage/context)
	Customer *Journeycustomer `json:"customer,omitempty"`

	// CustomerSession - A subset of the Journey System's tracked customer session data at a point-in-time (for external linkage and internal usage/context)
	CustomerSession *Journeycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction - A subset of the Journey System's action data relevant to a part of a conversation (for external linkage and internal usage/context)
	TriggeringAction *Journeyaction `json:"triggeringAction,omitempty"`
}

Journeycontext

func (*Journeycontext) String ¶

func (o *Journeycontext) String() string

String returns a JSON representation of the model

type Journeycustomer ¶

type Journeycustomer struct {
	// Id - An ID of a customer within the Journey System at a point-in-time.  Note that a customer entity can have multiple customerIds based on the stitching process.  Depending on the context within the PureCloud conversation, this may or may not be mutable.
	Id *string `json:"id,omitempty"`

	// IdType - The type of the customerId within the Journey System (e.g. cookie).
	IdType *string `json:"idType,omitempty"`
}

Journeycustomer

func (*Journeycustomer) String ¶

func (o *Journeycustomer) String() string

String returns a JSON representation of the model

type Journeycustomersession ¶

type Journeycustomersession struct {
	// Id - An ID of a Customer/User's session within the Journey System at a point-in-time
	Id *string `json:"id,omitempty"`

	// VarType - The type of the Customer/User's session within the Journey System (e.g. web, app)
	VarType *string `json:"type,omitempty"`
}

Journeycustomersession

func (*Journeycustomersession) String ¶

func (o *Journeycustomersession) String() string

String returns a JSON representation of the model

type Journeypattern ¶

type Journeypattern struct {
	// Criteria - A list of one or more criteria to satisfy.
	Criteria *[]Criteria `json:"criteria,omitempty"`

	// Count - The number of times the pattern must match.
	Count *int `json:"count,omitempty"`

	// StreamType - The stream type for which this pattern can be matched on.
	StreamType *string `json:"streamType,omitempty"`

	// SessionType - The session type for which this pattern can be matched on.
	SessionType *string `json:"sessionType,omitempty"`

	// EventName - The name of the event for which this pattern can be matched on.
	EventName *string `json:"eventName,omitempty"`
}

Journeypattern

func (*Journeypattern) String ¶

func (o *Journeypattern) String() string

String returns a JSON representation of the model

type Journeysegment ¶

type Journeysegment struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// IsActive - Whether or not the segment is active.
	IsActive *bool `json:"isActive,omitempty"`

	// DisplayName - The display name of the segment.
	DisplayName *string `json:"displayName,omitempty"`

	// Version - The version of the segment.
	Version *int `json:"version,omitempty"`

	// Description - A description of the segment.
	Description *string `json:"description,omitempty"`

	// Color - The hexadecimal color value of the segment.
	Color *string `json:"color,omitempty"`

	// Scope - The target entity that a segment applies to.
	Scope *string `json:"scope,omitempty"`

	// ShouldDisplayToAgent - Whether or not the segment should be displayed to agent/supervisor users.
	ShouldDisplayToAgent *bool `json:"shouldDisplayToAgent,omitempty"`

	// Context - The context of the segment.
	Context *Context `json:"context,omitempty"`

	// Journey - The pattern of rules defining the segment.
	Journey *Journey `json:"journey,omitempty"`

	// ExternalSegment - Details of an entity corresponding to this segment in an external system.
	ExternalSegment *Externalsegment `json:"externalSegment,omitempty"`

	// AssignmentExpirationDays - Time, in days, from when the segment is assigned until it is automatically unassigned.
	AssignmentExpirationDays *int `json:"assignmentExpirationDays,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// CreatedDate - Timestamp indicating when the segment 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 the segment 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"`
}

Journeysegment

func (*Journeysegment) String ¶

func (o *Journeysegment) String() string

String returns a JSON representation of the model

type Journeysurveyquestion ¶

type Journeysurveyquestion struct {
	// VarType - Type of survey question.
	VarType *string `json:"type,omitempty"`

	// Label - Label of question.
	Label *string `json:"label,omitempty"`

	// CustomerProperty - The customer property that the answer maps to.
	CustomerProperty *string `json:"customerProperty,omitempty"`

	// Choices - Choices available to user.
	Choices *[]string `json:"choices,omitempty"`

	// IsMandatory - Whether answering this question is mandatory.
	IsMandatory *bool `json:"isMandatory,omitempty"`
}

Journeysurveyquestion

func (*Journeysurveyquestion) String ¶

func (o *Journeysurveyquestion) String() string

String returns a JSON representation of the model

type Jsonnode ¶

type Jsonnode struct {
	// Float
	Float *bool `json:"float,omitempty"`

	// NodeType
	NodeType *string `json:"nodeType,omitempty"`

	// Number
	Number *bool `json:"number,omitempty"`

	// ValueNode
	ValueNode *bool `json:"valueNode,omitempty"`

	// ContainerNode
	ContainerNode *bool `json:"containerNode,omitempty"`

	// FloatingPointNumber
	FloatingPointNumber *bool `json:"floatingPointNumber,omitempty"`

	// MissingNode
	MissingNode *bool `json:"missingNode,omitempty"`

	// Object
	Object *bool `json:"object,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"`

	// Boolean
	Boolean *bool `json:"boolean,omitempty"`

	// Binary
	Binary *bool `json:"binary,omitempty"`

	// Array
	Array *bool `json:"array,omitempty"`

	// Null
	Null *bool `json:"null,omitempty"`
}

Jsonnode

func (*Jsonnode) String ¶

func (o *Jsonnode) String() string

String returns a JSON representation of the model

type Jsonnodesearchresponse ¶

type Jsonnodesearchresponse struct {
	// Total - The total number of results found
	Total *int `json:"total,omitempty"`

	// PageCount - The total number of pages
	PageCount *int `json:"pageCount,omitempty"`

	// PageSize - The current page size
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The current page number
	PageNumber *int `json:"pageNumber,omitempty"`

	// PreviousPage - Q64 value for the previous page of results
	PreviousPage *string `json:"previousPage,omitempty"`

	// CurrentPage - Q64 value for the current page of results
	CurrentPage *string `json:"currentPage,omitempty"`

	// NextPage - Q64 value for the next page of results
	NextPage *string `json:"nextPage,omitempty"`

	// Types - Resource types the search was performed against
	Types *[]string `json:"types,omitempty"`

	// Results - Search results
	Results *Arraynode `json:"results,omitempty"`

	// Aggregations
	Aggregations *Arraynode `json:"aggregations,omitempty"`
}

Jsonnodesearchresponse

func (*Jsonnodesearchresponse) String ¶

func (o *Jsonnodesearchresponse) String() string

String returns a JSON representation of the model

type Jsonschemadocument ¶

type Jsonschemadocument struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Schema
	Schema *string `json:"$schema,omitempty"`

	// Title
	Title *string `json:"title,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// Required
	Required *[]string `json:"required,omitempty"`

	// Properties
	Properties *map[string]interface{} `json:"properties,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Jsonschemadocument - A JSON Schema document.

func (*Jsonschemadocument) String ¶

func (o *Jsonschemadocument) String() string

String returns a JSON representation of the model

type Jsonsearchresponse ¶

type Jsonsearchresponse struct {
	// Total - The total number of results found
	Total *int `json:"total,omitempty"`

	// PageCount - The total number of pages
	PageCount *int `json:"pageCount,omitempty"`

	// PageSize - The current page size
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The current page number
	PageNumber *int `json:"pageNumber,omitempty"`

	// Types - Resource types the search was performed against
	Types *[]string `json:"types,omitempty"`

	// Results - Search results
	Results *Arraynode `json:"results,omitempty"`

	// Aggregations
	Aggregations *Arraynode `json:"aggregations,omitempty"`
}

Jsonsearchresponse

func (*Jsonsearchresponse) String ¶

func (o *Jsonsearchresponse) String() string

String returns a JSON representation of the model

type Keyperformanceindicator ¶

type Keyperformanceindicator struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the Key Performance Indicator.
	Name *string `json:"name,omitempty"`
}

Keyperformanceindicator

func (*Keyperformanceindicator) String ¶

func (o *Keyperformanceindicator) String() string

String returns a JSON representation of the model

type Keyperformanceindicatorassessment ¶

type Keyperformanceindicatorassessment struct {
	// Kpi - Name of the key performance indicator assessed.
	Kpi *string `json:"kpi,omitempty"`

	// AssessmentResult - The overall result of the assessment for a key performance indicator.
	AssessmentResult *string `json:"assessmentResult,omitempty"`

	// Checks - Set of checks executed as part of an assessment.
	Checks *[]Check `json:"checks,omitempty"`
}

Keyperformanceindicatorassessment

func (*Keyperformanceindicatorassessment) String ¶

String returns a JSON representation of the model

type Keyrotationschedule ¶

type Keyrotationschedule struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Period - Value to set schedule to
	Period *string `json:"period,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Keyrotationschedule

func (*Keyrotationschedule) String ¶

func (o *Keyrotationschedule) String() string

String returns a JSON representation of the model

type Keyvalue ¶

type Keyvalue struct {
	// Key - Key for free-form data.
	Key *string `json:"key,omitempty"`

	// Value - Value for free-form data.
	Value *string `json:"value,omitempty"`
}

Keyvalue

func (*Keyvalue) String ¶

func (o *Keyvalue) String() string

String returns a JSON representation of the model

type Klaxonheartbeatalertstopicheartbeatalert ¶

type Klaxonheartbeatalertstopicheartbeatalert struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// SenderId
	SenderId *string `json:"senderId,omitempty"`

	// HeartBeatTimeoutInMinutes
	HeartBeatTimeoutInMinutes *float32 `json:"heartBeatTimeoutInMinutes,omitempty"`

	// RuleId
	RuleId *string `json:"ruleId,omitempty"`

	// StartDate
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate
	EndDate *time.Time `json:"endDate,omitempty"`

	// NotificationUsers
	NotificationUsers *[]Klaxonheartbeatalertstopicnotificationuser `json:"notificationUsers,omitempty"`

	// AlertTypes
	AlertTypes *[]string `json:"alertTypes,omitempty"`

	// RuleType
	RuleType *string `json:"ruleType,omitempty"`
}

Klaxonheartbeatalertstopicheartbeatalert

func (*Klaxonheartbeatalertstopicheartbeatalert) String ¶

String returns a JSON representation of the model

type Klaxonheartbeatalertstopicnotificationuser ¶

type Klaxonheartbeatalertstopicnotificationuser struct {
	// Id
	Id *string `json:"id,omitempty"`

	// DisplayName
	DisplayName *string `json:"displayName,omitempty"`
}

Klaxonheartbeatalertstopicnotificationuser

func (*Klaxonheartbeatalertstopicnotificationuser) String ¶

String returns a JSON representation of the model

type Klaxonheartbeatrulestopicheartbeatrule ¶

type Klaxonheartbeatrulestopicheartbeatrule struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// SenderId
	SenderId *string `json:"senderId,omitempty"`

	// HeartBeatTimeoutInMinutes
	HeartBeatTimeoutInMinutes *float32 `json:"heartBeatTimeoutInMinutes,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// InAlarm
	InAlarm *bool `json:"inAlarm,omitempty"`

	// NotificationUsers
	NotificationUsers *[]Klaxonheartbeatrulestopicnotificationuser `json:"notificationUsers,omitempty"`

	// AlertTypes
	AlertTypes *[]string `json:"alertTypes,omitempty"`

	// RuleType
	RuleType *string `json:"ruleType,omitempty"`
}

Klaxonheartbeatrulestopicheartbeatrule

func (*Klaxonheartbeatrulestopicheartbeatrule) String ¶

String returns a JSON representation of the model

type Klaxonheartbeatrulestopicnotificationuser ¶

type Klaxonheartbeatrulestopicnotificationuser struct {
	// Id
	Id *string `json:"id,omitempty"`

	// DisplayName
	DisplayName *string `json:"displayName,omitempty"`
}

Klaxonheartbeatrulestopicnotificationuser

func (*Klaxonheartbeatrulestopicnotificationuser) String ¶

String returns a JSON representation of the model

type Klaxoninteractionstatsalertstopicinteractionstatalert ¶

type Klaxoninteractionstatsalertstopicinteractionstatalert struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// RuleId
	RuleId *string `json:"ruleId,omitempty"`

	// Dimension
	Dimension *string `json:"dimension,omitempty"`

	// DimensionValue
	DimensionValue *string `json:"dimensionValue,omitempty"`

	// DimensionValueName
	DimensionValueName *string `json:"dimensionValueName,omitempty"`

	// Metric
	Metric *string `json:"metric,omitempty"`

	// MediaType
	MediaType *string `json:"mediaType,omitempty"`

	// NumericRange
	NumericRange *string `json:"numericRange,omitempty"`

	// Statistic
	Statistic *string `json:"statistic,omitempty"`

	// Value
	Value *float32 `json:"value,omitempty"`

	// Unread
	Unread *bool `json:"unread,omitempty"`

	// StartDate
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate
	EndDate *time.Time `json:"endDate,omitempty"`

	// NotificationUsers
	NotificationUsers *[]Klaxoninteractionstatsalertstopicnotificationuser `json:"notificationUsers,omitempty"`

	// AlertTypes
	AlertTypes *[]string `json:"alertTypes,omitempty"`
}

Klaxoninteractionstatsalertstopicinteractionstatalert

func (*Klaxoninteractionstatsalertstopicinteractionstatalert) String ¶

String returns a JSON representation of the model

type Klaxoninteractionstatsalertstopicnotificationuser ¶

type Klaxoninteractionstatsalertstopicnotificationuser struct {
	// Id
	Id *string `json:"id,omitempty"`

	// DisplayName
	DisplayName *string `json:"displayName,omitempty"`
}

Klaxoninteractionstatsalertstopicnotificationuser

func (*Klaxoninteractionstatsalertstopicnotificationuser) String ¶

String returns a JSON representation of the model

type Klaxoninteractionstatsrulestopicinteractionstatrule ¶

type Klaxoninteractionstatsrulestopicinteractionstatrule struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Dimension
	Dimension *string `json:"dimension,omitempty"`

	// DimensionValue
	DimensionValue *string `json:"dimensionValue,omitempty"`

	// DimensionValueName
	DimensionValueName *string `json:"dimensionValueName,omitempty"`

	// Metric
	Metric *string `json:"metric,omitempty"`

	// MediaType
	MediaType *string `json:"mediaType,omitempty"`

	// NumericRange
	NumericRange *string `json:"numericRange,omitempty"`

	// Statistic
	Statistic *string `json:"statistic,omitempty"`

	// Value
	Value *float32 `json:"value,omitempty"`

	// InAlarm
	InAlarm *bool `json:"inAlarm,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// NotificationUsers
	NotificationUsers *[]Klaxoninteractionstatsrulestopicnotificationuser `json:"notificationUsers,omitempty"`

	// AlertTypes
	AlertTypes *[]string `json:"alertTypes,omitempty"`
}

Klaxoninteractionstatsrulestopicinteractionstatrule

func (*Klaxoninteractionstatsrulestopicinteractionstatrule) String ¶

String returns a JSON representation of the model

type Klaxoninteractionstatsrulestopicnotificationuser ¶

type Klaxoninteractionstatsrulestopicnotificationuser struct {
	// Id
	Id *string `json:"id,omitempty"`

	// DisplayName
	DisplayName *string `json:"displayName,omitempty"`
}

Klaxoninteractionstatsrulestopicnotificationuser

func (*Klaxoninteractionstatsrulestopicnotificationuser) String ¶

String returns a JSON representation of the model

type KnowledgeApi ¶

type KnowledgeApi struct {
	Configuration *Configuration
}

KnowledgeApi provides functions for API endpoints

func NewKnowledgeApi ¶

func NewKnowledgeApi() *KnowledgeApi

NewKnowledgeApi creates an API instance using the default configuration

func NewKnowledgeApiWithConfig ¶

func NewKnowledgeApiWithConfig(config *Configuration) *KnowledgeApi

NewKnowledgeApiWithConfig creates an API instance using the provided configuration

func (KnowledgeApi) DeleteKnowledgeKnowledgebase ¶

func (a KnowledgeApi) DeleteKnowledgeKnowledgebase(knowledgeBaseId string) (*Knowledgebase, *APIResponse, error)

DeleteKnowledgeKnowledgebase invokes DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}

Delete knowledge base

func (KnowledgeApi) DeleteKnowledgeKnowledgebaseLanguageCategory ¶

func (a KnowledgeApi) DeleteKnowledgeKnowledgebaseLanguageCategory(categoryId string, knowledgeBaseId string, languageCode string) (*Knowledgecategory, *APIResponse, error)

DeleteKnowledgeKnowledgebaseLanguageCategory invokes DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}

Delete category

func (KnowledgeApi) DeleteKnowledgeKnowledgebaseLanguageDocument ¶

func (a KnowledgeApi) DeleteKnowledgeKnowledgebaseLanguageDocument(documentId string, knowledgeBaseId string, languageCode string) (*Knowledgedocument, *APIResponse, error)

DeleteKnowledgeKnowledgebaseLanguageDocument invokes DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}

Delete document

func (KnowledgeApi) GetKnowledgeKnowledgebase ¶

func (a KnowledgeApi) GetKnowledgeKnowledgebase(knowledgeBaseId string) (*Knowledgebase, *APIResponse, error)

GetKnowledgeKnowledgebase invokes GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}

Get knowledge base

func (KnowledgeApi) GetKnowledgeKnowledgebaseLanguageCategories ¶

func (a KnowledgeApi) GetKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId string, languageCode string, before string, after string, limit string, pageSize string, name string) (*Categorylisting, *APIResponse, error)

GetKnowledgeKnowledgebaseLanguageCategories invokes GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories

Get categories

func (KnowledgeApi) GetKnowledgeKnowledgebaseLanguageCategory ¶

func (a KnowledgeApi) GetKnowledgeKnowledgebaseLanguageCategory(categoryId string, knowledgeBaseId string, languageCode string) (*Knowledgeextendedcategory, *APIResponse, error)

GetKnowledgeKnowledgebaseLanguageCategory invokes GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}

Get category

func (KnowledgeApi) GetKnowledgeKnowledgebaseLanguageDocument ¶

func (a KnowledgeApi) GetKnowledgeKnowledgebaseLanguageDocument(documentId string, knowledgeBaseId string, languageCode string) (*Knowledgedocument, *APIResponse, error)

GetKnowledgeKnowledgebaseLanguageDocument invokes GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}

Get document

func (KnowledgeApi) GetKnowledgeKnowledgebaseLanguageDocuments ¶

func (a KnowledgeApi) GetKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId string, languageCode string, before string, after string, limit string, pageSize string, categories string, title string, documentIds []string) (*Documentlisting, *APIResponse, error)

GetKnowledgeKnowledgebaseLanguageDocuments invokes GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents

Get documents

func (KnowledgeApi) GetKnowledgeKnowledgebaseLanguageTraining ¶

func (a KnowledgeApi) GetKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId string, languageCode string, trainingId string) (*Knowledgetraining, *APIResponse, error)

GetKnowledgeKnowledgebaseLanguageTraining invokes GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}

Get training detail

func (KnowledgeApi) GetKnowledgeKnowledgebaseLanguageTrainings ¶

func (a KnowledgeApi) GetKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId string, languageCode string, before string, after string, limit string, pageSize string, knowledgeDocumentsState string) (*Traininglisting, *APIResponse, error)

GetKnowledgeKnowledgebaseLanguageTrainings invokes GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings

Get all trainings information for a knowledgebase

func (KnowledgeApi) GetKnowledgeKnowledgebases ¶

func (a KnowledgeApi) GetKnowledgeKnowledgebases(before string, after string, limit string, pageSize string, name string, coreLanguage string, published bool) (*Knowledgebaselisting, *APIResponse, error)

GetKnowledgeKnowledgebases invokes GET /api/v2/knowledge/knowledgebases

Get knowledge bases

func (KnowledgeApi) PatchKnowledgeKnowledgebase ¶

func (a KnowledgeApi) PatchKnowledgeKnowledgebase(knowledgeBaseId string, body Knowledgebase) (*Knowledgebase, *APIResponse, error)

PatchKnowledgeKnowledgebase invokes PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}

Update knowledge base

func (KnowledgeApi) PatchKnowledgeKnowledgebaseLanguageCategory ¶

func (a KnowledgeApi) PatchKnowledgeKnowledgebaseLanguageCategory(categoryId string, knowledgeBaseId string, languageCode string, body Knowledgecategoryrequest) (*Knowledgeextendedcategory, *APIResponse, error)

PatchKnowledgeKnowledgebaseLanguageCategory invokes PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}

Update category

func (KnowledgeApi) PatchKnowledgeKnowledgebaseLanguageDocument ¶

func (a KnowledgeApi) PatchKnowledgeKnowledgebaseLanguageDocument(documentId string, knowledgeBaseId string, languageCode string, body Knowledgedocumentrequest) (*Knowledgedocument, *APIResponse, error)

PatchKnowledgeKnowledgebaseLanguageDocument invokes PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}

Update document

func (KnowledgeApi) PatchKnowledgeKnowledgebaseLanguageDocuments ¶

func (a KnowledgeApi) PatchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId string, languageCode string, body []Knowledgedocumentbulkrequest) (*Documentlisting, *APIResponse, error)

PatchKnowledgeKnowledgebaseLanguageDocuments invokes PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents

Update documents collection

func (KnowledgeApi) PostKnowledgeKnowledgebaseLanguageCategories ¶

func (a KnowledgeApi) PostKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId string, languageCode string, body Knowledgecategoryrequest) (*Knowledgeextendedcategory, *APIResponse, error)

PostKnowledgeKnowledgebaseLanguageCategories invokes POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories

Create new category

func (KnowledgeApi) PostKnowledgeKnowledgebaseLanguageDocuments ¶

func (a KnowledgeApi) PostKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId string, languageCode string, body Knowledgedocumentrequest) (*Knowledgedocument, *APIResponse, error)

PostKnowledgeKnowledgebaseLanguageDocuments invokes POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents

Create document

func (KnowledgeApi) PostKnowledgeKnowledgebaseLanguageTrainingPromote ¶

func (a KnowledgeApi) PostKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId string, languageCode string, trainingId string) (*Knowledgetraining, *APIResponse, error)

PostKnowledgeKnowledgebaseLanguageTrainingPromote invokes POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote

Promote trained documents from draft state to active.

func (KnowledgeApi) PostKnowledgeKnowledgebaseLanguageTrainings ¶

func (a KnowledgeApi) PostKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId string, languageCode string) (*Knowledgetraining, *APIResponse, error)

PostKnowledgeKnowledgebaseLanguageTrainings invokes POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings

Trigger training

func (KnowledgeApi) PostKnowledgeKnowledgebaseSearch ¶

func (a KnowledgeApi) PostKnowledgeKnowledgebaseSearch(knowledgeBaseId string, body Knowledgesearchrequest) (*Knowledgesearchresponse, *APIResponse, error)

PostKnowledgeKnowledgebaseSearch invokes POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search

Search Documents

func (KnowledgeApi) PostKnowledgeKnowledgebases ¶

func (a KnowledgeApi) PostKnowledgeKnowledgebases(body Knowledgebase) (*Knowledgebase, *APIResponse, error)

PostKnowledgeKnowledgebases invokes POST /api/v2/knowledge/knowledgebases

Create new knowledge base

type Knowledgebase ¶

type Knowledgebase struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Description - Knowledge base description
	Description *string `json:"description,omitempty"`

	// CoreLanguage - Core language for knowledge base in which initial content must be created first
	CoreLanguage *string `json:"coreLanguage,omitempty"`

	// DateCreated - Knowledge base creation date-time. 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 - Knowledge base last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// FaqCount - The count representing the number of documents of type FAQ in the KnowledgeBase
	FaqCount *int `json:"faqCount,omitempty"`

	// DateDocumentLastModified - The date representing when the last document is modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateDocumentLastModified *time.Time `json:"dateDocumentLastModified,omitempty"`

	// ArticleCount - The count representing the number of documents of type Article in the KnowledgeBase
	ArticleCount *int `json:"articleCount,omitempty"`

	// Published - Flag that indicates the knowledge base is published
	Published *bool `json:"published,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Knowledgebase

func (*Knowledgebase) String ¶

func (o *Knowledgebase) String() string

String returns a JSON representation of the model

type Knowledgebaselisting ¶

type Knowledgebaselisting struct {
	// Entities
	Entities *[]Knowledgebase `json:"entities,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`
}

Knowledgebaselisting

func (*Knowledgebaselisting) String ¶

func (o *Knowledgebaselisting) String() string

String returns a JSON representation of the model

type Knowledgecategory ¶

type Knowledgecategory struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - Category name
	Name *string `json:"name,omitempty"`

	// Description - Category description
	Description *string `json:"description,omitempty"`

	// KnowledgeBase - Knowledge base which category does belong to
	KnowledgeBase *Knowledgebase `json:"knowledgeBase,omitempty"`

	// LanguageCode - Actual language of the category
	LanguageCode *string `json:"languageCode,omitempty"`

	// DateCreated - Category creation date-time. 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 - Category last modification date-time. 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"`
}

Knowledgecategory

func (*Knowledgecategory) String ¶

func (o *Knowledgecategory) String() string

String returns a JSON representation of the model

type Knowledgecategoryrequest ¶

type Knowledgecategoryrequest struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - Category name
	Name *string `json:"name,omitempty"`

	// Description - Category description
	Description *string `json:"description,omitempty"`

	// Parent - Category parent
	Parent *Documentcategoryinput `json:"parent,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Knowledgecategoryrequest

func (*Knowledgecategoryrequest) String ¶

func (o *Knowledgecategoryrequest) String() string

String returns a JSON representation of the model

type Knowledgedocument ¶

type Knowledgedocument struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// LanguageCode - Language of the document
	LanguageCode *string `json:"languageCode,omitempty"`

	// VarType - Document type
	VarType *string `json:"type,omitempty"`

	// Faq - FAQ document details
	Faq *Documentfaq `json:"faq,omitempty"`

	// DateCreated - Document creation date-time. 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 - Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Categories - Document categories
	Categories *[]Knowledgecategory `json:"categories,omitempty"`

	// KnowledgeBase - Knowledge base which document does belong to
	KnowledgeBase *Knowledgebase `json:"knowledgeBase,omitempty"`

	// ExternalUrl - External URL to the document
	ExternalUrl *string `json:"externalUrl,omitempty"`

	// Article - Article
	Article *Documentarticle `json:"article,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Knowledgedocument

func (*Knowledgedocument) String ¶

func (o *Knowledgedocument) String() string

String returns a JSON representation of the model

type Knowledgedocumentbulkrequest ¶

type Knowledgedocumentbulkrequest struct {
	// VarType - Document type according to assigned template
	VarType *string `json:"type,omitempty"`

	// ExternalUrl - External Url to the document
	ExternalUrl *string `json:"externalUrl,omitempty"`

	// Faq - Faq document details
	Faq *Documentfaq `json:"faq,omitempty"`

	// Categories - Document categories
	Categories *[]Documentcategoryinput `json:"categories,omitempty"`

	// Article - Article details
	Article *Documentarticle `json:"article,omitempty"`

	// Id - Identifier of document for update. Omit for create new Document.
	Id *string `json:"id,omitempty"`
}

Knowledgedocumentbulkrequest

func (*Knowledgedocumentbulkrequest) String ¶

String returns a JSON representation of the model

type Knowledgedocumentrequest ¶

type Knowledgedocumentrequest struct {
	// VarType - Document type according to assigned template
	VarType *string `json:"type,omitempty"`

	// ExternalUrl - External Url to the document
	ExternalUrl *string `json:"externalUrl,omitempty"`

	// Faq - Faq document details
	Faq *Documentfaq `json:"faq,omitempty"`

	// Categories - Document categories
	Categories *[]Documentcategoryinput `json:"categories,omitempty"`

	// Article - Article details
	Article *Documentarticle `json:"article,omitempty"`
}

Knowledgedocumentrequest

func (*Knowledgedocumentrequest) String ¶

func (o *Knowledgedocumentrequest) String() string

String returns a JSON representation of the model

type Knowledgeextendedcategory ¶

type Knowledgeextendedcategory struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - Category name
	Name *string `json:"name,omitempty"`

	// Description - Category description
	Description *string `json:"description,omitempty"`

	// KnowledgeBase - Knowledge base which category does belong to
	KnowledgeBase *Knowledgebase `json:"knowledgeBase,omitempty"`

	// LanguageCode - Actual language of the category
	LanguageCode *string `json:"languageCode,omitempty"`

	// DateCreated - Category creation date-time. 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 - Category last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Parent - Category parent
	Parent *Knowledgecategory `json:"parent,omitempty"`

	// Children - Category children
	Children *[]Knowledgecategory `json:"children,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Knowledgeextendedcategory

func (*Knowledgeextendedcategory) String ¶

func (o *Knowledgeextendedcategory) String() string

String returns a JSON representation of the model

type Knowledgesearchdocument ¶

type Knowledgesearchdocument struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// LanguageCode - Language of the document
	LanguageCode *string `json:"languageCode,omitempty"`

	// VarType - Document type
	VarType *string `json:"type,omitempty"`

	// Faq - FAQ document details
	Faq *Documentfaq `json:"faq,omitempty"`

	// DateCreated - Document creation date-time. 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 - Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Categories - Document categories
	Categories *[]Knowledgecategory `json:"categories,omitempty"`

	// KnowledgeBase - Knowledge base which document does belong to
	KnowledgeBase *Knowledgebase `json:"knowledgeBase,omitempty"`

	// ExternalUrl - External URL to the document
	ExternalUrl *string `json:"externalUrl,omitempty"`

	// Article - Article
	Article *Documentarticle `json:"article,omitempty"`

	// Confidence - The confidence associated with a document with respect to a search query
	Confidence *float64 `json:"confidence,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Knowledgesearchdocument

func (*Knowledgesearchdocument) String ¶

func (o *Knowledgesearchdocument) String() string

String returns a JSON representation of the model

type Knowledgesearchrequest ¶

type Knowledgesearchrequest struct {
	// Query - Input query to search content in the knowledge base
	Query *string `json:"query,omitempty"`

	// PageSize - Page size of the returned results
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - Page number of the returned results
	PageNumber *int `json:"pageNumber,omitempty"`

	// DocumentType - Document type to be used while searching
	DocumentType *string `json:"documentType,omitempty"`

	// LanguageCode - query search for specific languageCode
	LanguageCode *string `json:"languageCode,omitempty"`

	// SearchOnDraftDocuments - If true the search query will be executed on draft documents, else it will be on active documents
	SearchOnDraftDocuments *bool `json:"searchOnDraftDocuments,omitempty"`
}

Knowledgesearchrequest

func (*Knowledgesearchrequest) String ¶

func (o *Knowledgesearchrequest) String() string

String returns a JSON representation of the model

type Knowledgesearchresponse ¶

type Knowledgesearchresponse struct {
	// SearchId - Search Id
	SearchId *string `json:"searchId,omitempty"`

	// Total - Total number of records returned
	Total *int `json:"total,omitempty"`

	// PageCount - Number of pages returned in the result calculated according to the pageSize and the total
	PageCount *int `json:"pageCount,omitempty"`

	// PageSize - Number of records according to the page size
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - Current page number for the returned records
	PageNumber *int `json:"pageNumber,omitempty"`

	// Results - Results associated to the search response
	Results *[]Knowledgesearchdocument `json:"results,omitempty"`
}

Knowledgesearchresponse

func (*Knowledgesearchresponse) String ¶

func (o *Knowledgesearchresponse) String() string

String returns a JSON representation of the model

type Knowledgetraining ¶

type Knowledgetraining struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// DateTriggered - Trigger date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateTriggered *time.Time `json:"dateTriggered,omitempty"`

	// DateCompleted - Training completed date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCompleted *time.Time `json:"dateCompleted,omitempty"`

	// Status - Training status.
	Status *string `json:"status,omitempty"`

	// LanguageCode - Language of the documents that are trained.
	LanguageCode *string `json:"languageCode,omitempty"`

	// KnowledgeBase - Knowledge Base that the training belongs to.
	KnowledgeBase *Knowledgebase `json:"knowledgeBase,omitempty"`

	// ErrorMessage - Any error message during the Training or Promote action.
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// KnowledgeDocumentsState - State of the Trained Documents, which can be one of these Draft, Active, Discarded, Archived.
	KnowledgeDocumentsState *string `json:"knowledgeDocumentsState,omitempty"`

	// DatePromoted - Trained Documents Promoted date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DatePromoted *time.Time `json:"datePromoted,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Knowledgetraining

func (*Knowledgetraining) String ¶

func (o *Knowledgetraining) String() string

String returns a JSON representation of the model

type Language ¶

type Language struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The language name.
	Name *string `json:"name,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"`

	// State
	State *string `json:"state,omitempty"`

	// Version
	Version *string `json:"version,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Language

func (*Language) String ¶

func (o *Language) String() string

String returns a JSON representation of the model

type LanguageUnderstandingApi ¶

type LanguageUnderstandingApi struct {
	Configuration *Configuration
}

LanguageUnderstandingApi provides functions for API endpoints

func NewLanguageUnderstandingApi ¶

func NewLanguageUnderstandingApi() *LanguageUnderstandingApi

NewLanguageUnderstandingApi creates an API instance using the default configuration

func NewLanguageUnderstandingApiWithConfig ¶

func NewLanguageUnderstandingApiWithConfig(config *Configuration) *LanguageUnderstandingApi

NewLanguageUnderstandingApiWithConfig creates an API instance using the provided configuration

func (LanguageUnderstandingApi) DeleteLanguageunderstandingDomain ¶

func (a LanguageUnderstandingApi) DeleteLanguageunderstandingDomain(domainId string) (*APIResponse, error)

DeleteLanguageunderstandingDomain invokes DELETE /api/v2/languageunderstanding/domains/{domainId}

Delete an NLU Domain.

func (LanguageUnderstandingApi) DeleteLanguageunderstandingDomainFeedbackFeedbackId ¶

func (a LanguageUnderstandingApi) DeleteLanguageunderstandingDomainFeedbackFeedbackId(domainId string, feedbackId string) (*APIResponse, error)

DeleteLanguageunderstandingDomainFeedbackFeedbackId invokes DELETE /api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}

Delete the feedback on the NLU Domain Version.

func (LanguageUnderstandingApi) DeleteLanguageunderstandingDomainVersion ¶

func (a LanguageUnderstandingApi) DeleteLanguageunderstandingDomainVersion(domainId string, domainVersionId string) (*APIResponse, error)

DeleteLanguageunderstandingDomainVersion invokes DELETE /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}

Delete an NLU Domain Version

func (LanguageUnderstandingApi) GetLanguageunderstandingDomain ¶

func (a LanguageUnderstandingApi) GetLanguageunderstandingDomain(domainId string) (*Nludomain, *APIResponse, error)

GetLanguageunderstandingDomain invokes GET /api/v2/languageunderstanding/domains/{domainId}

Find an NLU Domain.

func (LanguageUnderstandingApi) GetLanguageunderstandingDomainFeedback ¶

func (a LanguageUnderstandingApi) GetLanguageunderstandingDomainFeedback(domainId string, intentName string, assessment string, dateStart time.Time, dateEnd time.Time, includeDeleted bool, pageNumber int, pageSize int, enableCursorPagination bool, after string, fields []string) (*Nlufeedbacklisting, *APIResponse, error)

GetLanguageunderstandingDomainFeedback invokes GET /api/v2/languageunderstanding/domains/{domainId}/feedback

Get all feedback in the given NLU Domain Version.

func (LanguageUnderstandingApi) GetLanguageunderstandingDomainFeedbackFeedbackId ¶

func (a LanguageUnderstandingApi) GetLanguageunderstandingDomainFeedbackFeedbackId(domainId string, feedbackId string, fields []string) (*Nlufeedbackresponse, *APIResponse, error)

GetLanguageunderstandingDomainFeedbackFeedbackId invokes GET /api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}

Find a Feedback

func (LanguageUnderstandingApi) GetLanguageunderstandingDomainVersion ¶

func (a LanguageUnderstandingApi) GetLanguageunderstandingDomainVersion(domainId string, domainVersionId string, includeUtterances bool) (*Nludomainversion, *APIResponse, error)

GetLanguageunderstandingDomainVersion invokes GET /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}

Find an NLU Domain Version.

func (LanguageUnderstandingApi) GetLanguageunderstandingDomainVersionReport ¶

func (a LanguageUnderstandingApi) GetLanguageunderstandingDomainVersionReport(domainId string, domainVersionId string) (*Nludomainversionqualityreport, *APIResponse, error)

GetLanguageunderstandingDomainVersionReport invokes GET /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report

Retrieved quality report for the specified NLU Domain Version

func (LanguageUnderstandingApi) GetLanguageunderstandingDomainVersions ¶

func (a LanguageUnderstandingApi) GetLanguageunderstandingDomainVersions(domainId string, includeUtterances bool, pageNumber int, pageSize int) (*Nludomainversionlisting, *APIResponse, error)

GetLanguageunderstandingDomainVersions invokes GET /api/v2/languageunderstanding/domains/{domainId}/versions

Get all NLU Domain Versions for a given Domain.

func (LanguageUnderstandingApi) GetLanguageunderstandingDomains ¶

func (a LanguageUnderstandingApi) GetLanguageunderstandingDomains(pageNumber int, pageSize int) (*Nludomainlisting, *APIResponse, error)

GetLanguageunderstandingDomains invokes GET /api/v2/languageunderstanding/domains

Get all NLU Domains.

func (LanguageUnderstandingApi) PatchLanguageunderstandingDomain ¶

func (a LanguageUnderstandingApi) PatchLanguageunderstandingDomain(domainId string, body Nludomain) (*Nludomain, *APIResponse, error)

PatchLanguageunderstandingDomain invokes PATCH /api/v2/languageunderstanding/domains/{domainId}

Update an NLU Domain.

func (LanguageUnderstandingApi) PostLanguageunderstandingDomainFeedback ¶

func (a LanguageUnderstandingApi) PostLanguageunderstandingDomainFeedback(domainId string, body Nlufeedbackrequest) (*Nlufeedbackresponse, *APIResponse, error)

PostLanguageunderstandingDomainFeedback invokes POST /api/v2/languageunderstanding/domains/{domainId}/feedback

Create feedback for the NLU Domain Version.

func (LanguageUnderstandingApi) PostLanguageunderstandingDomainVersionDetect ¶

func (a LanguageUnderstandingApi) PostLanguageunderstandingDomainVersionDetect(domainId string, domainVersionId string, body Nludetectionrequest) (*Nludetectionresponse, *APIResponse, error)

PostLanguageunderstandingDomainVersionDetect invokes POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect

Detect intent, entities, etc. in the submitted text using the specified NLU domain version.

func (LanguageUnderstandingApi) PostLanguageunderstandingDomainVersionPublish ¶

func (a LanguageUnderstandingApi) PostLanguageunderstandingDomainVersionPublish(domainId string, domainVersionId string) (*Nludomainversion, *APIResponse, error)

PostLanguageunderstandingDomainVersionPublish invokes POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish

Publish the draft NLU Domain Version.

func (LanguageUnderstandingApi) PostLanguageunderstandingDomainVersionTrain ¶

func (a LanguageUnderstandingApi) PostLanguageunderstandingDomainVersionTrain(domainId string, domainVersionId string) (*Nludomainversiontrainingresponse, *APIResponse, error)

PostLanguageunderstandingDomainVersionTrain invokes POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train

Train the draft NLU Domain Version.

func (LanguageUnderstandingApi) PostLanguageunderstandingDomainVersions ¶

func (a LanguageUnderstandingApi) PostLanguageunderstandingDomainVersions(domainId string, body Nludomainversion) (*Nludomainversion, *APIResponse, error)

PostLanguageunderstandingDomainVersions invokes POST /api/v2/languageunderstanding/domains/{domainId}/versions

Create an NLU Domain Version.

func (LanguageUnderstandingApi) PostLanguageunderstandingDomains ¶

func (a LanguageUnderstandingApi) PostLanguageunderstandingDomains(body Nludomain) (*Nludomain, *APIResponse, error)

PostLanguageunderstandingDomains invokes POST /api/v2/languageunderstanding/domains

Create an NLU Domain.

func (LanguageUnderstandingApi) PutLanguageunderstandingDomainVersion ¶

func (a LanguageUnderstandingApi) PutLanguageunderstandingDomainVersion(domainId string, domainVersionId string, body Nludomainversion) (*Nludomainversion, *APIResponse, error)

PutLanguageunderstandingDomainVersion invokes PUT /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}

Update an NLU Domain Version.

type Languageentitylisting ¶

type Languageentitylisting struct {
	// Entities
	Entities *[]Language `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Languageentitylisting

func (*Languageentitylisting) String ¶

func (o *Languageentitylisting) String() string

String returns a JSON representation of the model

type Languageoverride ¶

type Languageoverride struct {
	// Language - The language code of the language being overridden
	Language *string `json:"language,omitempty"`

	// Engine - The ID of the TTS engine to use for this language override
	Engine *string `json:"engine,omitempty"`

	// Voice - The ID of the voice to use for this language override. The voice must be supported by the chosen engine.
	Voice *string `json:"voice,omitempty"`
}

Languageoverride

func (*Languageoverride) String ¶

func (o *Languageoverride) String() string

String returns a JSON representation of the model

type Languagereference ¶

type Languagereference 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"`
}

Languagereference

func (*Languagereference) String ¶

func (o *Languagereference) String() string

String returns a JSON representation of the model

type LanguagesApi ¶

type LanguagesApi struct {
	Configuration *Configuration
}

LanguagesApi provides functions for API endpoints

func NewLanguagesApi ¶

func NewLanguagesApi() *LanguagesApi

NewLanguagesApi creates an API instance using the default configuration

func NewLanguagesApiWithConfig ¶

func NewLanguagesApiWithConfig(config *Configuration) *LanguagesApi

NewLanguagesApiWithConfig creates an API instance using the provided configuration

func (LanguagesApi) DeleteLanguage ¶

func (a LanguagesApi) DeleteLanguage(languageId string) (*APIResponse, error)

DeleteLanguage invokes DELETE /api/v2/languages/{languageId}

Delete Language (Deprecated)

This endpoint is deprecated. It has been moved to /routing/languages/{languageId}

func (LanguagesApi) DeleteRoutingLanguage ¶

func (a LanguagesApi) DeleteRoutingLanguage(languageId string) (*APIResponse, error)

DeleteRoutingLanguage invokes DELETE /api/v2/routing/languages/{languageId}

Delete Language

func (LanguagesApi) GetLanguage ¶

func (a LanguagesApi) GetLanguage(languageId string) (*Language, *APIResponse, error)

GetLanguage invokes GET /api/v2/languages/{languageId}

Get language (Deprecated)

This endpoint is deprecated. It has been moved to /routing/languages/{languageId}

func (LanguagesApi) GetLanguages ¶

func (a LanguagesApi) GetLanguages(pageSize int, pageNumber int, sortOrder string, name string) (*Languageentitylisting, *APIResponse, error)

GetLanguages invokes GET /api/v2/languages

Get the list of supported languages. (Deprecated)

This endpoint is deprecated. It has been moved to /routing/languages

func (LanguagesApi) GetLanguagesTranslations ¶

func (a LanguagesApi) GetLanguagesTranslations() (*Availabletranslations, *APIResponse, error)

GetLanguagesTranslations invokes GET /api/v2/languages/translations

Get all available languages for translation

func (LanguagesApi) GetLanguagesTranslationsBuiltin ¶

func (a LanguagesApi) GetLanguagesTranslationsBuiltin(language string) (*map[string]interface{}, *APIResponse, error)

GetLanguagesTranslationsBuiltin invokes GET /api/v2/languages/translations/builtin

Get the builtin translation for a language

func (LanguagesApi) GetLanguagesTranslationsOrganization ¶

func (a LanguagesApi) GetLanguagesTranslationsOrganization(language string) (*map[string]interface{}, *APIResponse, error)

GetLanguagesTranslationsOrganization invokes GET /api/v2/languages/translations/organization

Get effective translation for an organization by language

func (LanguagesApi) GetLanguagesTranslationsUser ¶

func (a LanguagesApi) GetLanguagesTranslationsUser(userId string) (*map[string]interface{}, *APIResponse, error)

GetLanguagesTranslationsUser invokes GET /api/v2/languages/translations/users/{userId}

Get effective language translation for a user

func (LanguagesApi) GetRoutingLanguage ¶

func (a LanguagesApi) GetRoutingLanguage(languageId string) (*Language, *APIResponse, error)

GetRoutingLanguage invokes GET /api/v2/routing/languages/{languageId}

Get language

func (LanguagesApi) PostLanguages ¶

func (a LanguagesApi) PostLanguages(body Language) (*Language, *APIResponse, error)

PostLanguages invokes POST /api/v2/languages

Create Language (Deprecated)

This endpoint is deprecated. It has been moved to /routing/languages

type Leaderboard ¶

type Leaderboard struct {
	// Division - The targeted division for this leaderboard
	Division *Division `json:"division,omitempty"`

	// Metric - The metric id if the leaderboard is about a specific metric
	Metric *Metric `json:"metric,omitempty"`

	// DateStartWorkday - Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateStartWorkday *time.Time `json:"dateStartWorkday,omitempty"`

	// DateEndWorkday - End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateEndWorkday *time.Time `json:"dateEndWorkday,omitempty"`

	// Leaders - The list of leaders generated.
	Leaders *[]Leaderboarditem `json:"leaders,omitempty"`

	// UserRank - The requesting user's rank
	UserRank *Leaderboarditem `json:"userRank,omitempty"`
}

Leaderboard

func (*Leaderboard) String ¶

func (o *Leaderboard) String() string

String returns a JSON representation of the model

type Leaderboarditem ¶

type Leaderboarditem struct {
	// User - The user object for this leaderboard rank
	User *Userreference `json:"user,omitempty"`

	// Rank - The rank of the user
	Rank *int `json:"rank,omitempty"`

	// Points - The points collected by the user
	Points *int `json:"points,omitempty"`
}

Leaderboarditem

func (*Leaderboarditem) String ¶

func (o *Leaderboarditem) String() string

String returns a JSON representation of the model

type LearningApi ¶

type LearningApi struct {
	Configuration *Configuration
}

LearningApi provides functions for API endpoints

func NewLearningApi ¶

func NewLearningApi() *LearningApi

NewLearningApi creates an API instance using the default configuration

func NewLearningApiWithConfig ¶

func NewLearningApiWithConfig(config *Configuration) *LearningApi

NewLearningApiWithConfig creates an API instance using the provided configuration

func (LearningApi) DeleteLearningAssignment ¶

func (a LearningApi) DeleteLearningAssignment(assignmentId string) (*APIResponse, error)

DeleteLearningAssignment invokes DELETE /api/v2/learning/assignments/{assignmentId}

Delete a learning assignment

func (LearningApi) DeleteLearningModule ¶

func (a LearningApi) DeleteLearningModule(moduleId string) (*APIResponse, error)

DeleteLearningModule invokes DELETE /api/v2/learning/modules/{moduleId}

Delete a learning module ¶

This will delete a learning module if it is unpublished or it will delete a published and archived learning module

func (LearningApi) GetLearningAssignment ¶

func (a LearningApi) GetLearningAssignment(assignmentId string, expand []string) (*Learningassignment, *APIResponse, error)

GetLearningAssignment invokes GET /api/v2/learning/assignments/{assignmentId}

Get Learning Assignment ¶

Permission not required if you are the assigned user of the learning assignment

func (LearningApi) GetLearningAssignments ¶

func (a LearningApi) GetLearningAssignments(moduleId string, interval string, completionInterval string, overdue string, pageSize int, pageNumber int, sortOrder string, sortBy string, userId []string, types []string, states []string, expand []string) (*Learningassignmentsdomainentity, *APIResponse, error)

GetLearningAssignments invokes GET /api/v2/learning/assignments

List of Learning module Assignments ¶

Either moduleId or user value is required

func (LearningApi) GetLearningAssignmentsMe ¶

func (a LearningApi) GetLearningAssignmentsMe(moduleId string, interval string, completionInterval string, overdue string, pageSize int, pageNumber int, sortOrder string, sortBy string, types []string, states []string, expand []string) (*Learningassignmentsdomainentity, *APIResponse, error)

GetLearningAssignmentsMe invokes GET /api/v2/learning/assignments/me

List of Learning Assignments assigned to current user

func (LearningApi) GetLearningModule ¶

func (a LearningApi) GetLearningModule(moduleId string, expand []string) (*Learningmodule, *APIResponse, error)

GetLearningModule invokes GET /api/v2/learning/modules/{moduleId}

Get a learning module

func (LearningApi) GetLearningModuleRule ¶

func (a LearningApi) GetLearningModuleRule(moduleId string) (*Learningmodulerule, *APIResponse, error)

GetLearningModuleRule invokes GET /api/v2/learning/modules/{moduleId}/rule

Get a learning module rule

func (LearningApi) GetLearningModuleVersion ¶

func (a LearningApi) GetLearningModuleVersion(moduleId string, versionId string, expand []string) (*Learningmodule, *APIResponse, error)

GetLearningModuleVersion invokes GET /api/v2/learning/modules/{moduleId}/versions/{versionId}

Get specific version of a published module

func (LearningApi) GetLearningModules ¶

func (a LearningApi) GetLearningModules(isArchived bool, types []string, pageSize int, pageNumber int, sortOrder string, sortBy string, searchTerm string, expand []string) (*Learningmodulesdomainentitylisting, *APIResponse, error)

GetLearningModules invokes GET /api/v2/learning/modules

Get all learning modules of an organization

func (LearningApi) PatchLearningAssignment ¶

func (a LearningApi) PatchLearningAssignment(assignmentId string, body Learningassignmentupdate) (*Learningassignment, *APIResponse, error)

PatchLearningAssignment invokes PATCH /api/v2/learning/assignments/{assignmentId}

Update Learning Assignment

func (LearningApi) PostLearningAssignments ¶

func (a LearningApi) PostLearningAssignments(body Learningassignmentcreate) (*Learningassignment, *APIResponse, error)

PostLearningAssignments invokes POST /api/v2/learning/assignments

Create Learning Assignment

func (LearningApi) PostLearningAssignmentsAggregatesQuery ¶

func (a LearningApi) PostLearningAssignmentsAggregatesQuery(body Learningassignmentaggregateparam) (*Learningassignmentaggregateresponse, *APIResponse, error)

PostLearningAssignmentsAggregatesQuery invokes POST /api/v2/learning/assignments/aggregates/query

Retrieve aggregated assignment data

func (LearningApi) PostLearningAssignmentsBulkadd ¶

func (a LearningApi) PostLearningAssignmentsBulkadd(body []Learningassignmentitem) (*Learningassignmentbulkaddresponse, *APIResponse, error)

PostLearningAssignmentsBulkadd invokes POST /api/v2/learning/assignments/bulkadd

Add multiple learning assignments

func (LearningApi) PostLearningAssignmentsBulkremove ¶

func (a LearningApi) PostLearningAssignmentsBulkremove(body []string) (*Learningassignmentbulkremoveresponse, *APIResponse, error)

PostLearningAssignmentsBulkremove invokes POST /api/v2/learning/assignments/bulkremove

Remove multiple Learning Assignments

func (LearningApi) PostLearningModulePublish ¶

func (a LearningApi) PostLearningModulePublish(moduleId string) (*Learningmodulepublishresponse, *APIResponse, error)

PostLearningModulePublish invokes POST /api/v2/learning/modules/{moduleId}/publish

Publish a Learning module

func (LearningApi) PostLearningModules ¶

func (a LearningApi) PostLearningModules(body Learningmodulerequest) (*Learningmodule, *APIResponse, error)

PostLearningModules invokes POST /api/v2/learning/modules

Create a new learning module ¶

This will create a new unpublished learning module with the specified fields.

func (LearningApi) PostLearningRulesQuery ¶

func (a LearningApi) PostLearningRulesQuery(pageSize int, pageNumber int, body Learningassignmentuserquery) (*Learningassignmentuserlisting, *APIResponse, error)

PostLearningRulesQuery invokes POST /api/v2/learning/rules/query

Get users for learning module rule ¶

This will get the users who matches the given rule.

func (LearningApi) PutLearningModule ¶

func (a LearningApi) PutLearningModule(moduleId string, body Learningmodulerequest) (*Learningmodule, *APIResponse, error)

PutLearningModule invokes PUT /api/v2/learning/modules/{moduleId}

Update a learning module ¶

This will update the name, description, completion time in days and inform steps for a learning module

func (LearningApi) PutLearningModuleRule ¶

func (a LearningApi) PutLearningModuleRule(moduleId string, body Learningmodulerule) (*Learningmodulerule, *APIResponse, error)

PutLearningModuleRule invokes PUT /api/v2/learning/modules/{moduleId}/rule

Update a learning module rule ¶

This will update a learning module rule with the specified fields.

type Learningassessment ¶

type Learningassessment struct {
	// AssessmentId - The Id of the assessment
	AssessmentId *string `json:"assessmentId,omitempty"`

	// ContextId - The context Id of the related assessment form
	ContextId *string `json:"contextId,omitempty"`

	// AssessmentFormId - The Id of the related assessment form
	AssessmentFormId *string `json:"assessmentFormId,omitempty"`

	// Status - Status of the assessment
	Status *string `json:"status,omitempty"`

	// Answers - Answers for the assessment
	Answers *Assessmentscoringset `json:"answers,omitempty"`

	// DateCreated - Date the assessment 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"`

	// DateModified - Date the assessment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// DateSubmitted - Date the assessment was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateSubmitted *time.Time `json:"dateSubmitted,omitempty"`
}

Learningassessment

func (*Learningassessment) String ¶

func (o *Learningassessment) String() string

String returns a JSON representation of the model

type Learningassignment ¶

type Learningassignment struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// CreatedBy - The user who created the assignment
	CreatedBy *Userreference `json:"createdBy,omitempty"`

	// DateCreated - The date when the assignment 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 user who modified the assignment
	ModifiedBy *Userreference `json:"modifiedBy,omitempty"`

	// DateModified - The date when the assignment 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"`

	// IsOverdue - True if the assignment is overdue
	IsOverdue *bool `json:"isOverdue,omitempty"`

	// IsRule - True if this assignment was created by a Rule
	IsRule *bool `json:"isRule,omitempty"`

	// IsManual - True if this assignment was created manually
	IsManual *bool `json:"isManual,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// State - The Learning Assignment state
	State *string `json:"state,omitempty"`

	// DateRecommendedForCompletion - The recommended completion date of the assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateRecommendedForCompletion *time.Time `json:"dateRecommendedForCompletion,omitempty"`

	// Version - The version of Learning module assigned
	Version *int `json:"version,omitempty"`

	// Module - The Learning module object associated with this assignment
	Module *Learningmodule `json:"module,omitempty"`

	// User - The user to whom the assignment is assigned
	User *Userreference `json:"user,omitempty"`
}

Learningassignment - Learning module assignment with user information

func (*Learningassignment) String ¶

func (o *Learningassignment) String() string

String returns a JSON representation of the model

type Learningassignmentaggregateparam ¶

type Learningassignmentaggregateparam struct {
	// Interval - Specifies the range of due dates to be used for filtering. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. 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 - The list of metrics to be returned. If omitted, all metrics are returned.
	Metrics *[]string `json:"metrics,omitempty"`

	// GroupBy - Specifies if the aggregated data is combined into a single set of metrics (groupBy is empty or not specified), or contains an element per attendeeId (groupBy is \"attendeeId\")
	GroupBy *[]string `json:"groupBy,omitempty"`

	// Filter - The filter applied to the data.  This is ANDed with the interval parameter.
	Filter *Learningassignmentaggregatequeryrequestfilter `json:"filter,omitempty"`
}

Learningassignmentaggregateparam

func (*Learningassignmentaggregateparam) String ¶

String returns a JSON representation of the model

type Learningassignmentaggregatequeryrequestclause ¶

type Learningassignmentaggregatequeryrequestclause struct {
	// VarType - The logic used to combine the predicates
	VarType *string `json:"type,omitempty"`

	// Predicates - The list of predicates used to filter the data
	Predicates *[]Learningassignmentaggregatequeryrequestpredicate `json:"predicates,omitempty"`
}

Learningassignmentaggregatequeryrequestclause

func (*Learningassignmentaggregatequeryrequestclause) String ¶

String returns a JSON representation of the model

type Learningassignmentaggregatequeryrequestfilter ¶

type Learningassignmentaggregatequeryrequestfilter struct {
	// VarType - The logic used to combine the clauses
	VarType *string `json:"type,omitempty"`

	// Clauses - The list of clauses used to filter the data. Note that clauses must filter by attendeeId and a maximum of 100 user IDs are allowed
	Clauses *[]Learningassignmentaggregatequeryrequestclause `json:"clauses,omitempty"`
}

Learningassignmentaggregatequeryrequestfilter

func (*Learningassignmentaggregatequeryrequestfilter) String ¶

String returns a JSON representation of the model

type Learningassignmentaggregatequeryrequestpredicate ¶

type Learningassignmentaggregatequeryrequestpredicate struct {
	// Dimension - Each predicates specifies a dimension.
	Dimension *string `json:"dimension,omitempty"`

	// Value - Corresponding value for dimensions in predicates. If the dimensions is type, Valid Values: Informational, AssessedContent, Questionnaire
	Value *string `json:"value,omitempty"`
}

Learningassignmentaggregatequeryrequestpredicate

func (*Learningassignmentaggregatequeryrequestpredicate) String ¶

String returns a JSON representation of the model

type Learningassignmentaggregatequeryresponsedata ¶

type Learningassignmentaggregatequeryresponsedata struct {
	// Interval - Specifies the range of due dates to be used for filtering. A maximum of 1 year can be specified in the range. 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 - The list of aggregated metrics
	Metrics *[]Learningassignmentaggregatequeryresponsemetric `json:"metrics,omitempty"`
}

Learningassignmentaggregatequeryresponsedata

func (*Learningassignmentaggregatequeryresponsedata) String ¶

String returns a JSON representation of the model

type Learningassignmentaggregatequeryresponsegroupeddata ¶

type Learningassignmentaggregatequeryresponsegroupeddata struct {
	// Group - The group values for this data
	Group *map[string]string `json:"group,omitempty"`

	// Data - The metrics in this group
	Data *[]Learningassignmentaggregatequeryresponsedata `json:"data,omitempty"`
}

Learningassignmentaggregatequeryresponsegroupeddata

func (*Learningassignmentaggregatequeryresponsegroupeddata) String ¶

String returns a JSON representation of the model

type Learningassignmentaggregatequeryresponsemetric ¶

type Learningassignmentaggregatequeryresponsemetric struct {
	// Metric - The metric this applies to
	Metric *string `json:"metric,omitempty"`

	// Stats - The aggregated values for this metric
	Stats *Learningassignmentaggregatequeryresponsestats `json:"stats,omitempty"`
}

Learningassignmentaggregatequeryresponsemetric

func (*Learningassignmentaggregatequeryresponsemetric) String ¶

String returns a JSON representation of the model

type Learningassignmentaggregatequeryresponsestats ¶

type Learningassignmentaggregatequeryresponsestats struct {
	// Count - The count for this metric
	Count *int `json:"count,omitempty"`
}

Learningassignmentaggregatequeryresponsestats

func (*Learningassignmentaggregatequeryresponsestats) String ¶

String returns a JSON representation of the model

type Learningassignmentaggregateresponse ¶

type Learningassignmentaggregateresponse struct {
	// Results - The results of the query
	Results *[]Learningassignmentaggregatequeryresponsegroupeddata `json:"results,omitempty"`
}

Learningassignmentaggregateresponse

func (*Learningassignmentaggregateresponse) String ¶

String returns a JSON representation of the model

type Learningassignmentbulkaddresponse ¶

type Learningassignmentbulkaddresponse struct {
	// Entities - The learning assignments that were assigned correctly
	Entities *[]Learningassignment `json:"entities,omitempty"`

	// DisallowedEntities - The items that were not allowed to be assigned
	DisallowedEntities *[]Disallowedentitylearningassignmentitem `json:"disallowedEntities,omitempty"`
}

Learningassignmentbulkaddresponse

func (*Learningassignmentbulkaddresponse) String ¶

String returns a JSON representation of the model

type Learningassignmentbulkremoveresponse ¶

type Learningassignmentbulkremoveresponse struct {
	// Entities - The learning assignments that were removed successfully
	Entities *[]Learningassignmententity `json:"entities,omitempty"`

	// DisallowedEntities - The learning assignments that were not removed due to missing permissions
	DisallowedEntities *[]Disallowedentitylearningassignmentreference `json:"disallowedEntities,omitempty"`
}

Learningassignmentbulkremoveresponse

func (*Learningassignmentbulkremoveresponse) String ¶

String returns a JSON representation of the model

type Learningassignmentcreate ¶

type Learningassignmentcreate struct {
	// ModuleId - The Learning module Id associated with this assignment
	ModuleId *string `json:"moduleId,omitempty"`

	// UserId - The User for whom the assignment is assigned
	UserId *string `json:"userId,omitempty"`

	// RecommendedCompletionDate - The recommended completion date of assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	RecommendedCompletionDate *time.Time `json:"recommendedCompletionDate,omitempty"`
}

Learningassignmentcreate

func (*Learningassignmentcreate) String ¶

func (o *Learningassignmentcreate) String() string

String returns a JSON representation of the model

type Learningassignmententity ¶

type Learningassignmententity struct {
	// AssignmentId
	AssignmentId *string `json:"assignmentId,omitempty"`
}

Learningassignmententity

func (*Learningassignmententity) String ¶

func (o *Learningassignmententity) String() string

String returns a JSON representation of the model

type Learningassignmentitem ¶

type Learningassignmentitem struct {
	// ModuleId - The Learning Module ID associated with this assignment
	ModuleId *string `json:"moduleId,omitempty"`

	// UserId - The User ID associated with this assignment
	UserId *string `json:"userId,omitempty"`
}

Learningassignmentitem

func (*Learningassignmentitem) String ¶

func (o *Learningassignmentitem) String() string

String returns a JSON representation of the model

type Learningassignmentreference ¶

type Learningassignmentreference 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"`
}

Learningassignmentreference

func (*Learningassignmentreference) String ¶

func (o *Learningassignmentreference) String() string

String returns a JSON representation of the model

type Learningassignmentsdomainentity ¶

type Learningassignmentsdomainentity struct {
	// Entities
	Entities *[]Learningassignment `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Learningassignmentsdomainentity

func (*Learningassignmentsdomainentity) String ¶

String returns a JSON representation of the model

type Learningassignmentupdate ¶

type Learningassignmentupdate struct {
	// State - The Learning Assignment state
	State *string `json:"state,omitempty"`

	// Assessment - An updated Assessment
	Assessment *Learningassessment `json:"assessment,omitempty"`
}

Learningassignmentupdate

func (*Learningassignmentupdate) String ¶

func (o *Learningassignmentupdate) String() string

String returns a JSON representation of the model

type Learningassignmentuser ¶

type Learningassignmentuser struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Learningassignmentuser

func (*Learningassignmentuser) String ¶

func (o *Learningassignmentuser) String() string

String returns a JSON representation of the model

type Learningassignmentuserlisting ¶

type Learningassignmentuserlisting struct {
	// Entities
	Entities *[]Learningassignmentuser `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total - The number of users matching search term
	Total *int `json:"total,omitempty"`

	// UnfilteredTotal - The total number of users
	UnfilteredTotal *int `json:"unfilteredTotal,omitempty"`

	// FirstUri
	FirstUri *string `json:"firstUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Learningassignmentuserlisting - List of users matching the learning module rule

func (*Learningassignmentuserlisting) String ¶

String returns a JSON representation of the model

type Learningassignmentuserquery ¶

type Learningassignmentuserquery struct {
	// Rule - Learning module rule object
	Rule *Learningmodulerule `json:"rule,omitempty"`

	// SearchTerm - The user name to be searched for
	SearchTerm *string `json:"searchTerm,omitempty"`
}

Learningassignmentuserquery - Learning module users query request model

func (*Learningassignmentuserquery) String ¶

func (o *Learningassignmentuserquery) String() string

String returns a JSON representation of the model

type Learningmodule ¶

type Learningmodule struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of learning module
	Name *string `json:"name,omitempty"`

	// CreatedBy - The user who created learning module
	CreatedBy *Userreference `json:"createdBy,omitempty"`

	// DateCreated - The date/time learning module 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 user who modified learning module
	ModifiedBy *Userreference `json:"modifiedBy,omitempty"`

	// DateModified - The date/time learning module was 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"`

	// Version - The version of published learning module
	Version *int `json:"version,omitempty"`

	// ExternalId - The external ID of the learning module
	ExternalId *string `json:"externalId,omitempty"`

	// Source - The source of the learning module
	Source *string `json:"source,omitempty"`

	// Rule - The rule for learning module; read-only, and only populated when requested via expand param.
	Rule *Learningmodulerule `json:"rule,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// IsArchived - If true, learning module is archived
	IsArchived *bool `json:"isArchived,omitempty"`

	// IsPublished - If true, learning module is published
	IsPublished *bool `json:"isPublished,omitempty"`

	// Description - The description of learning module
	Description *string `json:"description,omitempty"`

	// CompletionTimeInDays - The completion time of learning module in days
	CompletionTimeInDays *int `json:"completionTimeInDays,omitempty"`

	// InformSteps - The list of inform steps in a learning module
	InformSteps *[]Learningmoduleinformstep `json:"informSteps,omitempty"`
}

Learningmodule - Learning module response

func (*Learningmodule) String ¶

func (o *Learningmodule) String() string

String returns a JSON representation of the model

type Learningmoduleinformstep ¶

type Learningmoduleinformstep struct {
	// VarType - The learning module inform step type
	VarType *string `json:"type,omitempty"`

	// Name - The name of the inform step or content
	Name *string `json:"name,omitempty"`

	// Value - The value for inform step
	Value *string `json:"value,omitempty"`

	// SharingUri - The sharing uri for Content type inform step
	SharingUri *string `json:"sharingUri,omitempty"`

	// ContentType - The document type for Content type Inform step
	ContentType *string `json:"contentType,omitempty"`

	// Order - The order of inform step in a learning module
	Order *int `json:"order,omitempty"`
}

Learningmoduleinformstep

func (*Learningmoduleinformstep) String ¶

func (o *Learningmoduleinformstep) String() string

String returns a JSON representation of the model

type Learningmoduleinformsteprequest ¶

type Learningmoduleinformsteprequest struct {
	// VarType - The learning module inform step type
	VarType *string `json:"type,omitempty"`

	// Name - The name of the inform step or content
	Name *string `json:"name,omitempty"`

	// Value - The value for inform step
	Value *string `json:"value,omitempty"`

	// SharingUri - The sharing uri for Content type inform step
	SharingUri *string `json:"sharingUri,omitempty"`

	// ContentType - The document type for Content type Inform step
	ContentType *string `json:"contentType,omitempty"`

	// Order - The order of inform step in a learning module
	Order *int `json:"order,omitempty"`
}

Learningmoduleinformsteprequest - Learning module inform steps request

func (*Learningmoduleinformsteprequest) String ¶

String returns a JSON representation of the model

type Learningmodulepublishresponse ¶

type Learningmodulepublishresponse struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Version - The version of published learning module
	Version *int `json:"version,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Learningmodulepublishresponse - Learning module publish response

func (*Learningmodulepublishresponse) String ¶

String returns a JSON representation of the model

type Learningmodulerequest ¶

type Learningmodulerequest struct {
	// Name - The name of learning module
	Name *string `json:"name,omitempty"`

	// Description - The description of learning module
	Description *string `json:"description,omitempty"`

	// CompletionTimeInDays - The completion time of learning module in days
	CompletionTimeInDays *int `json:"completionTimeInDays,omitempty"`

	// InformSteps - The list of inform steps in a learning module
	InformSteps *[]Learningmoduleinformsteprequest `json:"informSteps,omitempty"`
}

Learningmodulerequest - Learning module request

func (*Learningmodulerequest) String ¶

func (o *Learningmodulerequest) String() string

String returns a JSON representation of the model

type Learningmodulerule ¶

type Learningmodulerule struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// IsActive - If true, rule is active
	IsActive *bool `json:"isActive,omitempty"`

	// Parts - The parts of a learning module rule
	Parts *[]Learningmoduleruleparts `json:"parts,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Learningmodulerule

func (*Learningmodulerule) String ¶

func (o *Learningmodulerule) String() string

String returns a JSON representation of the model

type Learningmoduleruleparts ¶

type Learningmoduleruleparts struct {
	// Operation - The learning module rule operation
	Operation *string `json:"operation,omitempty"`

	// Selector - The learning module rule selector
	Selector *string `json:"selector,omitempty"`

	// Value - The value of rules
	Value *[]string `json:"value,omitempty"`

	// Order - The order of rules in learning module rule
	Order *int `json:"order,omitempty"`
}

Learningmoduleruleparts

func (*Learningmoduleruleparts) String ¶

func (o *Learningmoduleruleparts) String() string

String returns a JSON representation of the model

type Learningmodulesdomainentitylisting ¶

type Learningmodulesdomainentitylisting struct {
	// Entities
	Entities *[]Learningmodule `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Learningmodulesdomainentitylisting

func (*Learningmodulesdomainentitylisting) String ¶

String returns a JSON representation of the model

type Learningmodulesummary ¶

type Learningmodulesummary struct {
	// AssignedCount - The total number of assignments assigned for a learning module
	AssignedCount *int `json:"assignedCount,omitempty"`

	// CompletedCount - The number of assignments completed for a learning module
	CompletedCount *int `json:"completedCount,omitempty"`

	// PassedCount - The number of assignments passed for a learning module
	PassedCount *int `json:"passedCount,omitempty"`

	// CompletedSum - The sum of assignment scores for a learning module
	CompletedSum *float32 `json:"completedSum,omitempty"`
}

Learningmodulesummary - Learning module summary data

func (*Learningmodulesummary) String ¶

func (o *Learningmodulesummary) String() string

String returns a JSON representation of the model

type Lexbot ¶

type Lexbot struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Description - A description of the Lex bot
	Description *string `json:"description,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Lexbot

func (*Lexbot) String ¶

func (o *Lexbot) String() string

String returns a JSON representation of the model

type Lexbotalias ¶

type Lexbotalias struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Bot - The Lex bot this is an alias for
	Bot *Lexbot `json:"bot,omitempty"`

	// BotVersion - The version of the Lex bot this alias points at
	BotVersion *string `json:"botVersion,omitempty"`

	// Status - The status of the Lex bot alias
	Status *string `json:"status,omitempty"`

	// FailureReason - If the status is FAILED, Amazon Lex explains why it failed to build the bot
	FailureReason *string `json:"failureReason,omitempty"`

	// Language - The target language of the Lex bot
	Language *string `json:"language,omitempty"`

	// Intents - An array of Intents associated with this bot alias
	Intents *[]Lexintent `json:"intents,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Lexbotalias

func (*Lexbotalias) String ¶

func (o *Lexbotalias) String() string

String returns a JSON representation of the model

type Lexbotaliasentitylisting ¶

type Lexbotaliasentitylisting struct {
	// Entities
	Entities *[]Lexbotalias `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Lexbotaliasentitylisting

func (*Lexbotaliasentitylisting) String ¶

func (o *Lexbotaliasentitylisting) String() string

String returns a JSON representation of the model

type Lexbotentitylisting ¶

type Lexbotentitylisting struct {
	// Entities
	Entities *[]Lexbot `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Lexbotentitylisting

func (*Lexbotentitylisting) String ¶

func (o *Lexbotentitylisting) String() string

String returns a JSON representation of the model

type Lexintent ¶

type Lexintent struct {
	// Name - The intent name
	Name *string `json:"name,omitempty"`

	// Description - A description of the intent
	Description *string `json:"description,omitempty"`

	// Slots - An object mapping slot names to Slot objects
	Slots *map[string]Lexslot `json:"slots,omitempty"`

	// Version - The intent version
	Version *string `json:"version,omitempty"`
}

Lexintent

func (*Lexintent) String ¶

func (o *Lexintent) String() string

String returns a JSON representation of the model

type Lexslot ¶

type Lexslot struct {
	// Name - The slot name
	Name *string `json:"name,omitempty"`

	// Description - The slot description
	Description *string `json:"description,omitempty"`

	// VarType - The slot type
	VarType *string `json:"type,omitempty"`

	// Priority - The priority of the slot
	Priority *int `json:"priority,omitempty"`
}

Lexslot

func (*Lexslot) String ¶

func (o *Lexslot) String() string

String returns a JSON representation of the model

type Library ¶

type Library struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The library name.
	Name *string `json:"name,omitempty"`

	// Version - Current version for this resource.
	Version *int `json:"version,omitempty"`

	// CreatedBy - User that created the library.
	CreatedBy *User `json:"createdBy,omitempty"`

	// DateCreated - The date and time the response 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"`

	// ResponseType - This value is deprecated. Responses representing message templates may be added to any library.
	ResponseType *string `json:"responseType,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Library

func (*Library) String ¶

func (o *Library) String() string

String returns a JSON representation of the model

type Libraryentitylisting ¶

type Libraryentitylisting struct {
	// Entities
	Entities *[]Library `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Libraryentitylisting

func (*Libraryentitylisting) String ¶

func (o *Libraryentitylisting) String() string

String returns a JSON representation of the model

type LicenseApi ¶

type LicenseApi struct {
	Configuration *Configuration
}

LicenseApi provides functions for API endpoints

func NewLicenseApi ¶

func NewLicenseApi() *LicenseApi

NewLicenseApi creates an API instance using the default configuration

func NewLicenseApiWithConfig ¶

func NewLicenseApiWithConfig(config *Configuration) *LicenseApi

NewLicenseApiWithConfig creates an API instance using the provided configuration

func (LicenseApi) GetLicenseDefinition ¶

func (a LicenseApi) GetLicenseDefinition(licenseId string) (*Licensedefinition, *APIResponse, error)

GetLicenseDefinition invokes GET /api/v2/license/definitions/{licenseId}

Get PureCloud license definition.

func (LicenseApi) GetLicenseDefinitions ¶

func (a LicenseApi) GetLicenseDefinitions() ([]Licensedefinition, *APIResponse, error)

GetLicenseDefinitions invokes GET /api/v2/license/definitions

Get all PureCloud license definitions available for the organization.

func (LicenseApi) GetLicenseToggle ¶

func (a LicenseApi) GetLicenseToggle(featureName string) (*Licenseorgtoggle, *APIResponse, error)

GetLicenseToggle invokes GET /api/v2/license/toggles/{featureName}

Get PureCloud license feature toggle value.

func (LicenseApi) GetLicenseUser ¶

func (a LicenseApi) GetLicenseUser(userId string) (*Licenseuser, *APIResponse, error)

GetLicenseUser invokes GET /api/v2/license/users/{userId}

Get licenses for specified user.

func (LicenseApi) GetLicenseUsers ¶

func (a LicenseApi) GetLicenseUsers(pageSize int, pageNumber int) (*Userlicensesentitylisting, *APIResponse, error)

GetLicenseUsers invokes GET /api/v2/license/users

Get a page of users and their licenses ¶

Retrieve a page of users in an organization along with the licenses they possess.

func (LicenseApi) PostLicenseInfer ¶

func (a LicenseApi) PostLicenseInfer(body []string) ([]string, *APIResponse, error)

PostLicenseInfer invokes POST /api/v2/license/infer

Get a list of licenses inferred based on a list of roleIds

func (LicenseApi) PostLicenseOrganization ¶

func (a LicenseApi) PostLicenseOrganization(body Licensebatchassignmentrequest) ([]Licenseupdatestatus, *APIResponse, error)

PostLicenseOrganization invokes POST /api/v2/license/organization

Update the organization&#39;s license assignments in a batch.

func (LicenseApi) PostLicenseToggle ¶

func (a LicenseApi) PostLicenseToggle(featureName string) (*Licenseorgtoggle, *APIResponse, error)

PostLicenseToggle invokes POST /api/v2/license/toggles/{featureName}

Switch PureCloud license feature toggle value.

func (LicenseApi) PostLicenseUsers ¶

func (a LicenseApi) PostLicenseUsers(body []string) (*map[string]interface{}, *APIResponse, error)

PostLicenseUsers invokes POST /api/v2/license/users

Fetch user licenses in a batch.

type Licenseassignmentrequest ¶

type Licenseassignmentrequest struct {
	// LicenseId - The id of the license to assign/unassign.
	LicenseId *string `json:"licenseId,omitempty"`

	// UserIdsAdd - The ids of users to assign this license to.
	UserIdsAdd *[]string `json:"userIdsAdd,omitempty"`

	// UserIdsRemove - The ids of users to unassign this license from.
	UserIdsRemove *[]string `json:"userIdsRemove,omitempty"`
}

Licenseassignmentrequest

func (*Licenseassignmentrequest) String ¶

func (o *Licenseassignmentrequest) String() string

String returns a JSON representation of the model

type Licensebatchassignmentrequest ¶

type Licensebatchassignmentrequest struct {
	// Assignments - The list of license assignment updates to make.
	Assignments *[]Licenseassignmentrequest `json:"assignments,omitempty"`
}

Licensebatchassignmentrequest

func (*Licensebatchassignmentrequest) String ¶

String returns a JSON representation of the model

type Licensedefinition ¶

type Licensedefinition struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Permissions
	Permissions *Permissions `json:"permissions,omitempty"`

	// Prerequisites
	Prerequisites *[]Addressablelicensedefinition `json:"prerequisites,omitempty"`

	// Comprises
	Comprises *[]Licensedefinition `json:"comprises,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Licensedefinition

func (*Licensedefinition) String ¶

func (o *Licensedefinition) String() string

String returns a JSON representation of the model

type Licenseorgtoggle ¶

type Licenseorgtoggle struct {
	// FeatureName
	FeatureName *string `json:"featureName,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`
}

Licenseorgtoggle

func (*Licenseorgtoggle) String ¶

func (o *Licenseorgtoggle) String() string

String returns a JSON representation of the model

type Licenseupdatestatus ¶

type Licenseupdatestatus struct {
	// UserId
	UserId *string `json:"userId,omitempty"`

	// LicenseId
	LicenseId *string `json:"licenseId,omitempty"`

	// Result
	Result *string `json:"result,omitempty"`
}

Licenseupdatestatus

func (*Licenseupdatestatus) String ¶

func (o *Licenseupdatestatus) String() string

String returns a JSON representation of the model

type Licenseuser ¶

type Licenseuser struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Licenses
	Licenses *[]Licensedefinition `json:"licenses,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Licenseuser

func (*Licenseuser) String ¶

func (o *Licenseuser) String() string

String returns a JSON representation of the model

type Limit ¶

type Limit struct {
	// Key - The limit key
	Key *string `json:"key,omitempty"`

	// Value - The limit value
	Value *float64 `json:"value,omitempty"`
}

Limit

func (*Limit) String ¶

func (o *Limit) String() string

String returns a JSON representation of the model

type Limitchangerequestdetails ¶

type Limitchangerequestdetails struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Key - Limit key to be overridden (see https://developer.mypurecloud.com/api/rest/v2/organization/limits.html#available_limits)
	Key *string `json:"key,omitempty"`

	// Namespace - Namespace the key belongs to (see https://developer.mypurecloud.com/api/rest/v2/organization/limits.html#available_limits)
	Namespace *string `json:"namespace,omitempty"`

	// RequestedValue - Requested limit value for a given key
	RequestedValue *float64 `json:"requestedValue,omitempty"`

	// Description - Description of the need for the limit change request
	Description *string `json:"description,omitempty"`

	// SupportCaseUrl - The support case url created by Care
	SupportCaseUrl *string `json:"supportCaseUrl,omitempty"`

	// CreatedBy - The user who created the change request
	CreatedBy *string `json:"createdBy,omitempty"`

	// Status - Current status of the limit change request
	Status *string `json:"status,omitempty"`

	// CurrentValue - Current limit value for a given key
	CurrentValue *float64 `json:"currentValue,omitempty"`

	// DateCreated - The date of the limit change request creation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// StatusHistory - List of statuses that a limit change request has gone through
	StatusHistory *[]Statuschange `json:"statusHistory,omitempty"`

	// DateCompleted - The date of the limit change request completion (ChangeImplemented, Rejected, or RollbackImplemented. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCompleted *time.Time `json:"dateCompleted,omitempty"`

	// LastChangedBy - The user who last updated the status of the limit change request
	LastChangedBy *string `json:"lastChangedBy,omitempty"`

	// RejectReason - The reason for rejecting the limit override request
	RejectReason *string `json:"rejectReason,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Limitchangerequestdetails

func (*Limitchangerequestdetails) String ¶

func (o *Limitchangerequestdetails) String() string

String returns a JSON representation of the model

type Limitchangerequestsentitylisting ¶

type Limitchangerequestsentitylisting struct {
	// Entities
	Entities *[]Limitchangerequestdetails `json:"entities,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`
}

Limitchangerequestsentitylisting

func (*Limitchangerequestsentitylisting) String ¶

String returns a JSON representation of the model

type Limitsentitylisting ¶

type Limitsentitylisting struct {
	// Entities
	Entities *[]Limit `json:"entities,omitempty"`
}

Limitsentitylisting

func (*Limitsentitylisting) String ¶

func (o *Limitsentitylisting) String() string

String returns a JSON representation of the model

type Line ¶

type Line struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// Properties
	Properties *map[string]interface{} `json:"properties,omitempty"`

	// EdgeGroup
	EdgeGroup *Domainentityref `json:"edgeGroup,omitempty"`

	// Template
	Template *Domainentityref `json:"template,omitempty"`

	// Site
	Site *Domainentityref `json:"site,omitempty"`

	// LineBaseSettings
	LineBaseSettings *Domainentityref `json:"lineBaseSettings,omitempty"`

	// PrimaryEdge - The primary edge associated to the line. (Deprecated)
	PrimaryEdge *Edge `json:"primaryEdge,omitempty"`

	// SecondaryEdge - The secondary edge associated to the line. (Deprecated)
	SecondaryEdge *Edge `json:"secondaryEdge,omitempty"`

	// LoggedInUser
	LoggedInUser *Domainentityref `json:"loggedInUser,omitempty"`

	// DefaultForUser
	DefaultForUser *Domainentityref `json:"defaultForUser,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Line

func (*Line) String ¶

func (o *Line) String() string

String returns a JSON representation of the model

type Linebase ¶

type Linebase struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// LineMetaBase
	LineMetaBase *Domainentityref `json:"lineMetaBase,omitempty"`

	// Properties
	Properties *map[string]interface{} `json:"properties,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Linebase

func (*Linebase) String ¶

func (o *Linebase) String() string

String returns a JSON representation of the model

type Linebaseentitylisting ¶

type Linebaseentitylisting struct {
	// Entities
	Entities *[]Linebase `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Linebaseentitylisting

func (*Linebaseentitylisting) String ¶

func (o *Linebaseentitylisting) String() string

String returns a JSON representation of the model

type Lineentitylisting ¶

type Lineentitylisting struct {
	// Entities
	Entities *[]Line `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Lineentitylisting

func (*Lineentitylisting) String ¶

func (o *Lineentitylisting) String() string

String returns a JSON representation of the model

type Lineid ¶

type Lineid struct {
	// Ids - The set of Line userIds that this person has. Each userId is specific to the Line channel that the user interacts with.
	Ids *[]Lineuserid `json:"ids,omitempty"`

	// DisplayName - The displayName of this person's account in Line
	DisplayName *string `json:"displayName,omitempty"`
}

Lineid - User information for a Line account

func (*Lineid) String ¶

func (o *Lineid) String() string

String returns a JSON representation of the model

type Lineintegration ¶

type Lineintegration struct {
	// Id - A unique Integration Id
	Id *string `json:"id,omitempty"`

	// Name - The name of the LINE Integration
	Name *string `json:"name,omitempty"`

	// ChannelId - The Channel Id from LINE messenger
	ChannelId *string `json:"channelId,omitempty"`

	// WebhookUri - The Webhook URI to be updated in LINE platform
	WebhookUri *string `json:"webhookUri,omitempty"`

	// Status - The status of the LINE Integration
	Status *string `json:"status,omitempty"`

	// Recipient - The recipient associated to the Line Integration. This recipient is used to associate a flow to an integration
	Recipient *Domainentityref `json:"recipient,omitempty"`

	// DateCreated - Date this Integration 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"`

	// DateModified - Date this Integration was 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"`

	// CreatedBy - User reference that created this Integration
	CreatedBy *Domainentityref `json:"createdBy,omitempty"`

	// ModifiedBy - User reference that last modified this Integration
	ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"`

	// Version - Version number required for updates.
	Version *int `json:"version,omitempty"`

	// CreateStatus - Status of asynchronous create operation
	CreateStatus *string `json:"createStatus,omitempty"`

	// CreateError - Error information returned, if createStatus is set to Error
	CreateError *Errorbody `json:"createError,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Lineintegration

func (*Lineintegration) String ¶

func (o *Lineintegration) String() string

String returns a JSON representation of the model

type Lineintegrationentitylisting ¶

type Lineintegrationentitylisting struct {
	// Entities
	Entities *[]Lineintegration `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Lineintegrationentitylisting

func (*Lineintegrationentitylisting) String ¶

String returns a JSON representation of the model

type Lineintegrationrequest ¶

type Lineintegrationrequest struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the LINE Integration
	Name *string `json:"name,omitempty"`

	// ChannelId - The Channel Id from LINE messenger. New Official LINE account: To create a new official account, LINE requires a Webhook URL. It can be created without specifying Channel Id & Channel Secret. Once the Official account is created by LINE, use the update LINE Integration API to update Channel Id and Channel Secret.  All other accounts: Channel Id is mandatory. (NOTE: ChannelId can only be updated if the integration is set to inactive)
	ChannelId *string `json:"channelId,omitempty"`

	// ChannelSecret - The Channel Secret from LINE messenger. New Official LINE account: To create a new official account, LINE requires a Webhook URL. It can be created without specifying Channel Id & Channel Secret. Once the Official account is created by LINE, use the update LINE Integration API to update Channel Id and Channel Secret.  All other accounts: Channel Secret is mandatory. (NOTE: ChannelSecret can only be updated if the integration is set to inactive)
	ChannelSecret *string `json:"channelSecret,omitempty"`

	// SwitcherSecret - The Switcher Secret from LINE messenger. Some line official accounts are switcher functionality enabled. If the LINE account used for this integration is switcher enabled, then switcher secret is a required field. This secret can be found in your create documentation provided by LINE
	SwitcherSecret *string `json:"switcherSecret,omitempty"`

	// ServiceCode - The Service Code from LINE messenger. Only applicable to LINE Enterprise accounts. This service code can be found in your create documentation provided by LINE
	ServiceCode *string `json:"serviceCode,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Lineintegrationrequest

func (*Lineintegrationrequest) String ¶

func (o *Lineintegrationrequest) String() string

String returns a JSON representation of the model

type Linestatus ¶

type Linestatus struct {
	// Id - The id of this line
	Id *string `json:"id,omitempty"`

	// Reachable - Indicates whether the edge can reach the line.
	Reachable *bool `json:"reachable,omitempty"`

	// AddressOfRecord - The line's address of record.
	AddressOfRecord *string `json:"addressOfRecord,omitempty"`

	// ContactAddresses - The addresses used to contact the line.
	ContactAddresses *[]string `json:"contactAddresses,omitempty"`

	// ReachableStateTime - The time the line entered its current reachable state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ReachableStateTime *time.Time `json:"reachableStateTime,omitempty"`
}

Linestatus

func (*Linestatus) String ¶

func (o *Linestatus) String() string

String returns a JSON representation of the model

type Lineuserid ¶

type Lineuserid struct {
	// UserId - The unique channel-specific userId for the user
	UserId *string `json:"userId,omitempty"`
}

Lineuserid - Channel-specific User ID for Line accounts

func (*Lineuserid) String ¶

func (o *Lineuserid) String() string

String returns a JSON representation of the model

type Listedprogram ¶

type Listedprogram 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"`

	// Published
	Published *bool `json:"published,omitempty"`

	// TopicsCount
	TopicsCount *int `json:"topicsCount,omitempty"`

	// Tags
	Tags *[]string `json:"tags,omitempty"`

	// ModifiedBy
	ModifiedBy *Addressableentityref `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"`
}

Listedprogram

func (*Listedprogram) String ¶

func (o *Listedprogram) String() string

String returns a JSON representation of the model

type Listedtopic ¶

type Listedtopic 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"`

	// Published
	Published *bool `json:"published,omitempty"`

	// Strictness
	Strictness *string `json:"strictness,omitempty"`

	// ProgramsCount
	ProgramsCount *int `json:"programsCount,omitempty"`

	// Tags
	Tags *[]string `json:"tags,omitempty"`

	// Dialect
	Dialect *string `json:"dialect,omitempty"`

	// Participants
	Participants *string `json:"participants,omitempty"`

	// PhrasesCount
	PhrasesCount *int `json:"phrasesCount,omitempty"`

	// ModifiedBy
	ModifiedBy *Addressableentityref `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"`
}

Listedtopic

func (*Listedtopic) String ¶

func (o *Listedtopic) String() string

String returns a JSON representation of the model

type Listitemcomponent ¶

type Listitemcomponent struct {
	// Id - An ID assigned to this list item.
	Id *string `json:"id,omitempty"`

	// Rmid - An ID of the rich message instance.
	Rmid *string `json:"rmid,omitempty"`

	// VarType - The type of list item to render.
	VarType *string `json:"type,omitempty"`

	// Image - URL of an image.
	Image *string `json:"image,omitempty"`

	// Title - The main headline of the list item.
	Title *string `json:"title,omitempty"`

	// Description - Text to show in the list item description.
	Description *string `json:"description,omitempty"`

	// Actions - The list item actions.
	Actions *Contentactions `json:"actions,omitempty"`
}

Listitemcomponent - An entry in a List template.

func (*Listitemcomponent) String ¶

func (o *Listitemcomponent) String() string

String returns a JSON representation of the model

type Listwrapperinterval ¶

type Listwrapperinterval struct {
	// Values
	Values *[]string `json:"values,omitempty"`
}

Listwrapperinterval

func (*Listwrapperinterval) String ¶

func (o *Listwrapperinterval) String() string

String returns a JSON representation of the model

type Listwrappershiftstartvariance ¶

type Listwrappershiftstartvariance struct {
	// Values
	Values *[]Shiftstartvariance `json:"values,omitempty"`
}

Listwrappershiftstartvariance

func (*Listwrappershiftstartvariance) String ¶

String returns a JSON representation of the model

type Localencryptionconfiguration ¶

type Localencryptionconfiguration struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Url - The url for decryption. This must specify the path to where Purecloud can requests decryption
	Url *string `json:"url,omitempty"`

	// ApiId - The api id for Hawk Authentication.
	ApiId *string `json:"apiId,omitempty"`

	// ApiKey - The api shared symmetric key used for hawk authentication
	ApiKey *string `json:"apiKey,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Localencryptionconfiguration

func (*Localencryptionconfiguration) String ¶

String returns a JSON representation of the model

type Localencryptionconfigurationlisting ¶

type Localencryptionconfigurationlisting struct {
	// Total
	Total *int `json:"total,omitempty"`

	// Entities
	Entities *[]Localencryptionconfiguration `json:"entities,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`
}

Localencryptionconfigurationlisting

func (*Localencryptionconfigurationlisting) String ¶

String returns a JSON representation of the model

type Localencryptionkeyrequest ¶

type Localencryptionkeyrequest struct {
	// ConfigId - The local configuration id that contains metadata on private local service
	ConfigId *string `json:"configId,omitempty"`

	// PublicKey - Base 64 encoded public key, generated by the local service.
	PublicKey *string `json:"publicKey,omitempty"`

	// KeypairId - The key pair id from the local service.
	KeypairId *string `json:"keypairId,omitempty"`
}

Localencryptionkeyrequest

func (*Localencryptionkeyrequest) String ¶

func (o *Localencryptionkeyrequest) String() string

String returns a JSON representation of the model

type Location ¶

type Location struct {
	// Id - Unique identifier for the location
	Id *string `json:"id,omitempty"`

	// FloorplanId - Unique identifier for the location floorplan image
	FloorplanId *string `json:"floorplanId,omitempty"`

	// Coordinates - Users coordinates on the floorplan. Only used when floorplanImage is set
	Coordinates *map[string]float64 `json:"coordinates,omitempty"`

	// Notes - Optional description on the users location
	Notes *string `json:"notes,omitempty"`

	// LocationDefinition
	LocationDefinition *Locationdefinition `json:"locationDefinition,omitempty"`
}

Location

func (*Location) String ¶

func (o *Location) String() string

String returns a JSON representation of the model

type Locationaddress ¶

type Locationaddress struct {
	// City
	City *string `json:"city,omitempty"`

	// Country
	Country *string `json:"country,omitempty"`

	// CountryName
	CountryName *string `json:"countryName,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Street1
	Street1 *string `json:"street1,omitempty"`

	// Street2
	Street2 *string `json:"street2,omitempty"`

	// Zipcode
	Zipcode *string `json:"zipcode,omitempty"`
}

Locationaddress

func (*Locationaddress) String ¶

func (o *Locationaddress) String() string

String returns a JSON representation of the model

type Locationaddressverificationdetails ¶

type Locationaddressverificationdetails struct {
	// Status - Status of address verification process
	Status *string `json:"status,omitempty"`

	// DateFinished - Finished time of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateFinished *time.Time `json:"dateFinished,omitempty"`

	// DateStarted - Time started of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateStarted *time.Time `json:"dateStarted,omitempty"`

	// Service - Third party service used for address verification
	Service *string `json:"service,omitempty"`
}

Locationaddressverificationdetails

func (*Locationaddressverificationdetails) String ¶

String returns a JSON representation of the model

type Locationcreatedefinition ¶

type Locationcreatedefinition struct {
	// Name - The name of the Location. Required for creates, not required for updates
	Name *string `json:"name,omitempty"`

	// Version - Current version of the location
	Version *int `json:"version,omitempty"`

	// State - Current activity status of the location.
	State *string `json:"state,omitempty"`

	// Path - A list of ancestor ids
	Path *[]string `json:"path,omitempty"`

	// Notes - Notes for the location
	Notes *string `json:"notes,omitempty"`

	// ContactUser - The user id of the location contact
	ContactUser *string `json:"contactUser,omitempty"`

	// EmergencyNumber - Emergency number for the location
	EmergencyNumber *Locationemergencynumber `json:"emergencyNumber,omitempty"`

	// Address - Address of the location
	Address *Locationaddress `json:"address,omitempty"`
}

Locationcreatedefinition

func (*Locationcreatedefinition) String ¶

func (o *Locationcreatedefinition) String() string

String returns a JSON representation of the model

type Locationdefinition ¶

type Locationdefinition struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ContactUser - Site contact for the location entity
	ContactUser *Addressableentityref `json:"contactUser,omitempty"`

	// EmergencyNumber - Emergency number for the location entity
	EmergencyNumber *Locationemergencynumber `json:"emergencyNumber,omitempty"`

	// Address
	Address *Locationaddress `json:"address,omitempty"`

	// State - Current state of the location entity
	State *string `json:"state,omitempty"`

	// Notes - Notes for the location entity
	Notes *string `json:"notes,omitempty"`

	// Version - Current version of the location entity, value to be supplied should be retrieved by a GET or on create/update response
	Version *int `json:"version,omitempty"`

	// Path - A list of ancestor IDs in order
	Path *[]string `json:"path,omitempty"`

	// ProfileImage - Profile image of the location entity, retrieved with ?expand=images query parameter
	ProfileImage *[]Locationimage `json:"profileImage,omitempty"`

	// FloorplanImage - Floorplan images of the location entity, retrieved with ?expand=images query parameter
	FloorplanImage *[]Locationimage `json:"floorplanImage,omitempty"`

	// AddressVerificationDetails - Address verification information, retrieve dwith the ?expand=addressVerificationDetails query parameter
	AddressVerificationDetails *Locationaddressverificationdetails `json:"addressVerificationDetails,omitempty"`

	// AddressVerified - Boolean field which states if the address has been verified as an actual address
	AddressVerified *bool `json:"addressVerified,omitempty"`

	// AddressStored - Boolean field which states if the address has been stored for E911
	AddressStored *bool `json:"addressStored,omitempty"`

	// Images
	Images *string `json:"images,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Locationdefinition

func (*Locationdefinition) String ¶

func (o *Locationdefinition) String() string

String returns a JSON representation of the model

type Locationemergencynumber ¶

type Locationemergencynumber struct {
	// E164
	E164 *string `json:"e164,omitempty"`

	// Number
	Number *string `json:"number,omitempty"`

	// VarType - The type of emergency number.
	VarType *string `json:"type,omitempty"`
}

Locationemergencynumber

func (*Locationemergencynumber) String ¶

func (o *Locationemergencynumber) String() string

String returns a JSON representation of the model

type Locationentitylisting ¶

type Locationentitylisting struct {
	// Entities
	Entities *[]Locationdefinition `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Locationentitylisting

func (*Locationentitylisting) String ¶

func (o *Locationentitylisting) String() string

String returns a JSON representation of the model

type Locationimage ¶

type Locationimage struct {
	// Resolution - Height and/or width of image. ex: 640x480 or x128
	Resolution *string `json:"resolution,omitempty"`

	// ImageUri
	ImageUri *string `json:"imageUri,omitempty"`
}

Locationimage

func (*Locationimage) String ¶

func (o *Locationimage) String() string

String returns a JSON representation of the model

type LocationsApi ¶

type LocationsApi struct {
	Configuration *Configuration
}

LocationsApi provides functions for API endpoints

func NewLocationsApi ¶

func NewLocationsApi() *LocationsApi

NewLocationsApi creates an API instance using the default configuration

func NewLocationsApiWithConfig ¶

func NewLocationsApiWithConfig(config *Configuration) *LocationsApi

NewLocationsApiWithConfig creates an API instance using the provided configuration

func (LocationsApi) DeleteLocation ¶

func (a LocationsApi) DeleteLocation(locationId string) (*APIResponse, error)

DeleteLocation invokes DELETE /api/v2/locations/{locationId}

Delete a location

func (LocationsApi) GetLocation ¶

func (a LocationsApi) GetLocation(locationId string, expand []string) (*Locationdefinition, *APIResponse, error)

GetLocation invokes GET /api/v2/locations/{locationId}

Get Location by ID.

func (LocationsApi) GetLocationSublocations ¶

func (a LocationsApi) GetLocationSublocations(locationId string) (*Locationentitylisting, *APIResponse, error)

GetLocationSublocations invokes GET /api/v2/locations/{locationId}/sublocations

Get sublocations for location ID.

func (LocationsApi) GetLocations ¶

func (a LocationsApi) GetLocations(pageSize int, pageNumber int, id []string, sortOrder string) (*Locationentitylisting, *APIResponse, error)

GetLocations invokes GET /api/v2/locations

Get a list of all locations.

func (LocationsApi) GetLocationsSearch ¶

func (a LocationsApi) GetLocationsSearch(q64 string, expand []string) (*Locationssearchresponse, *APIResponse, error)

GetLocationsSearch invokes GET /api/v2/locations/search

Search locations using the q64 value returned from a previous search

func (LocationsApi) PatchLocation ¶

func (a LocationsApi) PatchLocation(locationId string, body Locationupdatedefinition) (*Locationdefinition, *APIResponse, error)

PatchLocation invokes PATCH /api/v2/locations/{locationId}

Update a location

func (LocationsApi) PostLocations ¶

PostLocations invokes POST /api/v2/locations

Create a location

func (LocationsApi) PostLocationsSearch ¶

PostLocationsSearch invokes POST /api/v2/locations/search

Search locations

type Locationsearchcriteria ¶

type Locationsearchcriteria struct {
	// EndValue - The end value of the range. This field is used for range search types.
	EndValue *string `json:"endValue,omitempty"`

	// Values - A list of values for the search to match against
	Values *[]string `json:"values,omitempty"`

	// StartValue - The start value of the range. This field is used for range search types.
	StartValue *string `json:"startValue,omitempty"`

	// Fields - Field names to search against
	Fields *[]string `json:"fields,omitempty"`

	// Value - A value for the search to match against
	Value *string `json:"value,omitempty"`

	// Operator - How to apply this search criteria against other criteria
	Operator *string `json:"operator,omitempty"`

	// Group - Groups multiple conditions
	Group *[]Locationsearchcriteria `json:"group,omitempty"`

	// DateFormat - Set date format for criteria values when using date range search type.  Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX.
	DateFormat *string `json:"dateFormat,omitempty"`

	// VarType - Search Type
	VarType *string `json:"type,omitempty"`
}

Locationsearchcriteria

func (*Locationsearchcriteria) String ¶

func (o *Locationsearchcriteria) String() string

String returns a JSON representation of the model

type Locationsearchrequest ¶

type Locationsearchrequest struct {
	// SortOrder - The sort order for results
	SortOrder *string `json:"sortOrder,omitempty"`

	// SortBy - The field in the resource that you want to sort the results by
	SortBy *string `json:"sortBy,omitempty"`

	// PageSize - The number of results per page
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The page of resources you want to retrieve
	PageNumber *int `json:"pageNumber,omitempty"`

	// Sort - Multi-value sort order, list of multiple sort values
	Sort *[]Searchsort `json:"sort,omitempty"`

	// Expand - Provides more details about a specified resource
	Expand *[]string `json:"expand,omitempty"`

	// Query
	Query *[]Locationsearchcriteria `json:"query,omitempty"`
}

Locationsearchrequest

func (*Locationsearchrequest) String ¶

func (o *Locationsearchrequest) String() string

String returns a JSON representation of the model

type Locationssearchresponse ¶

type Locationssearchresponse struct {
	// Total - The total number of results found
	Total *int `json:"total,omitempty"`

	// PageCount - The total number of pages
	PageCount *int `json:"pageCount,omitempty"`

	// PageSize - The current page size
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The current page number
	PageNumber *int `json:"pageNumber,omitempty"`

	// PreviousPage - Q64 value for the previous page of results
	PreviousPage *string `json:"previousPage,omitempty"`

	// CurrentPage - Q64 value for the current page of results
	CurrentPage *string `json:"currentPage,omitempty"`

	// NextPage - Q64 value for the next page of results
	NextPage *string `json:"nextPage,omitempty"`

	// Types - Resource types the search was performed against
	Types *[]string `json:"types,omitempty"`

	// Results - Search results
	Results *[]Locationdefinition `json:"results,omitempty"`
}

Locationssearchresponse

func (*Locationssearchresponse) String ¶

func (o *Locationssearchresponse) String() string

String returns a JSON representation of the model

type Locationupdatedefinition ¶

type Locationupdatedefinition struct {
	// Name - The name of the Location. Required for creates, not required for updates
	Name *string `json:"name,omitempty"`

	// Version - Current version of the location
	Version *int `json:"version,omitempty"`

	// State - Current activity status of the location.
	State *string `json:"state,omitempty"`

	// Path - A list of ancestor ids
	Path *[]string `json:"path,omitempty"`

	// Notes - Notes for the location
	Notes *string `json:"notes,omitempty"`

	// ContactUser - The user id of the location contact
	ContactUser *string `json:"contactUser,omitempty"`

	// EmergencyNumber - Emergency number for the location
	EmergencyNumber *Locationemergencynumber `json:"emergencyNumber,omitempty"`

	// Address - Address of the location
	Address *Locationaddress `json:"address,omitempty"`
}

Locationupdatedefinition

func (*Locationupdatedefinition) String ¶

func (o *Locationupdatedefinition) String() string

String returns a JSON representation of the model

type Lockinfo ¶

type Lockinfo struct {
	// LockedBy
	LockedBy *Domainentityref `json:"lockedBy,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"`

	// DateExpires - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateExpires *time.Time `json:"dateExpires,omitempty"`

	// Action
	Action *string `json:"action,omitempty"`
}

Lockinfo

func (*Lockinfo) String ¶

func (o *Lockinfo) String() string

String returns a JSON representation of the model

type Logcaptureuserconfiguration ¶

type Logcaptureuserconfiguration struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// DateExpired - Indicates when log capture will be turned off for the user. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateExpired *time.Time `json:"dateExpired,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Logcaptureuserconfiguration

func (*Logcaptureuserconfiguration) String ¶

func (o *Logcaptureuserconfiguration) String() string

String returns a JSON representation of the model

type LoggingConfiguration ¶

type LoggingConfiguration struct {
	LogLevel        LoggingLevel `json:"logLevel,omitempty"`
	LogRequestBody  bool         `json:"logRequestBody,omitempty"`
	LogResponseBody bool         `json:"logResponseBody,omitempty"`
	// contains filtered or unexported fields
}

LoggingConfiguration has settings to configure the SDK logging

func (*LoggingConfiguration) GetLogFilePath ¶

func (c *LoggingConfiguration) GetLogFilePath() string

func (*LoggingConfiguration) GetLogFormat ¶

func (c *LoggingConfiguration) GetLogFormat() LoggingFormat

func (*LoggingConfiguration) GetLogToConsole ¶

func (c *LoggingConfiguration) GetLogToConsole() bool

func (*LoggingConfiguration) SetLogFilePath ¶

func (c *LoggingConfiguration) SetLogFilePath(logFilePath string)

func (*LoggingConfiguration) SetLogFormat ¶

func (c *LoggingConfiguration) SetLogFormat(logFormat LoggingFormat)

func (*LoggingConfiguration) SetLogToConsole ¶

func (c *LoggingConfiguration) SetLogToConsole(logToConsole bool)

type LoggingFormat ¶

type LoggingFormat int
const (
	JSON LoggingFormat = iota
	Text
)

type LoggingLevel ¶

type LoggingLevel int
const (
	LTrace LoggingLevel = iota
	LDebug
	LError
	LNone
)

type Logicalinterfaceentitylisting ¶

type Logicalinterfaceentitylisting struct {
	// Entities
	Entities *[]Domainlogicalinterface `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Logicalinterfaceentitylisting

func (*Logicalinterfaceentitylisting) String ¶

String returns a JSON representation of the model

type Longtermforecastplanninggroupdata ¶

type Longtermforecastplanninggroupdata struct {
	// PlanningGroupId - The ID of the planning group to which this data applies. Note this is a snapshot of the planning group at the time of forecast creation and may not correspond to the current configuration
	PlanningGroupId *string `json:"planningGroupId,omitempty"`

	// OfferedPerDay - Forecast offered counts per day for this planning group
	OfferedPerDay *[]float64 `json:"offeredPerDay,omitempty"`

	// AverageHandleTimeSecondsPerDay - Forecast average handle time per day in seconds
	AverageHandleTimeSecondsPerDay *[]float64 `json:"averageHandleTimeSecondsPerDay,omitempty"`
}

Longtermforecastplanninggroupdata

func (*Longtermforecastplanninggroupdata) String ¶

String returns a JSON representation of the model

type Longtermforecastresult ¶

type Longtermforecastresult struct {
	// PlanningGroups - The forecast data broken up by planning group
	PlanningGroups *[]Longtermforecastplanninggroupdata `json:"planningGroups,omitempty"`

	// ReferenceStartDate - The reference start date relative to the business unit time zone in this forecast. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"`

	// WeekCount - The number of weeks in this forecast
	WeekCount *int `json:"weekCount,omitempty"`
}

Longtermforecastresult

func (*Longtermforecastresult) String ¶

func (o *Longtermforecastresult) String() string

String returns a JSON representation of the model

type Longtermforecastresultresponse ¶

type Longtermforecastresultresponse struct {
	// Result - The result of the operation.  Populated whenever the result is small enough to pass through the api directly
	Result *Longtermforecastresult `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"`
}

Longtermforecastresultresponse

func (*Longtermforecastresultresponse) String ¶

String returns a JSON representation of the model

type Mailfromresult ¶

type Mailfromresult struct {
	// Status - The verification status.
	Status *string `json:"status,omitempty"`

	// Records - The list of DNS records that pertain that need to exist for verification.
	Records *[]Record `json:"records,omitempty"`

	// MailFromDomain - The custom MAIL FROM domain.
	MailFromDomain *string `json:"mailFromDomain,omitempty"`
}

Mailfromresult

func (*Mailfromresult) String ¶

func (o *Mailfromresult) String() string

String returns a JSON representation of the model

type Managementunit ¶

type Managementunit struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// BusinessUnit - The business unit to which this management unit belongs
	BusinessUnit *Businessunitreference `json:"businessUnit,omitempty"`

	// StartDayOfWeek - Start day of week for scheduling and forecasting purposes. Moving to Business Unit
	StartDayOfWeek *string `json:"startDayOfWeek,omitempty"`

	// TimeZone - The time zone for the management unit in standard Olson format.  Moving to Business Unit
	TimeZone *string `json:"timeZone,omitempty"`

	// Settings - The configuration settings for this management unit
	Settings *Managementunitsettingsresponse `json:"settings,omitempty"`

	// Metadata - Version info metadata for this management unit. Deprecated, use settings.metadata
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Divisionreference `json:"division,omitempty"`

	// Version - The version of the underlying entity.  Deprecated, use field from settings.metadata instead
	Version *int `json:"version,omitempty"`

	// DateModified - The date and time at which this entity was last modified.  Deprecated, use field from settings.metadata instead. 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 who last modified this entity.  Deprecated, use field from settings.metadata instead
	ModifiedBy *Userreference `json:"modifiedBy,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Managementunit - Management Unit object for Workforce Management

func (*Managementunit) String ¶

func (o *Managementunit) String() string

String returns a JSON representation of the model

type Managementunitlisting ¶

type Managementunitlisting struct {
	// Entities
	Entities *[]Managementunit `json:"entities,omitempty"`

	// PageSize - Deprecated, paging is not supported
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - Deprecated, paging is not supported
	PageNumber *int `json:"pageNumber,omitempty"`

	// Total - Deprecated, paging is not supported
	Total *int `json:"total,omitempty"`

	// FirstUri - Deprecated, paging is not supported
	FirstUri *string `json:"firstUri,omitempty"`

	// NextUri - Deprecated, paging is not supported
	NextUri *string `json:"nextUri,omitempty"`

	// PageCount - Deprecated, paging is not supported
	PageCount *int `json:"pageCount,omitempty"`

	// PreviousUri - Deprecated, paging is not supported
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri - Deprecated, paging is not supported
	LastUri *string `json:"lastUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`
}

Managementunitlisting

func (*Managementunitlisting) String ¶

func (o *Managementunitlisting) String() string

String returns a JSON representation of the model

type Managementunitreference ¶

type Managementunitreference 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"`
}

Managementunitreference - Management unit reference object for Workforce Management (ID/selfUri only)

func (*Managementunitreference) String ¶

func (o *Managementunitreference) String() string

String returns a JSON representation of the model

type Managementunitsettingsrequest ¶

type Managementunitsettingsrequest struct {
	// Adherence - Adherence settings for this management unit
	Adherence *Adherencesettings `json:"adherence,omitempty"`

	// ShortTermForecasting - Short term forecasting settings for this management unit.  Moving to Business Unit
	ShortTermForecasting *Shorttermforecastingsettings `json:"shortTermForecasting,omitempty"`

	// TimeOff - Time off request settings for this management unit
	TimeOff *Timeoffrequestsettings `json:"timeOff,omitempty"`

	// Scheduling - Scheduling settings for this management unit
	Scheduling *Schedulingsettingsrequest `json:"scheduling,omitempty"`

	// ShiftTrading - Shift trade settings for this management unit
	ShiftTrading *Shifttradesettings `json:"shiftTrading,omitempty"`

	// Metadata - Version info metadata for the associated management unit
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Managementunitsettingsrequest - Management Unit Settings

func (*Managementunitsettingsrequest) String ¶

String returns a JSON representation of the model

type Managementunitsettingsresponse ¶

type Managementunitsettingsresponse struct {
	// Adherence - Adherence settings for this management unit
	Adherence *Adherencesettings `json:"adherence,omitempty"`

	// ShortTermForecasting - Short term forecasting settings for this management unit
	ShortTermForecasting *Shorttermforecastingsettings `json:"shortTermForecasting,omitempty"`

	// TimeOff - Time off request settings for this management unit
	TimeOff *Timeoffrequestsettings `json:"timeOff,omitempty"`

	// Scheduling - Scheduling settings for this management unit. These settings are only available if you have the permission wfm:managementUnit:view
	Scheduling *Schedulingsettingsresponse `json:"scheduling,omitempty"`

	// ShiftTrading - Shift trade settings for this management unit
	ShiftTrading *Shifttradesettings `json:"shiftTrading,omitempty"`

	// Metadata - Version info metadata for the associated management unit
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Managementunitsettingsresponse

func (*Managementunitsettingsresponse) String ¶

String returns a JSON representation of the model

type Manager ¶

type Manager struct {
	// Value - The ID of the manager.
	Value *string `json:"value,omitempty"`

	// Ref - The reference URI of the manager's user record.
	Ref *string `json:"$ref,omitempty"`
}

Manager - Defines a SCIM manager.

func (*Manager) String ¶

func (o *Manager) String() string

String returns a JSON representation of the model

type Matchshifttraderequest ¶

type Matchshifttraderequest struct {
	// ReceivingScheduleId - The ID of the schedule with which the shift trade is associated
	ReceivingScheduleId *string `json:"receivingScheduleId,omitempty"`

	// ReceivingShiftId - The ID of the shift the receiving user is giving up in trade, if applicable
	ReceivingShiftId *string `json:"receivingShiftId,omitempty"`

	// Metadata - Version metadata for the shift trade
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Matchshifttraderequest

func (*Matchshifttraderequest) String ¶

func (o *Matchshifttraderequest) String() string

String returns a JSON representation of the model

type Matchshifttraderesponse ¶

type Matchshifttraderesponse struct {
	// Trade - The associated shift trade
	Trade *Shifttraderesponse `json:"trade,omitempty"`

	// Violations - Constraint violations which disallow this shift trade
	Violations *[]Shifttradematchviolation `json:"violations,omitempty"`

	// AdminReviewViolations - Constraint violations for this shift trade which require shift trade administrator review
	AdminReviewViolations *[]Shifttradematchviolation `json:"adminReviewViolations,omitempty"`
}

Matchshifttraderesponse

func (*Matchshifttraderesponse) String ¶

func (o *Matchshifttraderesponse) String() string

String returns a JSON representation of the model

type Maxlength ¶

type Maxlength struct {
	// Min - A non-negative integer for a text-based schema field denoting the minimum largest length string the field can contain for a schema instance.
	Min *int `json:"min,omitempty"`

	// Max - A non-negative integer for a text-based schema field denoting the maximum largest string the field can contain for a schema instance.
	Max *int `json:"max,omitempty"`
}

Maxlength

func (*Maxlength) String ¶

func (o *Maxlength) String() string

String returns a JSON representation of the model

type Maxparticipants ¶

type Maxparticipants struct {
	// MaxParticipants - The maximum number of participants that are allowed on a conversation.
	MaxParticipants *int `json:"maxParticipants,omitempty"`
}

Maxparticipants

func (*Maxparticipants) String ¶

func (o *Maxparticipants) String() string

String returns a JSON representation of the model

type Mediaparticipantrequest ¶

type Mediaparticipantrequest struct {
	// Wrapup - Wrap-up to assign to this participant.
	Wrapup *Wrapup `json:"wrapup,omitempty"`

	// State - The state to update to set for this participant's communications.  Possible values are: 'connected' and 'disconnected'.
	State *string `json:"state,omitempty"`

	// Recording - True to enable recording of this participant, otherwise false to disable recording.
	Recording *bool `json:"recording,omitempty"`

	// Muted - True to mute this conversation participant.
	Muted *bool `json:"muted,omitempty"`

	// Confined - True to confine this conversation participant.  Should only be used for ad-hoc conferences
	Confined *bool `json:"confined,omitempty"`

	// Held - True to hold this conversation participant.
	Held *bool `json:"held,omitempty"`

	// WrapupSkipped - True to skip wrap-up for this participant.
	WrapupSkipped *bool `json:"wrapupSkipped,omitempty"`
}

Mediaparticipantrequest

func (*Mediaparticipantrequest) String ¶

func (o *Mediaparticipantrequest) String() string

String returns a JSON representation of the model

type Mediapolicies ¶

type Mediapolicies struct {
	// CallPolicy - Conditions and actions for calls
	CallPolicy *Callmediapolicy `json:"callPolicy,omitempty"`

	// ChatPolicy - Conditions and actions for chats
	ChatPolicy *Chatmediapolicy `json:"chatPolicy,omitempty"`

	// EmailPolicy - Conditions and actions for emails
	EmailPolicy *Emailmediapolicy `json:"emailPolicy,omitempty"`

	// MessagePolicy - Conditions and actions for messages
	MessagePolicy *Messagemediapolicy `json:"messagePolicy,omitempty"`
}

Mediapolicies

func (*Mediapolicies) String ¶

func (o *Mediapolicies) String() string

String returns a JSON representation of the model

type Mediaresult ¶

type Mediaresult struct {
	// MediaUri
	MediaUri *string `json:"mediaUri,omitempty"`

	// WaveformData
	WaveformData *[]float32 `json:"waveformData,omitempty"`
}

Mediaresult

func (*Mediaresult) String ¶

func (o *Mediaresult) String() string

String returns a JSON representation of the model

type Mediasetting ¶

type Mediasetting struct {
	// AlertingTimeoutSeconds
	AlertingTimeoutSeconds *int `json:"alertingTimeoutSeconds,omitempty"`

	// ServiceLevel
	ServiceLevel *Servicelevel `json:"serviceLevel,omitempty"`
}

Mediasetting

func (*Mediasetting) String ¶

func (o *Mediasetting) String() string

String returns a JSON representation of the model

type Mediasummary ¶

type Mediasummary struct {
	// ContactCenter
	ContactCenter *Mediasummarydetail `json:"contactCenter,omitempty"`

	// Enterprise
	Enterprise *Mediasummarydetail `json:"enterprise,omitempty"`
}

Mediasummary

func (*Mediasummary) String ¶

func (o *Mediasummary) String() string

String returns a JSON representation of the model

type Mediasummarydetail ¶

type Mediasummarydetail struct {
	// Active
	Active *int `json:"active,omitempty"`

	// Acw
	Acw *int `json:"acw,omitempty"`
}

Mediasummarydetail

func (*Mediasummarydetail) String ¶

func (o *Mediasummarydetail) String() string

String returns a JSON representation of the model

type Mediatranscription ¶

type Mediatranscription struct {
	// DisplayName
	DisplayName *string `json:"displayName,omitempty"`

	// TranscriptionProvider
	TranscriptionProvider *string `json:"transcriptionProvider,omitempty"`

	// IntegrationId
	IntegrationId *string `json:"integrationId,omitempty"`
}

Mediatranscription

func (*Mediatranscription) String ¶

func (o *Mediatranscription) String() string

String returns a JSON representation of the model

type Mediatype ¶

type Mediatype struct {
	// VarType - The media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types.
	VarType *string `json:"type,omitempty"`
}

Mediatype - Media type definition

func (*Mediatype) String ¶

func (o *Mediatype) String() string

String returns a JSON representation of the model

type Mediatypeaccess ¶

type Mediatypeaccess struct {
	// Inbound - List of media types allowed for inbound messages from customers. If inbound messages from a customer contain media that is not in this list, the media will be dropped from the outbound message.
	Inbound *[]Mediatype `json:"inbound,omitempty"`

	// Outbound - List of media types allowed for outbound messages to customers. If an outbound message is sent that contains media that is not in this list, the message will not be sent.
	Outbound *[]Mediatype `json:"outbound,omitempty"`
}

Mediatypeaccess - Media type access definitions

func (*Mediatypeaccess) String ¶

func (o *Mediatypeaccess) String() string

String returns a JSON representation of the model

type Mediatypes ¶

type Mediatypes struct {
	// Allow - Specify allowed media types for inbound and outbound messages. If this field is empty, all inbound and outbound media will be blocked.
	Allow *Mediatypeaccess `json:"allow,omitempty"`
}

Mediatypes - Media types

func (*Mediatypes) String ¶

func (o *Mediatypes) String() string

String returns a JSON representation of the model

type Mediautilization ¶

type Mediautilization struct {
	// MaximumCapacity - Defines the maximum number of conversations of this type that an agent can handle at one time.
	MaximumCapacity *int `json:"maximumCapacity,omitempty"`

	// InterruptableMediaTypes - Defines the list of other media types that can interrupt a conversation of this media type.  Values include call, chat, email, callback, and message.
	InterruptableMediaTypes *[]string `json:"interruptableMediaTypes,omitempty"`

	// IncludeNonAcd - If true, then track non-ACD conversations against utilization
	IncludeNonAcd *bool `json:"includeNonAcd,omitempty"`
}

Mediautilization

func (*Mediautilization) String ¶

func (o *Mediautilization) String() string

String returns a JSON representation of the model

type Memberentity ¶

type Memberentity struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Memberentity

func (*Memberentity) String ¶

func (o *Memberentity) String() string

String returns a JSON representation of the model

type Mergeoperation ¶

type Mergeoperation struct {
	// SourceContact - The source contact for the merge operation
	SourceContact *Addressableentityref `json:"sourceContact,omitempty"`

	// TargetContact - The target contact for the merge operation
	TargetContact *Addressableentityref `json:"targetContact,omitempty"`

	// ResultingContact - The contact created as a result of the merge operation
	ResultingContact *Addressableentityref `json:"resultingContact,omitempty"`
}

Mergeoperation

func (*Mergeoperation) String ¶

func (o *Mergeoperation) String() string

String returns a JSON representation of the model

type Message ¶

type Message 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"`

	// Held - True if this call is held and the person on this side hears silence.
	Held *bool `json:"held,omitempty"`

	// Segments - The time line of the participant's message, divided into activity segments.
	Segments *[]Segment `json:"segments,omitempty"`

	// Direction - The direction of the message.
	Direction *string `json:"direction,omitempty"`

	// RecordingId - A globally unique identifier for the recording associated with this message.
	RecordingId *string `json:"recordingId,omitempty"`

	// ErrorInfo
	ErrorInfo *Errorbody `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 message was placed on hold in the cloud clock if the message 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 message.
	Provider *string `json:"provider,omitempty"`

	// VarType - Indicates the type of message platform from which the message originated.
	VarType *string `json:"type,omitempty"`

	// RecipientCountry - Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format.
	RecipientCountry *string `json:"recipientCountry,omitempty"`

	// RecipientType - The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type.
	RecipientType *string `json:"recipientType,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"`

	// ToAddress - Address and name data for a call endpoint.
	ToAddress *Address `json:"toAddress,omitempty"`

	// FromAddress - Address and name data for a call endpoint.
	FromAddress *Address `json:"fromAddress,omitempty"`

	// Messages - The messages sent on this communication channel.
	Messages *[]Messagedetails `json:"messages,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"`
}

Message

func (*Message) String ¶

func (o *Message) String() string

String returns a JSON representation of the model

type Messagecontent ¶

type Messagecontent struct {
	// ContentType - Type of this content element. If contentType = \"Attachment\" only one item is allowed.
	ContentType *string `json:"contentType,omitempty"`

	// Location - Location content.
	Location *Contentlocation `json:"location,omitempty"`

	// Attachment - Attachment content.
	Attachment *Contentattachment `json:"attachment,omitempty"`

	// QuickReply - Quick reply content.
	QuickReply *Contentquickreply `json:"quickReply,omitempty"`

	// ButtonResponse - Button response content.
	ButtonResponse *Contentbuttonresponse `json:"buttonResponse,omitempty"`

	// Generic - Generic content.
	Generic *Contentgeneric `json:"generic,omitempty"`

	// List - List content.
	List *Contentlist `json:"list,omitempty"`

	// Template - Template notification content.
	Template *Contentnotificationtemplate `json:"template,omitempty"`

	// Reactions - A set of reactions to a message.
	Reactions *[]Contentreaction `json:"reactions,omitempty"`

	// Mention - Mention content.
	Mention *Messagingrecipient `json:"mention,omitempty"`

	// Postback - Structured message postback (Deprecated).
	Postback *Contentpostback `json:"postback,omitempty"`
}

Messagecontent - Message content element.

func (*Messagecontent) String ¶

func (o *Messagecontent) String() string

String returns a JSON representation of the model

type Messageconversation ¶

type Messageconversation 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 *[]Messagemediaparticipant `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"`
}

Messageconversation

func (*Messageconversation) String ¶

func (o *Messageconversation) String() string

String returns a JSON representation of the model

type Messageconversationentitylisting ¶

type Messageconversationentitylisting struct {
	// Entities
	Entities *[]Emailconversation `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Messageconversationentitylisting

func (*Messageconversationentitylisting) String ¶

String returns a JSON representation of the model

type Messagedata ¶

type Messagedata struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ProviderMessageId - The unique identifier of the message from provider
	ProviderMessageId *string `json:"providerMessageId,omitempty"`

	// Timestamp - The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Timestamp *time.Time `json:"timestamp,omitempty"`

	// FromAddress - The sender of the text message.
	FromAddress *string `json:"fromAddress,omitempty"`

	// ToAddress - The recipient of the text message.
	ToAddress *string `json:"toAddress,omitempty"`

	// Direction - The direction of the message.
	Direction *string `json:"direction,omitempty"`

	// MessengerType - Type of text messenger.
	MessengerType *string `json:"messengerType,omitempty"`

	// TextBody - The body of the text message.
	TextBody *string `json:"textBody,omitempty"`

	// Status - The status of the message.
	Status *string `json:"status,omitempty"`

	// Media - The media details associated to a message.
	Media *[]Messagemedia `json:"media,omitempty"`

	// Stickers - The sticker details associated to a message.
	Stickers *[]Messagesticker `json:"stickers,omitempty"`

	// CreatedBy - User who sent this message.
	CreatedBy *User `json:"createdBy,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Messagedata

func (*Messagedata) String ¶

func (o *Messagedata) String() string

String returns a JSON representation of the model

type Messagedetails ¶

type Messagedetails struct {
	// MessageId - UUID identifying the message media.
	MessageId *string `json:"messageId,omitempty"`

	// MessageURI - A URI for this message entity.
	MessageURI *string `json:"messageURI,omitempty"`

	// MessageStatus - Indicates the delivery status of the message.
	MessageStatus *string `json:"messageStatus,omitempty"`

	// MessageSegmentCount - The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g. SMS character limits.
	MessageSegmentCount *int `json:"messageSegmentCount,omitempty"`

	// MessageTime - The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	MessageTime *time.Time `json:"messageTime,omitempty"`

	// Media - The media (images, files, etc) associated with this message, if any
	Media *[]Messagemedia `json:"media,omitempty"`

	// Stickers - One or more stickers associated with this message, if any
	Stickers *[]Messagesticker `json:"stickers,omitempty"`
}

Messagedetails

func (*Messagedetails) String ¶

func (o *Messagedetails) String() string

String returns a JSON representation of the model

type Messageevaluation ¶

type Messageevaluation struct {
	// ContactColumn
	ContactColumn *string `json:"contactColumn,omitempty"`

	// ContactAddress
	ContactAddress *string `json:"contactAddress,omitempty"`

	// WrapupCodeId
	WrapupCodeId *string `json:"wrapupCodeId,omitempty"`

	// Timestamp - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Timestamp *time.Time `json:"timestamp,omitempty"`
}

Messageevaluation

func (*Messageevaluation) String ¶

func (o *Messageevaluation) String() string

String returns a JSON representation of the model

type Messageinfo ¶

type Messageinfo struct {
	// LocalizableMessageCode - Key that can be used to localize the message.
	LocalizableMessageCode *string `json:"localizableMessageCode,omitempty"`

	// Message - Description of the message.
	Message *string `json:"message,omitempty"`

	// MessageWithParams - Message with template fields for variable replacement.
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams - Map with fields for variable replacement.
	MessageParams *map[string]string `json:"messageParams,omitempty"`
}

Messageinfo

func (*Messageinfo) String ¶

func (o *Messageinfo) String() string

String returns a JSON representation of the model

type Messagemedia ¶

type Messagemedia struct {
	// Url - The location of the media, useful for retrieving it
	Url *string `json:"url,omitempty"`

	// MediaType - The optional internet media type of the the media object.  If null then the media type should be dictated by the url
	MediaType *string `json:"mediaType,omitempty"`

	// ContentLengthBytes - The optional content length of the the media object, in bytes.
	ContentLengthBytes *int `json:"contentLengthBytes,omitempty"`

	// Name - The optional name of the the media object.
	Name *string `json:"name,omitempty"`

	// Id - The optional id of the the media object.
	Id *string `json:"id,omitempty"`
}

Messagemedia

func (*Messagemedia) String ¶

func (o *Messagemedia) String() string

String returns a JSON representation of the model

type Messagemediaattachment ¶

type Messagemediaattachment struct {
	// Url - The location of the media, useful for retrieving it
	Url *string `json:"url,omitempty"`

	// MediaType - The optional internet media type of the the media object.If null then the media type should be dictated by the url.
	MediaType *string `json:"mediaType,omitempty"`

	// ContentLength - The optional content length of the the media object, in bytes.
	ContentLength *int `json:"contentLength,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`
}

Messagemediaattachment

func (*Messagemediaattachment) String ¶

func (o *Messagemediaattachment) String() string

String returns a JSON representation of the model

type Messagemediadata ¶

type Messagemediadata struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Url - The location of the media, useful for retrieving it
	Url *string `json:"url,omitempty"`

	// MediaType - The detected internet media type of the the media object.  If null then the media type should be dictated by the url.
	MediaType *string `json:"mediaType,omitempty"`

	// ContentLengthBytes - The optional content length of the the media object, in bytes.
	ContentLengthBytes *int `json:"contentLengthBytes,omitempty"`

	// UploadUrl - The URL returned to upload an attachment
	UploadUrl *string `json:"uploadUrl,omitempty"`

	// Status - The status of the media, indicates if the media is in the process of uploading. If the upload fails, the media becomes invalid
	Status *string `json:"status,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Messagemediadata

func (*Messagemediadata) String ¶

func (o *Messagemediadata) String() string

String returns a JSON representation of the model

type Messagemediaparticipant ¶

type Messagemediaparticipant 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"`

	// ToAddress - Address for the participant on receiving side of the message conversation. If the address is a phone number, E.164 format is recommended.
	ToAddress *Address `json:"toAddress,omitempty"`

	// FromAddress - Address for the participant on the sending side of the message conversation. If the address is a phone number, E.164 format is recommended.
	FromAddress *Address `json:"fromAddress,omitempty"`

	// Messages - Message instance details on the communication.
	Messages *[]Messagedetails `json:"messages,omitempty"`

	// VarType - Indicates the type of message platform from which the message originated.
	VarType *string `json:"type,omitempty"`

	// RecipientCountry - Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format.
	RecipientCountry *string `json:"recipientCountry,omitempty"`

	// RecipientType - The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type.
	RecipientType *string `json:"recipientType,omitempty"`
}

Messagemediaparticipant

func (*Messagemediaparticipant) String ¶

func (o *Messagemediaparticipant) String() string

String returns a JSON representation of the model

type Messagemediapolicy ¶

type Messagemediapolicy struct {
	// Actions - Actions applied when specified conditions are met
	Actions *Policyactions `json:"actions,omitempty"`

	// Conditions - Conditions for when actions should be applied
	Conditions *Messagemediapolicyconditions `json:"conditions,omitempty"`
}

Messagemediapolicy

func (*Messagemediapolicy) String ¶

func (o *Messagemediapolicy) String() string

String returns a JSON representation of the model

type Messagemediapolicyconditions ¶

type Messagemediapolicyconditions 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"`
}

Messagemediapolicyconditions

func (*Messagemediapolicyconditions) String ¶

String returns a JSON representation of the model

type Messagesticker ¶

type Messagesticker struct {
	// Url - The location of the sticker, useful for retrieving it
	Url *string `json:"url,omitempty"`

	// Id - The unique id of the the sticker object.
	Id *string `json:"id,omitempty"`
}

Messagesticker

func (*Messagesticker) String ¶

func (o *Messagesticker) String() string

String returns a JSON representation of the model

type Messagestickerattachment ¶

type Messagestickerattachment struct {
	// Url - The location of the media, useful for retrieving it
	Url *string `json:"url,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`
}

Messagestickerattachment

func (*Messagestickerattachment) String ¶

func (o *Messagestickerattachment) String() string

String returns a JSON representation of the model

type Messagingcampaign ¶

type Messagingcampaign 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"`

	// CampaignStatus - The current status of the messaging campaign. A messaging campaign may be turned 'on' or 'off'.
	CampaignStatus *string `json:"campaignStatus,omitempty"`

	// CallableTimeSet - The callable time set for this messaging campaign.
	CallableTimeSet *Domainentityref `json:"callableTimeSet,omitempty"`

	// ContactList - The contact list that this messaging campaign will send messages for.
	ContactList *Domainentityref `json:"contactList,omitempty"`

	// DncLists - The dnc lists to check before sending a message for this messaging campaign.
	DncLists *[]Domainentityref `json:"dncLists,omitempty"`

	// AlwaysRunning - Whether this messaging campaign is always running
	AlwaysRunning *bool `json:"alwaysRunning,omitempty"`

	// ContactSorts - The order in which to sort contacts for dialing, based on up to four columns.
	ContactSorts *[]Contactsort `json:"contactSorts,omitempty"`

	// MessagesPerMinute - How many messages this messaging campaign will send per minute.
	MessagesPerMinute *int `json:"messagesPerMinute,omitempty"`

	// Errors - A list of current error conditions associated with this messaging campaign.
	Errors *[]Resterrordetail `json:"errors,omitempty"`

	// SmsConfig - Configuration for this messaging campaign to send SMS messages.
	SmsConfig *Smsconfig `json:"smsConfig,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Messagingcampaign

func (*Messagingcampaign) String ¶

func (o *Messagingcampaign) String() string

String returns a JSON representation of the model

type Messagingcampaigndivisionview ¶

type Messagingcampaigndivisionview 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"`
}

Messagingcampaigndivisionview

func (*Messagingcampaigndivisionview) String ¶

String returns a JSON representation of the model

type Messagingcampaigndivisionviewentitylisting ¶

type Messagingcampaigndivisionviewentitylisting struct {
	// Entities
	Entities *[]Messagingcampaigndivisionview `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Messagingcampaigndivisionviewentitylisting

func (*Messagingcampaigndivisionviewentitylisting) String ¶

String returns a JSON representation of the model

type Messagingcampaignentitylisting ¶

type Messagingcampaignentitylisting struct {
	// Entities
	Entities *[]Messagingcampaign `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Messagingcampaignentitylisting

func (*Messagingcampaignentitylisting) String ¶

String returns a JSON representation of the model

type Messagingintegration ¶

type Messagingintegration struct {
	// Id - A unique Integration Id
	Id *string `json:"id,omitempty"`

	// Name - The name of the Integration
	Name *string `json:"name,omitempty"`

	// Status - The status of the Integration
	Status *string `json:"status,omitempty"`

	// MessengerType - The type of Messaging Integration
	MessengerType *string `json:"messengerType,omitempty"`

	// Recipient - The recipient associated to the Integration. This recipient is used to associate a flow to an integration
	Recipient *Domainentityref `json:"recipient,omitempty"`

	// DateCreated - Date this Integration 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"`

	// DateModified - Date this Integration was 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"`

	// CreatedBy - User reference that created this Integration
	CreatedBy *Domainentityref `json:"createdBy,omitempty"`

	// ModifiedBy - User reference that last modified this Integration
	ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"`

	// Version - Version number required for updates.
	Version *int `json:"version,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Messagingintegration

func (*Messagingintegration) String ¶

func (o *Messagingintegration) String() string

String returns a JSON representation of the model

type Messagingintegrationentitylisting ¶

type Messagingintegrationentitylisting struct {
	// Entities
	Entities *[]Messagingintegration `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Messagingintegrationentitylisting

func (*Messagingintegrationentitylisting) String ¶

String returns a JSON representation of the model

type Messagingrecipient ¶

type Messagingrecipient struct {
	// Nickname - Nickname or display name of the recipient.
	Nickname *string `json:"nickname,omitempty"`

	// Id - The recipient ID specific to the provider.
	Id *string `json:"id,omitempty"`

	// IdType - The recipient ID type. This is used to indicate the format used for the ID.
	IdType *string `json:"idType,omitempty"`

	// Image - URL of an image that represents the recipient.
	Image *string `json:"image,omitempty"`

	// FirstName - First name of the recipient.
	FirstName *string `json:"firstName,omitempty"`

	// LastName - Last name of the recipient.
	LastName *string `json:"lastName,omitempty"`

	// Email - E-mail address of the recipient.
	Email *string `json:"email,omitempty"`
}

Messagingrecipient - Information about the recipient the message is sent to or received from.

func (*Messagingrecipient) String ¶

func (o *Messagingrecipient) String() string

String returns a JSON representation of the model

type Messagingsticker ¶

type Messagingsticker struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ProviderStickerId - The sticker Id of the sticker, assigned by the sticker provider.
	ProviderStickerId *int `json:"providerStickerId,omitempty"`

	// ProviderPackageId - The package Id of the sticker, assigned by the sticker provider.
	ProviderPackageId *int `json:"providerPackageId,omitempty"`

	// PackageName - The package name of the sticker, assigned by the sticker provider.
	PackageName *string `json:"packageName,omitempty"`

	// MessengerType - The type of the messenger provider.
	MessengerType *string `json:"messengerType,omitempty"`

	// StickerType - The type of the sticker.
	StickerType *string `json:"stickerType,omitempty"`

	// ProviderVersion - The version of the sticker, assigned by the provider.
	ProviderVersion *int `json:"providerVersion,omitempty"`

	// UriLocation
	UriLocation *string `json:"uriLocation,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Messagingsticker

func (*Messagingsticker) String ¶

func (o *Messagingsticker) String() string

String returns a JSON representation of the model

type Messagingstickerentitylisting ¶

type Messagingstickerentitylisting struct {
	// Entities
	Entities *[]Messagingsticker `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Messagingstickerentitylisting

func (*Messagingstickerentitylisting) String ¶

String returns a JSON representation of the model

type Messagingtemplate ¶

type Messagingtemplate struct {
	// WhatsApp - Defines a messaging template for a WhatsApp messaging channel
	WhatsApp *Whatsappdefinition `json:"whatsApp,omitempty"`
}

Messagingtemplate - The messaging template identifies a structured message templates supported by a messaging channel.

func (*Messagingtemplate) String ¶

func (o *Messagingtemplate) String() string

String returns a JSON representation of the model

type Messagingtemplaterequest ¶

type Messagingtemplaterequest struct {
	// ResponseId - A Response Management response identifier for a messaging template defined response
	ResponseId *string `json:"responseId,omitempty"`

	// Parameters - A list of Response Management response substitutions for the response's messaging template
	Parameters *[]Templateparameter `json:"parameters,omitempty"`
}

Messagingtemplaterequest

func (*Messagingtemplaterequest) String ¶

func (o *Messagingtemplaterequest) String() string

String returns a JSON representation of the model

type Metabase ¶

type Metabase struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Metabase

func (*Metabase) String ¶

func (o *Metabase) String() string

String returns a JSON representation of the model

type Metadata ¶

type Metadata struct {
	// PairingToken
	PairingToken *string `json:"pairing-token,omitempty"`

	// PairingTrust
	PairingTrust *[]string `json:"pairing-trust,omitempty"`

	// PairingUrl
	PairingUrl *string `json:"pairing-url,omitempty"`
}

Metadata

func (*Metadata) String ¶

func (o *Metadata) String() string

String returns a JSON representation of the model

type Meteredassignmentbyagent ¶

type Meteredassignmentbyagent struct {
	// EvaluationContextId
	EvaluationContextId *string `json:"evaluationContextId,omitempty"`

	// Evaluators
	Evaluators *[]User `json:"evaluators,omitempty"`

	// MaxNumberEvaluations
	MaxNumberEvaluations *int `json:"maxNumberEvaluations,omitempty"`

	// EvaluationForm
	EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"`

	// TimeInterval
	TimeInterval *Timeinterval `json:"timeInterval,omitempty"`

	// TimeZone
	TimeZone *string `json:"timeZone,omitempty"`
}

Meteredassignmentbyagent

func (*Meteredassignmentbyagent) String ¶

func (o *Meteredassignmentbyagent) String() string

String returns a JSON representation of the model

type Meteredevaluationassignment ¶

type Meteredevaluationassignment struct {
	// EvaluationContextId
	EvaluationContextId *string `json:"evaluationContextId,omitempty"`

	// Evaluators
	Evaluators *[]User `json:"evaluators,omitempty"`

	// MaxNumberEvaluations
	MaxNumberEvaluations *int `json:"maxNumberEvaluations,omitempty"`

	// EvaluationForm
	EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"`

	// AssignToActiveUser
	AssignToActiveUser *bool `json:"assignToActiveUser,omitempty"`

	// TimeInterval
	TimeInterval *Timeinterval `json:"timeInterval,omitempty"`
}

Meteredevaluationassignment

func (*Meteredevaluationassignment) String ¶

func (o *Meteredevaluationassignment) String() string

String returns a JSON representation of the model

type Metric ¶

type Metric struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of this metric
	Name *string `json:"name,omitempty"`

	// MetricDefinitionId - The id of associated metric definition
	MetricDefinitionId *string `json:"metricDefinitionId,omitempty"`

	// Objective - Associated objective for this metric
	Objective *Objective `json:"objective,omitempty"`

	// PerformanceProfileId - Performance profile id of this metric
	PerformanceProfileId *string `json:"performanceProfileId,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Metric

func (*Metric) String ¶

func (o *Metric) String() string

String returns a JSON representation of the model

type Metricdefinition ¶

type Metricdefinition struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// UnitType - The type of associated metric unit
	UnitType *string `json:"unitType,omitempty"`

	// ShortName - An alternate name for this metric definition, often abbreviation
	ShortName *string `json:"shortName,omitempty"`

	// DividendMetrics - Metric names used as dividend
	DividendMetrics *[]string `json:"dividendMetrics,omitempty"`

	// DivisorMetrics - Metric names used as divisor
	DivisorMetrics *[]string `json:"divisorMetrics,omitempty"`

	// DefaultObjective - A predefined default objective for this metric
	DefaultObjective *Defaultobjective `json:"defaultObjective,omitempty"`

	// LockTemplateId - An optional field to specify if this metric definition is locked to certain template. e.g. punctuality
	LockTemplateId *string `json:"lockTemplateId,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Metricdefinition

func (*Metricdefinition) String ¶

func (o *Metricdefinition) String() string

String returns a JSON representation of the model

type Metrics ¶

type Metrics struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Order - The order of metric within a performance profile
	Order *int `json:"order,omitempty"`

	// MetricDefinitionName - The name of associated metric definition
	MetricDefinitionName *string `json:"metricDefinitionName,omitempty"`

	// MetricDefinitionId - The id of associated metric definition
	MetricDefinitionId *string `json:"metricDefinitionId,omitempty"`

	// UnitType - Corresponding unit type for this metric
	UnitType *string `json:"unitType,omitempty"`

	// Enabled - A flag for whether this metric is enabled for a performance profile
	Enabled *bool `json:"enabled,omitempty"`

	// TemplateName - The name of associated objective template
	TemplateName *string `json:"templateName,omitempty"`

	// MaxPoints - Achievable maximum points for this metric
	MaxPoints *int `json:"maxPoints,omitempty"`

	// PerformanceProfileId - Performance profile id of this metric
	PerformanceProfileId *string `json:"performanceProfileId,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Metrics

func (*Metrics) String ¶

func (o *Metrics) String() string

String returns a JSON representation of the model

type Minlength ¶

type Minlength struct {
	// Min - A non-negative integer for a text-based schema field denoting the minimum smallest length a string field can contain for a schema instance.
	Min *int `json:"min,omitempty"`

	// Max - A non-negative integer for a text-based schema field denoting the maximum smallest length string the field can contain for a schema instance.
	Max *int `json:"max,omitempty"`
}

Minlength

func (*Minlength) String ¶

func (o *Minlength) String() string

String returns a JSON representation of the model

type MobileDevicesApi ¶

type MobileDevicesApi struct {
	Configuration *Configuration
}

MobileDevicesApi provides functions for API endpoints

func NewMobileDevicesApi ¶

func NewMobileDevicesApi() *MobileDevicesApi

NewMobileDevicesApi creates an API instance using the default configuration

func NewMobileDevicesApiWithConfig ¶

func NewMobileDevicesApiWithConfig(config *Configuration) *MobileDevicesApi

NewMobileDevicesApiWithConfig creates an API instance using the provided configuration

func (MobileDevicesApi) DeleteMobiledevice ¶

func (a MobileDevicesApi) DeleteMobiledevice(deviceId string) (*APIResponse, error)

DeleteMobiledevice invokes DELETE /api/v2/mobiledevices/{deviceId}

Delete device

func (MobileDevicesApi) GetMobiledevice ¶

func (a MobileDevicesApi) GetMobiledevice(deviceId string) (*Userdevice, *APIResponse, error)

GetMobiledevice invokes GET /api/v2/mobiledevices/{deviceId}

Get device

func (MobileDevicesApi) GetMobiledevices ¶

func (a MobileDevicesApi) GetMobiledevices(pageSize int, pageNumber int, sortOrder string) (*Directoryuserdeviceslisting, *APIResponse, error)

GetMobiledevices invokes GET /api/v2/mobiledevices

Get a list of all devices.

func (MobileDevicesApi) PostMobiledevices ¶

func (a MobileDevicesApi) PostMobiledevices(body Userdevice) (*Userdevice, *APIResponse, error)

PostMobiledevices invokes POST /api/v2/mobiledevices

Create User device

func (MobileDevicesApi) PutMobiledevice ¶

func (a MobileDevicesApi) PutMobiledevice(deviceId string, body Userdevice) (*Userdevice, *APIResponse, error)

PutMobiledevice invokes PUT /api/v2/mobiledevices/{deviceId}

Update device

type Modelingprocessingerror ¶

type Modelingprocessingerror struct {
	// InternalErrorCode - An internal code representing the type of error. ModelInputMissing for 'Model Builder inputs not found.' ModelInputInvalid for 'Model Builder inputs are invalid. Ensure the input data format is correct.' ModelFailed for 'An error occured while building the model with the given input.'
	InternalErrorCode *string `json:"internalErrorCode,omitempty"`

	// Description - A text description of the error
	Description *string `json:"description,omitempty"`
}

Modelingprocessingerror

func (*Modelingprocessingerror) String ¶

func (o *Modelingprocessingerror) String() string

String returns a JSON representation of the model

type Modelingstatusresponse ¶

type Modelingstatusresponse struct {
	// Id - The ID generated for the modeling job.  Use to GET result when job is completed.
	Id *string `json:"id,omitempty"`

	// Status - The status of the modeling job.
	Status *string `json:"status,omitempty"`

	// ErrorDetails - If the request could not be properly processed, error details will be given here.
	ErrorDetails *[]Modelingprocessingerror `json:"errorDetails,omitempty"`

	// ModelingResultUri - The uri of the modeling result. It has a value if the status is either 'Success', 'PartialFailure', or 'Failed'.
	ModelingResultUri *string `json:"modelingResultUri,omitempty"`
}

Modelingstatusresponse

func (*Modelingstatusresponse) String ¶

func (o *Modelingstatusresponse) String() string

String returns a JSON representation of the model

type Movemanagementunitrequest ¶

type Movemanagementunitrequest struct {
	// BusinessUnitId - The ID of the business unit to which to move the management unit
	BusinessUnitId *string `json:"businessUnitId,omitempty"`
}

Movemanagementunitrequest

func (*Movemanagementunitrequest) String ¶

func (o *Movemanagementunitrequest) String() string

String returns a JSON representation of the model

type Movemanagementunitresponse ¶

type Movemanagementunitresponse struct {
	// BusinessUnit - The new business unit
	BusinessUnit *Businessunitreference `json:"businessUnit,omitempty"`

	// Status - The status of the move.  Will always be 'Processing' unless the Management Unit is already in the requested Business Unit in which case it will be 'Complete'
	Status *string `json:"status,omitempty"`
}

Movemanagementunitresponse

func (*Movemanagementunitresponse) String ¶

func (o *Movemanagementunitresponse) String() string

String returns a JSON representation of the model

type Murescheduleresultwrapper ¶

type Murescheduleresultwrapper struct {
	// AgentSchedules - The list of agent schedules
	AgentSchedules *[]Buagentschedulerescheduleresponse `json:"agentSchedules,omitempty"`
}

Murescheduleresultwrapper

func (*Murescheduleresultwrapper) String ¶

func (o *Murescheduleresultwrapper) String() string

String returns a JSON representation of the model

type Namedentity ¶

type Namedentity struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the object.
	Name *string `json:"name,omitempty"`
}

Namedentity

func (*Namedentity) String ¶

func (o *Namedentity) String() string

String returns a JSON representation of the model

type Namedentityannotation ¶

type Namedentityannotation struct {
	// Name - The name of the annotated named entity.
	Name *string `json:"name,omitempty"`
}

Namedentityannotation

func (*Namedentityannotation) String ¶

func (o *Namedentityannotation) String() string

String returns a JSON representation of the model

type Namedentitydefinition ¶

type Namedentitydefinition struct {
	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// VarType - The name of the entity type.
	VarType *string `json:"type,omitempty"`
}

Namedentitydefinition

func (*Namedentitydefinition) String ¶

func (o *Namedentitydefinition) String() string

String returns a JSON representation of the model

type Namedentitytypebinding ¶

type Namedentitytypebinding struct {
	// EntityType - The named entity type of the binding. It can be a built-in one such as builtin:number or a custom entity type such as BeverageType.
	EntityType *string `json:"entityType,omitempty"`

	// EntityName - The name that this named entity type is bound to.
	EntityName *string `json:"entityName,omitempty"`
}

Namedentitytypebinding

func (*Namedentitytypebinding) String ¶

func (o *Namedentitytypebinding) String() string

String returns a JSON representation of the model

type Namedentitytypedefinition ¶

type Namedentitytypedefinition struct {
	// Name - The name of the entity type.
	Name *string `json:"name,omitempty"`

	// Description - Description of the of the named entity type.
	Description *string `json:"description,omitempty"`

	// Mechanism - The mechanism enabling detection of the named entity type.
	Mechanism *Namedentitytypemechanism `json:"mechanism,omitempty"`
}

Namedentitytypedefinition

func (*Namedentitytypedefinition) String ¶

func (o *Namedentitytypedefinition) String() string

String returns a JSON representation of the model

type Namedentitytypeitem ¶

type Namedentitytypeitem struct {
	// Value - A value for an named entity type definition.
	Value *string `json:"value,omitempty"`

	// Synonyms - Synonyms for the given named entity value.
	Synonyms *[]string `json:"synonyms,omitempty"`
}

Namedentitytypeitem

func (*Namedentitytypeitem) String ¶

func (o *Namedentitytypeitem) String() string

String returns a JSON representation of the model

type Namedentitytypemechanism ¶

type Namedentitytypemechanism struct {
	// Items - The items that define the named entity type.
	Items *[]Namedentitytypeitem `json:"items,omitempty"`

	// Restricted - Whether the named entity type is restricted to the items provided. Default: false
	Restricted *bool `json:"restricted,omitempty"`

	// VarType - The type of the mechanism.
	VarType *string `json:"type,omitempty"`
}

Namedentitytypemechanism

func (*Namedentitytypemechanism) String ¶

func (o *Namedentitytypemechanism) String() string

String returns a JSON representation of the model

type Nluconfusionmatrixcolumn ¶

type Nluconfusionmatrixcolumn struct {
	// Name - The name of the intent for the column.
	Name *string `json:"name,omitempty"`

	// Value - The confusion value between the intents
	Value *float32 `json:"value,omitempty"`
}

Nluconfusionmatrixcolumn

func (*Nluconfusionmatrixcolumn) String ¶

func (o *Nluconfusionmatrixcolumn) String() string

String returns a JSON representation of the model

type Nluconfusionmatrixrow ¶

type Nluconfusionmatrixrow struct {
	// Name - The name of the intent for the row.
	Name *string `json:"name,omitempty"`

	// Columns - The columns of confusion matrix for the intent
	Columns *[]Nluconfusionmatrixcolumn `json:"columns,omitempty"`
}

Nluconfusionmatrixrow

func (*Nluconfusionmatrixrow) String ¶

func (o *Nluconfusionmatrixrow) String() string

String returns a JSON representation of the model

type Nludetectioncontext ¶

type Nludetectioncontext struct {
	// Intent - Restrict detection to this intent.
	Intent *Contextintent `json:"intent,omitempty"`

	// Entity - Use this entity to restrict detection.
	Entity *Contextentity `json:"entity,omitempty"`
}

Nludetectioncontext

func (*Nludetectioncontext) String ¶

func (o *Nludetectioncontext) String() string

String returns a JSON representation of the model

type Nludetectioninput ¶

type Nludetectioninput struct {
	// Text - The text to perform NLU detection on.
	Text *string `json:"text,omitempty"`
}

Nludetectioninput

func (*Nludetectioninput) String ¶

func (o *Nludetectioninput) String() string

String returns a JSON representation of the model

type Nludetectionoutput ¶

type Nludetectionoutput struct {
	// Intents - The detected intents.
	Intents *[]Detectedintent `json:"intents,omitempty"`

	// DialogActs - The detected dialog acts.
	DialogActs *[]Detecteddialogact `json:"dialogActs,omitempty"`
}

Nludetectionoutput

func (*Nludetectionoutput) String ¶

func (o *Nludetectionoutput) String() string

String returns a JSON representation of the model

type Nludetectionrequest ¶

type Nludetectionrequest struct {
	// Input - The input subject to NLU detection.
	Input *Nludetectioninput `json:"input,omitempty"`

	// Context - The context for the input to NLU detection.
	Context *Nludetectioncontext `json:"context,omitempty"`
}

Nludetectionrequest

func (*Nludetectionrequest) String ¶

func (o *Nludetectionrequest) String() string

String returns a JSON representation of the model

type Nludetectionresponse ¶

type Nludetectionresponse struct {
	// Version - The NLU domain version which performed the detection.
	Version *Nludomainversion `json:"version,omitempty"`

	// Output
	Output *Nludetectionoutput `json:"output,omitempty"`

	// Input
	Input *Nludetectioninput `json:"input,omitempty"`
}

Nludetectionresponse

func (*Nludetectionresponse) String ¶

func (o *Nludetectionresponse) String() string

String returns a JSON representation of the model

type Nludomain ¶

type Nludomain struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the NLU domain.
	Name *string `json:"name,omitempty"`

	// Language - The language culture of the NLU domain, e.g. `en-us`, `de-de`.
	Language *string `json:"language,omitempty"`

	// DraftVersion - The draft version of that NLU domain.
	DraftVersion *Nludomainversion `json:"draftVersion,omitempty"`

	// LastPublishedVersion - The last published version of that NLU domain.
	LastPublishedVersion *Nludomainversion `json:"lastPublishedVersion,omitempty"`

	// DateCreated - The date when the NLU domain 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"`

	// DateModified - The date when the NLU domain was updated. 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"`
}

Nludomain

func (*Nludomain) String ¶

func (o *Nludomain) String() string

String returns a JSON representation of the model

type Nludomainlisting ¶

type Nludomainlisting struct {
	// Entities
	Entities *[]Nludomain `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Nludomainlisting

func (*Nludomainlisting) String ¶

func (o *Nludomainlisting) String() string

String returns a JSON representation of the model

type Nludomainversion ¶

type Nludomainversion struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Domain - The NLU domain of the version.
	Domain **Nludomain `json:"domain,omitempty"`

	// Description - The description of the NLU domain version.
	Description *string `json:"description,omitempty"`

	// Language - The language that the NLU domain version supports.
	Language *string `json:"language,omitempty"`

	// Published - Whether this NLU domain version has been published.
	Published *bool `json:"published,omitempty"`

	// DateCreated - The date when the NLU domain version 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"`

	// DateModified - The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// DateTrained - The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateTrained *time.Time `json:"dateTrained,omitempty"`

	// DatePublished - The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DatePublished *time.Time `json:"datePublished,omitempty"`

	// TrainingStatus - The training status of the NLU domain version.
	TrainingStatus *string `json:"trainingStatus,omitempty"`

	// EvaluationStatus - The evaluation status of the NLU domain version.
	EvaluationStatus *string `json:"evaluationStatus,omitempty"`

	// Intents - The intents defined for this NLU domain version.
	Intents *[]Intentdefinition `json:"intents,omitempty"`

	// EntityTypes - The entity types defined for this NLU domain version.
	EntityTypes *[]Namedentitytypedefinition `json:"entityTypes,omitempty"`

	// Entities - The entities defined for this NLU domain version.This field is mutually exclusive with entityTypeBindings
	Entities *[]Namedentitydefinition `json:"entities,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Nludomainversion

func (*Nludomainversion) String ¶

func (o *Nludomainversion) String() string

String returns a JSON representation of the model

type Nludomainversionlisting ¶

type Nludomainversionlisting struct {
	// Entities
	Entities *[]Nludomainversion `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Nludomainversionlisting

func (*Nludomainversionlisting) String ¶

func (o *Nludomainversionlisting) String() string

String returns a JSON representation of the model

type Nludomainversionqualityreport ¶

type Nludomainversionqualityreport struct {
	// Version - The domain and version details of the quality report
	Version *Nludomainversion `json:"version,omitempty"`

	// ConfusionMatrix - The confusion matrix for the Domain Version
	ConfusionMatrix *[]Nluconfusionmatrixrow `json:"confusionMatrix,omitempty"`

	// Summary - The quality report summary for the Domain Version
	Summary *Nluqualityreportsummary `json:"summary,omitempty"`
}

Nludomainversionqualityreport

func (*Nludomainversionqualityreport) String ¶

String returns a JSON representation of the model

type Nludomainversiontrainingresponse ¶

type Nludomainversiontrainingresponse struct {
	// Message - A message indicating result of the action.
	Message *string `json:"message,omitempty"`

	// Version
	Version *Nludomainversion `json:"version,omitempty"`
}

Nludomainversiontrainingresponse

func (*Nludomainversiontrainingresponse) String ¶

String returns a JSON representation of the model

type Nlufeedbacklisting ¶

type Nlufeedbacklisting struct {
	// Entities
	Entities *[]Nlufeedbackresponse `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Nlufeedbacklisting

func (*Nlufeedbacklisting) String ¶

func (o *Nlufeedbacklisting) String() string

String returns a JSON representation of the model

type Nlufeedbackrequest ¶

type Nlufeedbackrequest struct {
	// Text - The feedback text.
	Text *string `json:"text,omitempty"`

	// Intents - Detected intent of the utterance
	Intents *[]Intentfeedback `json:"intents,omitempty"`

	// VersionId - The domain version ID of the feedback.
	VersionId *string `json:"versionId,omitempty"`
}

Nlufeedbackrequest

func (*Nlufeedbackrequest) String ¶

func (o *Nlufeedbackrequest) String() string

String returns a JSON representation of the model

type Nlufeedbackresponse ¶

type Nlufeedbackresponse struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Text - The feedback text.
	Text *string `json:"text,omitempty"`

	// Intents - Detected intent of the utterance
	Intents *[]Intentfeedback `json:"intents,omitempty"`

	// Version - The domain version of the feedback.
	Version *Nludomainversion `json:"version,omitempty"`

	// DateCreated - The date when the feedback 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"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Nlufeedbackresponse

func (*Nlufeedbackresponse) String ¶

func (o *Nlufeedbackresponse) String() string

String returns a JSON representation of the model

type Nluinfo ¶

type Nluinfo struct {
	// Domain
	Domain *Addressableentityref `json:"domain,omitempty"`

	// Version
	Version **Nludomainversion `json:"version,omitempty"`

	// Intents
	Intents *[]Intent `json:"intents,omitempty"`
}

Nluinfo

func (*Nluinfo) String ¶

func (o *Nluinfo) String() string

String returns a JSON representation of the model

type Nluqualityreportsummary ¶

type Nluqualityreportsummary struct {
	// Metrics - The list of metrics in the summary
	Metrics *[]Nluqualityreportsummarymetric `json:"metrics,omitempty"`
}

Nluqualityreportsummary

func (*Nluqualityreportsummary) String ¶

func (o *Nluqualityreportsummary) String() string

String returns a JSON representation of the model

type Nluqualityreportsummarymetric ¶

type Nluqualityreportsummarymetric struct {
	// Name - The name of the metric. e.g. recall, f1_score
	Name *string `json:"name,omitempty"`

	// Value - The value of the metric
	Value *float32 `json:"value,omitempty"`
}

Nluqualityreportsummarymetric

func (*Nluqualityreportsummarymetric) String ¶

String returns a JSON representation of the model

type Nluutterance ¶

type Nluutterance struct {
	// Segments - The list of segments that that constitute this utterance for the given intent.
	Segments *[]Nluutterancesegment `json:"segments,omitempty"`
}

Nluutterance

func (*Nluutterance) String ¶

func (o *Nluutterance) String() string

String returns a JSON representation of the model

type Nluutterancesegment ¶

type Nluutterancesegment struct {
	// Text - The text of the segment.
	Text *string `json:"text,omitempty"`

	// Entity - The entity annotation of the segment.
	Entity *Namedentityannotation `json:"entity,omitempty"`
}

Nluutterancesegment

func (*Nluutterancesegment) String ¶

func (o *Nluutterancesegment) String() string

String returns a JSON representation of the model

type Note ¶

type Note struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// EntityId - The id of the contact or organization to which this note refers. This only needs to be set for input when using the Bulk APIs.
	EntityId *string `json:"entityId,omitempty"`

	// EntityType - This is only need to be set when using Bulk API. Using any other value than contact or organization will result in null being used.
	EntityType *string `json:"entityType,omitempty"`

	// NoteText
	NoteText *string `json:"noteText,omitempty"`

	// ModifyDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ModifyDate *time.Time `json:"modifyDate,omitempty"`

	// CreateDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CreateDate *time.Time `json:"createDate,omitempty"`

	// CreatedBy - When creating or updating a note, only User.id is required. User object is fully populated when expanding a note.
	CreatedBy *User `json:"createdBy,omitempty"`

	// ExternalDataSources - Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record.  Read-only, and only populated when requested via expand param.
	ExternalDataSources *[]Externaldatasource `json:"externalDataSources,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Note

func (*Note) String ¶

func (o *Note) String() string

String returns a JSON representation of the model

type Notelisting ¶

type Notelisting struct {
	// Entities
	Entities *[]Note `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Notelisting

func (*Notelisting) String ¶

func (o *Notelisting) String() string

String returns a JSON representation of the model

type NotificationsApi ¶

type NotificationsApi struct {
	Configuration *Configuration
}

NotificationsApi provides functions for API endpoints

func NewNotificationsApi ¶

func NewNotificationsApi() *NotificationsApi

NewNotificationsApi creates an API instance using the default configuration

func NewNotificationsApiWithConfig ¶

func NewNotificationsApiWithConfig(config *Configuration) *NotificationsApi

NewNotificationsApiWithConfig creates an API instance using the provided configuration

func (NotificationsApi) DeleteNotificationsChannelSubscriptions ¶

func (a NotificationsApi) DeleteNotificationsChannelSubscriptions(channelId string) (*APIResponse, error)

DeleteNotificationsChannelSubscriptions invokes DELETE /api/v2/notifications/channels/{channelId}/subscriptions

Remove all subscriptions

func (NotificationsApi) GetNotificationsAvailabletopics ¶

func (a NotificationsApi) GetNotificationsAvailabletopics(expand []string, includePreview bool) (*Availabletopicentitylisting, *APIResponse, error)

GetNotificationsAvailabletopics invokes GET /api/v2/notifications/availabletopics

Get available notification topics.

func (NotificationsApi) GetNotificationsChannelSubscriptions ¶

func (a NotificationsApi) GetNotificationsChannelSubscriptions(channelId string) (*Channeltopicentitylisting, *APIResponse, error)

GetNotificationsChannelSubscriptions invokes GET /api/v2/notifications/channels/{channelId}/subscriptions

The list of all subscriptions for this channel

func (NotificationsApi) GetNotificationsChannels ¶

func (a NotificationsApi) GetNotificationsChannels(includechannels string) (*Channelentitylisting, *APIResponse, error)

GetNotificationsChannels invokes GET /api/v2/notifications/channels

The list of existing channels

func (NotificationsApi) PostNotificationsChannelSubscriptions ¶

func (a NotificationsApi) PostNotificationsChannelSubscriptions(channelId string, body []Channeltopic) (*Channeltopicentitylisting, *APIResponse, error)

PostNotificationsChannelSubscriptions invokes POST /api/v2/notifications/channels/{channelId}/subscriptions

Add a list of subscriptions to the existing list of subscriptions

func (NotificationsApi) PostNotificationsChannels ¶

func (a NotificationsApi) PostNotificationsChannels() (*Channel, *APIResponse, error)

PostNotificationsChannels invokes POST /api/v2/notifications/channels

Create a new channel ¶

There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first.

func (NotificationsApi) PutNotificationsChannelSubscriptions ¶

func (a NotificationsApi) PutNotificationsChannelSubscriptions(channelId string, body []Channeltopic) (*Channeltopicentitylisting, *APIResponse, error)

PutNotificationsChannelSubscriptions invokes PUT /api/v2/notifications/channels/{channelId}/subscriptions

Replace the current list of subscriptions with a new list.

type Notificationsresponse ¶

type Notificationsresponse struct {
	// Entities
	Entities *[]Wfmusernotification `json:"entities,omitempty"`
}

Notificationsresponse

func (*Notificationsresponse) String ¶

func (o *Notificationsresponse) String() string

String returns a JSON representation of the model

type Notificationtemplatebody ¶

type Notificationtemplatebody struct {
	// Text - Body text. For WhatsApp, ignored.
	Text *string `json:"text,omitempty"`

	// Parameters - Template parameters for placeholders in template.
	Parameters *[]Notificationtemplateparameter `json:"parameters,omitempty"`
}

Notificationtemplatebody - Template body object.

func (*Notificationtemplatebody) String ¶

func (o *Notificationtemplatebody) String() string

String returns a JSON representation of the model

type Notificationtemplatefooter ¶

type Notificationtemplatefooter struct {
	// Text - Footer text. For WhatsApp, ignored.
	Text *string `json:"text,omitempty"`
}

Notificationtemplatefooter - Template footer object.

func (*Notificationtemplatefooter) String ¶

func (o *Notificationtemplatefooter) String() string

String returns a JSON representation of the model

type Notificationtemplateheader ¶

type Notificationtemplateheader struct {
	// VarType - Template header type.
	VarType *string `json:"type,omitempty"`

	// Text - Header text. For WhatsApp, ignored.
	Text *string `json:"text,omitempty"`

	// Media - Media template header image.
	Media *Contentattachment `json:"media,omitempty"`

	// Parameters - Template parameters for placeholders in template.
	Parameters *[]Notificationtemplateparameter `json:"parameters,omitempty"`
}

Notificationtemplateheader - Template header object.

func (*Notificationtemplateheader) String ¶

func (o *Notificationtemplateheader) String() string

String returns a JSON representation of the model

type Notificationtemplateparameter ¶

type Notificationtemplateparameter struct {
	// Name - Parameter name.
	Name *string `json:"name,omitempty"`

	// Text - Parameter text value.
	Text *string `json:"text,omitempty"`
}

Notificationtemplateparameter - Template parameters for placeholders in template.

func (*Notificationtemplateparameter) String ¶

String returns a JSON representation of the model

type Ntpsettings ¶

type Ntpsettings struct {
	// Servers - List of NTP servers, in priority order
	Servers *[]string `json:"servers,omitempty"`
}

Ntpsettings

func (*Ntpsettings) String ¶

func (o *Ntpsettings) String() string

String returns a JSON representation of the model

type Number ¶

type Number struct {
	// Start
	Start *string `json:"start,omitempty"`

	// End
	End *string `json:"end,omitempty"`
}

Number

func (*Number) String ¶

func (o *Number) String() string

String returns a JSON representation of the model

type Numberplan ¶

type Numberplan struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// Match
	Match *string `json:"match,omitempty"`

	// NormalizedFormat
	NormalizedFormat *string `json:"normalizedFormat,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Numbers
	Numbers *[]Number `json:"numbers,omitempty"`

	// DigitLength
	DigitLength *Digitlength `json:"digitLength,omitempty"`

	// Classification
	Classification *string `json:"classification,omitempty"`

	// MatchType
	MatchType *string `json:"matchType,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Numberplan

func (*Numberplan) String ¶

func (o *Numberplan) String() string

String returns a JSON representation of the model

type Numericrange ¶

type Numericrange struct {
	// Gt - Greater than
	Gt *float32 `json:"gt,omitempty"`

	// Gte - Greater than or equal to
	Gte *float32 `json:"gte,omitempty"`

	// Lt - Less than
	Lt *float32 `json:"lt,omitempty"`

	// Lte - Less than or equal to
	Lte *float32 `json:"lte,omitempty"`
}

Numericrange

func (*Numericrange) String ¶

func (o *Numericrange) String() string

String returns a JSON representation of the model

type OAuthApi ¶

type OAuthApi struct {
	Configuration *Configuration
}

OAuthApi provides functions for API endpoints

func NewOAuthApi ¶

func NewOAuthApi() *OAuthApi

NewOAuthApi creates an API instance using the default configuration

func NewOAuthApiWithConfig ¶

func NewOAuthApiWithConfig(config *Configuration) *OAuthApi

NewOAuthApiWithConfig creates an API instance using the provided configuration

func (OAuthApi) DeleteOauthClient ¶

func (a OAuthApi) DeleteOauthClient(clientId string) (*APIResponse, error)

DeleteOauthClient invokes DELETE /api/v2/oauth/clients/{clientId}

Delete OAuth Client

func (OAuthApi) GetOauthAuthorization ¶

func (a OAuthApi) GetOauthAuthorization(clientId string) (*Oauthauthorization, *APIResponse, error)

GetOauthAuthorization invokes GET /api/v2/oauth/authorizations/{clientId}

Get a client that is authorized by the resource owner

func (OAuthApi) GetOauthAuthorizations ¶

func (a OAuthApi) GetOauthAuthorizations() (*Oauthauthorizationlisting, *APIResponse, error)

GetOauthAuthorizations invokes GET /api/v2/oauth/authorizations

List clients that are authorized by the resource owner

func (OAuthApi) GetOauthClient ¶

func (a OAuthApi) GetOauthClient(clientId string) (*Oauthclient, *APIResponse, error)

GetOauthClient invokes GET /api/v2/oauth/clients/{clientId}

Get OAuth Client

func (OAuthApi) GetOauthClientUsageQueryResult ¶

func (a OAuthApi) GetOauthClientUsageQueryResult(executionId string, clientId string) (*Apiusagequeryresult, *APIResponse, error)

GetOauthClientUsageQueryResult invokes GET /api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}

Get the results of a usage query

func (OAuthApi) GetOauthClientUsageSummary ¶

func (a OAuthApi) GetOauthClientUsageSummary(clientId string, days string) (*Usageexecutionresult, *APIResponse, error)

GetOauthClientUsageSummary invokes GET /api/v2/oauth/clients/{clientId}/usage/summary

Get a summary of OAuth client API usage ¶

After calling this method, you will then need to poll for the query results based on the returned execution Id

func (OAuthApi) GetOauthClients ¶

func (a OAuthApi) GetOauthClients() (*Oauthcliententitylisting, *APIResponse, error)

GetOauthClients invokes GET /api/v2/oauth/clients

The list of OAuth clients

func (OAuthApi) GetOauthScope ¶

func (a OAuthApi) GetOauthScope(scopeId string, acceptLanguage string) (*Oauthscope, *APIResponse, error)

GetOauthScope invokes GET /api/v2/oauth/scopes/{scopeId}

An OAuth scope

func (OAuthApi) GetOauthScopes ¶

func (a OAuthApi) GetOauthScopes(acceptLanguage string) (*Oauthscopelisting, *APIResponse, error)

GetOauthScopes invokes GET /api/v2/oauth/scopes

The list of OAuth scopes

func (OAuthApi) PostOauthClientSecret ¶

func (a OAuthApi) PostOauthClientSecret(clientId string) (*Oauthclient, *APIResponse, error)

PostOauthClientSecret invokes POST /api/v2/oauth/clients/{clientId}/secret

Regenerate Client Secret ¶

This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.

func (OAuthApi) PostOauthClientUsageQuery ¶

func (a OAuthApi) PostOauthClientUsageQuery(clientId string, body Apiusagequery) (*Usageexecutionresult, *APIResponse, error)

PostOauthClientUsageQuery invokes POST /api/v2/oauth/clients/{clientId}/usage/query

Query for OAuth client API usage ¶

After calling this method, you will then need to poll for the query results based on the returned execution Id

func (OAuthApi) PostOauthClients ¶

func (a OAuthApi) PostOauthClients(body Oauthclientrequest) (*Oauthclient, *APIResponse, error)

PostOauthClients invokes POST /api/v2/oauth/clients

Create OAuth client ¶

The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. The preferred authorizedGrantTypes is &#39;CODE&#39; which requires applications to send a client ID and client secret. This is typically a web server. If the client is unable to secure the client secret then the &#39;TOKEN&#39; grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. If a client is to be used outside of the context of a user then the &#39;CLIENT-CREDENTIALS&#39; grant may be used. In this case the client must be granted roles via the &#39;roleIds&#39; field.

func (OAuthApi) PutOauthClient ¶

func (a OAuthApi) PutOauthClient(clientId string, body Oauthclientrequest) (*Oauthclient, *APIResponse, error)

PutOauthClient invokes PUT /api/v2/oauth/clients/{clientId}

Update OAuth Client

type Oauthauthorization ¶

type Oauthauthorization struct {
	// Client
	Client *Oauthclient `json:"client,omitempty"`

	// Scope
	Scope *[]string `json:"scope,omitempty"`

	// ResourceOwner
	ResourceOwner *Domainentityref `json:"resourceOwner,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"`

	// 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"`

	// CreatedBy
	CreatedBy *Domainentityref `json:"createdBy,omitempty"`

	// ModifiedBy
	ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"`

	// Pending
	Pending *bool `json:"pending,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Oauthauthorization

func (*Oauthauthorization) String ¶

func (o *Oauthauthorization) String() string

String returns a JSON representation of the model

type Oauthauthorizationlisting ¶

type Oauthauthorizationlisting struct {
	// Total
	Total *int `json:"total,omitempty"`

	// Entities
	Entities *[]Oauthauthorization `json:"entities,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`
}

Oauthauthorizationlisting

func (*Oauthauthorizationlisting) String ¶

func (o *Oauthauthorizationlisting) String() string

String returns a JSON representation of the model

type Oauthclient ¶

type Oauthclient struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the OAuth client.
	Name *string `json:"name,omitempty"`

	// AccessTokenValiditySeconds - The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied.
	AccessTokenValiditySeconds *int `json:"accessTokenValiditySeconds,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// RegisteredRedirectUri - List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback
	RegisteredRedirectUri *[]string `json:"registeredRedirectUri,omitempty"`

	// Secret - System created secret assigned to this client. Secrets are required for code authorization and client credential grants.
	Secret *string `json:"secret,omitempty"`

	// RoleIds - Deprecated. Use roleDivisions instead.
	RoleIds *[]string `json:"roleIds,omitempty"`

	// DateCreated - Date this client 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"`

	// DateModified - Date this client 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"`

	// CreatedBy - User that created this client
	CreatedBy *Domainentityref `json:"createdBy,omitempty"`

	// ModifiedBy - User that last modified this client
	ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"`

	// AuthorizedGrantType - The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. PKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client.
	AuthorizedGrantType *string `json:"authorizedGrantType,omitempty"`

	// Scope - The scope requested by this client. Scopes only apply to clients not using the client_credential grant
	Scope *[]string `json:"scope,omitempty"`

	// RoleDivisions - Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant
	RoleDivisions *[]Roledivision `json:"roleDivisions,omitempty"`

	// State - The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted.
	State *string `json:"state,omitempty"`

	// DateToDelete - The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateToDelete *time.Time `json:"dateToDelete,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Oauthclient

func (*Oauthclient) String ¶

func (o *Oauthclient) String() string

String returns a JSON representation of the model

type Oauthcliententitylisting ¶

type Oauthcliententitylisting struct {
	// Entities
	Entities *[]Oauthclientlisting `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Oauthcliententitylisting

func (*Oauthcliententitylisting) String ¶

func (o *Oauthcliententitylisting) String() string

String returns a JSON representation of the model

type Oauthclientlisting ¶

type Oauthclientlisting struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the OAuth client.
	Name *string `json:"name,omitempty"`

	// AccessTokenValiditySeconds - The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied.
	AccessTokenValiditySeconds *int `json:"accessTokenValiditySeconds,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// RegisteredRedirectUri - List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback
	RegisteredRedirectUri *[]string `json:"registeredRedirectUri,omitempty"`

	// Secret - System created secret assigned to this client. Secrets are required for code authorization and client credential grants.
	Secret *string `json:"secret,omitempty"`

	// RoleIds - Deprecated. Use roleDivisions instead.
	RoleIds *[]string `json:"roleIds,omitempty"`

	// DateCreated - Date this client 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"`

	// DateModified - Date this client 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"`

	// CreatedBy - User that created this client
	CreatedBy *Domainentityref `json:"createdBy,omitempty"`

	// ModifiedBy - User that last modified this client
	ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"`

	// Scope - The scope requested by this client. Scopes only apply to clients not using the client_credential grant
	Scope *[]string `json:"scope,omitempty"`

	// RoleDivisions - Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant
	RoleDivisions *[]Roledivision `json:"roleDivisions,omitempty"`

	// State - The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted.
	State *string `json:"state,omitempty"`

	// DateToDelete - The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateToDelete *time.Time `json:"dateToDelete,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Oauthclientlisting

func (*Oauthclientlisting) String ¶

func (o *Oauthclientlisting) String() string

String returns a JSON representation of the model

type Oauthclientrequest ¶

type Oauthclientrequest struct {
	// Name - The name of the OAuth client.
	Name *string `json:"name,omitempty"`

	// AccessTokenValiditySeconds - The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied.
	AccessTokenValiditySeconds *int `json:"accessTokenValiditySeconds,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// RegisteredRedirectUri - List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback
	RegisteredRedirectUri *[]string `json:"registeredRedirectUri,omitempty"`

	// RoleIds - Deprecated. Use roleDivisions instead.
	RoleIds *[]string `json:"roleIds,omitempty"`

	// AuthorizedGrantType - The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. PKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client.
	AuthorizedGrantType *string `json:"authorizedGrantType,omitempty"`

	// Scope - The scope requested by this client. Scopes only apply to clients not using the client_credential grant
	Scope *[]string `json:"scope,omitempty"`

	// RoleDivisions - Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant
	RoleDivisions *[]Roledivision `json:"roleDivisions,omitempty"`

	// State - The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted.
	State *string `json:"state,omitempty"`

	// DateToDelete - The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateToDelete *time.Time `json:"dateToDelete,omitempty"`
}

Oauthclientrequest

func (*Oauthclientrequest) String ¶

func (o *Oauthclientrequest) String() string

String returns a JSON representation of the model

type Oauthlasttokenissued ¶

type Oauthlasttokenissued struct {
	// DateIssued - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateIssued *time.Time `json:"dateIssued,omitempty"`
}

Oauthlasttokenissued

func (*Oauthlasttokenissued) String ¶

func (o *Oauthlasttokenissued) String() string

String returns a JSON representation of the model

type Oauthprovider ¶

type Oauthprovider 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"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Oauthprovider

func (*Oauthprovider) String ¶

func (o *Oauthprovider) String() string

String returns a JSON representation of the model

type Oauthproviderentitylisting ¶

type Oauthproviderentitylisting struct {
	// Entities
	Entities *[]Oauthprovider `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Oauthproviderentitylisting

func (*Oauthproviderentitylisting) String ¶

func (o *Oauthproviderentitylisting) String() string

String returns a JSON representation of the model

type Oauthscope ¶

type Oauthscope struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Oauthscope

func (*Oauthscope) String ¶

func (o *Oauthscope) String() string

String returns a JSON representation of the model

type Oauthscopelisting ¶

type Oauthscopelisting struct {
	// Total
	Total *int `json:"total,omitempty"`

	// Entities
	Entities *[]Oauthscope `json:"entities,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`
}

Oauthscopelisting

func (*Oauthscopelisting) String ¶

func (o *Oauthscopelisting) String() string

String returns a JSON representation of the model

type Objective ¶

type Objective struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// TemplateId - The id of this objective's base template
	TemplateId *string `json:"templateId,omitempty"`

	// Zones - Objective zone specifies min,max points and values for the associated metric
	Zones *[]Objectivezone `json:"zones,omitempty"`

	// Enabled - A flag for whether this objective is enabled for the related metric
	Enabled *bool `json:"enabled,omitempty"`

	// DateStart - start date of the objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateStart *time.Time `json:"dateStart,omitempty"`
}

Objective

func (*Objective) String ¶

func (o *Objective) String() string

String returns a JSON representation of the model

type Objectivetemplate ¶

type Objectivetemplate struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Zones
	Zones *[]Objectivezone `json:"zones,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Objectivetemplate

func (*Objectivetemplate) String ¶

func (o *Objectivetemplate) String() string

String returns a JSON representation of the model

type Objectivezone ¶

type Objectivezone struct {
	// Label - label
	Label *string `json:"label,omitempty"`

	// DirectionType - direction type
	DirectionType *string `json:"directionType,omitempty"`

	// ZoneType - zone type
	ZoneType *string `json:"zoneType,omitempty"`

	// UpperLimitPoints - upper limit points
	UpperLimitPoints *int `json:"upperLimitPoints,omitempty"`

	// LowerLimitPoints - lower limit points
	LowerLimitPoints *int `json:"lowerLimitPoints,omitempty"`

	// UpperLimitValue - upper limit value
	UpperLimitValue *int `json:"upperLimitValue,omitempty"`

	// LowerLimitValue - lower limit value
	LowerLimitValue *int `json:"lowerLimitValue,omitempty"`
}

Objectivezone

func (*Objectivezone) String ¶

func (o *Objectivezone) String() string

String returns a JSON representation of the model

type ObjectsApi ¶

type ObjectsApi struct {
	Configuration *Configuration
}

ObjectsApi provides functions for API endpoints

func NewObjectsApi ¶

func NewObjectsApi() *ObjectsApi

NewObjectsApi creates an API instance using the default configuration

func NewObjectsApiWithConfig ¶

func NewObjectsApiWithConfig(config *Configuration) *ObjectsApi

NewObjectsApiWithConfig creates an API instance using the provided configuration

func (ObjectsApi) DeleteAuthorizationDivision ¶

func (a ObjectsApi) DeleteAuthorizationDivision(divisionId string, force bool) (*APIResponse, error)

DeleteAuthorizationDivision invokes DELETE /api/v2/authorization/divisions/{divisionId}

Delete a division.

func (ObjectsApi) GetAuthorizationDivision ¶

func (a ObjectsApi) GetAuthorizationDivision(divisionId string, objectCount bool) (*Authzdivision, *APIResponse, error)

GetAuthorizationDivision invokes GET /api/v2/authorization/divisions/{divisionId}

Returns an authorization division.

func (ObjectsApi) GetAuthorizationDivisions ¶

func (a ObjectsApi) 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 \&quot;id\&quot;, e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&amp;id=72e9fb25-c484-488d-9312-7acba82435b3

func (ObjectsApi) GetAuthorizationDivisionsHome ¶

func (a ObjectsApi) 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 (ObjectsApi) GetAuthorizationDivisionsLimit ¶

func (a ObjectsApi) GetAuthorizationDivisionsLimit() (*int, *APIResponse, error)

GetAuthorizationDivisionsLimit invokes GET /api/v2/authorization/divisions/limit

Returns the maximum allowed number of divisions.

func (ObjectsApi) PostAuthorizationDivisionObject ¶

func (a ObjectsApi) 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, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\&quot;206ce31f-61ec-40ed-a8b1-be6f06303998\&quot;,\&quot;250a754e-f5e4-4f51-800f-a92f09d3bf8c\&quot;]

func (ObjectsApi) PostAuthorizationDivisionRestore ¶

func (a ObjectsApi) PostAuthorizationDivisionRestore(divisionId string, body Authzdivision) (*Authzdivision, *APIResponse, error)

PostAuthorizationDivisionRestore invokes POST /api/v2/authorization/divisions/{divisionId}/restore

Recreate a previously deleted division.

func (ObjectsApi) PostAuthorizationDivisions ¶

func (a ObjectsApi) PostAuthorizationDivisions(body Authzdivision) (*Authzdivision, *APIResponse, error)

PostAuthorizationDivisions invokes POST /api/v2/authorization/divisions

Create a division.

func (ObjectsApi) PutAuthorizationDivision ¶

func (a ObjectsApi) PutAuthorizationDivision(divisionId string, body Authzdivision) (*Authzdivision, *APIResponse, error)

PutAuthorizationDivision invokes PUT /api/v2/authorization/divisions/{divisionId}

Update a division.

type Observationmetricdata ¶

type Observationmetricdata struct {
	// Metric
	Metric *string `json:"metric,omitempty"`

	// Qualifier
	Qualifier *string `json:"qualifier,omitempty"`

	// Stats
	Stats *Statisticalsummary `json:"stats,omitempty"`

	// Truncated - Flag for a truncated list of observations. If truncated, the first half of the list of observations will contain the oldest observations and the second half the newest observations.
	Truncated *bool `json:"truncated,omitempty"`

	// Observations - List of observations sorted by timestamp in ascending order. This list may be truncated.
	Observations *[]Observationvalue `json:"observations,omitempty"`
}

Observationmetricdata

func (*Observationmetricdata) String ¶

func (o *Observationmetricdata) String() string

String returns a JSON representation of the model

type Observationvalue ¶

type Observationvalue struct {
	// ObservationDate - The time at which the observation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ObservationDate *time.Time `json:"observationDate,omitempty"`

	// ConversationId - Unique identifier for the conversation
	ConversationId *string `json:"conversationId,omitempty"`

	// SessionId - The unique identifier of this session
	SessionId *string `json:"sessionId,omitempty"`

	// RequestedRoutingSkillIds - Unique identifier for a skill requested for an interaction
	RequestedRoutingSkillIds *[]string `json:"requestedRoutingSkillIds,omitempty"`

	// RequestedLanguageId - Unique identifier for the language requested for an interaction
	RequestedLanguageId *string `json:"requestedLanguageId,omitempty"`

	// RoutingPriority - Routing priority for the current interaction
	RoutingPriority *int `json:"routingPriority,omitempty"`

	// ParticipantName - A human readable name identifying the participant
	ParticipantName *string `json:"participantName,omitempty"`

	// UserId - Unique identifier for the user
	UserId *string `json:"userId,omitempty"`

	// Direction - The direction of the communication
	Direction *string `json:"direction,omitempty"`

	// ConvertedFrom - Session media type that was converted from in case of a media type conversion
	ConvertedFrom *string `json:"convertedFrom,omitempty"`

	// ConvertedTo - Session media type that was converted to in case of a media type conversion
	ConvertedTo *string `json:"convertedTo,omitempty"`

	// AddressFrom - The address that initiated an action
	AddressFrom *string `json:"addressFrom,omitempty"`

	// AddressTo - The address receiving an action
	AddressTo *string `json:"addressTo,omitempty"`

	// Ani - Automatic Number Identification (caller's number)
	Ani *string `json:"ani,omitempty"`

	// Dnis - Dialed number identification service (number dialed by the calling party)
	Dnis *string `json:"dnis,omitempty"`

	// TeamId - The team id the user is a member of
	TeamId *string `json:"teamId,omitempty"`

	// RequestedRoutings - All routing types for requested/attempted routing methods
	RequestedRoutings *[]string `json:"requestedRoutings,omitempty"`

	// UsedRouting - Complete routing method
	UsedRouting *string `json:"usedRouting,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Analyticsscoredagent `json:"scoredAgents,omitempty"`
}

Observationvalue

func (*Observationvalue) String ¶

func (o *Observationvalue) String() string

String returns a JSON representation of the model

type Okta ¶

type Okta 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"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Okta

func (*Okta) String ¶

func (o *Okta) String() string

String returns a JSON representation of the model

type Onelogin ¶

type Onelogin 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"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Onelogin

func (*Onelogin) String ¶

func (o *Onelogin) String() string

String returns a JSON representation of the model

type Openintegration ¶

type Openintegration struct {
	// Id - A unique Integration Id.
	Id *string `json:"id,omitempty"`

	// Name - The name of the Open messaging integration.
	Name *string `json:"name,omitempty"`

	// OutboundNotificationWebhookUrl - The outbound notification webhook URL for the Open messaging integration.
	OutboundNotificationWebhookUrl *string `json:"outboundNotificationWebhookUrl,omitempty"`

	// OutboundNotificationWebhookSignatureSecretToken - The outbound notification webhook signature secret token.
	OutboundNotificationWebhookSignatureSecretToken *string `json:"outboundNotificationWebhookSignatureSecretToken,omitempty"`

	// WebhookHeaders - The user specified headers for the Open messaging integration.
	WebhookHeaders *map[string]string `json:"webhookHeaders,omitempty"`

	// Status - The status of the Open Integration
	Status *string `json:"status,omitempty"`

	// Recipient - The recipient associated to the Open messaging Integration. This recipient is used to associate a flow to an integration
	Recipient *Domainentityref `json:"recipient,omitempty"`

	// DateCreated - Date this Integration 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"`

	// DateModified - Date this Integration 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"`

	// CreatedBy - User reference that created this Integration
	CreatedBy *Domainentityref `json:"createdBy,omitempty"`

	// ModifiedBy - User reference that last modified this Integration
	ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"`

	// CreateStatus - Status of asynchronous create operation
	CreateStatus *string `json:"createStatus,omitempty"`

	// CreateError - Error information returned, if createStatus is set to Error
	CreateError *Errorbody `json:"createError,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Openintegration

func (*Openintegration) String ¶

func (o *Openintegration) String() string

String returns a JSON representation of the model

type Openintegrationentitylisting ¶

type Openintegrationentitylisting struct {
	// Entities
	Entities *[]Openintegration `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Openintegrationentitylisting

func (*Openintegrationentitylisting) String ¶

String returns a JSON representation of the model

type Openintegrationrequest ¶

type Openintegrationrequest struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the Open messaging integration.
	Name *string `json:"name,omitempty"`

	// OutboundNotificationWebhookUrl - The outbound notification webhook URL for the Open messaging integration.
	OutboundNotificationWebhookUrl *string `json:"outboundNotificationWebhookUrl,omitempty"`

	// OutboundNotificationWebhookSignatureSecretToken - The outbound notification webhook signature secret token.
	OutboundNotificationWebhookSignatureSecretToken *string `json:"outboundNotificationWebhookSignatureSecretToken,omitempty"`

	// WebhookHeaders - The user specified headers for the Open messaging integration.
	WebhookHeaders *map[string]string `json:"webhookHeaders,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Openintegrationrequest

func (*Openintegrationrequest) String ¶

func (o *Openintegrationrequest) String() string

String returns a JSON representation of the model

type Openintegrationupdaterequest ¶

type Openintegrationupdaterequest struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the Open messaging integration.
	Name *string `json:"name,omitempty"`

	// OutboundNotificationWebhookUrl - The outbound notification webhook URL for the Open messaging integration.
	OutboundNotificationWebhookUrl *string `json:"outboundNotificationWebhookUrl,omitempty"`

	// OutboundNotificationWebhookSignatureSecretToken - The outbound notification webhook signature secret token.
	OutboundNotificationWebhookSignatureSecretToken *string `json:"outboundNotificationWebhookSignatureSecretToken,omitempty"`

	// WebhookHeaders - The user specified headers for the Open messaging integration.
	WebhookHeaders *map[string]string `json:"webhookHeaders,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Openintegrationupdaterequest

func (*Openintegrationupdaterequest) String ¶

String returns a JSON representation of the model

type Openmessagecontent ¶

type Openmessagecontent struct {
	// ContentType - Type of this content element. If contentType = \"Attachment\" only one item is allowed.
	ContentType *string `json:"contentType,omitempty"`

	// Attachment - Attachment content.
	Attachment *Contentattachment `json:"attachment,omitempty"`
}

Openmessagecontent - Message content element.

func (*Openmessagecontent) String ¶

func (o *Openmessagecontent) String() string

String returns a JSON representation of the model

type Openmessagingchannel ¶

type Openmessagingchannel struct {
	// Id - The Messaging Platform integration ID.
	Id *string `json:"id,omitempty"`

	// Platform - The provider type.
	Platform *string `json:"platform,omitempty"`

	// VarType - Specifies if this message is part of a private or public conversation.
	VarType *string `json:"type,omitempty"`

	// MessageId - Unique provider ID of the message such as a Facebook message ID.
	MessageId *string `json:"messageId,omitempty"`

	// To - Information about the recipient the message is sent to.
	To *Openmessagingtorecipient `json:"to,omitempty"`

	// From - Information about the recipient the message is received from.
	From *Openmessagingfromrecipient `json:"from,omitempty"`

	// Time - Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Time *time.Time `json:"time,omitempty"`
}

Openmessagingchannel - Channel-specific information that describes the message and the message channel/provider.

func (*Openmessagingchannel) String ¶

func (o *Openmessagingchannel) String() string

String returns a JSON representation of the model

type Openmessagingfromrecipient ¶

type Openmessagingfromrecipient struct {
	// Nickname - Nickname or display name of the recipient.
	Nickname *string `json:"nickname,omitempty"`

	// Id - The recipient ID specific to the provider.
	Id *string `json:"id,omitempty"`

	// IdType - The recipient ID type. This is used to indicate the format used for the ID.
	IdType *string `json:"idType,omitempty"`

	// FirstName - First name of the recipient.
	FirstName *string `json:"firstName,omitempty"`

	// LastName - Last name of the recipient.
	LastName *string `json:"lastName,omitempty"`
}

Openmessagingfromrecipient - Information about the recipient the message is received from.

func (*Openmessagingfromrecipient) String ¶

func (o *Openmessagingfromrecipient) String() string

String returns a JSON representation of the model

type Openmessagingtorecipient ¶

type Openmessagingtorecipient struct {
	// Nickname - Nickname or display name of the recipient.
	Nickname *string `json:"nickname,omitempty"`

	// Id - The recipient ID specific to the provider.
	Id *string `json:"id,omitempty"`

	// IdType - The recipient ID type. This is used to indicate the format used for the ID.
	IdType *string `json:"idType,omitempty"`

	// FirstName - First name of the recipient.
	FirstName *string `json:"firstName,omitempty"`

	// LastName - Last name of the recipient.
	LastName *string `json:"lastName,omitempty"`
}

Openmessagingtorecipient - Information about the recipient the message is sent to.

func (*Openmessagingtorecipient) String ¶

func (o *Openmessagingtorecipient) String() string

String returns a JSON representation of the model

type Opennormalizedmessage ¶

type Opennormalizedmessage struct {
	// Id - Unique ID of the message. This ID is generated by Messaging Platform. Message receipts will have the same ID as the message they reference.
	Id *string `json:"id,omitempty"`

	// Channel - Channel-specific information that describes the message and the message channel/provider.
	Channel *Openmessagingchannel `json:"channel,omitempty"`

	// VarType - Message type.
	VarType *string `json:"type,omitempty"`

	// Text - Message text.
	Text *string `json:"text,omitempty"`

	// Content - List of content elements.
	Content *[]Openmessagecontent `json:"content,omitempty"`

	// Direction - The direction of the message.
	Direction *string `json:"direction,omitempty"`
}

Opennormalizedmessage - Open Messaging rich media message structure

func (*Opennormalizedmessage) String ¶

func (o *Opennormalizedmessage) String() string

String returns a JSON representation of the model

type Operation ¶

type Operation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Complete
	Complete *bool `json:"complete,omitempty"`

	// User
	User *User `json:"user,omitempty"`

	// Client
	Client *Domainentityref `json:"client,omitempty"`

	// ErrorMessage
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// ErrorDetails
	ErrorDetails *[]Detail `json:"errorDetails,omitempty"`

	// ErrorMessageParams
	ErrorMessageParams *map[string]string `json:"errorMessageParams,omitempty"`

	// ActionName - Action name
	ActionName *string `json:"actionName,omitempty"`

	// ActionStatus - Action status
	ActionStatus *string `json:"actionStatus,omitempty"`
}

Operation

func (*Operation) String ¶

func (o *Operation) String() string

String returns a JSON representation of the model

type Organization ¶

type Organization struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// DefaultLanguage - The default language for this organization. Example: 'en'
	DefaultLanguage *string `json:"defaultLanguage,omitempty"`

	// DefaultCountryCode - The default country code for this organization. Example: 'US'
	DefaultCountryCode *string `json:"defaultCountryCode,omitempty"`

	// ThirdPartyOrgName - The short name for the organization. This field is globally unique and cannot be changed.
	ThirdPartyOrgName *string `json:"thirdPartyOrgName,omitempty"`

	// ThirdPartyURI
	ThirdPartyURI *string `json:"thirdPartyURI,omitempty"`

	// Domain
	Domain *string `json:"domain,omitempty"`

	// Version - The current version of the organization.
	Version *int `json:"version,omitempty"`

	// State - The current state. Examples are active, inactive, deleted.
	State *string `json:"state,omitempty"`

	// DefaultSiteId
	DefaultSiteId *string `json:"defaultSiteId,omitempty"`

	// SupportURI - Email address where support tickets are sent to.
	SupportURI *string `json:"supportURI,omitempty"`

	// VoicemailEnabled
	VoicemailEnabled *bool `json:"voicemailEnabled,omitempty"`

	// ProductPlatform - Organizations Originating Platform.
	ProductPlatform *string `json:"productPlatform,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// Features - The state of features available for the organization.
	Features *map[string]bool `json:"features,omitempty"`
}

Organization

func (*Organization) String ¶

func (o *Organization) String() string

String returns a JSON representation of the model

type OrganizationApi ¶

type OrganizationApi struct {
	Configuration *Configuration
}

OrganizationApi provides functions for API endpoints

func NewOrganizationApi ¶

func NewOrganizationApi() *OrganizationApi

NewOrganizationApi creates an API instance using the default configuration

func NewOrganizationApiWithConfig ¶

func NewOrganizationApiWithConfig(config *Configuration) *OrganizationApi

NewOrganizationApiWithConfig creates an API instance using the provided configuration

func (OrganizationApi) GetFieldconfig ¶

func (a OrganizationApi) GetFieldconfig(varType string) (*Fieldconfig, *APIResponse, error)

GetFieldconfig invokes GET /api/v2/fieldconfig

Fetch field config for an entity type

func (OrganizationApi) GetOrganizationsEmbeddedintegration ¶

func (a OrganizationApi) GetOrganizationsEmbeddedintegration() (*Embeddedintegration, *APIResponse, error)

GetOrganizationsEmbeddedintegration invokes GET /api/v2/organizations/embeddedintegration

Get the list of domains that will be allowed to embed PureCloud applications

func (OrganizationApi) GetOrganizationsIpaddressauthentication ¶

func (a OrganizationApi) GetOrganizationsIpaddressauthentication() (*Ipaddressauthentication, *APIResponse, error)

GetOrganizationsIpaddressauthentication invokes GET /api/v2/organizations/ipaddressauthentication

Get organization IP address whitelist settings

func (OrganizationApi) GetOrganizationsLimitsChangerequest ¶

func (a OrganizationApi) GetOrganizationsLimitsChangerequest(requestId string) (*Limitchangerequestdetails, *APIResponse, error)

GetOrganizationsLimitsChangerequest invokes GET /api/v2/organizations/limits/changerequests/{requestId}

Get a limit change request

func (OrganizationApi) GetOrganizationsLimitsChangerequests ¶

func (a OrganizationApi) GetOrganizationsLimitsChangerequests(after int, before int, status string, pageSize int, expand []string) (*Limitchangerequestsentitylisting, *APIResponse, error)

GetOrganizationsLimitsChangerequests invokes GET /api/v2/organizations/limits/changerequests

Get the available limit change requests ¶

Timestamp interval defaults to the last 365 days if both query parameters are omitted. If only one parameter is omitted, the interval will default to a 180 day range in the specified direction.

func (OrganizationApi) GetOrganizationsLimitsDocs ¶

func (a OrganizationApi) GetOrganizationsLimitsDocs() (*Urlresponse, *APIResponse, error)

GetOrganizationsLimitsDocs invokes GET /api/v2/organizations/limits/docs

Get a link to the limit documentation

func (OrganizationApi) GetOrganizationsLimitsNamespace ¶

func (a OrganizationApi) GetOrganizationsLimitsNamespace(namespaceName string) (*Limitsentitylisting, *APIResponse, error)

GetOrganizationsLimitsNamespace invokes GET /api/v2/organizations/limits/namespaces/{namespaceName}

Get the effective limits in a namespace for an organization

func (OrganizationApi) GetOrganizationsLimitsNamespaces ¶

func (a OrganizationApi) GetOrganizationsLimitsNamespaces(pageSize int, pageNumber int) (*Limitsentitylisting, *APIResponse, error)

GetOrganizationsLimitsNamespaces invokes GET /api/v2/organizations/limits/namespaces

Get the available limit namespaces

func (OrganizationApi) GetOrganizationsMe ¶

func (a OrganizationApi) GetOrganizationsMe() (*Organization, *APIResponse, error)

GetOrganizationsMe invokes GET /api/v2/organizations/me

Get organization.

func (OrganizationApi) GetOrganizationsWhitelist ¶

func (a OrganizationApi) GetOrganizationsWhitelist() (*Orgwhitelistsettings, *APIResponse, error)

GetOrganizationsWhitelist invokes GET /api/v2/organizations/whitelist

Use PUT /api/v2/organizations/embeddedintegration instead

func (OrganizationApi) PatchOrganizationsFeature ¶

func (a OrganizationApi) PatchOrganizationsFeature(featureName string, enabled Featurestate) (*Organizationfeatures, *APIResponse, error)

PatchOrganizationsFeature invokes PATCH /api/v2/organizations/features/{featureName}

Update organization

func (OrganizationApi) PutOrganizationsEmbeddedintegration ¶

func (a OrganizationApi) PutOrganizationsEmbeddedintegration(body Embeddedintegration) (*Embeddedintegration, *APIResponse, error)

PutOrganizationsEmbeddedintegration invokes PUT /api/v2/organizations/embeddedintegration

Update the list of domains that will be allowed to embed PureCloud applications

func (OrganizationApi) PutOrganizationsIpaddressauthentication ¶

func (a OrganizationApi) PutOrganizationsIpaddressauthentication(body Ipaddressauthentication) (*Ipaddressauthentication, *APIResponse, error)

PutOrganizationsIpaddressauthentication invokes PUT /api/v2/organizations/ipaddressauthentication

Update organization IP address whitelist settings

func (OrganizationApi) PutOrganizationsMe ¶

func (a OrganizationApi) PutOrganizationsMe(body Organization) (*Organization, *APIResponse, error)

PutOrganizationsMe invokes PUT /api/v2/organizations/me

Update organization.

func (OrganizationApi) PutOrganizationsWhitelist ¶

func (a OrganizationApi) PutOrganizationsWhitelist(body Orgwhitelistsettings) (*Orgwhitelistsettings, *APIResponse, error)

PutOrganizationsWhitelist invokes PUT /api/v2/organizations/whitelist

Use PUT /api/v2/organizations/embeddedintegration instead

type OrganizationAuthorizationApi ¶

type OrganizationAuthorizationApi struct {
	Configuration *Configuration
}

OrganizationAuthorizationApi provides functions for API endpoints

func NewOrganizationAuthorizationApi ¶

func NewOrganizationAuthorizationApi() *OrganizationAuthorizationApi

NewOrganizationAuthorizationApi creates an API instance using the default configuration

func NewOrganizationAuthorizationApiWithConfig ¶

func NewOrganizationAuthorizationApiWithConfig(config *Configuration) *OrganizationAuthorizationApi

NewOrganizationAuthorizationApiWithConfig creates an API instance using the provided configuration

func (OrganizationAuthorizationApi) DeleteOrgauthorizationTrustee ¶

func (a OrganizationAuthorizationApi) DeleteOrgauthorizationTrustee(trusteeOrgId string) (*APIResponse, error)

DeleteOrgauthorizationTrustee invokes DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}

Delete Org Trust

func (OrganizationAuthorizationApi) DeleteOrgauthorizationTrusteeUser ¶

func (a OrganizationAuthorizationApi) DeleteOrgauthorizationTrusteeUser(trusteeOrgId string, trusteeUserId string) (*APIResponse, error)

DeleteOrgauthorizationTrusteeUser invokes DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}

Delete Trustee User

func (OrganizationAuthorizationApi) DeleteOrgauthorizationTrusteeUserRoles ¶

func (a OrganizationAuthorizationApi) DeleteOrgauthorizationTrusteeUserRoles(trusteeOrgId string, trusteeUserId string) (*APIResponse, error)

DeleteOrgauthorizationTrusteeUserRoles invokes DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles

Delete Trustee User Roles

func (OrganizationAuthorizationApi) DeleteOrgauthorizationTrustor ¶

func (a OrganizationAuthorizationApi) DeleteOrgauthorizationTrustor(trustorOrgId string) (*APIResponse, error)

DeleteOrgauthorizationTrustor invokes DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}

Delete Org Trust

func (OrganizationAuthorizationApi) DeleteOrgauthorizationTrustorUser ¶

func (a OrganizationAuthorizationApi) DeleteOrgauthorizationTrustorUser(trustorOrgId string, trusteeUserId string) (*APIResponse, error)

DeleteOrgauthorizationTrustorUser invokes DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}

Delete Trustee User

func (OrganizationAuthorizationApi) GetOrgauthorizationPairing ¶

func (a OrganizationAuthorizationApi) GetOrgauthorizationPairing(pairingId string) (*Trustrequest, *APIResponse, error)

GetOrgauthorizationPairing invokes GET /api/v2/orgauthorization/pairings/{pairingId}

Get Pairing Info

func (OrganizationAuthorizationApi) GetOrgauthorizationTrustee ¶

func (a OrganizationAuthorizationApi) GetOrgauthorizationTrustee(trusteeOrgId string) (*Trustee, *APIResponse, error)

GetOrgauthorizationTrustee invokes GET /api/v2/orgauthorization/trustees/{trusteeOrgId}

Get Org Trust

func (OrganizationAuthorizationApi) GetOrgauthorizationTrusteeUser ¶

func (a OrganizationAuthorizationApi) GetOrgauthorizationTrusteeUser(trusteeOrgId string, trusteeUserId string) (*Trustuser, *APIResponse, error)

GetOrgauthorizationTrusteeUser invokes GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}

Get Trustee User

func (OrganizationAuthorizationApi) GetOrgauthorizationTrusteeUserRoles ¶

func (a OrganizationAuthorizationApi) GetOrgauthorizationTrusteeUserRoles(trusteeOrgId string, trusteeUserId string) (*Userauthorization, *APIResponse, error)

GetOrgauthorizationTrusteeUserRoles invokes GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles

Get Trustee User Roles

func (OrganizationAuthorizationApi) GetOrgauthorizationTrusteeUsers ¶

func (a OrganizationAuthorizationApi) GetOrgauthorizationTrusteeUsers(trusteeOrgId string, pageSize int, pageNumber int) (*Trustuserentitylisting, *APIResponse, error)

GetOrgauthorizationTrusteeUsers invokes GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users

The list of trustee users for this organization (i.e. users granted access to this organization).

func (OrganizationAuthorizationApi) GetOrgauthorizationTrustees ¶

func (a OrganizationAuthorizationApi) GetOrgauthorizationTrustees(pageSize int, pageNumber int) (*Trustentitylisting, *APIResponse, error)

GetOrgauthorizationTrustees invokes GET /api/v2/orgauthorization/trustees

The list of trustees for this organization (i.e. organizations granted access to this organization).

func (OrganizationAuthorizationApi) GetOrgauthorizationTrustor ¶

func (a OrganizationAuthorizationApi) GetOrgauthorizationTrustor(trustorOrgId string) (*Trustor, *APIResponse, error)

GetOrgauthorizationTrustor invokes GET /api/v2/orgauthorization/trustors/{trustorOrgId}

Get Org Trust

func (OrganizationAuthorizationApi) GetOrgauthorizationTrustorUser ¶

func (a OrganizationAuthorizationApi) GetOrgauthorizationTrustorUser(trustorOrgId string, trusteeUserId string) (*Trustuser, *APIResponse, error)

GetOrgauthorizationTrustorUser invokes GET /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}

Get Trustee User

func (OrganizationAuthorizationApi) GetOrgauthorizationTrustorUsers ¶

func (a OrganizationAuthorizationApi) GetOrgauthorizationTrustorUsers(trustorOrgId string, pageSize int, pageNumber int) (*Trustuserentitylisting, *APIResponse, error)

GetOrgauthorizationTrustorUsers invokes GET /api/v2/orgauthorization/trustors/{trustorOrgId}/users

The list of users in the trustor organization (i.e. users granted access).

func (OrganizationAuthorizationApi) GetOrgauthorizationTrustors ¶

func (a OrganizationAuthorizationApi) GetOrgauthorizationTrustors(pageSize int, pageNumber int) (*Trustorentitylisting, *APIResponse, error)

GetOrgauthorizationTrustors invokes GET /api/v2/orgauthorization/trustors

The list of organizations that have authorized/trusted your organization.

func (OrganizationAuthorizationApi) PostOrgauthorizationPairings ¶

func (a OrganizationAuthorizationApi) PostOrgauthorizationPairings(body Trustrequestcreate) (*Trustrequest, *APIResponse, error)

PostOrgauthorizationPairings invokes POST /api/v2/orgauthorization/pairings

A pairing id is created by the trustee and given to the trustor to create a trust.

func (OrganizationAuthorizationApi) PostOrgauthorizationTrusteeUsers ¶

func (a OrganizationAuthorizationApi) PostOrgauthorizationTrusteeUsers(trusteeOrgId string, body Trustmembercreate) (*Trustuser, *APIResponse, error)

PostOrgauthorizationTrusteeUsers invokes POST /api/v2/orgauthorization/trustees/{trusteeOrgId}/users

Add a user to the trust.

func (OrganizationAuthorizationApi) PostOrgauthorizationTrustees ¶

func (a OrganizationAuthorizationApi) PostOrgauthorizationTrustees(body Trustcreate) (*Trustee, *APIResponse, error)

PostOrgauthorizationTrustees invokes POST /api/v2/orgauthorization/trustees

Create a new organization authorization trust. This is required to grant other organizations access to your organization.

func (OrganizationAuthorizationApi) PostOrgauthorizationTrusteesAudits ¶

func (a OrganizationAuthorizationApi) PostOrgauthorizationTrusteesAudits(body Trusteeauditqueryrequest, pageSize int, pageNumber int, sortBy string, sortOrder string) (*Auditqueryresponse, *APIResponse, error)

PostOrgauthorizationTrusteesAudits invokes POST /api/v2/orgauthorization/trustees/audits

Get Org Trustee Audits

func (OrganizationAuthorizationApi) PostOrgauthorizationTrustorAudits ¶

func (a OrganizationAuthorizationApi) PostOrgauthorizationTrustorAudits(body Trustorauditqueryrequest, pageSize int, pageNumber int, sortBy string, sortOrder string) (*Auditqueryresponse, *APIResponse, error)

PostOrgauthorizationTrustorAudits invokes POST /api/v2/orgauthorization/trustor/audits

Get Org Trustor Audits

func (OrganizationAuthorizationApi) PutOrgauthorizationTrustee ¶

func (a OrganizationAuthorizationApi) PutOrgauthorizationTrustee(trusteeOrgId string, body Trustupdate) (*Trustee, *APIResponse, error)

PutOrgauthorizationTrustee invokes PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}

Update Org Trust

func (OrganizationAuthorizationApi) PutOrgauthorizationTrusteeUserRoledivisions ¶

func (a OrganizationAuthorizationApi) PutOrgauthorizationTrusteeUserRoledivisions(trusteeOrgId string, trusteeUserId string, body Roledivisiongrants) (*Userauthorization, *APIResponse, error)

PutOrgauthorizationTrusteeUserRoledivisions invokes PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roledivisions

Update Trustee User Roles

func (OrganizationAuthorizationApi) PutOrgauthorizationTrusteeUserRoles ¶

func (a OrganizationAuthorizationApi) PutOrgauthorizationTrusteeUserRoles(trusteeOrgId string, trusteeUserId string, body []string) (*Userauthorization, *APIResponse, error)

PutOrgauthorizationTrusteeUserRoles invokes PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles

Update Trustee User Roles

func (OrganizationAuthorizationApi) PutOrgauthorizationTrustorUser ¶

func (a OrganizationAuthorizationApi) PutOrgauthorizationTrustorUser(trustorOrgId string, trusteeUserId string) (*Trustuser, *APIResponse, error)

PutOrgauthorizationTrustorUser invokes PUT /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}

Add a Trustee user to the trust.

type Organizationfeatures ¶

type Organizationfeatures struct {
	// RealtimeCIC
	RealtimeCIC *bool `json:"realtimeCIC,omitempty"`

	// Purecloud
	Purecloud *bool `json:"purecloud,omitempty"`

	// Hipaa
	Hipaa *bool `json:"hipaa,omitempty"`

	// UcEnabled
	UcEnabled *bool `json:"ucEnabled,omitempty"`

	// Pci
	Pci *bool `json:"pci,omitempty"`

	// PurecloudVoice
	PurecloudVoice *bool `json:"purecloudVoice,omitempty"`

	// XmppFederation
	XmppFederation *bool `json:"xmppFederation,omitempty"`

	// Chat
	Chat *bool `json:"chat,omitempty"`

	// InformalPhotos
	InformalPhotos *bool `json:"informalPhotos,omitempty"`

	// Directory
	Directory *bool `json:"directory,omitempty"`

	// ContactCenter
	ContactCenter *bool `json:"contactCenter,omitempty"`

	// UnifiedCommunications
	UnifiedCommunications *bool `json:"unifiedCommunications,omitempty"`

	// Custserv
	Custserv *bool `json:"custserv,omitempty"`
}

Organizationfeatures

func (*Organizationfeatures) String ¶

func (o *Organizationfeatures) String() string

String returns a JSON representation of the model

type Organizationpresence ¶

type Organizationpresence struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// LanguageLabels - The label used for the system presence in each specified language
	LanguageLabels *map[string]string `json:"languageLabels,omitempty"`

	// SystemPresence
	SystemPresence *string `json:"systemPresence,omitempty"`

	// Deactivated
	Deactivated *bool `json:"deactivated,omitempty"`

	// Primary
	Primary *bool `json:"primary,omitempty"`

	// CreatedBy
	CreatedBy *User `json:"createdBy,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"`

	// ModifiedBy
	ModifiedBy *User `json:"modifiedBy,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"`
}

Organizationpresence

func (*Organizationpresence) String ¶

func (o *Organizationpresence) String() string

String returns a JSON representation of the model

type Organizationpresenceentitylisting ¶

type Organizationpresenceentitylisting struct {
	// Entities
	Entities *[]Organizationpresence `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Organizationpresenceentitylisting

func (*Organizationpresenceentitylisting) String ¶

String returns a JSON representation of the model

type Organizationproductentitylisting ¶

type Organizationproductentitylisting struct {
	// Entities
	Entities *[]Domainorganizationproduct `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"`
}

Organizationproductentitylisting

func (*Organizationproductentitylisting) String ¶

String returns a JSON representation of the model

type Organizationroleentitylisting ¶

type Organizationroleentitylisting struct {
	// Entities
	Entities *[]Domainorganizationrole `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Organizationroleentitylisting

func (*Organizationroleentitylisting) String ¶

String returns a JSON representation of the model

type Orgoauthclient ¶

type Orgoauthclient struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the OAuth client.
	Name *string `json:"name,omitempty"`

	// DateCreated - Date this client 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"`

	// DateModified - Date this client 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"`

	// CreatedBy - User that created this client
	CreatedBy *Domainentityref `json:"createdBy,omitempty"`

	// ModifiedBy - User that last modified this client
	ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"`

	// AuthorizedGrantType - The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. PKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client.
	AuthorizedGrantType *string `json:"authorizedGrantType,omitempty"`

	// Scope - The scope requested by this client. Scopes only apply to clients not using the client_credential grant
	Scope *[]string `json:"scope,omitempty"`

	// RoleDivisions - Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant
	RoleDivisions *[]Roledivision `json:"roleDivisions,omitempty"`

	// State - The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted.
	State *string `json:"state,omitempty"`

	// DateToDelete - The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateToDelete *time.Time `json:"dateToDelete,omitempty"`

	// Organization - The  oauth client's organization.
	Organization *Namedentity `json:"organization,omitempty"`
}

Orgoauthclient

func (*Orgoauthclient) String ¶

func (o *Orgoauthclient) String() string

String returns a JSON representation of the model

type Orguser ¶

type Orguser 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"`

	// Chat
	Chat *Chat `json:"chat,omitempty"`

	// Department
	Department *string `json:"department,omitempty"`

	// Email
	Email *string `json:"email,omitempty"`

	// PrimaryContactInfo - Auto populated from addresses.
	PrimaryContactInfo *[]Contact `json:"primaryContactInfo,omitempty"`

	// Addresses - Email addresses and phone numbers for this user
	Addresses *[]Contact `json:"addresses,omitempty"`

	// State - The current state for this user.
	State *string `json:"state,omitempty"`

	// Title
	Title *string `json:"title,omitempty"`

	// Username
	Username *string `json:"username,omitempty"`

	// Manager
	Manager **User `json:"manager,omitempty"`

	// Images
	Images *[]Userimage `json:"images,omitempty"`

	// Version - Required when updating a user, this value should be the current version of the user.  The current version can be obtained with a GET on the user before doing a PATCH.
	Version *int `json:"version,omitempty"`

	// Certifications
	Certifications *[]string `json:"certifications,omitempty"`

	// Biography
	Biography *Biography `json:"biography,omitempty"`

	// EmployerInfo
	EmployerInfo *Employerinfo `json:"employerInfo,omitempty"`

	// RoutingStatus - ACD routing status
	RoutingStatus *Routingstatus `json:"routingStatus,omitempty"`

	// Presence - Active presence
	Presence *Userpresence `json:"presence,omitempty"`

	// ConversationSummary - Summary of conversion statistics for conversation types.
	ConversationSummary *Userconversationsummary `json:"conversationSummary,omitempty"`

	// OutOfOffice - Determine if out of office is enabled
	OutOfOffice *Outofoffice `json:"outOfOffice,omitempty"`

	// Geolocation - Current geolocation position
	Geolocation *Geolocation `json:"geolocation,omitempty"`

	// Station - Effective, default, and last station information
	Station *Userstations `json:"station,omitempty"`

	// Authorization - Roles and permissions assigned to the user
	Authorization *Userauthorization `json:"authorization,omitempty"`

	// ProfileSkills - Profile skills possessed by the user
	ProfileSkills *[]string `json:"profileSkills,omitempty"`

	// Locations - The user placement at each site location.
	Locations *[]Location `json:"locations,omitempty"`

	// Groups - The groups the user is a member of
	Groups *[]Group `json:"groups,omitempty"`

	// Team - The team the user is a member of
	Team *Team `json:"team,omitempty"`

	// Skills - Routing (ACD) skills possessed by the user
	Skills *[]Userroutingskill `json:"skills,omitempty"`

	// Languages - Routing (ACD) languages possessed by the user
	Languages *[]Userroutinglanguage `json:"languages,omitempty"`

	// AcdAutoAnswer - acd auto answer
	AcdAutoAnswer *bool `json:"acdAutoAnswer,omitempty"`

	// LanguagePreference - preferred language by the user
	LanguagePreference *string `json:"languagePreference,omitempty"`

	// LastTokenIssued
	LastTokenIssued *Oauthlasttokenissued `json:"lastTokenIssued,omitempty"`

	// Organization
	Organization *Organization `json:"organization,omitempty"`
}

Orguser

func (*Orguser) String ¶

func (o *Orguser) String() string

String returns a JSON representation of the model

type Orgwhitelistsettings ¶

type Orgwhitelistsettings struct {
	// EnableWhitelist
	EnableWhitelist *bool `json:"enableWhitelist,omitempty"`

	// DomainWhitelist
	DomainWhitelist *[]string `json:"domainWhitelist,omitempty"`
}

Orgwhitelistsettings

func (*Orgwhitelistsettings) String ¶

func (o *Orgwhitelistsettings) String() string

String returns a JSON representation of the model

type Orphanrecording ¶

type Orphanrecording struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// CreatedTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CreatedTime *time.Time `json:"createdTime,omitempty"`

	// RecoveredTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	RecoveredTime *time.Time `json:"recoveredTime,omitempty"`

	// ProviderType
	ProviderType *string `json:"providerType,omitempty"`

	// MediaSizeBytes
	MediaSizeBytes *int `json:"mediaSizeBytes,omitempty"`

	// MediaType
	MediaType *string `json:"mediaType,omitempty"`

	// FileState
	FileState *string `json:"fileState,omitempty"`

	// ProviderEndpoint
	ProviderEndpoint *Endpoint `json:"providerEndpoint,omitempty"`

	// Recording
	Recording *Recording `json:"recording,omitempty"`

	// OrphanStatus - The status of the orphaned recording's conversation.
	OrphanStatus *string `json:"orphanStatus,omitempty"`

	// SourceOrphaningId - An identifier used during recovery operations by the supplying hybrid platform to track back and determine which interaction this recording is associated with
	SourceOrphaningId *string `json:"sourceOrphaningId,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Orphanrecording

func (*Orphanrecording) String ¶

func (o *Orphanrecording) String() string

String returns a JSON representation of the model

type Orphanrecordinglisting ¶

type Orphanrecordinglisting struct {
	// Entities
	Entities *[]Orphanrecording `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Orphanrecordinglisting

func (*Orphanrecordinglisting) String ¶

func (o *Orphanrecordinglisting) String() string

String returns a JSON representation of the model

type Orphanupdaterequest ¶

type Orphanupdaterequest struct {
	// ArchiveDate - The orphan recording's archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ArchiveDate *time.Time `json:"archiveDate,omitempty"`

	// DeleteDate - The orphan recording's delete date. Must be greater than archiveDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DeleteDate *time.Time `json:"deleteDate,omitempty"`

	// ConversationId - A conversation Id that this orphan's recording is to be attached to. If not present, the conversationId will be deduced from the recording media.
	ConversationId *string `json:"conversationId,omitempty"`
}

Orphanupdaterequest

func (*Orphanupdaterequest) String ¶

func (o *Orphanupdaterequest) String() string

String returns a JSON representation of the model

type OutboundApi ¶

type OutboundApi struct {
	Configuration *Configuration
}

OutboundApi provides functions for API endpoints

func NewOutboundApi ¶

func NewOutboundApi() *OutboundApi

NewOutboundApi creates an API instance using the default configuration

func NewOutboundApiWithConfig ¶

func NewOutboundApiWithConfig(config *Configuration) *OutboundApi

NewOutboundApiWithConfig creates an API instance using the provided configuration

func (OutboundApi) DeleteOutboundAttemptlimit ¶

func (a OutboundApi) DeleteOutboundAttemptlimit(attemptLimitsId string) (*APIResponse, error)

DeleteOutboundAttemptlimit invokes DELETE /api/v2/outbound/attemptlimits/{attemptLimitsId}

Delete attempt limits

func (OutboundApi) DeleteOutboundCallabletimeset ¶

func (a OutboundApi) DeleteOutboundCallabletimeset(callableTimeSetId string) (*APIResponse, error)

DeleteOutboundCallabletimeset invokes DELETE /api/v2/outbound/callabletimesets/{callableTimeSetId}

Delete callable time set

func (OutboundApi) DeleteOutboundCallanalysisresponseset ¶

func (a OutboundApi) DeleteOutboundCallanalysisresponseset(callAnalysisSetId string) (*APIResponse, error)

DeleteOutboundCallanalysisresponseset invokes DELETE /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}

Delete a dialer call analysis response set.

func (OutboundApi) DeleteOutboundCampaign ¶

func (a OutboundApi) DeleteOutboundCampaign(campaignId string) (*Campaign, *APIResponse, error)

DeleteOutboundCampaign invokes DELETE /api/v2/outbound/campaigns/{campaignId}

Delete a campaign.

func (OutboundApi) DeleteOutboundCampaignProgress ¶

func (a OutboundApi) DeleteOutboundCampaignProgress(campaignId string) (*APIResponse, error)

DeleteOutboundCampaignProgress invokes DELETE /api/v2/outbound/campaigns/{campaignId}/progress

Reset campaign progress and recycle the campaign

func (OutboundApi) DeleteOutboundCampaignrule ¶

func (a OutboundApi) DeleteOutboundCampaignrule(campaignRuleId string) (*APIResponse, error)

DeleteOutboundCampaignrule invokes DELETE /api/v2/outbound/campaignrules/{campaignRuleId}

Delete Campaign Rule

func (OutboundApi) DeleteOutboundContactlist ¶

func (a OutboundApi) DeleteOutboundContactlist(contactListId string) (*APIResponse, error)

DeleteOutboundContactlist invokes DELETE /api/v2/outbound/contactlists/{contactListId}

Delete a contact list.

func (OutboundApi) DeleteOutboundContactlistContact ¶

func (a OutboundApi) DeleteOutboundContactlistContact(contactListId string, contactId string) (*APIResponse, error)

DeleteOutboundContactlistContact invokes DELETE /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}

Delete a contact.

func (OutboundApi) DeleteOutboundContactlistContacts ¶

func (a OutboundApi) DeleteOutboundContactlistContacts(contactListId string, contactIds []string) (*APIResponse, error)

DeleteOutboundContactlistContacts invokes DELETE /api/v2/outbound/contactlists/{contactListId}/contacts

Delete contacts from a contact list.

func (OutboundApi) DeleteOutboundContactlistfilter ¶

func (a OutboundApi) DeleteOutboundContactlistfilter(contactListFilterId string) (*APIResponse, error)

DeleteOutboundContactlistfilter invokes DELETE /api/v2/outbound/contactlistfilters/{contactListFilterId}

Delete Contact List Filter

func (OutboundApi) DeleteOutboundContactlists ¶

func (a OutboundApi) DeleteOutboundContactlists(id []string) (*APIResponse, error)

DeleteOutboundContactlists invokes DELETE /api/v2/outbound/contactlists

Delete multiple contact lists.

func (OutboundApi) DeleteOutboundDnclist ¶

func (a OutboundApi) DeleteOutboundDnclist(dncListId string) (*APIResponse, error)

DeleteOutboundDnclist invokes DELETE /api/v2/outbound/dnclists/{dncListId}

Delete dialer DNC list

func (OutboundApi) DeleteOutboundMessagingcampaign ¶

func (a OutboundApi) DeleteOutboundMessagingcampaign(messagingCampaignId string) (*Messagingcampaign, *APIResponse, error)

DeleteOutboundMessagingcampaign invokes DELETE /api/v2/outbound/messagingcampaigns/{messagingCampaignId}

Delete an Outbound Messaging Campaign

func (OutboundApi) DeleteOutboundRuleset ¶

func (a OutboundApi) DeleteOutboundRuleset(ruleSetId string) (*APIResponse, error)

DeleteOutboundRuleset invokes DELETE /api/v2/outbound/rulesets/{ruleSetId}

Delete a Rule set.

func (OutboundApi) DeleteOutboundSchedulesCampaign ¶

func (a OutboundApi) DeleteOutboundSchedulesCampaign(campaignId string) (*APIResponse, error)

DeleteOutboundSchedulesCampaign invokes DELETE /api/v2/outbound/schedules/campaigns/{campaignId}

Delete a dialer campaign schedule.

func (OutboundApi) DeleteOutboundSchedulesSequence ¶

func (a OutboundApi) DeleteOutboundSchedulesSequence(sequenceId string) (*APIResponse, error)

DeleteOutboundSchedulesSequence invokes DELETE /api/v2/outbound/schedules/sequences/{sequenceId}

Delete a dialer sequence schedule.

func (OutboundApi) DeleteOutboundSequence ¶

func (a OutboundApi) DeleteOutboundSequence(sequenceId string) (*APIResponse, error)

DeleteOutboundSequence invokes DELETE /api/v2/outbound/sequences/{sequenceId}

Delete a dialer campaign sequence.

func (OutboundApi) GetOutboundAttemptlimit ¶

func (a OutboundApi) GetOutboundAttemptlimit(attemptLimitsId string) (*Attemptlimits, *APIResponse, error)

GetOutboundAttemptlimit invokes GET /api/v2/outbound/attemptlimits/{attemptLimitsId}

Get attempt limits

func (OutboundApi) GetOutboundAttemptlimits ¶

func (a OutboundApi) GetOutboundAttemptlimits(pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, sortBy string, sortOrder string) (*Attemptlimitsentitylisting, *APIResponse, error)

GetOutboundAttemptlimits invokes GET /api/v2/outbound/attemptlimits

Query attempt limits list

func (OutboundApi) GetOutboundCallabletimeset ¶

func (a OutboundApi) GetOutboundCallabletimeset(callableTimeSetId string) (*Callabletimeset, *APIResponse, error)

GetOutboundCallabletimeset invokes GET /api/v2/outbound/callabletimesets/{callableTimeSetId}

Get callable time set

func (OutboundApi) GetOutboundCallabletimesets ¶

func (a OutboundApi) GetOutboundCallabletimesets(pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, sortBy string, sortOrder string) (*Callabletimesetentitylisting, *APIResponse, error)

GetOutboundCallabletimesets invokes GET /api/v2/outbound/callabletimesets

Query callable time set list

func (OutboundApi) GetOutboundCallanalysisresponseset ¶

func (a OutboundApi) GetOutboundCallanalysisresponseset(callAnalysisSetId string) (*Responseset, *APIResponse, error)

GetOutboundCallanalysisresponseset invokes GET /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}

Get a dialer call analysis response set.

func (OutboundApi) GetOutboundCallanalysisresponsesets ¶

func (a OutboundApi) GetOutboundCallanalysisresponsesets(pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, sortBy string, sortOrder string) (*Responsesetentitylisting, *APIResponse, error)

GetOutboundCallanalysisresponsesets invokes GET /api/v2/outbound/callanalysisresponsesets

Query a list of dialer call analysis response sets.

func (OutboundApi) GetOutboundCampaign ¶

func (a OutboundApi) GetOutboundCampaign(campaignId string) (*Campaign, *APIResponse, error)

GetOutboundCampaign invokes GET /api/v2/outbound/campaigns/{campaignId}

Get dialer campaign.

func (OutboundApi) GetOutboundCampaignAgentownedmappingpreviewResults ¶

func (a OutboundApi) GetOutboundCampaignAgentownedmappingpreviewResults(campaignId string) (*Agentownedmappingpreviewlisting, *APIResponse, error)

GetOutboundCampaignAgentownedmappingpreviewResults invokes GET /api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview/results

Get a preview of how agents will be mapped to this campaign&#39;s contact list.

func (OutboundApi) GetOutboundCampaignDiagnostics ¶

func (a OutboundApi) GetOutboundCampaignDiagnostics(campaignId string) (*Campaigndiagnostics, *APIResponse, error)

GetOutboundCampaignDiagnostics invokes GET /api/v2/outbound/campaigns/{campaignId}/diagnostics

Get campaign diagnostics

func (OutboundApi) GetOutboundCampaignInteractions ¶

func (a OutboundApi) GetOutboundCampaignInteractions(campaignId string) (*Campaigninteractions, *APIResponse, error)

GetOutboundCampaignInteractions invokes GET /api/v2/outbound/campaigns/{campaignId}/interactions

Get dialer campaign interactions.

func (OutboundApi) GetOutboundCampaignProgress ¶

func (a OutboundApi) GetOutboundCampaignProgress(campaignId string) (*Campaignprogress, *APIResponse, error)

GetOutboundCampaignProgress invokes GET /api/v2/outbound/campaigns/{campaignId}/progress

Get campaign progress

func (OutboundApi) GetOutboundCampaignStats ¶

func (a OutboundApi) GetOutboundCampaignStats(campaignId string) (*Campaignstats, *APIResponse, error)

GetOutboundCampaignStats invokes GET /api/v2/outbound/campaigns/{campaignId}/stats

Get statistics about a Dialer Campaign

func (OutboundApi) GetOutboundCampaignrule ¶

func (a OutboundApi) GetOutboundCampaignrule(campaignRuleId string) (*Campaignrule, *APIResponse, error)

GetOutboundCampaignrule invokes GET /api/v2/outbound/campaignrules/{campaignRuleId}

Get Campaign Rule

func (OutboundApi) GetOutboundCampaignrules ¶

func (a OutboundApi) GetOutboundCampaignrules(pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, sortBy string, sortOrder string) (*Campaignruleentitylisting, *APIResponse, error)

GetOutboundCampaignrules invokes GET /api/v2/outbound/campaignrules

Query Campaign Rule list

func (OutboundApi) GetOutboundCampaigns ¶

func (a OutboundApi) GetOutboundCampaigns(pageSize int, pageNumber int, filterType string, name string, id []string, contactListId string, dncListIds string, distributionQueueId string, edgeGroupId string, callAnalysisResponseSetId string, divisionId []string, sortBy string, sortOrder string) (*Campaignentitylisting, *APIResponse, error)

GetOutboundCampaigns invokes GET /api/v2/outbound/campaigns

Query a list of dialer campaigns.

func (OutboundApi) GetOutboundCampaignsAll ¶

func (a OutboundApi) GetOutboundCampaignsAll(pageSize int, pageNumber int, id []string, name string, divisionId []string, mediaType []string, sortOrder string) (*Commoncampaignentitylisting, *APIResponse, error)

GetOutboundCampaignsAll invokes GET /api/v2/outbound/campaigns/all

Query across all types of campaigns by division

func (OutboundApi) GetOutboundCampaignsAllDivisionviews ¶

func (a OutboundApi) GetOutboundCampaignsAllDivisionviews(pageSize int, pageNumber int, id []string, name string, divisionId []string, mediaType []string, sortOrder string) (*Commoncampaigndivisionviewentitylisting, *APIResponse, error)

GetOutboundCampaignsAllDivisionviews invokes GET /api/v2/outbound/campaigns/all/divisionviews

Query across all types of campaigns

func (OutboundApi) GetOutboundCampaignsDivisionview ¶

func (a OutboundApi) GetOutboundCampaignsDivisionview(campaignId string) (*Campaigndivisionview, *APIResponse, error)

GetOutboundCampaignsDivisionview invokes GET /api/v2/outbound/campaigns/divisionviews/{campaignId}

Get a basic Campaign information object ¶

This returns a simplified version of a Campaign, consisting of name and division.

func (OutboundApi) GetOutboundCampaignsDivisionviews ¶

func (a OutboundApi) GetOutboundCampaignsDivisionviews(pageSize int, pageNumber int, filterType string, name string, id []string, sortBy string, sortOrder string) (*Campaigndivisionviewlisting, *APIResponse, error)

GetOutboundCampaignsDivisionviews invokes GET /api/v2/outbound/campaigns/divisionviews

Query a list of basic Campaign information objects ¶

This returns a simplified version of a Campaign, consisting of name and division.

func (OutboundApi) GetOutboundContactlist ¶

func (a OutboundApi) GetOutboundContactlist(contactListId string, includeImportStatus bool, includeSize bool) (*Contactlist, *APIResponse, error)

GetOutboundContactlist invokes GET /api/v2/outbound/contactlists/{contactListId}

Get a dialer contact list.

func (OutboundApi) GetOutboundContactlistContact ¶

func (a OutboundApi) GetOutboundContactlistContact(contactListId string, contactId string) (*Dialercontact, *APIResponse, error)

GetOutboundContactlistContact invokes GET /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}

Get a contact.

func (OutboundApi) GetOutboundContactlistExport ¶

func (a OutboundApi) GetOutboundContactlistExport(contactListId string, download string) (*Exporturi, *APIResponse, error)

GetOutboundContactlistExport invokes GET /api/v2/outbound/contactlists/{contactListId}/export

Get the URI of a contact list export.

func (OutboundApi) GetOutboundContactlistImportstatus ¶

func (a OutboundApi) GetOutboundContactlistImportstatus(contactListId string) (*Importstatus, *APIResponse, error)

GetOutboundContactlistImportstatus invokes GET /api/v2/outbound/contactlists/{contactListId}/importstatus

Get dialer contactList import status.

func (OutboundApi) GetOutboundContactlistTimezonemappingpreview ¶

func (a OutboundApi) GetOutboundContactlistTimezonemappingpreview(contactListId string) (*Timezonemappingpreview, *APIResponse, error)

GetOutboundContactlistTimezonemappingpreview invokes GET /api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview

Preview the result of applying Automatic Time Zone Mapping to a contact list

func (OutboundApi) GetOutboundContactlistfilter ¶

func (a OutboundApi) GetOutboundContactlistfilter(contactListFilterId string) (*Contactlistfilter, *APIResponse, error)

GetOutboundContactlistfilter invokes GET /api/v2/outbound/contactlistfilters/{contactListFilterId}

Get Contact list filter

func (OutboundApi) GetOutboundContactlistfilters ¶

func (a OutboundApi) GetOutboundContactlistfilters(pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, sortBy string, sortOrder string, contactListId string) (*Contactlistfilterentitylisting, *APIResponse, error)

GetOutboundContactlistfilters invokes GET /api/v2/outbound/contactlistfilters

Query Contact list filters

func (OutboundApi) GetOutboundContactlists ¶

func (a OutboundApi) GetOutboundContactlists(includeImportStatus bool, includeSize bool, pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, id []string, divisionId []string, sortBy string, sortOrder string) (*Contactlistentitylisting, *APIResponse, error)

GetOutboundContactlists invokes GET /api/v2/outbound/contactlists

Query a list of contact lists.

func (OutboundApi) GetOutboundContactlistsDivisionview ¶

func (a OutboundApi) GetOutboundContactlistsDivisionview(contactListId string, includeImportStatus bool, includeSize bool) (*Contactlistdivisionview, *APIResponse, error)

GetOutboundContactlistsDivisionview invokes GET /api/v2/outbound/contactlists/divisionviews/{contactListId}

Get a basic ContactList information object ¶

This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.

func (OutboundApi) GetOutboundContactlistsDivisionviews ¶

func (a OutboundApi) GetOutboundContactlistsDivisionviews(includeImportStatus bool, includeSize bool, pageSize int, pageNumber int, filterType string, name string, id []string, sortBy string, sortOrder string) (*Contactlistdivisionviewlisting, *APIResponse, error)

GetOutboundContactlistsDivisionviews invokes GET /api/v2/outbound/contactlists/divisionviews

Query a list of simplified contact list objects.

This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.

func (OutboundApi) GetOutboundDnclist ¶

func (a OutboundApi) GetOutboundDnclist(dncListId string, includeImportStatus bool, includeSize bool) (*Dnclist, *APIResponse, error)

GetOutboundDnclist invokes GET /api/v2/outbound/dnclists/{dncListId}

Get dialer DNC list

func (OutboundApi) GetOutboundDnclistExport ¶

func (a OutboundApi) GetOutboundDnclistExport(dncListId string, download string) (*Exporturi, *APIResponse, error)

GetOutboundDnclistExport invokes GET /api/v2/outbound/dnclists/{dncListId}/export

Get the URI of a DNC list export.

func (OutboundApi) GetOutboundDnclistImportstatus ¶

func (a OutboundApi) GetOutboundDnclistImportstatus(dncListId string) (*Importstatus, *APIResponse, error)

GetOutboundDnclistImportstatus invokes GET /api/v2/outbound/dnclists/{dncListId}/importstatus

Get dialer dncList import status.

func (OutboundApi) GetOutboundDnclists ¶

func (a OutboundApi) GetOutboundDnclists(includeImportStatus bool, includeSize bool, pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, dncSourceType string, divisionId []string, sortBy string, sortOrder string) (*Dnclistentitylisting, *APIResponse, error)

GetOutboundDnclists invokes GET /api/v2/outbound/dnclists

Query dialer DNC lists

func (OutboundApi) GetOutboundDnclistsDivisionview ¶

func (a OutboundApi) GetOutboundDnclistsDivisionview(dncListId string, includeImportStatus bool, includeSize bool) (*Dnclistdivisionview, *APIResponse, error)

GetOutboundDnclistsDivisionview invokes GET /api/v2/outbound/dnclists/divisionviews/{dncListId}

Get a basic DncList information object ¶

This returns a simplified version of a DncList, consisting of the name, division, import status, and size.

func (OutboundApi) GetOutboundDnclistsDivisionviews ¶

func (a OutboundApi) GetOutboundDnclistsDivisionviews(includeImportStatus bool, includeSize bool, pageSize int, pageNumber int, filterType string, name string, dncSourceType string, id []string, sortBy string, sortOrder string) (*Dnclistdivisionviewlisting, *APIResponse, error)

GetOutboundDnclistsDivisionviews invokes GET /api/v2/outbound/dnclists/divisionviews

Query a list of simplified dnc list objects.

This return a simplified version of dnc lists, consisting of the name, division, import status, and size.

func (OutboundApi) GetOutboundEvent ¶

func (a OutboundApi) GetOutboundEvent(eventId string) (*Eventlog, *APIResponse, error)

GetOutboundEvent invokes GET /api/v2/outbound/events/{eventId}

Get Dialer Event

func (OutboundApi) GetOutboundEvents ¶

func (a OutboundApi) GetOutboundEvents(pageSize int, pageNumber int, filterType string, category string, level string, sortBy string, sortOrder string) (*Dialerevententitylisting, *APIResponse, error)

GetOutboundEvents invokes GET /api/v2/outbound/events

Query Event Logs

func (OutboundApi) GetOutboundMessagingcampaign ¶

func (a OutboundApi) GetOutboundMessagingcampaign(messagingCampaignId string) (*Messagingcampaign, *APIResponse, error)

GetOutboundMessagingcampaign invokes GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}

Get an Outbound Messaging Campaign

func (OutboundApi) GetOutboundMessagingcampaignProgress ¶

func (a OutboundApi) GetOutboundMessagingcampaignProgress(messagingCampaignId string) (*Campaignprogress, *APIResponse, error)

GetOutboundMessagingcampaignProgress invokes GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress

Get messaging campaign&#39;s progress

func (OutboundApi) GetOutboundMessagingcampaigns ¶

func (a OutboundApi) GetOutboundMessagingcampaigns(pageSize int, pageNumber int, sortBy string, sortOrder string, name string, contactListId string, divisionId []string, varType string, senderSmsPhoneNumber string, id []string) (*Messagingcampaignentitylisting, *APIResponse, error)

GetOutboundMessagingcampaigns invokes GET /api/v2/outbound/messagingcampaigns

Query a list of Messaging Campaigns

func (OutboundApi) GetOutboundMessagingcampaignsDivisionview ¶

func (a OutboundApi) GetOutboundMessagingcampaignsDivisionview(messagingCampaignId string) (*Messagingcampaigndivisionview, *APIResponse, error)

GetOutboundMessagingcampaignsDivisionview invokes GET /api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}

Get a basic Messaging Campaign information object ¶

This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.

func (OutboundApi) GetOutboundMessagingcampaignsDivisionviews ¶

func (a OutboundApi) GetOutboundMessagingcampaignsDivisionviews(pageSize int, pageNumber int, sortOrder string, name string, id []string, senderSmsPhoneNumber string) (*Messagingcampaigndivisionviewentitylisting, *APIResponse, error)

GetOutboundMessagingcampaignsDivisionviews invokes GET /api/v2/outbound/messagingcampaigns/divisionviews

Query a list of basic Messaging Campaign information objects ¶

This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.

func (OutboundApi) GetOutboundRuleset ¶

func (a OutboundApi) GetOutboundRuleset(ruleSetId string) (*Ruleset, *APIResponse, error)

GetOutboundRuleset invokes GET /api/v2/outbound/rulesets/{ruleSetId}

Get a Rule Set by ID.

func (OutboundApi) GetOutboundRulesets ¶

func (a OutboundApi) GetOutboundRulesets(pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, sortBy string, sortOrder string) (*Rulesetentitylisting, *APIResponse, error)

GetOutboundRulesets invokes GET /api/v2/outbound/rulesets

Query a list of Rule Sets.

func (OutboundApi) GetOutboundSchedulesCampaign ¶

func (a OutboundApi) GetOutboundSchedulesCampaign(campaignId string) (*Campaignschedule, *APIResponse, error)

GetOutboundSchedulesCampaign invokes GET /api/v2/outbound/schedules/campaigns/{campaignId}

Get a dialer campaign schedule.

func (OutboundApi) GetOutboundSchedulesCampaigns ¶

func (a OutboundApi) GetOutboundSchedulesCampaigns() ([]Campaignschedule, *APIResponse, error)

GetOutboundSchedulesCampaigns invokes GET /api/v2/outbound/schedules/campaigns

Query for a list of dialer campaign schedules.

func (OutboundApi) GetOutboundSchedulesSequence ¶

func (a OutboundApi) GetOutboundSchedulesSequence(sequenceId string) (*Sequenceschedule, *APIResponse, error)

GetOutboundSchedulesSequence invokes GET /api/v2/outbound/schedules/sequences/{sequenceId}

Get a dialer sequence schedule.

func (OutboundApi) GetOutboundSchedulesSequences ¶

func (a OutboundApi) GetOutboundSchedulesSequences() ([]Sequenceschedule, *APIResponse, error)

GetOutboundSchedulesSequences invokes GET /api/v2/outbound/schedules/sequences

Query for a list of dialer sequence schedules.

func (OutboundApi) GetOutboundSequence ¶

func (a OutboundApi) GetOutboundSequence(sequenceId string) (*Campaignsequence, *APIResponse, error)

GetOutboundSequence invokes GET /api/v2/outbound/sequences/{sequenceId}

Get a dialer campaign sequence.

func (OutboundApi) GetOutboundSequences ¶

func (a OutboundApi) GetOutboundSequences(pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, sortBy string, sortOrder string) (*Campaignsequenceentitylisting, *APIResponse, error)

GetOutboundSequences invokes GET /api/v2/outbound/sequences

Query a list of dialer campaign sequences.

func (OutboundApi) GetOutboundSettings ¶

func (a OutboundApi) GetOutboundSettings() (*Outboundsettings, *APIResponse, error)

GetOutboundSettings invokes GET /api/v2/outbound/settings

Get the outbound settings for this organization

func (OutboundApi) GetOutboundWrapupcodemappings ¶

func (a OutboundApi) GetOutboundWrapupcodemappings() (*Wrapupcodemapping, *APIResponse, error)

GetOutboundWrapupcodemappings invokes GET /api/v2/outbound/wrapupcodemappings

Get the Dialer wrap up code mapping.

func (OutboundApi) PatchOutboundSettings ¶

func (a OutboundApi) PatchOutboundSettings(body Outboundsettings) (*APIResponse, error)

PatchOutboundSettings invokes PATCH /api/v2/outbound/settings

Update the outbound settings for this organization

func (OutboundApi) PostOutboundAttemptlimits ¶

func (a OutboundApi) PostOutboundAttemptlimits(body Attemptlimits) (*Attemptlimits, *APIResponse, error)

PostOutboundAttemptlimits invokes POST /api/v2/outbound/attemptlimits

Create attempt limits

func (OutboundApi) PostOutboundAudits ¶

func (a OutboundApi) PostOutboundAudits(body Dialerauditrequest, pageSize int, pageNumber int, sortBy string, sortOrder string, facetsOnly bool) (*Auditsearchresult, *APIResponse, error)

PostOutboundAudits invokes POST /api/v2/outbound/audits

Retrieves audits for dialer.

func (OutboundApi) PostOutboundCallabletimesets ¶

func (a OutboundApi) PostOutboundCallabletimesets(body Callabletimeset) (*Callabletimeset, *APIResponse, error)

PostOutboundCallabletimesets invokes POST /api/v2/outbound/callabletimesets

Create callable time set

func (OutboundApi) PostOutboundCallanalysisresponsesets ¶

func (a OutboundApi) PostOutboundCallanalysisresponsesets(body Responseset) (*Responseset, *APIResponse, error)

PostOutboundCallanalysisresponsesets invokes POST /api/v2/outbound/callanalysisresponsesets

Create a dialer call analysis response set.

func (OutboundApi) PostOutboundCampaignAgentownedmappingpreview ¶

func (a OutboundApi) PostOutboundCampaignAgentownedmappingpreview(campaignId string) (*Empty, *APIResponse, error)

PostOutboundCampaignAgentownedmappingpreview invokes POST /api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview

Initiate request for a preview of how agents will be mapped to this campaign&#39;s contact list.

func (OutboundApi) PostOutboundCampaignCallbackSchedule ¶

func (a OutboundApi) PostOutboundCampaignCallbackSchedule(campaignId string, body Contactcallbackrequest) (*Contactcallbackrequest, *APIResponse, error)

PostOutboundCampaignCallbackSchedule invokes POST /api/v2/outbound/campaigns/{campaignId}/callback/schedule

Schedule a Callback for a Dialer Campaign (Deprecated)

This endpoint is deprecated and may have unexpected results. Please use \&quot;/conversations/{conversationId}/participants/{participantId}/callbacks instead.\&quot;

func (OutboundApi) PostOutboundCampaignrules ¶

func (a OutboundApi) PostOutboundCampaignrules(body Campaignrule) (*Campaignrule, *APIResponse, error)

PostOutboundCampaignrules invokes POST /api/v2/outbound/campaignrules

Create Campaign Rule

func (OutboundApi) PostOutboundCampaigns ¶

func (a OutboundApi) PostOutboundCampaigns(body Campaign) (*Campaign, *APIResponse, error)

PostOutboundCampaigns invokes POST /api/v2/outbound/campaigns

Create a campaign.

func (OutboundApi) PostOutboundCampaignsProgress ¶

func (a OutboundApi) PostOutboundCampaignsProgress(body []string) ([]Campaignprogress, *APIResponse, error)

PostOutboundCampaignsProgress invokes POST /api/v2/outbound/campaigns/progress

Get progress for a list of campaigns

func (OutboundApi) PostOutboundContactlistClear ¶

func (a OutboundApi) PostOutboundContactlistClear(contactListId string) (*APIResponse, error)

PostOutboundContactlistClear invokes POST /api/v2/outbound/contactlists/{contactListId}/clear

Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.

func (OutboundApi) PostOutboundContactlistContacts ¶

func (a OutboundApi) PostOutboundContactlistContacts(contactListId string, body []Writabledialercontact, priority bool, clearSystemData bool, doNotQueue bool) ([]Dialercontact, *APIResponse, error)

PostOutboundContactlistContacts invokes POST /api/v2/outbound/contactlists/{contactListId}/contacts

Add contacts to a contact list.

func (OutboundApi) PostOutboundContactlistContactsBulk ¶

func (a OutboundApi) PostOutboundContactlistContactsBulk(contactListId string, body []string) ([]Dialercontact, *APIResponse, error)

PostOutboundContactlistContactsBulk invokes POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk

Get contacts from a contact list.

func (OutboundApi) PostOutboundContactlistExport ¶

func (a OutboundApi) PostOutboundContactlistExport(contactListId string) (*Domainentityref, *APIResponse, error)

PostOutboundContactlistExport invokes POST /api/v2/outbound/contactlists/{contactListId}/export

Initiate the export of a contact list.

Returns 200 if received OK.

func (OutboundApi) PostOutboundContactlistfilters ¶

func (a OutboundApi) PostOutboundContactlistfilters(body Contactlistfilter) (*Contactlistfilter, *APIResponse, error)

PostOutboundContactlistfilters invokes POST /api/v2/outbound/contactlistfilters

Create Contact List Filter

func (OutboundApi) PostOutboundContactlistfiltersPreview ¶

func (a OutboundApi) PostOutboundContactlistfiltersPreview(body Contactlistfilter) (*Filterpreviewresponse, *APIResponse, error)

PostOutboundContactlistfiltersPreview invokes POST /api/v2/outbound/contactlistfilters/preview

Get a preview of the output of a contact list filter

func (OutboundApi) PostOutboundContactlists ¶

func (a OutboundApi) PostOutboundContactlists(body Contactlist) (*Contactlist, *APIResponse, error)

PostOutboundContactlists invokes POST /api/v2/outbound/contactlists

Create a contact List.

func (OutboundApi) PostOutboundConversationDnc ¶

func (a OutboundApi) PostOutboundConversationDnc(conversationId string) (*APIResponse, error)

PostOutboundConversationDnc invokes POST /api/v2/outbound/conversations/{conversationId}/dnc

Add phone numbers to a Dialer DNC list.

func (OutboundApi) PostOutboundDnclistExport ¶

func (a OutboundApi) PostOutboundDnclistExport(dncListId string) (*Domainentityref, *APIResponse, error)

PostOutboundDnclistExport invokes POST /api/v2/outbound/dnclists/{dncListId}/export

Initiate the export of a dnc list.

Returns 200 if received OK.

func (OutboundApi) PostOutboundDnclistPhonenumbers ¶

func (a OutboundApi) PostOutboundDnclistPhonenumbers(dncListId string, body []string) (*APIResponse, error)

PostOutboundDnclistPhonenumbers invokes POST /api/v2/outbound/dnclists/{dncListId}/phonenumbers

Add phone numbers to a DNC list.

Only Internal DNC lists may be appended to

func (OutboundApi) PostOutboundDnclists ¶

func (a OutboundApi) PostOutboundDnclists(body Dnclistcreate) (*Dnclist, *APIResponse, error)

PostOutboundDnclists invokes POST /api/v2/outbound/dnclists

Create dialer DNC list

func (OutboundApi) PostOutboundMessagingcampaigns ¶

func (a OutboundApi) PostOutboundMessagingcampaigns(body Messagingcampaign) (*Messagingcampaign, *APIResponse, error)

PostOutboundMessagingcampaigns invokes POST /api/v2/outbound/messagingcampaigns

Create a Messaging Campaign

func (OutboundApi) PostOutboundMessagingcampaignsProgress ¶

func (a OutboundApi) PostOutboundMessagingcampaignsProgress(body []string) ([]Campaignprogress, *APIResponse, error)

PostOutboundMessagingcampaignsProgress invokes POST /api/v2/outbound/messagingcampaigns/progress

Get progress for a list of messaging campaigns

func (OutboundApi) PostOutboundRulesets ¶

func (a OutboundApi) PostOutboundRulesets(body Ruleset) (*Ruleset, *APIResponse, error)

PostOutboundRulesets invokes POST /api/v2/outbound/rulesets

Create a Dialer Call Analysis Response Set.

func (OutboundApi) PostOutboundSequences ¶

func (a OutboundApi) PostOutboundSequences(body Campaignsequence) (*Campaignsequence, *APIResponse, error)

PostOutboundSequences invokes POST /api/v2/outbound/sequences

Create a new campaign sequence.

func (OutboundApi) PutOutboundAttemptlimit ¶

func (a OutboundApi) PutOutboundAttemptlimit(attemptLimitsId string, body Attemptlimits) (*Attemptlimits, *APIResponse, error)

PutOutboundAttemptlimit invokes PUT /api/v2/outbound/attemptlimits/{attemptLimitsId}

Update attempt limits

func (OutboundApi) PutOutboundCallabletimeset ¶

func (a OutboundApi) PutOutboundCallabletimeset(callableTimeSetId string, body Callabletimeset) (*Callabletimeset, *APIResponse, error)

PutOutboundCallabletimeset invokes PUT /api/v2/outbound/callabletimesets/{callableTimeSetId}

Update callable time set

func (OutboundApi) PutOutboundCallanalysisresponseset ¶

func (a OutboundApi) PutOutboundCallanalysisresponseset(callAnalysisSetId string, body Responseset) (*Responseset, *APIResponse, error)

PutOutboundCallanalysisresponseset invokes PUT /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}

Update a dialer call analysis response set.

func (OutboundApi) PutOutboundCampaign ¶

func (a OutboundApi) PutOutboundCampaign(campaignId string, body Campaign) (*Campaign, *APIResponse, error)

PutOutboundCampaign invokes PUT /api/v2/outbound/campaigns/{campaignId}

Update a campaign.

func (OutboundApi) PutOutboundCampaignAgent ¶

func (a OutboundApi) PutOutboundCampaignAgent(campaignId string, userId string, body Agent) (*string, *APIResponse, error)

PutOutboundCampaignAgent invokes PUT /api/v2/outbound/campaigns/{campaignId}/agents/{userId}

Send notification that an agent&#39;s state changed

New agent state.

func (OutboundApi) PutOutboundCampaignrule ¶

func (a OutboundApi) PutOutboundCampaignrule(campaignRuleId string, body Campaignrule) (*Campaignrule, *APIResponse, error)

PutOutboundCampaignrule invokes PUT /api/v2/outbound/campaignrules/{campaignRuleId}

Update Campaign Rule

func (OutboundApi) PutOutboundContactlist ¶

func (a OutboundApi) PutOutboundContactlist(contactListId string, body Contactlist) (*Contactlist, *APIResponse, error)

PutOutboundContactlist invokes PUT /api/v2/outbound/contactlists/{contactListId}

Update a contact list.

func (OutboundApi) PutOutboundContactlistContact ¶

func (a OutboundApi) PutOutboundContactlistContact(contactListId string, contactId string, body Dialercontact) (*Dialercontact, *APIResponse, error)

PutOutboundContactlistContact invokes PUT /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}

Update a contact.

func (OutboundApi) PutOutboundContactlistfilter ¶

func (a OutboundApi) PutOutboundContactlistfilter(contactListFilterId string, body Contactlistfilter) (*Contactlistfilter, *APIResponse, error)

PutOutboundContactlistfilter invokes PUT /api/v2/outbound/contactlistfilters/{contactListFilterId}

Update Contact List Filter

func (OutboundApi) PutOutboundDnclist ¶

func (a OutboundApi) PutOutboundDnclist(dncListId string, body Dnclist) (*Dnclist, *APIResponse, error)

PutOutboundDnclist invokes PUT /api/v2/outbound/dnclists/{dncListId}

Update dialer DNC list

func (OutboundApi) PutOutboundMessagingcampaign ¶

func (a OutboundApi) PutOutboundMessagingcampaign(messagingCampaignId string, body Messagingcampaign) (*Messagingcampaign, *APIResponse, error)

PutOutboundMessagingcampaign invokes PUT /api/v2/outbound/messagingcampaigns/{messagingCampaignId}

Update an Outbound Messaging Campaign

func (OutboundApi) PutOutboundRuleset ¶

func (a OutboundApi) PutOutboundRuleset(ruleSetId string, body Ruleset) (*Ruleset, *APIResponse, error)

PutOutboundRuleset invokes PUT /api/v2/outbound/rulesets/{ruleSetId}

Update a RuleSet.

func (OutboundApi) PutOutboundSchedulesCampaign ¶

func (a OutboundApi) PutOutboundSchedulesCampaign(campaignId string, body Campaignschedule) (*Campaignschedule, *APIResponse, error)

PutOutboundSchedulesCampaign invokes PUT /api/v2/outbound/schedules/campaigns/{campaignId}

Update a new campaign schedule.

func (OutboundApi) PutOutboundSchedulesSequence ¶

func (a OutboundApi) PutOutboundSchedulesSequence(sequenceId string, body Sequenceschedule) (*Sequenceschedule, *APIResponse, error)

PutOutboundSchedulesSequence invokes PUT /api/v2/outbound/schedules/sequences/{sequenceId}

Update a new sequence schedule.

func (OutboundApi) PutOutboundSequence ¶

func (a OutboundApi) PutOutboundSequence(sequenceId string, body Campaignsequence) (*Campaignsequence, *APIResponse, error)

PutOutboundSequence invokes PUT /api/v2/outbound/sequences/{sequenceId}

Update a new campaign sequence.

func (OutboundApi) PutOutboundWrapupcodemappings ¶

func (a OutboundApi) PutOutboundWrapupcodemappings(body Wrapupcodemapping) (*Wrapupcodemapping, *APIResponse, error)

PutOutboundWrapupcodemappings invokes PUT /api/v2/outbound/wrapupcodemappings

Update the Dialer wrap up code mapping.

type Outbounddomain ¶

type Outbounddomain struct {
	// Id - Unique Id of the domain such as: example.com
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// CnameVerificationResult - CNAME registration Status
	CnameVerificationResult *Verificationresult `json:"cnameVerificationResult,omitempty"`

	// DkimVerificationResult - DKIM registration Status
	DkimVerificationResult *Verificationresult `json:"dkimVerificationResult,omitempty"`

	// FromEmail - The email that is used to display sender informations
	FromEmail *Emailaddress `json:"fromEmail,omitempty"`

	// ReplyToEmail - The email that is used if replies are expected
	ReplyToEmail *Emailaddress `json:"replyToEmail,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Outbounddomain

func (*Outbounddomain) String ¶

func (o *Outbounddomain) String() string

String returns a JSON representation of the model

type Outboundmessagingmessagingcampaignconfigchangecontactsort ¶

type Outboundmessagingmessagingcampaignconfigchangecontactsort struct {
	// FieldName
	FieldName *string `json:"fieldName,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// Numeric
	Numeric *bool `json:"numeric,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Outboundmessagingmessagingcampaignconfigchangecontactsort

func (*Outboundmessagingmessagingcampaignconfigchangecontactsort) String ¶

String returns a JSON representation of the model

type Outboundmessagingmessagingcampaignconfigchangeerrordetail ¶

type Outboundmessagingmessagingcampaignconfigchangeerrordetail struct {
	// VarError
	VarError *string `json:"error,omitempty"`

	// Details
	Details *string `json:"details,omitempty"`
}

Outboundmessagingmessagingcampaignconfigchangeerrordetail

func (*Outboundmessagingmessagingcampaignconfigchangeerrordetail) String ¶

String returns a JSON representation of the model

type Outboundmessagingmessagingcampaignconfigchangemessagingcampaign ¶

type Outboundmessagingmessagingcampaignconfigchangemessagingcampaign struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Division
	Division *Outboundmessagingmessagingcampaignconfigchangeurireference `json:"division,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// DateCreated
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// DateModified
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`

	// CampaignStatus
	CampaignStatus *string `json:"campaignStatus,omitempty"`

	// CallableTimeSet
	CallableTimeSet *Outboundmessagingmessagingcampaignconfigchangeurireference `json:"callableTimeSet,omitempty"`

	// ContactList
	ContactList *Outboundmessagingmessagingcampaignconfigchangeurireference `json:"contactList,omitempty"`

	// DncLists
	DncLists *[]Outboundmessagingmessagingcampaignconfigchangeurireference `json:"dncLists,omitempty"`

	// ContactListFilters
	ContactListFilters *[]Outboundmessagingmessagingcampaignconfigchangeurireference `json:"contactListFilters,omitempty"`

	// AlwaysRunning
	AlwaysRunning *bool `json:"alwaysRunning,omitempty"`

	// ContactSorts
	ContactSorts *[]Outboundmessagingmessagingcampaignconfigchangecontactsort `json:"contactSorts,omitempty"`

	// MessagesPerMinute
	MessagesPerMinute *int `json:"messagesPerMinute,omitempty"`

	// SmsConfig
	SmsConfig *Outboundmessagingmessagingcampaignconfigchangesmsconfig `json:"smsConfig,omitempty"`

	// Errors
	Errors *[]Outboundmessagingmessagingcampaignconfigchangeerrordetail `json:"errors,omitempty"`
}

Outboundmessagingmessagingcampaignconfigchangemessagingcampaign

func (*Outboundmessagingmessagingcampaignconfigchangemessagingcampaign) String ¶

String returns a JSON representation of the model

type Outboundmessagingmessagingcampaignconfigchangeresponseref ¶

type Outboundmessagingmessagingcampaignconfigchangeresponseref struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Outboundmessagingmessagingcampaignconfigchangeresponseref

func (*Outboundmessagingmessagingcampaignconfigchangeresponseref) String ¶

String returns a JSON representation of the model

type Outboundmessagingmessagingcampaignconfigchangesmsconfig ¶

type Outboundmessagingmessagingcampaignconfigchangesmsconfig struct {
	// MessageColumn
	MessageColumn *string `json:"messageColumn,omitempty"`

	// PhoneColumn
	PhoneColumn *string `json:"phoneColumn,omitempty"`

	// SenderSmsPhoneNumber
	SenderSmsPhoneNumber *Outboundmessagingmessagingcampaignconfigchangesmsphonenumberref `json:"senderSmsPhoneNumber,omitempty"`

	// ContentTemplate
	ContentTemplate *Outboundmessagingmessagingcampaignconfigchangeresponseref `json:"contentTemplate,omitempty"`
}

Outboundmessagingmessagingcampaignconfigchangesmsconfig

func (*Outboundmessagingmessagingcampaignconfigchangesmsconfig) String ¶

String returns a JSON representation of the model

type Outboundmessagingmessagingcampaignconfigchangesmsphonenumberref ¶

type Outboundmessagingmessagingcampaignconfigchangesmsphonenumberref struct {
	// PhoneNumber
	PhoneNumber *string `json:"phoneNumber,omitempty"`
}

Outboundmessagingmessagingcampaignconfigchangesmsphonenumberref

func (*Outboundmessagingmessagingcampaignconfigchangesmsphonenumberref) String ¶

String returns a JSON representation of the model

type Outboundmessagingmessagingcampaignconfigchangeurireference ¶

type Outboundmessagingmessagingcampaignconfigchangeurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Outboundmessagingmessagingcampaignconfigchangeurireference

func (*Outboundmessagingmessagingcampaignconfigchangeurireference) String ¶

String returns a JSON representation of the model

type Outboundmessagingmessagingcampaignprogresseventcampaignprogress ¶

type Outboundmessagingmessagingcampaignprogresseventcampaignprogress struct {
	// Campaign
	Campaign *Outboundmessagingmessagingcampaignprogresseventurireference `json:"campaign,omitempty"`

	// NumberOfContactsCalled
	NumberOfContactsCalled *float32 `json:"numberOfContactsCalled,omitempty"`

	// NumberOfContactsMessaged
	NumberOfContactsMessaged *float32 `json:"numberOfContactsMessaged,omitempty"`

	// TotalNumberOfContacts
	TotalNumberOfContacts *float32 `json:"totalNumberOfContacts,omitempty"`

	// Percentage
	Percentage *int `json:"percentage,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Outboundmessagingmessagingcampaignprogresseventcampaignprogress

func (*Outboundmessagingmessagingcampaignprogresseventcampaignprogress) String ¶

String returns a JSON representation of the model

type Outboundmessagingmessagingcampaignprogresseventurireference ¶

type Outboundmessagingmessagingcampaignprogresseventurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Outboundmessagingmessagingcampaignprogresseventurireference

func (*Outboundmessagingmessagingcampaignprogresseventurireference) String ¶

String returns a JSON representation of the model

type Outboundroute ¶

type Outboundroute struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// ClassificationTypes - The site associated to the outbound route.
	ClassificationTypes *[]string `json:"classificationTypes,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// Distribution
	Distribution *string `json:"distribution,omitempty"`

	// ExternalTrunkBases - Trunk base settings of trunkType \"EXTERNAL\".  This base must also be set on an edge logical interface for correct routing.
	ExternalTrunkBases *[]Domainentityref `json:"externalTrunkBases,omitempty"`

	// Site - The site associated to the outbound route.
	Site *Site `json:"site,omitempty"`

	// Managed - Is this outbound route being managed remotely.
	Managed *bool `json:"managed,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Outboundroute

func (*Outboundroute) String ¶

func (o *Outboundroute) String() string

String returns a JSON representation of the model

type Outboundroutebase ¶

type Outboundroutebase struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// ClassificationTypes - The site associated to the outbound route.
	ClassificationTypes *[]string `json:"classificationTypes,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// Distribution
	Distribution *string `json:"distribution,omitempty"`

	// ExternalTrunkBases - Trunk base settings of trunkType \"EXTERNAL\".  This base must also be set on an edge logical interface for correct routing.
	ExternalTrunkBases *[]Domainentityref `json:"externalTrunkBases,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Outboundroutebase

func (*Outboundroutebase) String ¶

func (o *Outboundroutebase) String() string

String returns a JSON representation of the model

type Outboundroutebaseentitylisting ¶

type Outboundroutebaseentitylisting struct {
	// Entities
	Entities *[]Outboundroutebase `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Outboundroutebaseentitylisting

func (*Outboundroutebaseentitylisting) String ¶

String returns a JSON representation of the model

type Outboundrouteentitylisting ¶

type Outboundrouteentitylisting struct {
	// Entities
	Entities *[]Outboundroute `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Outboundrouteentitylisting

func (*Outboundrouteentitylisting) String ¶

func (o *Outboundrouteentitylisting) String() string

String returns a JSON representation of the model

type Outboundsettings ¶

type Outboundsettings 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"`

	// MaxCallsPerAgent - The maximum number of calls that can be placed per agent on any campaign
	MaxCallsPerAgent *int `json:"maxCallsPerAgent,omitempty"`

	// MaxConfigurableCallsPerAgent - The maximum number of calls that can be configured to be placed per agent on any campaign
	MaxConfigurableCallsPerAgent *int `json:"maxConfigurableCallsPerAgent,omitempty"`

	// MaxLineUtilization - The maximum percentage of lines that should be used for Outbound, expressed as a decimal in the range [0.0, 1.0]
	MaxLineUtilization *float64 `json:"maxLineUtilization,omitempty"`

	// AbandonSeconds - The number of seconds used to determine if a call is abandoned
	AbandonSeconds *float64 `json:"abandonSeconds,omitempty"`

	// ComplianceAbandonRateDenominator - The denominator to be used in determining the compliance abandon rate
	ComplianceAbandonRateDenominator *string `json:"complianceAbandonRateDenominator,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Outboundsettings

func (*Outboundsettings) String ¶

func (o *Outboundsettings) String() string

String returns a JSON representation of the model

type Outcome ¶

type Outcome struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// IsActive - Whether or not the outcome is active.
	IsActive *bool `json:"isActive,omitempty"`

	// DisplayName - The display name of the outcome.
	DisplayName *string `json:"displayName,omitempty"`

	// Version - The version of the outcome.
	Version *int `json:"version,omitempty"`

	// Description - A description of the outcome.
	Description *string `json:"description,omitempty"`

	// IsPositive - Whether or not the outcome is positive.
	IsPositive *bool `json:"isPositive,omitempty"`

	// Context - The context of the outcome.
	Context *Context `json:"context,omitempty"`

	// Journey - The pattern of rules defining the filter of the outcome.
	Journey *Journey `json:"journey,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// CreatedDate - Timestamp indicating when the outcome 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 outcome 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"`
}

Outcome

func (*Outcome) String ¶

func (o *Outcome) String() string

String returns a JSON representation of the model

type Outcomelisting ¶

type Outcomelisting struct {
	// Entities
	Entities *[]Outcome `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Outcomelisting

func (*Outcomelisting) String ¶

func (o *Outcomelisting) String() string

String returns a JSON representation of the model

type Outcomeprobabilitycondition ¶

type Outcomeprobabilitycondition struct {
	// OutcomeId - The outcome ID.
	OutcomeId *string `json:"outcomeId,omitempty"`

	// MaximumProbability - Probability value for the selected outcome at or above which the action map will trigger.
	MaximumProbability *float32 `json:"maximumProbability,omitempty"`

	// Probability - Additional probability condition, where if set, the action map will trigger if the current outcome probability is lower or equal to the value.
	Probability *float32 `json:"probability,omitempty"`
}

Outcomeprobabilitycondition

func (*Outcomeprobabilitycondition) String ¶

func (o *Outcomeprobabilitycondition) String() string

String returns a JSON representation of the model

type Outofoffice ¶

type Outofoffice 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"`

	// StartDate - 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 - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndDate *time.Time `json:"endDate,omitempty"`

	// Active
	Active *bool `json:"active,omitempty"`

	// Indefinite
	Indefinite *bool `json:"indefinite,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Outofoffice

func (*Outofoffice) String ¶

func (o *Outofoffice) String() string

String returns a JSON representation of the model

type Outofofficeeventoutofoffice ¶

type Outofofficeeventoutofoffice struct {
	// User
	User *Outofofficeeventuser `json:"user,omitempty"`

	// Active
	Active *bool `json:"active,omitempty"`

	// Indefinite
	Indefinite *bool `json:"indefinite,omitempty"`

	// StartDate
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate
	EndDate *time.Time `json:"endDate,omitempty"`
}

Outofofficeeventoutofoffice

func (*Outofofficeeventoutofoffice) String ¶

func (o *Outofofficeeventoutofoffice) String() string

String returns a JSON representation of the model

type Outofofficeeventuser ¶

type Outofofficeeventuser struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Outofofficeeventuser

func (*Outofofficeeventuser) String ¶

func (o *Outofofficeeventuser) String() string

String returns a JSON representation of the model

type Overallbestpoints ¶

type Overallbestpoints struct {
	// Division - The requested division
	Division *Division `json:"division,omitempty"`

	// BestPoints - List of gamification best point items
	BestPoints *[]Overallbestpointsitem `json:"bestPoints,omitempty"`
}

Overallbestpoints

func (*Overallbestpoints) String ¶

func (o *Overallbestpoints) String() string

String returns a JSON representation of the model

type Overallbestpointsitem ¶

type Overallbestpointsitem struct {
	// GranularityType - Best points aggregation interval granularity
	GranularityType *string `json:"granularityType,omitempty"`

	// Users - List of associated users with the equal points.
	Users *[]Userreference `json:"users,omitempty"`

	// Count - The count of the user IDs in the list
	Count *int `json:"count,omitempty"`

	// Points - Gamification points
	Points *int `json:"points,omitempty"`

	// DateStartWorkday - Start workday of the best points aggregation interval. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateStartWorkday *time.Time `json:"dateStartWorkday,omitempty"`

	// DateEndWorkday - End workday of the best points aggregation interval. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateEndWorkday *time.Time `json:"dateEndWorkday,omitempty"`
}

Overallbestpointsitem

func (*Overallbestpointsitem) String ¶

func (o *Overallbestpointsitem) String() string

String returns a JSON representation of the model

type Page ¶

type Page struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// VersionId
	VersionId *string `json:"versionId,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"`

	// 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"`

	// RootContainer
	RootContainer *map[string]interface{} `json:"rootContainer,omitempty"`

	// Properties
	Properties *map[string]interface{} `json:"properties,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Page

func (*Page) String ¶

func (o *Page) String() string

String returns a JSON representation of the model

type Pagingspec ¶

type Pagingspec struct {
	// PageSize - How many results per page
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - How many pages in
	PageNumber *int `json:"pageNumber,omitempty"`
}

Pagingspec

func (*Pagingspec) String ¶

func (o *Pagingspec) String() string

String returns a JSON representation of the model

type Parameter ¶

type Parameter struct {
	// Name
	Name *string `json:"name,omitempty"`

	// ParameterType
	ParameterType *string `json:"parameterType,omitempty"`

	// Domain
	Domain *string `json:"domain,omitempty"`

	// Required
	Required *bool `json:"required,omitempty"`
}

Parameter

func (*Parameter) String ¶

func (o *Parameter) String() string

String returns a JSON representation of the model

type Parsedcertificate ¶

type Parsedcertificate struct {
	// CertificateDetails - The details of the certificates that were parsed correctly.
	CertificateDetails *[]Certificatedetails `json:"certificateDetails,omitempty"`
}

Parsedcertificate - Represents the parsed certificate information.

func (*Parsedcertificate) String ¶

func (o *Parsedcertificate) String() string

String returns a JSON representation of the model

type Participant ¶

type Participant struct {
	// Id - A globally unique identifier for this conversation.
	Id *string `json:"id,omitempty"`

	// StartTime - The timestamp when this participant joined the conversation in the provider clock. 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 timestamp when this participant 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
	EndTime *time.Time `json:"endTime,omitempty"`

	// ConnectedTime - The timestamp when this participant was connected to the conversation in the provider 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"`

	// Name - A human readable name identifying the participant.
	Name *string `json:"name,omitempty"`

	// UserUri - If this participant represents a user, then this will be an URI that can be used to fetch the user.
	UserUri *string `json:"userUri,omitempty"`

	// UserId - If this participant represents a user, then this will be the globally unique identifier for the user.
	UserId *string `json:"userId,omitempty"`

	// ExternalContactId - If this participant represents an external contact, then this will be the globally unique identifier for the external contact.
	ExternalContactId *string `json:"externalContactId,omitempty"`

	// ExternalOrganizationId - If this participant represents an external org, then this will be the globally unique identifier for the external org.
	ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"`

	// QueueId - If present, the queue id that the communication channel came in on.
	QueueId *string `json:"queueId,omitempty"`

	// GroupId - If present, group of users the participant represents.
	GroupId *string `json:"groupId,omitempty"`

	// TeamId - The team id that this participant is a member of when added to the conversation.
	TeamId *string `json:"teamId,omitempty"`

	// QueueName - If present, the queue name that the communication channel came in on.
	QueueName *string `json:"queueName,omitempty"`

	// Purpose - A well known string that specifies the purpose of this participant.
	Purpose *string `json:"purpose,omitempty"`

	// ParticipantType - A well known string that specifies the type of this participant.
	ParticipantType *string `json:"participantType,omitempty"`

	// ConsultParticipantId - If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred.
	ConsultParticipantId *string `json:"consultParticipantId,omitempty"`

	// Address - The address for the this participant. For a phone call this will be the ANI.
	Address *string `json:"address,omitempty"`

	// Ani - The address for the this participant. For a phone call this will be the ANI.
	Ani *string `json:"ani,omitempty"`

	// AniName - The ani-based name for this participant.
	AniName *string `json:"aniName,omitempty"`

	// Dnis - The address for the this participant. For a phone call this will be the ANI.
	Dnis *string `json:"dnis,omitempty"`

	// Locale - An ISO 639 language code specifying the locale for this participant
	Locale *string `json:"locale,omitempty"`

	// WrapupRequired - True iff this participant is required to enter wrapup for this conversation.
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupPrompt - This field controls how the UI prompts the agent for a wrapup.
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// WrapupTimeoutMs - Specifies how long a timed ACW session will last.
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// WrapupSkipped - The UI sets this field when the agent chooses to skip entering a wrapup for this participant.
	WrapupSkipped *bool `json:"wrapupSkipped,omitempty"`

	// Wrapup - Call wrap up or disposition data.
	Wrapup *Wrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData - Information on how a communication should be routed to an agent.
	ConversationRoutingData *Conversationroutingdata `json:"conversationRoutingData,omitempty"`

	// AlertingTimeoutMs - Specifies how long the agent has to answer an interaction before being marked as not responding.
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

	// MonitoredParticipantId - If this participant is a monitor, then this will be the id of the participant that is being monitored.
	MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"`

	// CoachedParticipantId - If this participant is a coach, then this will be the id of the participant that is being coached.
	CoachedParticipantId *string `json:"coachedParticipantId,omitempty"`

	// Attributes - Additional participant attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// Calls
	Calls *[]Call `json:"calls,omitempty"`

	// Callbacks
	Callbacks *[]Callback `json:"callbacks,omitempty"`

	// Chats
	Chats *[]Conversationchat `json:"chats,omitempty"`

	// Cobrowsesessions
	Cobrowsesessions *[]Cobrowsesession `json:"cobrowsesessions,omitempty"`

	// Emails
	Emails *[]Email `json:"emails,omitempty"`

	// Messages
	Messages *[]Message `json:"messages,omitempty"`

	// Screenshares
	Screenshares *[]Screenshare `json:"screenshares,omitempty"`

	// SocialExpressions
	SocialExpressions *[]Socialexpression `json:"socialExpressions,omitempty"`

	// Videos
	Videos *[]Video `json:"videos,omitempty"`

	// Evaluations
	Evaluations *[]Evaluation `json:"evaluations,omitempty"`

	// ScreenRecordingState - The current screen recording state for this participant.
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason - The reason specifying why participant flagged the conversation.
	FlaggedReason *string `json:"flaggedReason,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"`
}

Participant

func (*Participant) String ¶

func (o *Participant) String() string

String returns a JSON representation of the model

type Participantattributes ¶

type Participantattributes struct {
	// Attributes - The map of attribute keys to values.
	Attributes *map[string]string `json:"attributes,omitempty"`
}

Participantattributes

func (*Participantattributes) String ¶

func (o *Participantattributes) String() string

String returns a JSON representation of the model

type Participantbasic ¶

type Participantbasic struct {
	// Id - A globally unique identifier for this conversation.
	Id *string `json:"id,omitempty"`

	// StartTime - The timestamp when this participant joined the conversation in the provider clock. 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 timestamp when this participant 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
	EndTime *time.Time `json:"endTime,omitempty"`

	// ConnectedTime - The timestamp when this participant was connected to the conversation in the provider 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"`

	// Name - A human readable name identifying the participant.
	Name *string `json:"name,omitempty"`

	// UserUri - If this participant represents a user, then this will be an URI that can be used to fetch the user.
	UserUri *string `json:"userUri,omitempty"`

	// UserId - If this participant represents a user, then this will be the globally unique identifier for the user.
	UserId *string `json:"userId,omitempty"`

	// ExternalContactId - If this participant represents an external contact, then this will be the globally unique identifier for the external contact.
	ExternalContactId *string `json:"externalContactId,omitempty"`

	// ExternalOrganizationId - If this participant represents an external org, then this will be the globally unique identifier for the external org.
	ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"`

	// QueueId - If present, the queue id that the communication channel came in on.
	QueueId *string `json:"queueId,omitempty"`

	// GroupId - If present, group of users the participant represents.
	GroupId *string `json:"groupId,omitempty"`

	// TeamId - The team id that this participant is a member of when added to the conversation.
	TeamId *string `json:"teamId,omitempty"`

	// QueueName - If present, the queue name that the communication channel came in on.
	QueueName *string `json:"queueName,omitempty"`

	// Purpose - A well known string that specifies the purpose of this participant.
	Purpose *string `json:"purpose,omitempty"`

	// ParticipantType - A well known string that specifies the type of this participant.
	ParticipantType *string `json:"participantType,omitempty"`

	// ConsultParticipantId - If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred.
	ConsultParticipantId *string `json:"consultParticipantId,omitempty"`

	// Address - The address for the this participant. For a phone call this will be the ANI.
	Address *string `json:"address,omitempty"`

	// Ani - The address for the this participant. For a phone call this will be the ANI.
	Ani *string `json:"ani,omitempty"`

	// AniName - The ani-based name for this participant.
	AniName *string `json:"aniName,omitempty"`

	// Dnis - The address for the this participant. For a phone call this will be the ANI.
	Dnis *string `json:"dnis,omitempty"`

	// Locale - An ISO 639 language code specifying the locale for this participant
	Locale *string `json:"locale,omitempty"`

	// WrapupRequired - True iff this participant is required to enter wrapup for this conversation.
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupPrompt - This field controls how the UI prompts the agent for a wrapup.
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// WrapupTimeoutMs - Specifies how long a timed ACW session will last.
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// WrapupSkipped - The UI sets this field when the agent chooses to skip entering a wrapup for this participant.
	WrapupSkipped *bool `json:"wrapupSkipped,omitempty"`

	// Wrapup - Call wrap up or disposition data.
	Wrapup *Wrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData - Information on how a communication should be routed to an agent.
	ConversationRoutingData *Conversationroutingdata `json:"conversationRoutingData,omitempty"`

	// AlertingTimeoutMs - Specifies how long the agent has to answer an interaction before being marked as not responding.
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

	// MonitoredParticipantId - If this participant is a monitor, then this will be the id of the participant that is being monitored.
	MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"`

	// CoachedParticipantId - If this participant is a coach, then this will be the id of the participant that is being coached.
	CoachedParticipantId *string `json:"coachedParticipantId,omitempty"`

	// Attributes - Additional participant attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// Calls
	Calls *[]Callbasic `json:"calls,omitempty"`

	// Callbacks
	Callbacks *[]Callbackbasic `json:"callbacks,omitempty"`

	// Chats
	Chats *[]Conversationchat `json:"chats,omitempty"`

	// Cobrowsesessions
	Cobrowsesessions *[]Cobrowsesession `json:"cobrowsesessions,omitempty"`

	// Emails
	Emails *[]Email `json:"emails,omitempty"`

	// Messages
	Messages *[]Message `json:"messages,omitempty"`

	// Screenshares
	Screenshares *[]Screenshare `json:"screenshares,omitempty"`

	// SocialExpressions
	SocialExpressions *[]Socialexpression `json:"socialExpressions,omitempty"`

	// Videos
	Videos *[]Video `json:"videos,omitempty"`

	// Evaluations
	Evaluations *[]Evaluation `json:"evaluations,omitempty"`

	// ScreenRecordingState - The current screen recording state for this participant.
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason - The reason specifying why participant flagged the conversation.
	FlaggedReason *string `json:"flaggedReason,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"`
}

Participantbasic

func (*Participantbasic) String ¶

func (o *Participantbasic) String() string

String returns a JSON representation of the model

type Participantmetrics ¶

type Participantmetrics struct{}

Participantmetrics

func (*Participantmetrics) String ¶

func (o *Participantmetrics) String() string

String returns a JSON representation of the model

type Patchaction ¶

type Patchaction struct {
	// MediaType - Media type of action.
	MediaType *string `json:"mediaType,omitempty"`

	// ActionTemplate - Action template associated with the action map.
	ActionTemplate *Actionmapactiontemplate `json:"actionTemplate,omitempty"`

	// ArchitectFlowFields - Architect Flow Id and input contract.
	ArchitectFlowFields *Architectflowfields `json:"architectFlowFields,omitempty"`

	// WebMessagingOfferFields - Admin-configurable fields of a web messaging offer action.
	WebMessagingOfferFields *Webmessagingofferfields `json:"webMessagingOfferFields,omitempty"`
}

Patchaction

func (*Patchaction) String ¶

func (o *Patchaction) String() string

String returns a JSON representation of the model

type Patchactionmap ¶

type Patchactionmap 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 *Patchaction `json:"action,omitempty"`

	// ActionMapScheduleGroups - The action map's associated schedule groups.
	ActionMapScheduleGroups *Patchactionmapschedulegroups `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"`
}

Patchactionmap

func (*Patchactionmap) String ¶

func (o *Patchactionmap) String() string

String returns a JSON representation of the model

type Patchactionmapschedulegroups ¶

type Patchactionmapschedulegroups 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"`
}

Patchactionmapschedulegroups

func (*Patchactionmapschedulegroups) String ¶

String returns a JSON representation of the model

type Patchactionproperties ¶

type Patchactionproperties 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 *Patchactionsurvey `json:"webchatSurvey,omitempty"`
}

Patchactionproperties

func (*Patchactionproperties) String ¶

func (o *Patchactionproperties) String() string

String returns a JSON representation of the model

type Patchactionsurvey ¶

type Patchactionsurvey struct {
	// Questions - Questions shown to the user.
	Questions *[]Patchsurveyquestion `json:"questions,omitempty"`
}

Patchactionsurvey

func (*Patchactionsurvey) String ¶

func (o *Patchactionsurvey) String() string

String returns a JSON representation of the model

type Patchactiontarget ¶

type Patchactiontarget struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,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"`
}

Patchactiontarget

func (*Patchactiontarget) String ¶

func (o *Patchactiontarget) String() string

String returns a JSON representation of the model

type Patchactiontemplate ¶

type Patchactiontemplate struct {
	// 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 *Patchcontentoffer `json:"contentOffer,omitempty"`
}

Patchactiontemplate

func (*Patchactiontemplate) String ¶

func (o *Patchactiontemplate) String() string

String returns a JSON representation of the model

type Patchbureschedulingoptionsmanagementunitrequest ¶

type Patchbureschedulingoptionsmanagementunitrequest struct {
	// ManagementUnitId - The management unit portion of the rescheduling run to update
	ManagementUnitId *string `json:"managementUnitId,omitempty"`

	// Applied - Whether to mark the run as applied.  Only applies to reschedule runs.  Once applied, a run cannot be un-marked as applied
	Applied *bool `json:"applied,omitempty"`
}

Patchbureschedulingoptionsmanagementunitrequest

func (*Patchbureschedulingoptionsmanagementunitrequest) String ¶

String returns a JSON representation of the model

type Patchbureschedulingoptionsrequest ¶

type Patchbureschedulingoptionsrequest struct {
	// ManagementUnits - Per-management unit rescheduling options to update
	ManagementUnits *[]Patchbureschedulingoptionsmanagementunitrequest `json:"managementUnits,omitempty"`
}

Patchbureschedulingoptionsrequest

func (*Patchbureschedulingoptionsrequest) String ¶

String returns a JSON representation of the model

type Patchbuschedulerunrequest ¶

type Patchbuschedulerunrequest struct {
	// ReschedulingOptions - The rescheduling options to update
	ReschedulingOptions *Patchbureschedulingoptionsrequest `json:"reschedulingOptions,omitempty"`
}

Patchbuschedulerunrequest

func (*Patchbuschedulerunrequest) String ¶

func (o *Patchbuschedulerunrequest) String() string

String returns a JSON representation of the model

type Patchcalltoaction ¶

type Patchcalltoaction 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"`
}

Patchcalltoaction

func (*Patchcalltoaction) String ¶

func (o *Patchcalltoaction) String() string

String returns a JSON representation of the model

type Patchclosebuttonstyleproperties ¶

type Patchclosebuttonstyleproperties struct {
	// Color - Color of button. (eg. #FF0000)
	Color *string `json:"color,omitempty"`

	// Opacity - Opacity of button.
	Opacity *float32 `json:"opacity,omitempty"`
}

Patchclosebuttonstyleproperties

func (*Patchclosebuttonstyleproperties) String ¶

String returns a JSON representation of the model

type Patchcontentoffer ¶

type Patchcontentoffer 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 *Patchcalltoaction `json:"callToAction,omitempty"`

	// Style - Properties customizing the styling of the content offer.
	Style *Patchcontentofferstylingconfiguration `json:"style,omitempty"`
}

Patchcontentoffer

func (*Patchcontentoffer) String ¶

func (o *Patchcontentoffer) String() string

String returns a JSON representation of the model

type Patchcontentofferstyleproperties ¶

type Patchcontentofferstyleproperties 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"`
}

Patchcontentofferstyleproperties

func (*Patchcontentofferstyleproperties) String ¶

String returns a JSON representation of the model

type Patchcontentofferstylingconfiguration ¶

type Patchcontentofferstylingconfiguration struct {
	// Position - Properties for customizing the positioning of the content offer.
	Position *Patchcontentpositionproperties `json:"position,omitempty"`

	// Offer - Properties for customizing the appearance of the content offer.
	Offer *Patchcontentofferstyleproperties `json:"offer,omitempty"`

	// CloseButton - Properties for customizing the appearance of the close button.
	CloseButton *Patchclosebuttonstyleproperties `json:"closeButton,omitempty"`

	// CtaButton - Properties for customizing the appearance of the CTA button.
	CtaButton *Patchctabuttonstyleproperties `json:"ctaButton,omitempty"`

	// Title - Properties for customizing the appearance of the title text.
	Title *Patchtextstyleproperties `json:"title,omitempty"`

	// Headline - Properties for customizing the appearance of the headline text.
	Headline *Patchtextstyleproperties `json:"headline,omitempty"`

	// Body - Properties for customizing the appearance of the body text.
	Body *Patchtextstyleproperties `json:"body,omitempty"`
}

Patchcontentofferstylingconfiguration

func (*Patchcontentofferstylingconfiguration) String ¶

String returns a JSON representation of the model

type Patchcontentpositionproperties ¶

type Patchcontentpositionproperties 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"`
}

Patchcontentpositionproperties

func (*Patchcontentpositionproperties) String ¶

String returns a JSON representation of the model

type Patchctabuttonstyleproperties ¶

type Patchctabuttonstyleproperties struct {
	// Color - Color of the text. (eg. #FFFFFF)
	Color *string `json:"color,omitempty"`

	// Font - Font of the text. (eg. Helvetica)
	Font *string `json:"font,omitempty"`

	// FontSize - Font size of the text. (eg. '12')
	FontSize *string `json:"fontSize,omitempty"`

	// TextAlign - Text alignment.
	TextAlign *string `json:"textAlign,omitempty"`

	// BackgroundColor - Background color of the CTA button. (eg. #A04033)
	BackgroundColor *string `json:"backgroundColor,omitempty"`
}

Patchctabuttonstyleproperties

func (*Patchctabuttonstyleproperties) String ¶

String returns a JSON representation of the model

type Patchexternalsegment ¶

type Patchexternalsegment struct {
	// Name - Name for the external segment in the system where it originates from.
	Name *string `json:"name,omitempty"`
}

Patchexternalsegment

func (*Patchexternalsegment) String ¶

func (o *Patchexternalsegment) String() string

String returns a JSON representation of the model

type Patchintegrationaction ¶

type Patchintegrationaction struct {
	// Id - ID of the integration action to be invoked.
	Id *string `json:"id,omitempty"`
}

Patchintegrationaction

func (*Patchintegrationaction) String ¶

func (o *Patchintegrationaction) String() string

String returns a JSON representation of the model

type Patchintegrationactionfields ¶

type Patchintegrationactionfields struct {
	// IntegrationAction - Reference to the Integration Action to be used when integrationAction type is qualified
	IntegrationAction *Patchintegrationaction `json:"integrationAction,omitempty"`

	// RequestMappings - Collection of Request Mappings to use
	RequestMappings *[]Requestmapping `json:"requestMappings,omitempty"`
}

Patchintegrationactionfields

func (*Patchintegrationactionfields) String ¶

String returns a JSON representation of the model

type Patchoutcome ¶

type Patchoutcome struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// IsActive - Whether or not the outcome is active.
	IsActive *bool `json:"isActive,omitempty"`

	// DisplayName - The display name of the outcome.
	DisplayName *string `json:"displayName,omitempty"`

	// Version - The version of the outcome.
	Version *int `json:"version,omitempty"`

	// Description - A description of the outcome.
	Description *string `json:"description,omitempty"`

	// IsPositive - Whether or not the outcome is positive.
	IsPositive *bool `json:"isPositive,omitempty"`

	// Context - The context of the outcome.
	Context *Context `json:"context,omitempty"`

	// Journey - The pattern of rules defining the filter of the outcome.
	Journey *Journey `json:"journey,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// CreatedDate - Timestamp indicating when the outcome 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 outcome 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"`
}

Patchoutcome

func (*Patchoutcome) String ¶

func (o *Patchoutcome) String() string

String returns a JSON representation of the model

type Patchpredictorrequest ¶

type Patchpredictorrequest struct {
	// RoutingTimeoutSeconds - Number of seconds allocated to predictive routing before attempting a different routing method. This is a value between 12 and 900 seconds.
	RoutingTimeoutSeconds *int `json:"routingTimeoutSeconds,omitempty"`

	// Schedule - The predictor schedule that determines when the predictor is used for routing interactions.
	Schedule *Predictorschedule `json:"schedule,omitempty"`

	// WorkloadBalancingConfig - The predictor balancing configuration to enable workload balancing
	WorkloadBalancingConfig *Predictorworkloadbalancing `json:"workloadBalancingConfig,omitempty"`
}

Patchpredictorrequest

func (*Patchpredictorrequest) String ¶

func (o *Patchpredictorrequest) String() string

String returns a JSON representation of the model

type Patchsegment ¶

type Patchsegment struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// IsActive - Whether or not the segment is active.
	IsActive *bool `json:"isActive,omitempty"`

	// DisplayName - The display name of the segment.
	DisplayName *string `json:"displayName,omitempty"`

	// Version - The version of the segment.
	Version *int `json:"version,omitempty"`

	// Description - A description of the segment.
	Description *string `json:"description,omitempty"`

	// Color - The hexadecimal color value of the segment.
	Color *string `json:"color,omitempty"`

	// ShouldDisplayToAgent - Whether or not the segment should be displayed to agent/supervisor users.
	ShouldDisplayToAgent *bool `json:"shouldDisplayToAgent,omitempty"`

	// Context - The context of the segment.
	Context *Context `json:"context,omitempty"`

	// Journey - The pattern of rules defining the segment.
	Journey *Journey `json:"journey,omitempty"`

	// ExternalSegment - Details of an entity corresponding to this segment in an external system.
	ExternalSegment *Patchexternalsegment `json:"externalSegment,omitempty"`

	// AssignmentExpirationDays - Time, in days, from when the segment is assigned until it is automatically unassigned.
	AssignmentExpirationDays *int `json:"assignmentExpirationDays,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// CreatedDate - Timestamp indicating when the segment 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 the segment 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"`
}

Patchsegment

func (*Patchsegment) String ¶

func (o *Patchsegment) String() string

String returns a JSON representation of the model

type Patchshifttraderequest ¶

type Patchshifttraderequest struct {
	// ReceivingUserId - Update the ID of the receiving user to direct the request at a specific user, or set the wrapped id to null to open up a trade to be matched by any user.
	ReceivingUserId *Valuewrapperstring `json:"receivingUserId,omitempty"`

	// Expiration - Update the expiration time for this shift trade.
	Expiration *Valuewrapperdate `json:"expiration,omitempty"`

	// AcceptableIntervals - Update the acceptable intervals the initiating user is willing to accept in trade. Setting the enclosed list to empty will make this a one sided trade request
	AcceptableIntervals *Listwrapperinterval `json:"acceptableIntervals,omitempty"`

	// Metadata - Version metadata
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Patchshifttraderequest

func (*Patchshifttraderequest) String ¶

func (o *Patchshifttraderequest) String() string

String returns a JSON representation of the model

type Patchsurveyquestion ¶

type Patchsurveyquestion struct {
	// VarType - Type of survey question.
	VarType *string `json:"type,omitempty"`

	// Label - Label of question.
	Label *string `json:"label,omitempty"`

	// CustomerProperty - The customer property that the answer maps to.
	CustomerProperty *string `json:"customerProperty,omitempty"`

	// Choices - Choices available to user.
	Choices *[]string `json:"choices,omitempty"`

	// IsMandatory - Whether answering this question is mandatory.
	IsMandatory *bool `json:"isMandatory,omitempty"`
}

Patchsurveyquestion

func (*Patchsurveyquestion) String ¶

func (o *Patchsurveyquestion) String() string

String returns a JSON representation of the model

type Patchtextstyleproperties ¶

type Patchtextstyleproperties struct {
	// Color - Color of the text. (eg. #FFFFFF)
	Color *string `json:"color,omitempty"`

	// Font - Font of the text. (eg. Helvetica)
	Font *string `json:"font,omitempty"`

	// FontSize - Font size of the text. (eg. '12')
	FontSize *string `json:"fontSize,omitempty"`

	// TextAlign - Text alignment.
	TextAlign *string `json:"textAlign,omitempty"`
}

Patchtextstyleproperties

func (*Patchtextstyleproperties) String ¶

func (o *Patchtextstyleproperties) String() string

String returns a JSON representation of the model

type Patchuser ¶

type Patchuser struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// AcdAutoAnswer - The value that denotes if acdAutoAnswer is set on the user
	AcdAutoAnswer *bool `json:"acdAutoAnswer,omitempty"`
}

Patchuser

func (*Patchuser) String ¶

func (o *Patchuser) String() string

String returns a JSON representation of the model

type Performanceprofile ¶

type Performanceprofile struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - A name for this performance profile
	Name *string `json:"name,omitempty"`

	// Division - The division for this performance profile associate to
	Division *Division `json:"division,omitempty"`

	// Description - A description about this performance profile
	Description *string `json:"description,omitempty"`

	// MetricOrders - Order of the associated metrics. The list should contain valid ids for metrics
	MetricOrders *[]string `json:"metricOrders,omitempty"`

	// DateCreated - Creation date for this performance profile. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// ReportingIntervals - The reporting interval periods for this performance profile
	ReportingIntervals *[]Reportinginterval `json:"reportingIntervals,omitempty"`

	// Active - The flag for active profiles
	Active *bool `json:"active,omitempty"`

	// MaxLeaderboardRankSize - The maximum rank size for the leaderboard. This counts the number of ranks can be retrieved in a leaderboard queries
	MaxLeaderboardRankSize *int `json:"maxLeaderboardRankSize,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Performanceprofile

func (*Performanceprofile) String ¶

func (o *Performanceprofile) String() string

String returns a JSON representation of the model

type Permissioncollectionentitylisting ¶

type Permissioncollectionentitylisting struct {
	// Entities
	Entities *[]Domainpermissioncollection `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Permissioncollectionentitylisting

func (*Permissioncollectionentitylisting) String ¶

String returns a JSON representation of the model

type Permissiondetails ¶

type Permissiondetails struct {
	// VarType - The type of permission requirement
	VarType *string `json:"type,omitempty"`

	// Permissions - List of required permissions
	Permissions *[]string `json:"permissions,omitempty"`

	// AllowsCurrentUser - Whether the current user can subscribe, when division permissions are otherwise required
	AllowsCurrentUser *bool `json:"allowsCurrentUser,omitempty"`

	// Enforced - Whether or not this permission requirement is enforced
	Enforced *bool `json:"enforced,omitempty"`
}

Permissiondetails

func (*Permissiondetails) String ¶

func (o *Permissiondetails) String() string

String returns a JSON representation of the model

type Permissions ¶

type Permissions struct {
	// Ids - List of permission ids.
	Ids *[]string `json:"ids,omitempty"`
}

Permissions

func (*Permissions) String ¶

func (o *Permissions) String() string

String returns a JSON representation of the model

type Phone ¶

type Phone struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// Site - The site associated to the phone.
	Site *Domainentityref `json:"site,omitempty"`

	// PhoneBaseSettings - Phone Base Settings
	PhoneBaseSettings *Domainentityref `json:"phoneBaseSettings,omitempty"`

	// LineBaseSettings
	LineBaseSettings *Domainentityref `json:"lineBaseSettings,omitempty"`

	// PhoneMetaBase
	PhoneMetaBase *Domainentityref `json:"phoneMetaBase,omitempty"`

	// Lines - Lines
	Lines *[]Line `json:"lines,omitempty"`

	// Status - The status of the phone and lines from the primary Edge.
	Status *Phonestatus `json:"status,omitempty"`

	// SecondaryStatus - The status of the phone and lines from the secondary Edge.
	SecondaryStatus *Phonestatus `json:"secondaryStatus,omitempty"`

	// UserAgentInfo - User Agent Information for this phone. This includes model, firmware version, and manufacturer.
	UserAgentInfo *Useragentinfo `json:"userAgentInfo,omitempty"`

	// Properties
	Properties *map[string]interface{} `json:"properties,omitempty"`

	// Capabilities
	Capabilities *Phonecapabilities `json:"capabilities,omitempty"`

	// WebRtcUser - This is the user associated with a WebRTC type phone.  It is required for all WebRTC phones.
	WebRtcUser *Domainentityref `json:"webRtcUser,omitempty"`

	// PrimaryEdge
	PrimaryEdge *Edge `json:"primaryEdge,omitempty"`

	// SecondaryEdge
	SecondaryEdge *Edge `json:"secondaryEdge,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Phone

func (*Phone) String ¶

func (o *Phone) String() string

String returns a JSON representation of the model

type Phonebase ¶

type Phonebase struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// PhoneMetaBase - A phone metabase is essentially a database for storing phone configuration settings, which simplifies the configuration process.
	PhoneMetaBase *Domainentityref `json:"phoneMetaBase,omitempty"`

	// Lines - The list of linebases associated with the phone base.
	Lines *[]Linebase `json:"lines,omitempty"`

	// Properties
	Properties *map[string]interface{} `json:"properties,omitempty"`

	// Capabilities
	Capabilities *Phonecapabilities `json:"capabilities,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Phonebase

func (*Phonebase) String ¶

func (o *Phonebase) String() string

String returns a JSON representation of the model

type Phonebaseentitylisting ¶

type Phonebaseentitylisting struct {
	// Entities
	Entities *[]Phonebase `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Phonebaseentitylisting

func (*Phonebaseentitylisting) String ¶

func (o *Phonebaseentitylisting) String() string

String returns a JSON representation of the model

type Phonecapabilities ¶

type Phonecapabilities struct {
	// Provisions
	Provisions *bool `json:"provisions,omitempty"`

	// Registers
	Registers *bool `json:"registers,omitempty"`

	// DualRegisters
	DualRegisters *bool `json:"dualRegisters,omitempty"`

	// HardwareIdType
	HardwareIdType *string `json:"hardwareIdType,omitempty"`

	// AllowReboot
	AllowReboot *bool `json:"allowReboot,omitempty"`

	// NoRebalance
	NoRebalance *bool `json:"noRebalance,omitempty"`

	// NoCloudProvisioning
	NoCloudProvisioning *bool `json:"noCloudProvisioning,omitempty"`

	// MediaCodecs
	MediaCodecs *[]string `json:"mediaCodecs,omitempty"`

	// Cdm
	Cdm *bool `json:"cdm,omitempty"`
}

Phonecapabilities

func (*Phonecapabilities) String ¶

func (o *Phonecapabilities) String() string

String returns a JSON representation of the model

type Phonechangetopicedgereference ¶

type Phonechangetopicedgereference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`
}

Phonechangetopicedgereference

func (*Phonechangetopicedgereference) String ¶

String returns a JSON representation of the model

type Phonechangetopiclinestatus ¶

type Phonechangetopiclinestatus struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Reachable
	Reachable *bool `json:"reachable,omitempty"`

	// AddressOfRecord
	AddressOfRecord *string `json:"addressOfRecord,omitempty"`

	// ContactAddresses
	ContactAddresses *[]string `json:"contactAddresses,omitempty"`

	// ReachableStateTime
	ReachableStateTime *time.Time `json:"reachableStateTime,omitempty"`
}

Phonechangetopiclinestatus

func (*Phonechangetopiclinestatus) String ¶

func (o *Phonechangetopiclinestatus) String() string

String returns a JSON representation of the model

type Phonechangetopicphone ¶

type Phonechangetopicphone struct {
	// UserAgentInfo
	UserAgentInfo *Phonechangetopicuseragentinfo `json:"userAgentInfo,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Status
	Status *Phonechangetopicphonestatus `json:"status,omitempty"`

	// SecondaryStatus
	SecondaryStatus *Phonechangetopicphonestatus `json:"secondaryStatus,omitempty"`
}

Phonechangetopicphone

func (*Phonechangetopicphone) String ¶

func (o *Phonechangetopicphone) String() string

String returns a JSON representation of the model

type Phonechangetopicphonestatus ¶

type Phonechangetopicphonestatus struct {
	// Id
	Id *string `json:"id,omitempty"`

	// OperationalStatus
	OperationalStatus *string `json:"operationalStatus,omitempty"`

	// Edge
	Edge *Phonechangetopicedgereference `json:"edge,omitempty"`

	// Provision
	Provision *Phonechangetopicprovisioninfo `json:"provision,omitempty"`

	// LineStatuses
	LineStatuses *[]Phonechangetopiclinestatus `json:"lineStatuses,omitempty"`
}

Phonechangetopicphonestatus

func (*Phonechangetopicphonestatus) String ¶

func (o *Phonechangetopicphonestatus) String() string

String returns a JSON representation of the model

type Phonechangetopicprovisioninfo ¶

type Phonechangetopicprovisioninfo struct {
	// Time
	Time *time.Time `json:"time,omitempty"`

	// Source
	Source *string `json:"source,omitempty"`

	// ErrorInfo
	ErrorInfo *string `json:"errorInfo,omitempty"`
}

Phonechangetopicprovisioninfo

func (*Phonechangetopicprovisioninfo) String ¶

String returns a JSON representation of the model

type Phonechangetopicuseragentinfo ¶

type Phonechangetopicuseragentinfo struct {
	// FirmwareVersion
	FirmwareVersion *string `json:"firmwareVersion,omitempty"`

	// Manufacturer
	Manufacturer *string `json:"manufacturer,omitempty"`

	// Model
	Model *string `json:"model,omitempty"`
}

Phonechangetopicuseragentinfo

func (*Phonechangetopicuseragentinfo) String ¶

String returns a JSON representation of the model

type Phonecolumn ¶

type Phonecolumn struct {
	// ColumnName - The name of the phone column.
	ColumnName *string `json:"columnName,omitempty"`

	// VarType - The type of the phone column. For example, 'cell' or 'home'.
	VarType *string `json:"type,omitempty"`
}

Phonecolumn

func (*Phonecolumn) String ¶

func (o *Phonecolumn) String() string

String returns a JSON representation of the model

type Phoneentitylisting ¶

type Phoneentitylisting struct {
	// Entities
	Entities *[]Phone `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Phoneentitylisting

func (*Phoneentitylisting) String ¶

func (o *Phoneentitylisting) String() string

String returns a JSON representation of the model

type Phonemetabaseentitylisting ¶

type Phonemetabaseentitylisting struct {
	// Entities
	Entities *[]Metabase `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Phonemetabaseentitylisting

func (*Phonemetabaseentitylisting) String ¶

func (o *Phonemetabaseentitylisting) String() string

String returns a JSON representation of the model

type Phonenumber ¶

type Phonenumber struct {
	// Display
	Display *string `json:"display,omitempty"`

	// Extension
	Extension *int `json:"extension,omitempty"`

	// AcceptsSMS
	AcceptsSMS *bool `json:"acceptsSMS,omitempty"`

	// UserInput
	UserInput *string `json:"userInput,omitempty"`

	// E164
	E164 *string `json:"e164,omitempty"`

	// CountryCode
	CountryCode *string `json:"countryCode,omitempty"`
}

Phonenumber

func (*Phonenumber) String ¶

func (o *Phonenumber) String() string

String returns a JSON representation of the model

type Phonenumbercolumn ¶

type Phonenumbercolumn struct {
	// ColumnName
	ColumnName *string `json:"columnName,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Phonenumbercolumn

func (*Phonenumbercolumn) String ¶

func (o *Phonenumbercolumn) String() string

String returns a JSON representation of the model

type Phonenumberstatus ¶

type Phonenumberstatus struct {
	// Callable - Indicates whether or not a phone number is callable.
	Callable *bool `json:"callable,omitempty"`
}

Phonenumberstatus

func (*Phonenumberstatus) String ¶

func (o *Phonenumberstatus) String() string

String returns a JSON representation of the model

type Phonesreboot ¶

type Phonesreboot struct {
	// PhoneIds - The list of phone Ids to reboot.
	PhoneIds *[]string `json:"phoneIds,omitempty"`

	// SiteId - ID of the site for which to reboot all phones at that site. no.active.edge and phone.cannot.resolve errors are ignored.
	SiteId *string `json:"siteId,omitempty"`
}

Phonesreboot

func (*Phonesreboot) String ¶

func (o *Phonesreboot) String() string

String returns a JSON representation of the model

type Phonestatus ¶

type Phonestatus struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// OperationalStatus - The Operational Status of this phone
	OperationalStatus *string `json:"operationalStatus,omitempty"`

	// EdgesStatus - The status of the primary or secondary Edges assigned to the phone lines.
	EdgesStatus *string `json:"edgesStatus,omitempty"`

	// EventCreationTime - Event Creation Time represents an ISO-8601 string. For example: UTC, UTC+01:00, or Europe/London
	EventCreationTime *string `json:"eventCreationTime,omitempty"`

	// Provision - Provision information for this phone
	Provision *Provisioninfo `json:"provision,omitempty"`

	// LineStatuses - A list of LineStatus information for each of the lines of this phone
	LineStatuses *[]Linestatus `json:"lineStatuses,omitempty"`

	// PhoneAssignmentToEdgeType - The phone status's edge assignment type.
	PhoneAssignmentToEdgeType *string `json:"phoneAssignmentToEdgeType,omitempty"`

	// Edge - The URI of the edge that provided this status information.
	Edge *Domainentityref `json:"edge,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Phonestatus

func (*Phonestatus) String ¶

func (o *Phonestatus) String() string

String returns a JSON representation of the model

type Phrase ¶

type Phrase struct {
	// Text - The phrase text
	Text *string `json:"text,omitempty"`

	// Strictness - The phrase strictness, default value is null
	Strictness *string `json:"strictness,omitempty"`

	// Sentiment - The phrase sentiment, default value is Unspecified
	Sentiment *string `json:"sentiment,omitempty"`
}

Phrase

func (*Phrase) String ¶

func (o *Phrase) String() string

String returns a JSON representation of the model

type Physicalinterfaceentitylisting ¶

type Physicalinterfaceentitylisting struct {
	// Entities
	Entities *[]Domainphysicalinterface `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Physicalinterfaceentitylisting

func (*Physicalinterfaceentitylisting) String ¶

String returns a JSON representation of the model

type Pinconfiguration ¶

type Pinconfiguration struct {
	// MinimumLength
	MinimumLength *int `json:"minimumLength,omitempty"`

	// MaximumLength
	MaximumLength *int `json:"maximumLength,omitempty"`
}

Pinconfiguration

func (*Pinconfiguration) String ¶

func (o *Pinconfiguration) String() string

String returns a JSON representation of the model

type Pingidentity ¶

type Pingidentity 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"`
}

Pingidentity

func (*Pingidentity) String ¶

func (o *Pingidentity) String() string

String returns a JSON representation of the model

type Planninggroup ¶

type Planninggroup struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ServiceGoalTemplate - The ID of the service goal template associated with this planning group
	ServiceGoalTemplate *Servicegoaltemplatereference `json:"serviceGoalTemplate,omitempty"`

	// RoutePaths - Set of route paths associated with the planning group
	RoutePaths *[]Routepathresponse `json:"routePaths,omitempty"`

	// Metadata - Version metadata for the planning group
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Planninggroup - Planning Group

func (*Planninggroup) String ¶

func (o *Planninggroup) String() string

String returns a JSON representation of the model

type Planninggrouplist ¶

type Planninggrouplist struct {
	// Entities
	Entities *[]Planninggroup `json:"entities,omitempty"`
}

Planninggrouplist - List of planning groups

func (*Planninggrouplist) String ¶

func (o *Planninggrouplist) String() string

String returns a JSON representation of the model

type Planninggroupreference ¶

type Planninggroupreference 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"`
}

Planninggroupreference - Planning Group

func (*Planninggroupreference) String ¶

func (o *Planninggroupreference) String() string

String returns a JSON representation of the model

type Planningperiodsettings ¶

type Planningperiodsettings struct {
	// WeekCount - Planning period length in weeks
	WeekCount *int `json:"weekCount,omitempty"`

	// StartDate - Start date of the planning period in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	StartDate *time.Time `json:"startDate,omitempty"`
}

Planningperiodsettings

func (*Planningperiodsettings) String ¶

func (o *Planningperiodsettings) String() string

String returns a JSON representation of the model

type Policy ¶

type Policy struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,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"`

	// 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"`

	// Order
	Order *int `json:"order,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// MediaPolicies - Conditions and actions per media type
	MediaPolicies *Mediapolicies `json:"mediaPolicies,omitempty"`

	// Conditions - Conditions
	Conditions *Policyconditions `json:"conditions,omitempty"`

	// Actions - Actions
	Actions *Policyactions `json:"actions,omitempty"`

	// PolicyErrors
	PolicyErrors *Policyerrors `json:"policyErrors,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Policy

func (*Policy) String ¶

func (o *Policy) String() string

String returns a JSON representation of the model

type Policyactions ¶

type Policyactions struct {
	// RetainRecording - true to retain the recording associated with the conversation. Default = true
	RetainRecording *bool `json:"retainRecording,omitempty"`

	// DeleteRecording - true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false
	DeleteRecording *bool `json:"deleteRecording,omitempty"`

	// AlwaysDelete - true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false
	AlwaysDelete *bool `json:"alwaysDelete,omitempty"`

	// AssignEvaluations
	AssignEvaluations *[]Evaluationassignment `json:"assignEvaluations,omitempty"`

	// AssignMeteredEvaluations
	AssignMeteredEvaluations *[]Meteredevaluationassignment `json:"assignMeteredEvaluations,omitempty"`

	// AssignMeteredAssignmentByAgent
	AssignMeteredAssignmentByAgent *[]Meteredassignmentbyagent `json:"assignMeteredAssignmentByAgent,omitempty"`

	// AssignCalibrations
	AssignCalibrations *[]Calibrationassignment `json:"assignCalibrations,omitempty"`

	// AssignSurveys
	AssignSurveys *[]Surveyassignment `json:"assignSurveys,omitempty"`

	// RetentionDuration
	RetentionDuration *Retentionduration `json:"retentionDuration,omitempty"`

	// InitiateScreenRecording
	InitiateScreenRecording *Initiatescreenrecording `json:"initiateScreenRecording,omitempty"`

	// MediaTranscriptions
	MediaTranscriptions *[]Mediatranscription `json:"mediaTranscriptions,omitempty"`

	// IntegrationExport - Policy action for exporting recordings using an integration to 3rd party s3.
	IntegrationExport *Integrationexport `json:"integrationExport,omitempty"`
}

Policyactions

func (*Policyactions) String ¶

func (o *Policyactions) String() string

String returns a JSON representation of the model

type Policyconditions ¶

type Policyconditions struct {
	// ForUsers
	ForUsers *[]User `json:"forUsers,omitempty"`

	// Directions
	Directions *[]string `json:"directions,omitempty"`

	// DateRanges
	DateRanges *[]string `json:"dateRanges,omitempty"`

	// MediaTypes
	MediaTypes *[]string `json:"mediaTypes,omitempty"`

	// ForQueues
	ForQueues *[]Queue `json:"forQueues,omitempty"`

	// Duration
	Duration *Durationcondition `json:"duration,omitempty"`

	// WrapupCodes
	WrapupCodes *[]Wrapupcode `json:"wrapupCodes,omitempty"`

	// TimeAllowed
	TimeAllowed *Timeallowed `json:"timeAllowed,omitempty"`
}

Policyconditions

func (*Policyconditions) String ¶

func (o *Policyconditions) String() string

String returns a JSON representation of the model

type Policycreate ¶

type Policycreate struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The policy name.
	Name *string `json:"name,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"`

	// 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"`

	// Order
	Order *int `json:"order,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// MediaPolicies - Conditions and actions per media type
	MediaPolicies *Mediapolicies `json:"mediaPolicies,omitempty"`

	// Conditions - Conditions
	Conditions *Policyconditions `json:"conditions,omitempty"`

	// Actions - Actions
	Actions *Policyactions `json:"actions,omitempty"`

	// PolicyErrors
	PolicyErrors *Policyerrors `json:"policyErrors,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Policycreate

func (*Policycreate) String ¶

func (o *Policycreate) String() string

String returns a JSON representation of the model

type Policyentitylisting ¶

type Policyentitylisting struct {
	// Entities
	Entities *[]Policy `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Policyentitylisting

func (*Policyentitylisting) String ¶

func (o *Policyentitylisting) String() string

String returns a JSON representation of the model

type Policyerrormessage ¶

type Policyerrormessage struct {
	// StatusCode
	StatusCode *int `json:"statusCode,omitempty"`

	// UserMessage
	UserMessage *interface{} `json:"userMessage,omitempty"`

	// UserParamsMessage
	UserParamsMessage *string `json:"userParamsMessage,omitempty"`

	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// CorrelationId
	CorrelationId *string `json:"correlationId,omitempty"`

	// UserParams
	UserParams *[]Userparam `json:"userParams,omitempty"`

	// InsertDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	InsertDate *time.Time `json:"insertDate,omitempty"`
}

Policyerrormessage

func (*Policyerrormessage) String ¶

func (o *Policyerrormessage) String() string

String returns a JSON representation of the model

type Policyerrors ¶

type Policyerrors struct {
	// PolicyErrorMessages
	PolicyErrorMessages *[]Policyerrormessage `json:"policyErrorMessages,omitempty"`
}

Policyerrors

func (*Policyerrors) String ¶

func (o *Policyerrors) String() string

String returns a JSON representation of the model

type Policyupdate ¶

type Policyupdate struct {
	// Enabled
	Enabled *bool `json:"enabled,omitempty"`
}

Policyupdate

func (*Policyupdate) String ¶

func (o *Policyupdate) String() string

String returns a JSON representation of the model

type Postactioninput ¶

type Postactioninput struct {
	// Category - Category of action, Can be up to 256 characters long
	Category *string `json:"category,omitempty"`

	// Name - Name of action, Can be up to 256 characters long
	Name *string `json:"name,omitempty"`

	// IntegrationId - The ID of the integration this action is associated to
	IntegrationId *string `json:"integrationId,omitempty"`

	// Config - Configuration to support request and response processing
	Config *Actionconfig `json:"config,omitempty"`

	// Contract - Action contract
	Contract *Actioncontractinput `json:"contract,omitempty"`

	// Secure - Indication of whether or not the action is designed to accept sensitive data
	Secure *bool `json:"secure,omitempty"`
}

Postactioninput - Definition of an Action to be created or updated.

func (*Postactioninput) String ¶

func (o *Postactioninput) String() string

String returns a JSON representation of the model

type Postinputcontract ¶

type Postinputcontract 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.
	InputSchema *Jsonschemadocument `json:"inputSchema,omitempty"`
}

Postinputcontract - The schemas defining all of the expected requests/inputs.

func (*Postinputcontract) String ¶

func (o *Postinputcontract) String() string

String returns a JSON representation of the model

type Postoutputcontract ¶

type Postoutputcontract struct {
	// SuccessSchema - JSON schema that defines the transformed, successful result that will be sent back to the caller.
	SuccessSchema *Jsonschemadocument `json:"successSchema,omitempty"`
}

Postoutputcontract - The schemas defining all of the expected responses/outputs.

func (*Postoutputcontract) String ¶

func (o *Postoutputcontract) String() string

String returns a JSON representation of the model

type Posttextmessage ¶

type Posttextmessage struct {
	// VarType - Message type
	VarType *string `json:"type,omitempty"`

	// Text - Message text. If type is structured, used as fallback for clients that do not support particular structured content
	Text *string `json:"text,omitempty"`

	// Content - A list of content elements in message
	Content *[]Messagecontent `json:"content,omitempty"`
}

Posttextmessage

func (*Posttextmessage) String ¶

func (o *Posttextmessage) String() string

String returns a JSON representation of the model

type Posttextrequest ¶

type Posttextrequest struct {
	// BotId - ID of the bot to send the text to.
	BotId *string `json:"botId,omitempty"`

	// BotAlias - Alias/Version of the bot
	BotAlias *string `json:"botAlias,omitempty"`

	// IntegrationId - the integration service id for the bot's credentials
	IntegrationId *string `json:"integrationId,omitempty"`

	// BotSessionId - GUID for this bot's session
	BotSessionId *string `json:"botSessionId,omitempty"`

	// PostTextMessage - Message to send to the bot
	PostTextMessage *Posttextmessage `json:"postTextMessage,omitempty"`

	// LanguageCode - The launguage code the bot will run under
	LanguageCode *string `json:"languageCode,omitempty"`

	// BotSessionTimeoutMinutes - Override timeout for the bot session. This should be greater than 10 minutes.
	BotSessionTimeoutMinutes *int `json:"botSessionTimeoutMinutes,omitempty"`

	// BotChannels - The channels this bot is utilizing
	BotChannels *[]string `json:"botChannels,omitempty"`

	// BotCorrelationId - Id for tracking the activity - this will be returned in the response
	BotCorrelationId *string `json:"botCorrelationId,omitempty"`

	// MessagingPlatformType - If the channels list contains a 'Messaging' item and the messaging platform is known, include it here to get accurate analytics
	MessagingPlatformType *string `json:"messagingPlatformType,omitempty"`

	// AmazonLexRequest
	AmazonLexRequest *Amazonlexrequest `json:"amazonLexRequest,omitempty"`

	// GoogleDialogflow
	GoogleDialogflow *Googledialogflowcustomsettings `json:"googleDialogflow,omitempty"`

	// GenesysBotConnector
	GenesysBotConnector *Genesysbotconnector `json:"genesysBotConnector,omitempty"`
}

Posttextrequest

func (*Posttextrequest) String ¶

func (o *Posttextrequest) String() string

String returns a JSON representation of the model

type Posttextresponse ¶

type Posttextresponse struct {
	// BotState - The state of the bot after completion of the request
	BotState *string `json:"botState,omitempty"`

	// ReplyMessages - The list of messages to respond with, if any
	ReplyMessages *[]Posttextmessage `json:"replyMessages,omitempty"`

	// IntentName - The name of the intent the bot is either processing or has processed, this will be blank if no intent could be detected.
	IntentName *string `json:"intentName,omitempty"`

	// Slots - Data parameters detected and filled by the bot.
	Slots *map[string]string `json:"slots,omitempty"`

	// BotCorrelationId - The optional ID specified in the request
	BotCorrelationId *string `json:"botCorrelationId,omitempty"`

	// AmazonLex - Raw data response from AWS (if called)
	AmazonLex *map[string]interface{} `json:"amazonLex,omitempty"`

	// GoogleDialogFlow - Raw data response from Google Dialogflow (if called)
	GoogleDialogFlow *map[string]interface{} `json:"googleDialogFlow,omitempty"`

	// GenesysDialogEngine - Raw data response from Genesys' Dialogengine (if called)
	GenesysDialogEngine *map[string]interface{} `json:"genesysDialogEngine,omitempty"`

	// GenesysBotConnector - Raw data response from Genesys' BotConnector (if called)
	GenesysBotConnector *map[string]interface{} `json:"genesysBotConnector,omitempty"`
}

Posttextresponse

func (*Posttextresponse) String ¶

func (o *Posttextresponse) String() string

String returns a JSON representation of the model

type Predictionresults ¶

type Predictionresults struct {
	// Intent - Indicates the media type scope of this estimated wait time
	Intent *string `json:"intent,omitempty"`

	// Formula - Indicates the estimated wait time Formula
	Formula *string `json:"formula,omitempty"`

	// EstimatedWaitTimeSeconds - Estimated wait time in seconds
	EstimatedWaitTimeSeconds *int `json:"estimatedWaitTimeSeconds,omitempty"`
}

Predictionresults

func (*Predictionresults) String ¶

func (o *Predictionresults) String() string

String returns a JSON representation of the model

type Predictor ¶

type Predictor struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Queues - The queue IDs associated with the predictor.
	Queues *[]Addressableentityref `json:"queues,omitempty"`

	// Kpi - The KPI that the predictor attempts to maximize/minimize.
	Kpi *string `json:"kpi,omitempty"`

	// RoutingTimeoutSeconds - Number of seconds allocated to predictive routing before attempting a different routing method. This is a value between 12 and 900 seconds.
	RoutingTimeoutSeconds *int `json:"routingTimeoutSeconds,omitempty"`

	// Schedule - The predictor schedule that determines when the predictor is used for routing interactions.
	Schedule *Predictorschedule `json:"schedule,omitempty"`

	// State - The predictor state.
	State *string `json:"state,omitempty"`

	// DateCreated - DateTime indicating when the predictor 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"`

	// DateModified - DateTime indicating when the predictor was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// WorkloadBalancingConfig - The predictor balancing configuration to enable workload balancing.
	WorkloadBalancingConfig *Predictorworkloadbalancing `json:"workloadBalancingConfig,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Predictor

func (*Predictor) String ¶

func (o *Predictor) String() string

String returns a JSON representation of the model

type Predictorlisting ¶

type Predictorlisting struct {
	// Entities
	Entities *[]Predictor `json:"entities,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`
}

Predictorlisting

func (*Predictorlisting) String ¶

func (o *Predictorlisting) String() string

String returns a JSON representation of the model

type Predictorschedule ¶

type Predictorschedule struct {
	// ScheduleType - The predictor schedule type.
	ScheduleType *string `json:"scheduleType,omitempty"`

	// DateStarted - DateTime indicating when the predictor schedule was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateStarted *time.Time `json:"dateStarted,omitempty"`
}

Predictorschedule

func (*Predictorschedule) String ¶

func (o *Predictorschedule) String() string

String returns a JSON representation of the model

type Predictorworkloadbalancing ¶

type Predictorworkloadbalancing struct {
	// Enabled - Flag to activate and deactivate workload balancing.
	Enabled *bool `json:"enabled,omitempty"`
}

Predictorworkloadbalancing

func (*Predictorworkloadbalancing) String ¶

func (o *Predictorworkloadbalancing) String() string

String returns a JSON representation of the model

type PresenceApi ¶

type PresenceApi struct {
	Configuration *Configuration
}

PresenceApi provides functions for API endpoints

func NewPresenceApi ¶

func NewPresenceApi() *PresenceApi

NewPresenceApi creates an API instance using the default configuration

func NewPresenceApiWithConfig ¶

func NewPresenceApiWithConfig(config *Configuration) *PresenceApi

NewPresenceApiWithConfig creates an API instance using the provided configuration

func (PresenceApi) DeletePresencedefinition ¶

func (a PresenceApi) DeletePresencedefinition(presenceId string) (*APIResponse, error)

DeletePresencedefinition invokes DELETE /api/v2/presencedefinitions/{presenceId}

Delete a Presence Definition

func (PresenceApi) GetPresencedefinition ¶

func (a PresenceApi) GetPresencedefinition(presenceId string, localeCode string) (*Organizationpresence, *APIResponse, error)

GetPresencedefinition invokes GET /api/v2/presencedefinitions/{presenceId}

Get a Presence Definition

func (PresenceApi) GetPresencedefinitions ¶

func (a PresenceApi) GetPresencedefinitions(pageNumber int, pageSize int, deleted string, localeCode string) (*Organizationpresenceentitylisting, *APIResponse, error)

GetPresencedefinitions invokes GET /api/v2/presencedefinitions

Get an Organization&#39;s list of Presence Definitions

func (PresenceApi) GetSystempresences ¶

func (a PresenceApi) GetSystempresences() ([]Systempresence, *APIResponse, error)

GetSystempresences invokes GET /api/v2/systempresences

Get the list of SystemPresences

func (PresenceApi) GetUserPresence ¶

func (a PresenceApi) GetUserPresence(userId string, sourceId string) (*Userpresence, *APIResponse, error)

GetUserPresence invokes GET /api/v2/users/{userId}/presences/{sourceId}

Get a user&#39;s Presence

Get a user&#39;s presence for the specified source that is not specifically listed. Used to support custom presence sources.

func (PresenceApi) GetUserPresencesMicrosoftteams ¶

func (a PresenceApi) GetUserPresencesMicrosoftteams(userId string) (*Presenceexpand, *APIResponse, error)

GetUserPresencesMicrosoftteams invokes GET /api/v2/users/{userId}/presences/microsoftteams

Get a user&#39;s Microsoft Teams presence.

Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.

func (PresenceApi) GetUserPresencesPurecloud ¶

func (a PresenceApi) GetUserPresencesPurecloud(userId string) (*Userpresence, *APIResponse, error)

GetUserPresencesPurecloud invokes GET /api/v2/users/{userId}/presences/purecloud

Get a user&#39;s Genesys Cloud presence.

Get the default Genesys Cloud user presence source PURECLOUD

func (PresenceApi) GetUserPresencesZoomphone ¶

func (a PresenceApi) GetUserPresencesZoomphone(userId string) (*Presenceexpand, *APIResponse, error)

GetUserPresencesZoomphone invokes GET /api/v2/users/{userId}/presences/zoomphone

Get a user&#39;s Zoom Phone presence.

Gets the presence for a Zoom user. This will return the Zoom Phone presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.

func (PresenceApi) PatchUserPresence ¶

func (a PresenceApi) PatchUserPresence(userId string, sourceId string, body Userpresence) (*Userpresence, *APIResponse, error)

PatchUserPresence invokes PATCH /api/v2/users/{userId}/presences/{sourceId}

Patch a user&#39;s Presence

Patch a user&#39;s presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the &#39;source&#39; defined in the path as the user&#39;s primary presence source. Option 2: Provide the presenceDefinition value. The &#39;id&#39; is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.

func (PresenceApi) PatchUserPresencesPurecloud ¶

func (a PresenceApi) PatchUserPresencesPurecloud(userId string, body Userpresence) (*Userpresence, *APIResponse, error)

PatchUserPresencesPurecloud invokes PATCH /api/v2/users/{userId}/presences/purecloud

Patch a Genesys Cloud user&#39;s presence

The presence object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the PURECLOUD source as the user&#39;s primary presence source. Option 2: Provide the presenceDefinition value. The &#39;id&#39; is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.

func (PresenceApi) PostPresencedefinitions ¶

func (a PresenceApi) PostPresencedefinitions(body Organizationpresence) (*Organizationpresence, *APIResponse, error)

PostPresencedefinitions invokes POST /api/v2/presencedefinitions

Create a Presence Definition

func (PresenceApi) PutPresencedefinition ¶

func (a PresenceApi) PutPresencedefinition(presenceId string, body Organizationpresence) (*Organizationpresence, *APIResponse, error)

PutPresencedefinition invokes PUT /api/v2/presencedefinitions/{presenceId}

Update a Presence Definition

func (PresenceApi) PutUsersPresencesBulk ¶

func (a PresenceApi) PutUsersPresencesBulk(body []Userpresence) ([]Userpresence, *APIResponse, error)

PutUsersPresencesBulk invokes PUT /api/v2/users/presences/bulk

Update bulk user Presences

type Presencedefinition ¶

type Presencedefinition struct {
	// Id - description
	Id *string `json:"id,omitempty"`

	// SystemPresence
	SystemPresence *string `json:"systemPresence,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Presencedefinition

func (*Presencedefinition) String ¶

func (o *Presencedefinition) String() string

String returns a JSON representation of the model

type Presencedetailqueryclause ¶

type Presencedetailqueryclause 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 *[]Presencedetailquerypredicate `json:"predicates,omitempty"`
}

Presencedetailqueryclause

func (*Presencedetailqueryclause) String ¶

func (o *Presencedetailqueryclause) String() string

String returns a JSON representation of the model

type Presencedetailqueryfilter ¶

type Presencedetailqueryfilter 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 *[]Presencedetailqueryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Presencedetailquerypredicate `json:"predicates,omitempty"`
}

Presencedetailqueryfilter

func (*Presencedetailqueryfilter) String ¶

func (o *Presencedetailqueryfilter) String() string

String returns a JSON representation of the model

type Presencedetailquerypredicate ¶

type Presencedetailquerypredicate 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"`
}

Presencedetailquerypredicate

func (*Presencedetailquerypredicate) String ¶

String returns a JSON representation of the model

type Presenceeventorganizationpresence ¶

type Presenceeventorganizationpresence struct {
	// Id
	Id *string `json:"id,omitempty"`

	// SystemPresence
	SystemPresence *string `json:"systemPresence,omitempty"`
}

Presenceeventorganizationpresence

func (*Presenceeventorganizationpresence) String ¶

String returns a JSON representation of the model

type Presenceeventuserpresence ¶

type Presenceeventuserpresence struct {
	// Source
	Source *string `json:"source,omitempty"`

	// PresenceDefinition
	PresenceDefinition *Presenceeventorganizationpresence `json:"presenceDefinition,omitempty"`

	// Primary
	Primary *bool `json:"primary,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// ModifiedDate
	ModifiedDate *time.Time `json:"modifiedDate,omitempty"`
}

Presenceeventuserpresence

func (*Presenceeventuserpresence) String ¶

func (o *Presenceeventuserpresence) String() string

String returns a JSON representation of the model

type Presenceexpand ¶

type Presenceexpand struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Presences - An array of user presences
	Presences *[]Userpresence `json:"presences,omitempty"`

	// OutOfOffices - An array of out of office statuses
	OutOfOffices *[]Outofoffice `json:"outOfOffices,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Presenceexpand

func (*Presenceexpand) String ¶

func (o *Presenceexpand) String() string

String returns a JSON representation of the model

type Program ¶

type Program 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"`

	// Published
	Published *bool `json:"published,omitempty"`

	// Topics
	Topics *[]Basetopicentitiy `json:"topics,omitempty"`

	// Tags
	Tags *[]string `json:"tags,omitempty"`

	// ModifiedBy
	ModifiedBy *Addressableentityref `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"`

	// PublishedBy
	PublishedBy *Addressableentityref `json:"publishedBy,omitempty"`

	// DatePublished - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DatePublished *time.Time `json:"datePublished,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Program

func (*Program) String ¶

func (o *Program) String() string

String returns a JSON representation of the model

type Programjob ¶

type Programjob struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Programs
	Programs *[]Baseprogramentity `json:"programs,omitempty"`

	// CreatedBy
	CreatedBy *Addressableentityref `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"`

	// 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"`
}

Programjob

func (*Programjob) String ¶

func (o *Programjob) String() string

String returns a JSON representation of the model

type Programjobrequest ¶

type Programjobrequest struct {
	// ProgramIds - The ids of the programs used for this job
	ProgramIds *[]string `json:"programIds,omitempty"`
}

Programjobrequest

func (*Programjobrequest) String ¶

func (o *Programjobrequest) String() string

String returns a JSON representation of the model

type Programmappings ¶

type Programmappings struct {
	// Program
	Program *Baseprogramentity `json:"program,omitempty"`

	// Queues
	Queues *[]Addressableentityref `json:"queues,omitempty"`

	// Flows
	Flows *[]Addressableentityref `json:"flows,omitempty"`

	// ModifiedBy
	ModifiedBy *Addressableentityref `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"`
}

Programmappings

func (*Programmappings) String ¶

func (o *Programmappings) String() string

String returns a JSON representation of the model

type Programmappingsrequest ¶

type Programmappingsrequest struct {
	// QueueIds - The program queues
	QueueIds *[]string `json:"queueIds,omitempty"`

	// FlowIds - The program flows
	FlowIds *[]string `json:"flowIds,omitempty"`
}

Programmappingsrequest

func (*Programmappingsrequest) String ¶

func (o *Programmappingsrequest) String() string

String returns a JSON representation of the model

type Programrequest ¶

type Programrequest struct {
	// Name - The program name
	Name *string `json:"name,omitempty"`

	// Description - The program description
	Description *string `json:"description,omitempty"`

	// TopicIds - The ids of topics associated to the program
	TopicIds *[]string `json:"topicIds,omitempty"`

	// Tags - The program tags
	Tags *[]string `json:"tags,omitempty"`
}

Programrequest

func (*Programrequest) String ¶

func (o *Programrequest) String() string

String returns a JSON representation of the model

type Programsentitylisting ¶

type Programsentitylisting struct {
	// Entities
	Entities *[]Listedprogram `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Programsentitylisting

func (*Programsentitylisting) String ¶

func (o *Programsentitylisting) String() string

String returns a JSON representation of the model

type Programsmappingsentitylisting ¶

type Programsmappingsentitylisting struct {
	// Entities
	Entities *[]Programmappings `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Programsmappingsentitylisting

func (*Programsmappingsentitylisting) String ¶

String returns a JSON representation of the model

type Prompt ¶

type Prompt struct {
	// Id - The prompt identifier
	Id *string `json:"id,omitempty"`

	// Name - The prompt name.
	Name *string `json:"name,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Resources - List of resources associated with this prompt
	Resources *[]Promptasset `json:"resources,omitempty"`

	// CurrentOperation - Current prompt operation status
	CurrentOperation *Operation `json:"currentOperation,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Prompt

func (*Prompt) String ¶

func (o *Prompt) String() string

String returns a JSON representation of the model

type Promptasset ¶

type Promptasset struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// PromptId - Associated prompt ID
	PromptId *string `json:"promptId,omitempty"`

	// Language - Prompt resource language
	Language *string `json:"language,omitempty"`

	// MediaUri - URI of the resource audio
	MediaUri *string `json:"mediaUri,omitempty"`

	// TtsString - Text to speech of the resource
	TtsString *string `json:"ttsString,omitempty"`

	// Text - Text of the resource
	Text *string `json:"text,omitempty"`

	// UploadStatus - Audio upload status
	UploadStatus *string `json:"uploadStatus,omitempty"`

	// UploadUri - Upload URI for the resource audio
	UploadUri *string `json:"uploadUri,omitempty"`

	// LanguageDefault - Whether or not this resource locale is the default for the language
	LanguageDefault *bool `json:"languageDefault,omitempty"`

	// Tags
	Tags *map[string][]string `json:"tags,omitempty"`

	// DurationSeconds
	DurationSeconds *float64 `json:"durationSeconds,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Promptasset

func (*Promptasset) String ¶

func (o *Promptasset) String() string

String returns a JSON representation of the model

type Promptassetcreate ¶

type Promptassetcreate struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// PromptId - Associated prompt ID
	PromptId *string `json:"promptId,omitempty"`

	// Language - The prompt language.
	Language *string `json:"language,omitempty"`

	// MediaUri - URI of the resource audio
	MediaUri *string `json:"mediaUri,omitempty"`

	// TtsString - Text to speech of the resource
	TtsString *string `json:"ttsString,omitempty"`

	// Text - Text of the resource
	Text *string `json:"text,omitempty"`

	// UploadStatus - Audio upload status
	UploadStatus *string `json:"uploadStatus,omitempty"`

	// UploadUri - Upload URI for the resource audio
	UploadUri *string `json:"uploadUri,omitempty"`

	// LanguageDefault - Whether or not this resource locale is the default for the language
	LanguageDefault *bool `json:"languageDefault,omitempty"`

	// Tags
	Tags *map[string][]string `json:"tags,omitempty"`

	// DurationSeconds
	DurationSeconds *float64 `json:"durationSeconds,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Promptassetcreate

func (*Promptassetcreate) String ¶

func (o *Promptassetcreate) String() string

String returns a JSON representation of the model

type Promptassetentitylisting ¶

type Promptassetentitylisting struct {
	// Entities
	Entities *[]Promptasset `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Promptassetentitylisting

func (*Promptassetentitylisting) String ¶

func (o *Promptassetentitylisting) String() string

String returns a JSON representation of the model

type Promptentitylisting ¶

type Promptentitylisting struct {
	// Entities
	Entities *[]Prompt `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Promptentitylisting

func (*Promptentitylisting) String ¶

func (o *Promptentitylisting) String() string

String returns a JSON representation of the model

type Propertychange ¶

type Propertychange struct {
	// Property - The property that was changed
	Property *string `json:"property,omitempty"`

	// OldValues - Previous values for the property.
	OldValues *[]string `json:"oldValues,omitempty"`

	// NewValues - New values for the property.
	NewValues *[]string `json:"newValues,omitempty"`
}

Propertychange

func (*Propertychange) String ¶

func (o *Propertychange) String() string

String returns a JSON representation of the model

type Propertyindexrequest ¶

type Propertyindexrequest struct {
	// SessionId - Attach properties to a segment in the indicated session
	SessionId *string `json:"sessionId,omitempty"`

	// TargetDate - Attach properties to a segment covering a specific point in time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	TargetDate *time.Time `json:"targetDate,omitempty"`

	// Properties - The list of properties to index
	Properties *[]Analyticsproperty `json:"properties,omitempty"`
}

Propertyindexrequest

func (*Propertyindexrequest) String ¶

func (o *Propertyindexrequest) String() string

String returns a JSON representation of the model

type Provisioninfo ¶

type Provisioninfo struct {
	// Time - The time at which this phone was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Time *time.Time `json:"time,omitempty"`

	// Source - The source of the provisioning
	Source *string `json:"source,omitempty"`

	// ErrorInfo - The error information from the provision process, if any
	ErrorInfo *string `json:"errorInfo,omitempty"`
}

Provisioninfo

func (*Provisioninfo) String ¶

func (o *Provisioninfo) String() string

String returns a JSON representation of the model

type Publishdraftinput ¶

type Publishdraftinput struct {
	// Version - The current draft version.
	Version *int `json:"version,omitempty"`
}

Publishdraftinput - Draft to be published

func (*Publishdraftinput) String ¶

func (o *Publishdraftinput) String() string

String returns a JSON representation of the model

type Publishedsurveyformreference ¶

type Publishedsurveyformreference struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ContextId - The context id of this form.
	ContextId *string `json:"contextId,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Publishedsurveyformreference

func (*Publishedsurveyformreference) String ¶

String returns a JSON representation of the model

type Publishform ¶

type Publishform struct {
	// Published - Is this form published
	Published *bool `json:"published,omitempty"`

	// Id - Unique Id for this version of this form
	Id *string `json:"id,omitempty"`
}

Publishform

func (*Publishform) String ¶

func (o *Publishform) String() string

String returns a JSON representation of the model

type Publishprogrampublishjob ¶

type Publishprogrampublishjob struct {
	// Id
	Id *string `json:"id,omitempty"`

	// State
	State *string `json:"state,omitempty"`
}

Publishprogrampublishjob

func (*Publishprogrampublishjob) String ¶

func (o *Publishprogrampublishjob) String() string

String returns a JSON representation of the model

type Publishtopicpublishjob ¶

type Publishtopicpublishjob struct {
	// Id
	Id *string `json:"id,omitempty"`

	// State
	State *string `json:"state,omitempty"`
}

Publishtopicpublishjob

func (*Publishtopicpublishjob) String ¶

func (o *Publishtopicpublishjob) String() string

String returns a JSON representation of the model

type Punctualityevent ¶

type Punctualityevent struct {
	// DateScheduleStart - The scheduled activity start time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateScheduleStart *time.Time `json:"dateScheduleStart,omitempty"`

	// DateStart - The time the user started the activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateStart *time.Time `json:"dateStart,omitempty"`

	// LengthMinutes - The length of the activity in minutes
	LengthMinutes *int `json:"lengthMinutes,omitempty"`

	// Description - The description of the activity
	Description *string `json:"description,omitempty"`

	// ActivityCodeId - The ID of the activity code associated with this activity
	ActivityCodeId *string `json:"activityCodeId,omitempty"`

	// ActivityCode - The activity code
	ActivityCode *string `json:"activityCode,omitempty"`

	// Category - The category for the activity
	Category *string `json:"category,omitempty"`

	// Points - The points earned for this activity
	Points *int `json:"points,omitempty"`

	// Delta - Difference between this activity and the last activity in seconds
	Delta *float64 `json:"delta,omitempty"`

	// Bullseye
	Bullseye *bool `json:"bullseye,omitempty"`
}

Punctualityevent

func (*Punctualityevent) String ¶

func (o *Punctualityevent) String() string

String returns a JSON representation of the model

type Purecloud ¶

type Purecloud 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"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Purecloud

func (*Purecloud) String ¶

func (o *Purecloud) String() string

String returns a JSON representation of the model

type Pureengage ¶

type Pureengage 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"`

	// AutoProvisionUsers
	AutoProvisionUsers *bool `json:"autoProvisionUsers,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Pureengage

func (*Pureengage) String ¶

func (o *Pureengage) String() string

String returns a JSON representation of the model

type Qmauditqueryrequest ¶

type Qmauditqueryrequest 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"`

	// Filters - List of filters for the query.
	Filters *[]Qualityauditqueryfilter `json:"filters,omitempty"`

	// Sort - Sort parameter for the query.
	Sort *[]Auditquerysort `json:"sort,omitempty"`
}

Qmauditqueryrequest

func (*Qmauditqueryrequest) String ¶

func (o *Qmauditqueryrequest) String() string

String returns a JSON representation of the model

type QualityApi ¶

type QualityApi struct {
	Configuration *Configuration
}

QualityApi provides functions for API endpoints

func NewQualityApi ¶

func NewQualityApi() *QualityApi

NewQualityApi creates an API instance using the default configuration

func NewQualityApiWithConfig ¶

func NewQualityApiWithConfig(config *Configuration) *QualityApi

NewQualityApiWithConfig creates an API instance using the provided configuration

func (QualityApi) DeleteQualityCalibration ¶

func (a QualityApi) DeleteQualityCalibration(calibrationId string, calibratorId string) (*Calibration, *APIResponse, error)

DeleteQualityCalibration invokes DELETE /api/v2/quality/calibrations/{calibrationId}

Delete a calibration by id.

func (QualityApi) DeleteQualityConversationEvaluation ¶

func (a QualityApi) DeleteQualityConversationEvaluation(conversationId string, evaluationId string, expand string) (*Evaluation, *APIResponse, error)

DeleteQualityConversationEvaluation invokes DELETE /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}

Delete an evaluation

func (QualityApi) DeleteQualityForm ¶

func (a QualityApi) DeleteQualityForm(formId string) (*APIResponse, error)

DeleteQualityForm invokes DELETE /api/v2/quality/forms/{formId}

Delete an evaluation form.

func (QualityApi) DeleteQualityFormsEvaluation ¶

func (a QualityApi) DeleteQualityFormsEvaluation(formId string) (*APIResponse, error)

DeleteQualityFormsEvaluation invokes DELETE /api/v2/quality/forms/evaluations/{formId}

Delete an evaluation form.

func (QualityApi) DeleteQualityFormsSurvey ¶

func (a QualityApi) DeleteQualityFormsSurvey(formId string) (*APIResponse, error)

DeleteQualityFormsSurvey invokes DELETE /api/v2/quality/forms/surveys/{formId}

Delete a survey form.

func (QualityApi) GetQualityAgentsActivity ¶

func (a QualityApi) GetQualityAgentsActivity(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, startTime time.Time, endTime time.Time, agentUserId []string, evaluatorUserId string, name string, group string) (*Agentactivityentitylisting, *APIResponse, error)

GetQualityAgentsActivity invokes GET /api/v2/quality/agents/activity

Gets a list of Agent Activities ¶

Including the number of evaluations and average evaluation score

func (QualityApi) GetQualityCalibration ¶

func (a QualityApi) GetQualityCalibration(calibrationId string, calibratorId string, conversationId string) (*Calibration, *APIResponse, error)

GetQualityCalibration invokes GET /api/v2/quality/calibrations/{calibrationId}

Get a calibration by id. Requires either calibrator id or conversation id

func (QualityApi) GetQualityCalibrations ¶

func (a QualityApi) GetQualityCalibrations(calibratorId string, pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, conversationId string, startTime time.Time, endTime time.Time) (*Calibrationentitylisting, *APIResponse, error)

GetQualityCalibrations invokes GET /api/v2/quality/calibrations

Get the list of calibrations

func (QualityApi) GetQualityConversationAudits ¶

func (a QualityApi) GetQualityConversationAudits(conversationId string, pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, recordingId string, entityType string) (*Qualityauditpage, *APIResponse, error)

GetQualityConversationAudits invokes GET /api/v2/quality/conversations/{conversationId}/audits

Get audits for conversation or recording ¶

Different permissions are required for viewing different resource audit entries. The quality:evaluation:viewAudit permission is required to view evaluation audits, the recording:recording:viewAudit permission is required to view recording audits, and so on.This endpoint is deprecated. Use following async endpoints, To query for audits POST /api/v2/quality/conversations/audits/queryTo get status of audit query GET /api/v2/quality/conversations/audits/query/{transactionId}To get results of audit query GET /api/v2/quality/conversations/audits/query/{transactionId}/results

func (QualityApi) GetQualityConversationEvaluation ¶

func (a QualityApi) GetQualityConversationEvaluation(conversationId string, evaluationId string, expand string) (*Evaluation, *APIResponse, error)

GetQualityConversationEvaluation invokes GET /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}

Get an evaluation

func (QualityApi) GetQualityConversationSurveys ¶

func (a QualityApi) GetQualityConversationSurveys(conversationId string) ([]Survey, *APIResponse, error)

GetQualityConversationSurveys invokes GET /api/v2/quality/conversations/{conversationId}/surveys

Get the surveys for a conversation

func (QualityApi) GetQualityConversationsAuditsQueryTransactionId ¶

func (a QualityApi) GetQualityConversationsAuditsQueryTransactionId(transactionId string) (*Qualityauditqueryexecutionstatusresponse, *APIResponse, error)

GetQualityConversationsAuditsQueryTransactionId invokes GET /api/v2/quality/conversations/audits/query/{transactionId}

Get status of audit query execution

func (QualityApi) GetQualityConversationsAuditsQueryTransactionIdResults ¶

func (a QualityApi) GetQualityConversationsAuditsQueryTransactionIdResults(transactionId string, cursor string, pageSize int, expand []string) (*Qualityauditqueryexecutionresultsresponse, *APIResponse, error)

GetQualityConversationsAuditsQueryTransactionIdResults invokes GET /api/v2/quality/conversations/audits/query/{transactionId}/results

Get results of audit query

func (QualityApi) GetQualityEvaluationsQuery ¶

func (a QualityApi) GetQualityEvaluationsQuery(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, conversationId string, agentUserId string, evaluatorUserId string, queueId string, startTime string, endTime string, evaluationState []string, isReleased bool, agentHasRead bool, expandAnswerTotalScores bool, maximum int, sortOrder string) (*Evaluationentitylisting, *APIResponse, error)

GetQualityEvaluationsQuery invokes GET /api/v2/quality/evaluations/query

Queries Evaluations and returns a paged list ¶

Query params must include one of conversationId, evaluatorUserId, or agentUserId

func (QualityApi) GetQualityEvaluatorsActivity ¶

func (a QualityApi) GetQualityEvaluatorsActivity(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, startTime time.Time, endTime time.Time, name string, permission []string, group string) (*Evaluatoractivityentitylisting, *APIResponse, error)

GetQualityEvaluatorsActivity invokes GET /api/v2/quality/evaluators/activity

Get an evaluator activity

func (QualityApi) GetQualityForm ¶

func (a QualityApi) GetQualityForm(formId string) (*Evaluationform, *APIResponse, error)

GetQualityForm invokes GET /api/v2/quality/forms/{formId}

Get an evaluation form

func (QualityApi) GetQualityFormVersions ¶

func (a QualityApi) GetQualityFormVersions(formId string, pageSize int, pageNumber int) (*Evaluationformentitylisting, *APIResponse, error)

GetQualityFormVersions invokes GET /api/v2/quality/forms/{formId}/versions

Gets all the revisions for a specific evaluation.

func (QualityApi) GetQualityForms ¶

func (a QualityApi) GetQualityForms(pageSize int, pageNumber int, sortBy string, nextPage string, previousPage string, expand string, name string, sortOrder string) (*Evaluationformentitylisting, *APIResponse, error)

GetQualityForms invokes GET /api/v2/quality/forms

Get the list of evaluation forms

func (QualityApi) GetQualityFormsEvaluation ¶

func (a QualityApi) GetQualityFormsEvaluation(formId string) (*Evaluationform, *APIResponse, error)

GetQualityFormsEvaluation invokes GET /api/v2/quality/forms/evaluations/{formId}

Get an evaluation form

func (QualityApi) GetQualityFormsEvaluationVersions ¶

func (a QualityApi) GetQualityFormsEvaluationVersions(formId string, pageSize int, pageNumber int, sortOrder string) (*Evaluationformentitylisting, *APIResponse, error)

GetQualityFormsEvaluationVersions invokes GET /api/v2/quality/forms/evaluations/{formId}/versions

Gets all the revisions for a specific evaluation.

func (QualityApi) GetQualityFormsEvaluations ¶

func (a QualityApi) GetQualityFormsEvaluations(pageSize int, pageNumber int, sortBy string, nextPage string, previousPage string, expand string, name string, sortOrder string) (*Evaluationformentitylisting, *APIResponse, error)

GetQualityFormsEvaluations invokes GET /api/v2/quality/forms/evaluations

Get the list of evaluation forms

func (QualityApi) GetQualityFormsSurvey ¶

func (a QualityApi) GetQualityFormsSurvey(formId string) (*Surveyform, *APIResponse, error)

GetQualityFormsSurvey invokes GET /api/v2/quality/forms/surveys/{formId}

Get a survey form

func (QualityApi) GetQualityFormsSurveyVersions ¶

func (a QualityApi) GetQualityFormsSurveyVersions(formId string, pageSize int, pageNumber int) (*Surveyformentitylisting, *APIResponse, error)

GetQualityFormsSurveyVersions invokes GET /api/v2/quality/forms/surveys/{formId}/versions

Gets all the revisions for a specific survey.

func (QualityApi) GetQualityFormsSurveys ¶

func (a QualityApi) GetQualityFormsSurveys(pageSize int, pageNumber int, sortBy string, nextPage string, previousPage string, expand string, name string, sortOrder string) (*Surveyformentitylisting, *APIResponse, error)

GetQualityFormsSurveys invokes GET /api/v2/quality/forms/surveys

Get the list of survey forms

func (QualityApi) GetQualityFormsSurveysBulk ¶

func (a QualityApi) GetQualityFormsSurveysBulk(id []string) (*Surveyformentitylisting, *APIResponse, error)

GetQualityFormsSurveysBulk invokes GET /api/v2/quality/forms/surveys/bulk

Retrieve a list of survey forms by their ids

func (QualityApi) GetQualityFormsSurveysBulkContexts ¶

func (a QualityApi) GetQualityFormsSurveysBulkContexts(contextId []string, published bool) (*Surveyformentitylisting, *APIResponse, error)

GetQualityFormsSurveysBulkContexts invokes GET /api/v2/quality/forms/surveys/bulk/contexts

Retrieve a list of the latest form versions by context ids

func (QualityApi) GetQualityPublishedform ¶

func (a QualityApi) GetQualityPublishedform(formId string) (*Evaluationform, *APIResponse, error)

GetQualityPublishedform invokes GET /api/v2/quality/publishedforms/{formId}

Get the published evaluation forms.

func (QualityApi) GetQualityPublishedforms ¶

func (a QualityApi) GetQualityPublishedforms(pageSize int, pageNumber int, name string, onlyLatestPerContext bool) (*Evaluationformentitylisting, *APIResponse, error)

GetQualityPublishedforms invokes GET /api/v2/quality/publishedforms

Get the published evaluation forms.

func (QualityApi) GetQualityPublishedformsEvaluation ¶

func (a QualityApi) GetQualityPublishedformsEvaluation(formId string) (*Evaluationform, *APIResponse, error)

GetQualityPublishedformsEvaluation invokes GET /api/v2/quality/publishedforms/evaluations/{formId}

Get the most recent published version of an evaluation form.

func (QualityApi) GetQualityPublishedformsEvaluations ¶

func (a QualityApi) GetQualityPublishedformsEvaluations(pageSize int, pageNumber int, name string, onlyLatestPerContext bool) (*Evaluationformentitylisting, *APIResponse, error)

GetQualityPublishedformsEvaluations invokes GET /api/v2/quality/publishedforms/evaluations

Get the published evaluation forms.

func (QualityApi) GetQualityPublishedformsSurvey ¶

func (a QualityApi) GetQualityPublishedformsSurvey(formId string) (*Surveyform, *APIResponse, error)

GetQualityPublishedformsSurvey invokes GET /api/v2/quality/publishedforms/surveys/{formId}

Get the most recent published version of a survey form.

func (QualityApi) GetQualityPublishedformsSurveys ¶

func (a QualityApi) GetQualityPublishedformsSurveys(pageSize int, pageNumber int, name string, onlyLatestEnabledPerContext bool) (*Surveyformentitylisting, *APIResponse, error)

GetQualityPublishedformsSurveys invokes GET /api/v2/quality/publishedforms/surveys

Get the published survey forms.

func (QualityApi) GetQualitySurvey ¶

func (a QualityApi) GetQualitySurvey(surveyId string) (*Survey, *APIResponse, error)

GetQualitySurvey invokes GET /api/v2/quality/surveys/{surveyId}

Get a survey for a conversation

func (QualityApi) GetQualitySurveysScorable ¶

func (a QualityApi) GetQualitySurveysScorable(customerSurveyUrl string) (*Scorablesurvey, *APIResponse, error)

GetQualitySurveysScorable invokes GET /api/v2/quality/surveys/scorable

Get a survey as an end-customer, for the purposes of scoring it.

func (QualityApi) PatchQualityFormsSurvey ¶

func (a QualityApi) PatchQualityFormsSurvey(formId string, body Surveyform) (*Surveyform, *APIResponse, error)

PatchQualityFormsSurvey invokes PATCH /api/v2/quality/forms/surveys/{formId}

Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form.

func (QualityApi) PostAnalyticsEvaluationsAggregatesQuery ¶

func (a QualityApi) PostAnalyticsEvaluationsAggregatesQuery(body Evaluationaggregationquery) (*Evaluationaggregatequeryresponse, *APIResponse, error)

PostAnalyticsEvaluationsAggregatesQuery invokes POST /api/v2/analytics/evaluations/aggregates/query

Query for evaluation aggregates

func (QualityApi) PostAnalyticsSurveysAggregatesQuery ¶

func (a QualityApi) PostAnalyticsSurveysAggregatesQuery(body Surveyaggregationquery) (*Surveyaggregatequeryresponse, *APIResponse, error)

PostAnalyticsSurveysAggregatesQuery invokes POST /api/v2/analytics/surveys/aggregates/query

Query for survey aggregates

func (QualityApi) PostQualityCalibrations ¶

func (a QualityApi) PostQualityCalibrations(body Calibrationcreate, expand string) (*Calibration, *APIResponse, error)

PostQualityCalibrations invokes POST /api/v2/quality/calibrations

Create a calibration

func (QualityApi) PostQualityConversationEvaluations ¶

func (a QualityApi) PostQualityConversationEvaluations(conversationId string, body Evaluation, expand string) (*Evaluation, *APIResponse, error)

PostQualityConversationEvaluations invokes POST /api/v2/quality/conversations/{conversationId}/evaluations

Create an evaluation

func (QualityApi) PostQualityConversationsAuditsQuery ¶

func (a QualityApi) PostQualityConversationsAuditsQuery(body Qmauditqueryrequest) (*Qualityauditqueryexecutionstatusresponse, *APIResponse, error)

PostQualityConversationsAuditsQuery invokes POST /api/v2/quality/conversations/audits/query

Create audit query execution

func (QualityApi) PostQualityEvaluationsScoring ¶

func (a QualityApi) PostQualityEvaluationsScoring(body Evaluationformandscoringset) (*Evaluationscoringset, *APIResponse, error)

PostQualityEvaluationsScoring invokes POST /api/v2/quality/evaluations/scoring

Score evaluation

func (QualityApi) PostQualityForms ¶

func (a QualityApi) PostQualityForms(body Evaluationform) (*Evaluationform, *APIResponse, error)

PostQualityForms invokes POST /api/v2/quality/forms

Create an evaluation form.

func (QualityApi) PostQualityFormsEvaluations ¶

func (a QualityApi) PostQualityFormsEvaluations(body Evaluationform) (*Evaluationform, *APIResponse, error)

PostQualityFormsEvaluations invokes POST /api/v2/quality/forms/evaluations

Create an evaluation form.

func (QualityApi) PostQualityFormsSurveys ¶

func (a QualityApi) PostQualityFormsSurveys(body Surveyform) (*Surveyform, *APIResponse, error)

PostQualityFormsSurveys invokes POST /api/v2/quality/forms/surveys

Create a survey form.

func (QualityApi) PostQualityPublishedforms ¶

func (a QualityApi) PostQualityPublishedforms(body Publishform) (*Evaluationform, *APIResponse, error)

PostQualityPublishedforms invokes POST /api/v2/quality/publishedforms

Publish an evaluation form.

func (QualityApi) PostQualityPublishedformsEvaluations ¶

func (a QualityApi) PostQualityPublishedformsEvaluations(body Publishform) (*Evaluationform, *APIResponse, error)

PostQualityPublishedformsEvaluations invokes POST /api/v2/quality/publishedforms/evaluations

Publish an evaluation form.

func (QualityApi) PostQualityPublishedformsSurveys ¶

func (a QualityApi) PostQualityPublishedformsSurveys(body Publishform) (*Surveyform, *APIResponse, error)

PostQualityPublishedformsSurveys invokes POST /api/v2/quality/publishedforms/surveys

Publish a survey form.

func (QualityApi) PostQualitySurveysScoring ¶

func (a QualityApi) PostQualitySurveysScoring(body Surveyformandscoringset) (*Surveyscoringset, *APIResponse, error)

PostQualitySurveysScoring invokes POST /api/v2/quality/surveys/scoring

Score survey

func (QualityApi) PutQualityCalibration ¶

func (a QualityApi) PutQualityCalibration(calibrationId string, body Calibration) (*Calibration, *APIResponse, error)

PutQualityCalibration invokes PUT /api/v2/quality/calibrations/{calibrationId}

Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex

func (QualityApi) PutQualityConversationEvaluation ¶

func (a QualityApi) PutQualityConversationEvaluation(conversationId string, evaluationId string, body Evaluation, expand string) (*Evaluation, *APIResponse, error)

PutQualityConversationEvaluation invokes PUT /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}

Update an evaluation ¶

The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation.

func (QualityApi) PutQualityForm ¶

func (a QualityApi) PutQualityForm(formId string, body Evaluationform) (*Evaluationform, *APIResponse, error)

PutQualityForm invokes PUT /api/v2/quality/forms/{formId}

Update an evaluation form.

func (QualityApi) PutQualityFormsEvaluation ¶

func (a QualityApi) PutQualityFormsEvaluation(formId string, body Evaluationform) (*Evaluationform, *APIResponse, error)

PutQualityFormsEvaluation invokes PUT /api/v2/quality/forms/evaluations/{formId}

Update an evaluation form.

func (QualityApi) PutQualityFormsSurvey ¶

func (a QualityApi) PutQualityFormsSurvey(formId string, body Surveyform) (*Surveyform, *APIResponse, error)

PutQualityFormsSurvey invokes PUT /api/v2/quality/forms/surveys/{formId}

Update a survey form.

func (QualityApi) PutQualitySurveysScorable ¶

func (a QualityApi) PutQualitySurveysScorable(body Scorablesurvey, customerSurveyUrl string) (*Scorablesurvey, *APIResponse, error)

PutQualitySurveysScorable invokes PUT /api/v2/quality/surveys/scorable

Update a survey as an end-customer, for the purposes of scoring it.

type Qualityaudit ¶

type Qualityaudit 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"`

	// JobId
	JobId *string `json:"jobId,omitempty"`

	// Action
	Action *string `json:"action,omitempty"`

	// Level
	Level *string `json:"level,omitempty"`

	// Entity
	Entity *Auditentity `json:"entity,omitempty"`

	// Timestamp
	Timestamp *string `json:"timestamp,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`

	// Changes
	Changes *[]Change `json:"changes,omitempty"`

	// EntityType
	EntityType *string `json:"entityType,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Qualityaudit

func (*Qualityaudit) String ¶

func (o *Qualityaudit) String() string

String returns a JSON representation of the model

type Qualityauditlogmessage ¶

type Qualityauditlogmessage 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"`

	// UserTrusteeOrgId - Trustee Organization Id if this audit message is from trustee access.
	UserTrusteeOrgId *string `json:"userTrusteeOrgId,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"`

	// RemoteIps - List of IP addresses of systems that originated or handled the request.
	RemoteIps *[]string `json:"remoteIps,omitempty"`

	// ServiceName - Name of the service that logged this audit message.
	ServiceName *string `json:"serviceName,omitempty"`

	// Level - The level of this audit message.
	Level *string `json:"level,omitempty"`

	// Status - The status of the action of this audit message.
	Status *string `json:"status,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"`

	// MessageInfo - Message describing the event being audited.
	MessageInfo *Messageinfo `json:"messageInfo,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"`
}

Qualityauditlogmessage

func (*Qualityauditlogmessage) String ¶

func (o *Qualityauditlogmessage) String() string

String returns a JSON representation of the model

type Qualityauditpage ¶

type Qualityauditpage struct {
	// Entities
	Entities *[]Qualityaudit `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Qualityauditpage

func (*Qualityauditpage) String ¶

func (o *Qualityauditpage) String() string

String returns a JSON representation of the model

type Qualityauditqueryexecutionresultsresponse ¶

type Qualityauditqueryexecutionresultsresponse 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 *[]Qualityauditlogmessage `json:"entities,omitempty"`
}

Qualityauditqueryexecutionresultsresponse

func (*Qualityauditqueryexecutionresultsresponse) String ¶

String returns a JSON representation of the model

type Qualityauditqueryexecutionstatusresponse ¶

type Qualityauditqueryexecutionstatusresponse 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"`

	// DateStart - 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
	DateStart *time.Time `json:"dateStart,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"`

	// Filters - Filters for the audit query.
	Filters *[]Qualityauditqueryfilter `json:"filters,omitempty"`

	// Sort - Sort parameter for the audit query.
	Sort *[]Auditquerysort `json:"sort,omitempty"`
}

Qualityauditqueryexecutionstatusresponse

func (*Qualityauditqueryexecutionstatusresponse) String ¶

String returns a JSON representation of the model

type Qualityauditqueryfilter ¶

type Qualityauditqueryfilter 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"`
}

Qualityauditqueryfilter

func (*Qualityauditqueryfilter) String ¶

func (o *Qualityauditqueryfilter) String() string

String returns a JSON representation of the model

type Querydivision ¶

type Querydivision struct{}

Querydivision

func (*Querydivision) String ¶

func (o *Querydivision) String() string

String returns a JSON representation of the model

type Queryfacetinfo ¶

type Queryfacetinfo struct {
	// Attributes
	Attributes *[]Facetkeyattribute `json:"attributes,omitempty"`

	// Facets
	Facets *[]Facetentry `json:"facets,omitempty"`
}

Queryfacetinfo

func (*Queryfacetinfo) String ¶

func (o *Queryfacetinfo) String() string

String returns a JSON representation of the model

type Queryrequest ¶

type Queryrequest 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 *[]Sortitem `json:"sort,omitempty"`

	// Filters
	Filters *[]Contentfilteritem `json:"filters,omitempty"`

	// AttributeFilters
	AttributeFilters *[]Attributefilteritem `json:"attributeFilters,omitempty"`

	// IncludeShares
	IncludeShares *bool `json:"includeShares,omitempty"`
}

Queryrequest

func (*Queryrequest) String ¶

func (o *Queryrequest) String() string

String returns a JSON representation of the model

type Queryrequestclause ¶

type Queryrequestclause struct {
	// VarType - The logic used to combine the predicates
	VarType *string `json:"type,omitempty"`

	// Predicates - The list of predicates used to filter the data
	Predicates *[]Queryrequestpredicate `json:"predicates,omitempty"`
}

Queryrequestclause

func (*Queryrequestclause) String ¶

func (o *Queryrequestclause) String() string

String returns a JSON representation of the model

type Queryrequestfilter ¶

type Queryrequestfilter struct {
	// VarType - The logic used to combine the clauses
	VarType *string `json:"type,omitempty"`

	// Clauses - The list of clauses used to filter the data
	Clauses *[]Queryrequestclause `json:"clauses,omitempty"`
}

Queryrequestfilter

func (*Queryrequestfilter) String ¶

func (o *Queryrequestfilter) String() string

String returns a JSON representation of the model

type Queryrequestpredicate ¶

type Queryrequestpredicate struct {
	// Dimension - The dimension to be filtered
	Dimension *string `json:"dimension,omitempty"`

	// Value - The value to filter by
	Value *string `json:"value,omitempty"`
}

Queryrequestpredicate

func (*Queryrequestpredicate) String ¶

func (o *Queryrequestpredicate) String() string

String returns a JSON representation of the model

type Queryresponsedata ¶

type Queryresponsedata struct {
	// Interval - Interval with start and end represented as ISO-8601 string. i.e: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'/yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
	Interval *string `json:"interval,omitempty"`

	// Metrics - A list of aggregated metrics
	Metrics *[]Queryresponsemetric `json:"metrics,omitempty"`
}

Queryresponsedata

func (*Queryresponsedata) String ¶

func (o *Queryresponsedata) String() string

String returns a JSON representation of the model

type Queryresponsegroupeddata ¶

type Queryresponsegroupeddata struct {
	// Group - The group values for this data
	Group *map[string]string `json:"group,omitempty"`

	// Data - The metrics in this group
	Data *[]Queryresponsedata `json:"data,omitempty"`
}

Queryresponsegroupeddata

func (*Queryresponsegroupeddata) String ¶

func (o *Queryresponsegroupeddata) String() string

String returns a JSON representation of the model

type Queryresponsemetric ¶

type Queryresponsemetric struct {
	// Metric - The metric this applies to
	Metric *string `json:"metric,omitempty"`

	// Stats - The aggregated values for this metric
	Stats *Queryresponsestats `json:"stats,omitempty"`
}

Queryresponsemetric

func (*Queryresponsemetric) String ¶

func (o *Queryresponsemetric) String() string

String returns a JSON representation of the model

type Queryresponsestats ¶

type Queryresponsestats struct {
	// Count - The count for this metric
	Count *int `json:"count,omitempty"`
}

Queryresponsestats

func (*Queryresponsestats) String ¶

func (o *Queryresponsestats) String() string

String returns a JSON representation of the model

type Queryresult ¶

type Queryresult struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Body
	Body *Domainentity `json:"body,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Queryresult

func (*Queryresult) String ¶

func (o *Queryresult) String() string

String returns a JSON representation of the model

type Queryresults ¶

type Queryresults struct {
	// Results
	Results *Domainentitylistingqueryresult `json:"results,omitempty"`

	// FacetInfo
	FacetInfo *Queryfacetinfo `json:"facetInfo,omitempty"`
}

Queryresults

func (*Queryresults) String ¶

func (o *Queryresults) String() string

String returns a JSON representation of the model

type Queue ¶

type Queue 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"`

	// Description - The queue description.
	Description *string `json:"description,omitempty"`

	// DateCreated - The date the queue 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"`

	// DateModified - The date of the last modification to the queue. 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 ID of the user that last modified the queue.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the queue.
	CreatedBy *string `json:"createdBy,omitempty"`

	// MemberCount - The total number of members (joined or unjoined) in the queue.
	MemberCount *int `json:"memberCount,omitempty"`

	// JoinedMemberCount - The number of joined members in the queue.
	JoinedMemberCount *int `json:"joinedMemberCount,omitempty"`

	// MediaSettings - The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM
	MediaSettings *map[string]Mediasetting `json:"mediaSettings,omitempty"`

	// RoutingRules - The routing rules for the queue, used for routing to known or preferred agents.
	RoutingRules *[]Routingrule `json:"routingRules,omitempty"`

	// Bullseye - The bulls-eye settings for the queue.
	Bullseye *Bullseye `json:"bullseye,omitempty"`

	// AcwSettings - The ACW settings for the queue.
	AcwSettings *Acwsettings `json:"acwSettings,omitempty"`

	// SkillEvaluationMethod - The skill evaluation method to use when routing conversations.
	SkillEvaluationMethod *string `json:"skillEvaluationMethod,omitempty"`

	// QueueFlow - The in-queue flow to use for conversations waiting in queue.
	QueueFlow *Domainentityref `json:"queueFlow,omitempty"`

	// WhisperPrompt - The prompt used for whisper on the queue, if configured.
	WhisperPrompt *Domainentityref `json:"whisperPrompt,omitempty"`

	// AutoAnswerOnly - Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered.
	AutoAnswerOnly *bool `json:"autoAnswerOnly,omitempty"`

	// EnableTranscription - Indicates whether voice transcription is enabled for this queue.
	EnableTranscription *bool `json:"enableTranscription,omitempty"`

	// EnableManualAssignment - Indicates whether manual assignment is enabled for this queue.
	EnableManualAssignment *bool `json:"enableManualAssignment,omitempty"`

	// CallingPartyName - The name to use for caller identification for outbound calls from this queue.
	CallingPartyName *string `json:"callingPartyName,omitempty"`

	// CallingPartyNumber - The phone number to use for caller identification for outbound calls from this queue.
	CallingPartyNumber *string `json:"callingPartyNumber,omitempty"`

	// DefaultScripts - The default script Ids for the communication types.
	DefaultScripts *map[string]Script `json:"defaultScripts,omitempty"`

	// OutboundMessagingAddresses - The messaging addresses for the queue.
	OutboundMessagingAddresses *Queuemessagingaddresses `json:"outboundMessagingAddresses,omitempty"`

	// OutboundEmailAddress
	OutboundEmailAddress *Queueemailaddress `json:"outboundEmailAddress,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Queue

func (*Queue) String ¶

func (o *Queue) String() string

String returns a JSON representation of the model

type Queueconversationcallbackeventtopiccallbackconversation ¶

type Queueconversationcallbackeventtopiccallbackconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants
	Participants *[]Queueconversationcallbackeventtopiccallbackmediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`
}

Queueconversationcallbackeventtopiccallbackconversation

func (*Queueconversationcallbackeventtopiccallbackconversation) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopiccallbackmediaparticipant ¶

type Queueconversationcallbackeventtopiccallbackmediaparticipant 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 *Queueconversationcallbackeventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Queueconversationcallbackeventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Queueconversationcallbackeventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationcallbackeventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Queueconversationcallbackeventtopicurireference `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 *Queueconversationcallbackeventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Queueconversationcallbackeventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Queueconversationcallbackeventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Queueconversationcallbackeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Queueconversationcallbackeventtopicjourneycontext `json:"journeyContext,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// OutboundPreview
	OutboundPreview *Queueconversationcallbackeventtopicdialerpreview `json:"outboundPreview,omitempty"`

	// Voicemail
	Voicemail *Queueconversationcallbackeventtopicvoicemail `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"`
}

Queueconversationcallbackeventtopiccallbackmediaparticipant

func (*Queueconversationcallbackeventtopiccallbackmediaparticipant) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopicconversationroutingdata ¶

type Queueconversationcallbackeventtopicconversationroutingdata struct {
	// Queue
	Queue *Queueconversationcallbackeventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Queueconversationcallbackeventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Queueconversationcallbackeventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Queueconversationcallbackeventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Queueconversationcallbackeventtopicconversationroutingdata

func (*Queueconversationcallbackeventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopicdetail ¶

type Queueconversationcallbackeventtopicdetail 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"`
}

Queueconversationcallbackeventtopicdetail

func (*Queueconversationcallbackeventtopicdetail) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopicdialerpreview ¶

type Queueconversationcallbackeventtopicdialerpreview 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 *[]Queueconversationcallbackeventtopicphonenumbercolumn `json:"phoneNumberColumns,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationcallbackeventtopicdialerpreview

func (*Queueconversationcallbackeventtopicdialerpreview) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopicerrorbody ¶

type Queueconversationcallbackeventtopicerrorbody struct {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Queueconversationcallbackeventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Queueconversationcallbackeventtopicerrorbody `json:"errors,omitempty"`
}

Queueconversationcallbackeventtopicerrorbody

func (*Queueconversationcallbackeventtopicerrorbody) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopicjourneyaction ¶

type Queueconversationcallbackeventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Queueconversationcallbackeventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Queueconversationcallbackeventtopicjourneyaction

func (*Queueconversationcallbackeventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopicjourneyactionmap ¶

type Queueconversationcallbackeventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Queueconversationcallbackeventtopicjourneyactionmap

func (*Queueconversationcallbackeventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopicjourneycontext ¶

type Queueconversationcallbackeventtopicjourneycontext struct {
	// Customer
	Customer *Queueconversationcallbackeventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Queueconversationcallbackeventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Queueconversationcallbackeventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Queueconversationcallbackeventtopicjourneycontext

func (*Queueconversationcallbackeventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopicjourneycustomer ¶

type Queueconversationcallbackeventtopicjourneycustomer struct {
	// Id
	Id *string `json:"id,omitempty"`

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Queueconversationcallbackeventtopicjourneycustomer

func (*Queueconversationcallbackeventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopicjourneycustomersession ¶

type Queueconversationcallbackeventtopicjourneycustomersession struct {
	// Id
	Id *string `json:"id,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Queueconversationcallbackeventtopicjourneycustomersession

func (*Queueconversationcallbackeventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopicphonenumbercolumn ¶

type Queueconversationcallbackeventtopicphonenumbercolumn struct {
	// ColumnName
	ColumnName *string `json:"columnName,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationcallbackeventtopicphonenumbercolumn

func (*Queueconversationcallbackeventtopicphonenumbercolumn) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopicscoredagent ¶

type Queueconversationcallbackeventtopicscoredagent struct {
	// Agent
	Agent *Queueconversationcallbackeventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Queueconversationcallbackeventtopicscoredagent

func (*Queueconversationcallbackeventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopicurireference ¶

type Queueconversationcallbackeventtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Queueconversationcallbackeventtopicurireference

func (*Queueconversationcallbackeventtopicurireference) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopicvoicemail ¶

type Queueconversationcallbackeventtopicvoicemail struct {
	// Id
	Id *string `json:"id,omitempty"`

	// UploadStatus
	UploadStatus *string `json:"uploadStatus,omitempty"`
}

Queueconversationcallbackeventtopicvoicemail

func (*Queueconversationcallbackeventtopicvoicemail) String ¶

String returns a JSON representation of the model

type Queueconversationcallbackeventtopicwrapup ¶

type Queueconversationcallbackeventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationcallbackeventtopicwrapup

func (*Queueconversationcallbackeventtopicwrapup) String ¶

String returns a JSON representation of the model

type Queueconversationcalleventtopiccallconversation ¶

type Queueconversationcalleventtopiccallconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants
	Participants *[]Queueconversationcalleventtopiccallmediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`

	// RecordingState
	RecordingState *string `json:"recordingState,omitempty"`

	// MaxParticipants
	MaxParticipants *int `json:"maxParticipants,omitempty"`
}

Queueconversationcalleventtopiccallconversation

func (*Queueconversationcalleventtopiccallconversation) String ¶

String returns a JSON representation of the model

type Queueconversationcalleventtopiccallmediaparticipant ¶

type Queueconversationcalleventtopiccallmediaparticipant 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 *Queueconversationcalleventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Queueconversationcalleventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Queueconversationcalleventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationcalleventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Queueconversationcalleventtopicurireference `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 *Queueconversationcalleventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Queueconversationcalleventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Queueconversationcalleventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Queueconversationcalleventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Queueconversationcalleventtopicjourneycontext `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 *Queueconversationcalleventtopicurireference `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 *Queueconversationcalleventtopicfaxstatus `json:"faxStatus,omitempty"`
}

Queueconversationcalleventtopiccallmediaparticipant

func (*Queueconversationcalleventtopiccallmediaparticipant) String ¶

String returns a JSON representation of the model

type Queueconversationcalleventtopicconversationroutingdata ¶

type Queueconversationcalleventtopicconversationroutingdata struct {
	// Queue
	Queue *Queueconversationcalleventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Queueconversationcalleventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Queueconversationcalleventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Queueconversationcalleventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Queueconversationcalleventtopicconversationroutingdata

func (*Queueconversationcalleventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Queueconversationcalleventtopicdetail ¶

type Queueconversationcalleventtopicdetail 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"`
}

Queueconversationcalleventtopicdetail

func (*Queueconversationcalleventtopicdetail) String ¶

String returns a JSON representation of the model

type Queueconversationcalleventtopicerrorbody ¶

type Queueconversationcalleventtopicerrorbody struct {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Queueconversationcalleventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Queueconversationcalleventtopicerrorbody `json:"errors,omitempty"`
}

Queueconversationcalleventtopicerrorbody

func (*Queueconversationcalleventtopicerrorbody) String ¶

String returns a JSON representation of the model

type Queueconversationcalleventtopicfaxstatus ¶

type Queueconversationcalleventtopicfaxstatus 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"`
}

Queueconversationcalleventtopicfaxstatus

func (*Queueconversationcalleventtopicfaxstatus) String ¶

String returns a JSON representation of the model

type Queueconversationcalleventtopicjourneyaction ¶

type Queueconversationcalleventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Queueconversationcalleventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Queueconversationcalleventtopicjourneyaction

func (*Queueconversationcalleventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Queueconversationcalleventtopicjourneyactionmap ¶

type Queueconversationcalleventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Queueconversationcalleventtopicjourneyactionmap

func (*Queueconversationcalleventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Queueconversationcalleventtopicjourneycontext ¶

type Queueconversationcalleventtopicjourneycontext struct {
	// Customer
	Customer *Queueconversationcalleventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Queueconversationcalleventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Queueconversationcalleventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Queueconversationcalleventtopicjourneycontext

func (*Queueconversationcalleventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Queueconversationcalleventtopicjourneycustomer ¶

type Queueconversationcalleventtopicjourneycustomer struct {
	// Id
	Id *string `json:"id,omitempty"`

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Queueconversationcalleventtopicjourneycustomer

func (*Queueconversationcalleventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Queueconversationcalleventtopicjourneycustomersession ¶

type Queueconversationcalleventtopicjourneycustomersession struct {
	// Id
	Id *string `json:"id,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Queueconversationcalleventtopicjourneycustomersession

func (*Queueconversationcalleventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Queueconversationcalleventtopicscoredagent ¶

type Queueconversationcalleventtopicscoredagent struct {
	// Agent
	Agent *Queueconversationcalleventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Queueconversationcalleventtopicscoredagent

func (*Queueconversationcalleventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Queueconversationcalleventtopicurireference ¶

type Queueconversationcalleventtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Queueconversationcalleventtopicurireference

func (*Queueconversationcalleventtopicurireference) String ¶

String returns a JSON representation of the model

type Queueconversationcalleventtopicwrapup ¶

type Queueconversationcalleventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationcalleventtopicwrapup

func (*Queueconversationcalleventtopicwrapup) String ¶

String returns a JSON representation of the model

type Queueconversationchateventtopicchatconversation ¶

type Queueconversationchateventtopicchatconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants
	Participants *[]Queueconversationchateventtopicchatmediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`
}

Queueconversationchateventtopicchatconversation

func (*Queueconversationchateventtopicchatconversation) String ¶

String returns a JSON representation of the model

type Queueconversationchateventtopicchatmediaparticipant ¶

type Queueconversationchateventtopicchatmediaparticipant 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 *Queueconversationchateventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Queueconversationchateventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Queueconversationchateventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationchateventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Queueconversationchateventtopicurireference `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 *Queueconversationchateventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Queueconversationchateventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Queueconversationchateventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Queueconversationchateventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Queueconversationchateventtopicjourneycontext `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"`
}

Queueconversationchateventtopicchatmediaparticipant

func (*Queueconversationchateventtopicchatmediaparticipant) String ¶

String returns a JSON representation of the model

type Queueconversationchateventtopicconversationroutingdata ¶

type Queueconversationchateventtopicconversationroutingdata struct {
	// Queue
	Queue *Queueconversationchateventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Queueconversationchateventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Queueconversationchateventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Queueconversationchateventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Queueconversationchateventtopicconversationroutingdata

func (*Queueconversationchateventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Queueconversationchateventtopicdetail ¶

type Queueconversationchateventtopicdetail 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"`
}

Queueconversationchateventtopicdetail

func (*Queueconversationchateventtopicdetail) String ¶

String returns a JSON representation of the model

type Queueconversationchateventtopicerrorbody ¶

type Queueconversationchateventtopicerrorbody struct {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Queueconversationchateventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Queueconversationchateventtopicerrorbody `json:"errors,omitempty"`
}

Queueconversationchateventtopicerrorbody

func (*Queueconversationchateventtopicerrorbody) String ¶

String returns a JSON representation of the model

type Queueconversationchateventtopicjourneyaction ¶

type Queueconversationchateventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Queueconversationchateventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Queueconversationchateventtopicjourneyaction

func (*Queueconversationchateventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Queueconversationchateventtopicjourneyactionmap ¶

type Queueconversationchateventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Queueconversationchateventtopicjourneyactionmap

func (*Queueconversationchateventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Queueconversationchateventtopicjourneycontext ¶

type Queueconversationchateventtopicjourneycontext struct {
	// Customer
	Customer *Queueconversationchateventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Queueconversationchateventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Queueconversationchateventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Queueconversationchateventtopicjourneycontext

func (*Queueconversationchateventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Queueconversationchateventtopicjourneycustomer ¶

type Queueconversationchateventtopicjourneycustomer struct {
	// Id
	Id *string `json:"id,omitempty"`

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Queueconversationchateventtopicjourneycustomer

func (*Queueconversationchateventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Queueconversationchateventtopicjourneycustomersession ¶

type Queueconversationchateventtopicjourneycustomersession struct {
	// Id
	Id *string `json:"id,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Queueconversationchateventtopicjourneycustomersession

func (*Queueconversationchateventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Queueconversationchateventtopicscoredagent ¶

type Queueconversationchateventtopicscoredagent struct {
	// Agent
	Agent *Queueconversationchateventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Queueconversationchateventtopicscoredagent

func (*Queueconversationchateventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Queueconversationchateventtopicurireference ¶

type Queueconversationchateventtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Queueconversationchateventtopicurireference

func (*Queueconversationchateventtopicurireference) String ¶

String returns a JSON representation of the model

type Queueconversationchateventtopicwrapup ¶

type Queueconversationchateventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationchateventtopicwrapup

func (*Queueconversationchateventtopicwrapup) String ¶

String returns a JSON representation of the model

type Queueconversationcobrowseeventtopiccobrowseconversation ¶

type Queueconversationcobrowseeventtopiccobrowseconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants
	Participants *[]Queueconversationcobrowseeventtopiccobrowsemediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`
}

Queueconversationcobrowseeventtopiccobrowseconversation

func (*Queueconversationcobrowseeventtopiccobrowseconversation) String ¶

String returns a JSON representation of the model

type Queueconversationcobrowseeventtopiccobrowsemediaparticipant ¶

type Queueconversationcobrowseeventtopiccobrowsemediaparticipant 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 *Queueconversationcobrowseeventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Queueconversationcobrowseeventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Queueconversationcobrowseeventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationcobrowseeventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Queueconversationcobrowseeventtopicurireference `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 *Queueconversationcobrowseeventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Queueconversationcobrowseeventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Queueconversationcobrowseeventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Queueconversationcobrowseeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Queueconversationcobrowseeventtopicjourneycontext `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"`
}

Queueconversationcobrowseeventtopiccobrowsemediaparticipant

func (*Queueconversationcobrowseeventtopiccobrowsemediaparticipant) String ¶

String returns a JSON representation of the model

type Queueconversationcobrowseeventtopicconversationroutingdata ¶

type Queueconversationcobrowseeventtopicconversationroutingdata struct {
	// Queue
	Queue *Queueconversationcobrowseeventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Queueconversationcobrowseeventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Queueconversationcobrowseeventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Queueconversationcobrowseeventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Queueconversationcobrowseeventtopicconversationroutingdata

func (*Queueconversationcobrowseeventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Queueconversationcobrowseeventtopicdetail ¶

type Queueconversationcobrowseeventtopicdetail 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"`
}

Queueconversationcobrowseeventtopicdetail

func (*Queueconversationcobrowseeventtopicdetail) String ¶

String returns a JSON representation of the model

type Queueconversationcobrowseeventtopicerrorbody ¶

type Queueconversationcobrowseeventtopicerrorbody struct {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Queueconversationcobrowseeventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Queueconversationcobrowseeventtopicerrorbody `json:"errors,omitempty"`
}

Queueconversationcobrowseeventtopicerrorbody

func (*Queueconversationcobrowseeventtopicerrorbody) String ¶

String returns a JSON representation of the model

type Queueconversationcobrowseeventtopicjourneyaction ¶

type Queueconversationcobrowseeventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Queueconversationcobrowseeventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Queueconversationcobrowseeventtopicjourneyaction

func (*Queueconversationcobrowseeventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Queueconversationcobrowseeventtopicjourneyactionmap ¶

type Queueconversationcobrowseeventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Queueconversationcobrowseeventtopicjourneyactionmap

func (*Queueconversationcobrowseeventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Queueconversationcobrowseeventtopicjourneycontext ¶

type Queueconversationcobrowseeventtopicjourneycontext struct {
	// Customer
	Customer *Queueconversationcobrowseeventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Queueconversationcobrowseeventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Queueconversationcobrowseeventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Queueconversationcobrowseeventtopicjourneycontext

func (*Queueconversationcobrowseeventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Queueconversationcobrowseeventtopicjourneycustomer ¶

type Queueconversationcobrowseeventtopicjourneycustomer struct {
	// Id
	Id *string `json:"id,omitempty"`

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Queueconversationcobrowseeventtopicjourneycustomer

func (*Queueconversationcobrowseeventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Queueconversationcobrowseeventtopicjourneycustomersession ¶

type Queueconversationcobrowseeventtopicjourneycustomersession struct {
	// Id
	Id *string `json:"id,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Queueconversationcobrowseeventtopicjourneycustomersession

func (*Queueconversationcobrowseeventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Queueconversationcobrowseeventtopicscoredagent ¶

type Queueconversationcobrowseeventtopicscoredagent struct {
	// Agent
	Agent *Queueconversationcobrowseeventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Queueconversationcobrowseeventtopicscoredagent

func (*Queueconversationcobrowseeventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Queueconversationcobrowseeventtopicurireference ¶

type Queueconversationcobrowseeventtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Queueconversationcobrowseeventtopicurireference

func (*Queueconversationcobrowseeventtopicurireference) String ¶

String returns a JSON representation of the model

type Queueconversationcobrowseeventtopicwrapup ¶

type Queueconversationcobrowseeventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationcobrowseeventtopicwrapup

func (*Queueconversationcobrowseeventtopicwrapup) String ¶

String returns a JSON representation of the model

type Queueconversationemaileventtopicattachment ¶

type Queueconversationemaileventtopicattachment 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 *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationemaileventtopicattachment

func (*Queueconversationemaileventtopicattachment) String ¶

String returns a JSON representation of the model

type Queueconversationemaileventtopicconversationroutingdata ¶

type Queueconversationemaileventtopicconversationroutingdata struct {
	// Queue
	Queue *Queueconversationemaileventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Queueconversationemaileventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Queueconversationemaileventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Queueconversationemaileventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Queueconversationemaileventtopicconversationroutingdata

func (*Queueconversationemaileventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Queueconversationemaileventtopicdetail ¶

type Queueconversationemaileventtopicdetail 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"`
}

Queueconversationemaileventtopicdetail

func (*Queueconversationemaileventtopicdetail) String ¶

String returns a JSON representation of the model

type Queueconversationemaileventtopicemailconversation ¶

type Queueconversationemaileventtopicemailconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants
	Participants *[]Queueconversationemaileventtopicemailmediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`
}

Queueconversationemaileventtopicemailconversation

func (*Queueconversationemaileventtopicemailconversation) String ¶

String returns a JSON representation of the model

type Queueconversationemaileventtopicemailmediaparticipant ¶

type Queueconversationemaileventtopicemailmediaparticipant 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 *Queueconversationemaileventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Queueconversationemaileventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Queueconversationemaileventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationemaileventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Queueconversationemaileventtopicurireference `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 *Queueconversationemaileventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Queueconversationemaileventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Queueconversationemaileventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Queueconversationemaileventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Queueconversationemaileventtopicjourneycontext `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 *[]Queueconversationemaileventtopicattachment `json:"draftAttachments,omitempty"`

	// Spam
	Spam *bool `json:"spam,omitempty"`
}

Queueconversationemaileventtopicemailmediaparticipant

func (*Queueconversationemaileventtopicemailmediaparticipant) String ¶

String returns a JSON representation of the model

type Queueconversationemaileventtopicerrorbody ¶

type Queueconversationemaileventtopicerrorbody struct {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Queueconversationemaileventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Queueconversationemaileventtopicerrorbody `json:"errors,omitempty"`
}

Queueconversationemaileventtopicerrorbody

func (*Queueconversationemaileventtopicerrorbody) String ¶

String returns a JSON representation of the model

type Queueconversationemaileventtopicjourneyaction ¶

type Queueconversationemaileventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Queueconversationemaileventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Queueconversationemaileventtopicjourneyaction

func (*Queueconversationemaileventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Queueconversationemaileventtopicjourneyactionmap ¶

type Queueconversationemaileventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Queueconversationemaileventtopicjourneyactionmap

func (*Queueconversationemaileventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Queueconversationemaileventtopicjourneycontext ¶

type Queueconversationemaileventtopicjourneycontext struct {
	// Customer
	Customer *Queueconversationemaileventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Queueconversationemaileventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Queueconversationemaileventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Queueconversationemaileventtopicjourneycontext

func (*Queueconversationemaileventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Queueconversationemaileventtopicjourneycustomer ¶

type Queueconversationemaileventtopicjourneycustomer struct {
	// Id
	Id *string `json:"id,omitempty"`

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Queueconversationemaileventtopicjourneycustomer

func (*Queueconversationemaileventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Queueconversationemaileventtopicjourneycustomersession ¶

type Queueconversationemaileventtopicjourneycustomersession struct {
	// Id
	Id *string `json:"id,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Queueconversationemaileventtopicjourneycustomersession

func (*Queueconversationemaileventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Queueconversationemaileventtopicscoredagent ¶

type Queueconversationemaileventtopicscoredagent struct {
	// Agent
	Agent *Queueconversationemaileventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Queueconversationemaileventtopicscoredagent

func (*Queueconversationemaileventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Queueconversationemaileventtopicurireference ¶

type Queueconversationemaileventtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Queueconversationemaileventtopicurireference

func (*Queueconversationemaileventtopicurireference) String ¶

String returns a JSON representation of the model

type Queueconversationemaileventtopicwrapup ¶

type Queueconversationemaileventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationemaileventtopicwrapup

func (*Queueconversationemaileventtopicwrapup) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicaddress ¶

type Queueconversationeventtopicaddress struct {
	// Name
	Name *string `json:"name,omitempty"`

	// NameRaw
	NameRaw *string `json:"nameRaw,omitempty"`

	// AddressNormalized
	AddressNormalized *string `json:"addressNormalized,omitempty"`

	// AddressRaw
	AddressRaw *string `json:"addressRaw,omitempty"`

	// AddressDisplayable
	AddressDisplayable *string `json:"addressDisplayable,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopicaddress

func (*Queueconversationeventtopicaddress) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicaftercallwork ¶

type Queueconversationeventtopicaftercallwork struct {
	// State
	State *string `json:"state,omitempty"`

	// StartTime
	StartTime *time.Time `json:"startTime,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`
}

Queueconversationeventtopicaftercallwork

func (*Queueconversationeventtopicaftercallwork) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicattachment ¶

type Queueconversationeventtopicattachment 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 *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopicattachment

func (*Queueconversationeventtopicattachment) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopiccall ¶

type Queueconversationeventtopiccall struct {
	// Id
	Id *string `json:"id,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Recording
	Recording *bool `json:"recording,omitempty"`

	// RecordingState
	RecordingState *string `json:"recordingState,omitempty"`

	// Muted
	Muted *bool `json:"muted,omitempty"`

	// Confined
	Confined *bool `json:"confined,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationeventtopicerrordetails `json:"errorInfo,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// DocumentId
	DocumentId *string `json:"documentId,omitempty"`

	// Self
	Self *Queueconversationeventtopicaddress `json:"self,omitempty"`

	// Other
	Other *Queueconversationeventtopicaddress `json:"other,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// DisconnectReasons
	DisconnectReasons *[]Queueconversationeventtopicdisconnectreason `json:"disconnectReasons,omitempty"`

	// FaxStatus
	FaxStatus *Queueconversationeventtopicfaxstatus `json:"faxStatus,omitempty"`

	// UuiData
	UuiData *string `json:"uuiData,omitempty"`

	// Wrapup
	Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AgentAssistantId
	AgentAssistantId *string `json:"agentAssistantId,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopiccall

func (*Queueconversationeventtopiccall) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopiccallback ¶

type Queueconversationeventtopiccallback struct {
	// State
	State *string `json:"state,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// DialerPreview
	DialerPreview *Queueconversationeventtopicdialerpreview `json:"dialerPreview,omitempty"`

	// Voicemail
	Voicemail *Queueconversationeventtopicvoicemail `json:"voicemail,omitempty"`

	// CallbackNumbers
	CallbackNumbers *[]string `json:"callbackNumbers,omitempty"`

	// CallbackUserName
	CallbackUserName *string `json:"callbackUserName,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// ExternalCampaign
	ExternalCampaign *bool `json:"externalCampaign,omitempty"`

	// SkipEnabled
	SkipEnabled *bool `json:"skipEnabled,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// TimeoutSeconds
	TimeoutSeconds *int `json:"timeoutSeconds,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// CallbackScheduledTime
	CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"`

	// AutomatedCallbackConfigId
	AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"`

	// Wrapup
	Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// CallerId
	CallerId *string `json:"callerId,omitempty"`

	// CallerIdName
	CallerIdName *string `json:"callerIdName,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopiccallback

func (*Queueconversationeventtopiccallback) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicchat ¶

type Queueconversationeventtopicchat struct {
	// State
	State *string `json:"state,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// RoomId
	RoomId *string `json:"roomId,omitempty"`

	// AvatarImageUrl
	AvatarImageUrl *string `json:"avatarImageUrl,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// JourneyContext
	JourneyContext *Queueconversationeventtopicjourneycontext `json:"journeyContext,omitempty"`

	// Wrapup
	Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopicchat

func (*Queueconversationeventtopicchat) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopiccobrowse ¶

type Queueconversationeventtopiccobrowse struct {
	// State
	State *string `json:"state,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Self
	Self *Queueconversationeventtopicaddress `json:"self,omitempty"`

	// RoomId
	RoomId *string `json:"roomId,omitempty"`

	// CobrowseSessionId
	CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"`

	// CobrowseRole
	CobrowseRole *string `json:"cobrowseRole,omitempty"`

	// Controlling
	Controlling *[]string `json:"controlling,omitempty"`

	// ViewerUrl
	ViewerUrl *string `json:"viewerUrl,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// ProviderEventTime
	ProviderEventTime *time.Time `json:"providerEventTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Wrapup
	Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopiccobrowse

func (*Queueconversationeventtopiccobrowse) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicconversation ¶

type Queueconversationeventtopicconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// MaxParticipants
	MaxParticipants *int `json:"maxParticipants,omitempty"`

	// Participants
	Participants *[]Queueconversationeventtopicparticipant `json:"participants,omitempty"`

	// RecordingState
	RecordingState *string `json:"recordingState,omitempty"`

	// Address
	Address *string `json:"address,omitempty"`

	// ExternalTag
	ExternalTag *string `json:"externalTag,omitempty"`
}

Queueconversationeventtopicconversation

func (*Queueconversationeventtopicconversation) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicconversationroutingdata ¶

type Queueconversationeventtopicconversationroutingdata struct {
	// Queue
	Queue *Queueconversationeventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Queueconversationeventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Queueconversationeventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Queueconversationeventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Queueconversationeventtopicconversationroutingdata

func (*Queueconversationeventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicdialerpreview ¶

type Queueconversationeventtopicdialerpreview 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 *[]Queueconversationeventtopicphonenumbercolumn `json:"phoneNumberColumns,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopicdialerpreview

func (*Queueconversationeventtopicdialerpreview) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicdisconnectreason ¶

type Queueconversationeventtopicdisconnectreason struct {
	// VarType
	VarType *string `json:"type,omitempty"`

	// Code
	Code *int `json:"code,omitempty"`

	// Phrase
	Phrase *string `json:"phrase,omitempty"`
}

Queueconversationeventtopicdisconnectreason

func (*Queueconversationeventtopicdisconnectreason) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicemail ¶

type Queueconversationeventtopicemail struct {
	// Id
	Id *string `json:"id,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// AutoGenerated
	AutoGenerated *bool `json:"autoGenerated,omitempty"`

	// Subject
	Subject *string `json:"subject,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// MessagesSent
	MessagesSent *int `json:"messagesSent,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationeventtopicerrordetails `json:"errorInfo,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// MessageId
	MessageId *string `json:"messageId,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// DraftAttachments
	DraftAttachments *[]Queueconversationeventtopicattachment `json:"draftAttachments,omitempty"`

	// Spam
	Spam *bool `json:"spam,omitempty"`

	// Wrapup
	Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopicemail

func (*Queueconversationeventtopicemail) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicerrordetails ¶

type Queueconversationeventtopicerrordetails struct {
	// Status
	Status *int `json:"status,omitempty"`

	// Code
	Code *string `json:"code,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"`

	// Uri
	Uri *string `json:"uri,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopicerrordetails

func (*Queueconversationeventtopicerrordetails) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicfaxstatus ¶

type Queueconversationeventtopicfaxstatus 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"`

	// BaudRate
	BaudRate *int `json:"baudRate,omitempty"`

	// PageErrors
	PageErrors *int `json:"pageErrors,omitempty"`

	// LineErrors
	LineErrors *int `json:"lineErrors,omitempty"`
}

Queueconversationeventtopicfaxstatus

func (*Queueconversationeventtopicfaxstatus) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicjourneyaction ¶

type Queueconversationeventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Queueconversationeventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Queueconversationeventtopicjourneyaction

func (*Queueconversationeventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicjourneyactionmap ¶

type Queueconversationeventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Queueconversationeventtopicjourneyactionmap

func (*Queueconversationeventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicjourneycontext ¶

type Queueconversationeventtopicjourneycontext struct {
	// Customer
	Customer *Queueconversationeventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Queueconversationeventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Queueconversationeventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Queueconversationeventtopicjourneycontext

func (*Queueconversationeventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicjourneycustomer ¶

type Queueconversationeventtopicjourneycustomer struct {
	// Id
	Id *string `json:"id,omitempty"`

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Queueconversationeventtopicjourneycustomer

func (*Queueconversationeventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicjourneycustomersession ¶

type Queueconversationeventtopicjourneycustomersession struct {
	// Id
	Id *string `json:"id,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Queueconversationeventtopicjourneycustomersession

func (*Queueconversationeventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicmessage ¶

type Queueconversationeventtopicmessage struct {
	// Id
	Id *string `json:"id,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationeventtopicerrordetails `json:"errorInfo,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// ToAddress
	ToAddress *Queueconversationeventtopicaddress `json:"toAddress,omitempty"`

	// FromAddress
	FromAddress *Queueconversationeventtopicaddress `json:"fromAddress,omitempty"`

	// Messages
	Messages *[]Queueconversationeventtopicmessagedetails `json:"messages,omitempty"`

	// MessagesTranscriptUri
	MessagesTranscriptUri *string `json:"messagesTranscriptUri,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// RecipientCountry
	RecipientCountry *string `json:"recipientCountry,omitempty"`

	// RecipientType
	RecipientType *string `json:"recipientType,omitempty"`

	// JourneyContext
	JourneyContext *Queueconversationeventtopicjourneycontext `json:"journeyContext,omitempty"`

	// Wrapup
	Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopicmessage

func (*Queueconversationeventtopicmessage) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicmessagedetails ¶

type Queueconversationeventtopicmessagedetails struct {
	// MessageId
	MessageId *string `json:"messageId,omitempty"`

	// MessageTime
	MessageTime *time.Time `json:"messageTime,omitempty"`

	// MessageStatus
	MessageStatus *string `json:"messageStatus,omitempty"`

	// MessageSegmentCount
	MessageSegmentCount *int `json:"messageSegmentCount,omitempty"`

	// Media
	Media *[]Queueconversationeventtopicmessagemedia `json:"media,omitempty"`

	// Stickers
	Stickers *[]Queueconversationeventtopicmessagesticker `json:"stickers,omitempty"`
}

Queueconversationeventtopicmessagedetails

func (*Queueconversationeventtopicmessagedetails) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicmessagemedia ¶

type Queueconversationeventtopicmessagemedia struct {
	// Url
	Url *string `json:"url,omitempty"`

	// MediaType
	MediaType *string `json:"mediaType,omitempty"`

	// ContentLengthBytes
	ContentLengthBytes *int `json:"contentLengthBytes,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`
}

Queueconversationeventtopicmessagemedia

func (*Queueconversationeventtopicmessagemedia) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicmessagesticker ¶

type Queueconversationeventtopicmessagesticker struct {
	// Url
	Url *string `json:"url,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`
}

Queueconversationeventtopicmessagesticker

func (*Queueconversationeventtopicmessagesticker) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicparticipant ¶

type Queueconversationeventtopicparticipant struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`

	// UserId
	UserId *string `json:"userId,omitempty"`

	// ExternalContactId
	ExternalContactId *string `json:"externalContactId,omitempty"`

	// ExternalOrganizationId
	ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// QueueId
	QueueId *string `json:"queueId,omitempty"`

	// GroupId
	GroupId *string `json:"groupId,omitempty"`

	// TeamId
	TeamId *string `json:"teamId,omitempty"`

	// Purpose
	Purpose *string `json:"purpose,omitempty"`

	// ConsultParticipantId
	ConsultParticipantId *string `json:"consultParticipantId,omitempty"`

	// Address
	Address *string `json:"address,omitempty"`

	// WrapupRequired
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupExpected
	WrapupExpected *bool `json:"wrapupExpected,omitempty"`

	// WrapupPrompt
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// WrapupTimeoutMs
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// Wrapup
	Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Queueconversationeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// AlertingTimeoutMs
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

	// MonitoredParticipantId
	MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"`

	// CoachedParticipantId
	CoachedParticipantId *string `json:"coachedParticipantId,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// Calls
	Calls *[]Queueconversationeventtopiccall `json:"calls,omitempty"`

	// Callbacks
	Callbacks *[]Queueconversationeventtopiccallback `json:"callbacks,omitempty"`

	// Chats
	Chats *[]Queueconversationeventtopicchat `json:"chats,omitempty"`

	// Cobrowsesessions
	Cobrowsesessions *[]Queueconversationeventtopiccobrowse `json:"cobrowsesessions,omitempty"`

	// Emails
	Emails *[]Queueconversationeventtopicemail `json:"emails,omitempty"`

	// Messages
	Messages *[]Queueconversationeventtopicmessage `json:"messages,omitempty"`

	// Screenshares
	Screenshares *[]Queueconversationeventtopicscreenshare `json:"screenshares,omitempty"`

	// SocialExpressions
	SocialExpressions *[]Queueconversationeventtopicsocialexpression `json:"socialExpressions,omitempty"`

	// Videos
	Videos *[]Queueconversationeventtopicvideo `json:"videos,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopicparticipant

func (*Queueconversationeventtopicparticipant) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicphonenumbercolumn ¶

type Queueconversationeventtopicphonenumbercolumn struct {
	// ColumnName
	ColumnName *string `json:"columnName,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopicphonenumbercolumn

func (*Queueconversationeventtopicphonenumbercolumn) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicscoredagent ¶

type Queueconversationeventtopicscoredagent struct {
	// Agent
	Agent *Queueconversationeventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Queueconversationeventtopicscoredagent

func (*Queueconversationeventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicscreenshare ¶

type Queueconversationeventtopicscreenshare struct {
	// State
	State *string `json:"state,omitempty"`

	// Self
	Self *Queueconversationeventtopicaddress `json:"self,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Context
	Context *string `json:"context,omitempty"`

	// Sharing
	Sharing *bool `json:"sharing,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Wrapup
	Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopicscreenshare

func (*Queueconversationeventtopicscreenshare) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicsocialexpression ¶

type Queueconversationeventtopicsocialexpression struct {
	// State
	State *string `json:"state,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// SocialMediaId
	SocialMediaId *string `json:"socialMediaId,omitempty"`

	// SocialMediaHub
	SocialMediaHub *string `json:"socialMediaHub,omitempty"`

	// SocialUserName
	SocialUserName *string `json:"socialUserName,omitempty"`

	// PreviewText
	PreviewText *string `json:"previewText,omitempty"`

	// RecordingId
	RecordingId *string `json:"recordingId,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Wrapup
	Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopicsocialexpression

func (*Queueconversationeventtopicsocialexpression) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicurireference ¶

type Queueconversationeventtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Queueconversationeventtopicurireference

func (*Queueconversationeventtopicurireference) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicvideo ¶

type Queueconversationeventtopicvideo struct {
	// State
	State *string `json:"state,omitempty"`

	// Self
	Self *Queueconversationeventtopicaddress `json:"self,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Context
	Context *string `json:"context,omitempty"`

	// AudioMuted
	AudioMuted *bool `json:"audioMuted,omitempty"`

	// VideoMuted
	VideoMuted *bool `json:"videoMuted,omitempty"`

	// SharingScreen
	SharingScreen *bool `json:"sharingScreen,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Msids
	Msids *[]string `json:"msids,omitempty"`

	// Wrapup
	Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopicvideo

func (*Queueconversationeventtopicvideo) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicvoicemail ¶

type Queueconversationeventtopicvoicemail struct {
	// Id
	Id *string `json:"id,omitempty"`

	// UploadStatus
	UploadStatus *string `json:"uploadStatus,omitempty"`
}

Queueconversationeventtopicvoicemail

func (*Queueconversationeventtopicvoicemail) String ¶

String returns a JSON representation of the model

type Queueconversationeventtopicwrapup ¶

type Queueconversationeventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationeventtopicwrapup

func (*Queueconversationeventtopicwrapup) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicconversationroutingdata ¶

type Queueconversationmessageeventtopicconversationroutingdata struct {
	// Queue
	Queue *Queueconversationmessageeventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Queueconversationmessageeventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Queueconversationmessageeventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Queueconversationmessageeventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Queueconversationmessageeventtopicconversationroutingdata

func (*Queueconversationmessageeventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicdetail ¶

type Queueconversationmessageeventtopicdetail 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"`
}

Queueconversationmessageeventtopicdetail

func (*Queueconversationmessageeventtopicdetail) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicerrorbody ¶

type Queueconversationmessageeventtopicerrorbody struct {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Queueconversationmessageeventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Queueconversationmessageeventtopicerrorbody `json:"errors,omitempty"`
}

Queueconversationmessageeventtopicerrorbody

func (*Queueconversationmessageeventtopicerrorbody) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicjourneyaction ¶

type Queueconversationmessageeventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Queueconversationmessageeventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Queueconversationmessageeventtopicjourneyaction

func (*Queueconversationmessageeventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicjourneyactionmap ¶

type Queueconversationmessageeventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Queueconversationmessageeventtopicjourneyactionmap

func (*Queueconversationmessageeventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicjourneycontext ¶

type Queueconversationmessageeventtopicjourneycontext struct {
	// Customer
	Customer *Queueconversationmessageeventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Queueconversationmessageeventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Queueconversationmessageeventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Queueconversationmessageeventtopicjourneycontext

func (*Queueconversationmessageeventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicjourneycustomer ¶

type Queueconversationmessageeventtopicjourneycustomer struct {
	// Id
	Id *string `json:"id,omitempty"`

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Queueconversationmessageeventtopicjourneycustomer

func (*Queueconversationmessageeventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicjourneycustomersession ¶

type Queueconversationmessageeventtopicjourneycustomersession struct {
	// Id
	Id *string `json:"id,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Queueconversationmessageeventtopicjourneycustomersession

func (*Queueconversationmessageeventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicmessageconversation ¶

type Queueconversationmessageeventtopicmessageconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants
	Participants *[]Queueconversationmessageeventtopicmessagemediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`
}

Queueconversationmessageeventtopicmessageconversation

func (*Queueconversationmessageeventtopicmessageconversation) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicmessagedetails ¶

type Queueconversationmessageeventtopicmessagedetails struct {
	// Message
	Message *Queueconversationmessageeventtopicurireference `json:"message,omitempty"`

	// MessageTime
	MessageTime *time.Time `json:"messageTime,omitempty"`

	// MessageSegmentCount
	MessageSegmentCount *int `json:"messageSegmentCount,omitempty"`

	// MessageStatus
	MessageStatus *string `json:"messageStatus,omitempty"`

	// Media
	Media *[]Queueconversationmessageeventtopicmessagemedia `json:"media,omitempty"`

	// Stickers
	Stickers *[]Queueconversationmessageeventtopicmessagesticker `json:"stickers,omitempty"`
}

Queueconversationmessageeventtopicmessagedetails

func (*Queueconversationmessageeventtopicmessagedetails) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicmessagemedia ¶

type Queueconversationmessageeventtopicmessagemedia struct {
	// Url
	Url *string `json:"url,omitempty"`

	// MediaType
	MediaType *string `json:"mediaType,omitempty"`

	// ContentLengthBytes
	ContentLengthBytes *int `json:"contentLengthBytes,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`
}

Queueconversationmessageeventtopicmessagemedia

func (*Queueconversationmessageeventtopicmessagemedia) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicmessagemediaparticipant ¶

type Queueconversationmessageeventtopicmessagemediaparticipant 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 *Queueconversationmessageeventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Queueconversationmessageeventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Queueconversationmessageeventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationmessageeventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Queueconversationmessageeventtopicurireference `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 *Queueconversationmessageeventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Queueconversationmessageeventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Queueconversationmessageeventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Queueconversationmessageeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Queueconversationmessageeventtopicjourneycontext `json:"journeyContext,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// Messages
	Messages *[]Queueconversationmessageeventtopicmessagedetails `json:"messages,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// RecipientCountry
	RecipientCountry *string `json:"recipientCountry,omitempty"`

	// RecipientType
	RecipientType *string `json:"recipientType,omitempty"`
}

Queueconversationmessageeventtopicmessagemediaparticipant

func (*Queueconversationmessageeventtopicmessagemediaparticipant) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicmessagesticker ¶

type Queueconversationmessageeventtopicmessagesticker struct {
	// Url
	Url *string `json:"url,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`
}

Queueconversationmessageeventtopicmessagesticker

func (*Queueconversationmessageeventtopicmessagesticker) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicscoredagent ¶

type Queueconversationmessageeventtopicscoredagent struct {
	// Agent
	Agent *Queueconversationmessageeventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Queueconversationmessageeventtopicscoredagent

func (*Queueconversationmessageeventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicurireference ¶

type Queueconversationmessageeventtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Queueconversationmessageeventtopicurireference

func (*Queueconversationmessageeventtopicurireference) String ¶

String returns a JSON representation of the model

type Queueconversationmessageeventtopicwrapup ¶

type Queueconversationmessageeventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationmessageeventtopicwrapup

func (*Queueconversationmessageeventtopicwrapup) String ¶

String returns a JSON representation of the model

type Queueconversationscreenshareeventtopicconversationroutingdata ¶

type Queueconversationscreenshareeventtopicconversationroutingdata struct {
	// Queue
	Queue *Queueconversationscreenshareeventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Queueconversationscreenshareeventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Queueconversationscreenshareeventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Queueconversationscreenshareeventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Queueconversationscreenshareeventtopicconversationroutingdata

func (*Queueconversationscreenshareeventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Queueconversationscreenshareeventtopicdetail ¶

type Queueconversationscreenshareeventtopicdetail 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"`
}

Queueconversationscreenshareeventtopicdetail

func (*Queueconversationscreenshareeventtopicdetail) String ¶

String returns a JSON representation of the model

type Queueconversationscreenshareeventtopicerrorbody ¶

type Queueconversationscreenshareeventtopicerrorbody struct {
	// Message
	Message *string `json:"message,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// EntityId
	EntityId *string `json:"entityId,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// MessageWithParams
	MessageWithParams *string `json:"messageWithParams,omitempty"`

	// MessageParams
	MessageParams *map[string]string `json:"messageParams,omitempty"`

	// ContextId
	ContextId *string `json:"contextId,omitempty"`

	// Details
	Details *[]Queueconversationscreenshareeventtopicdetail `json:"details,omitempty"`

	// Errors
	Errors *[]Queueconversationscreenshareeventtopicerrorbody `json:"errors,omitempty"`
}

Queueconversationscreenshareeventtopicerrorbody

func (*Queueconversationscreenshareeventtopicerrorbody) String ¶

String returns a JSON representation of the model

type Queueconversationscreenshareeventtopicjourneyaction ¶

type Queueconversationscreenshareeventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Queueconversationscreenshareeventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Queueconversationscreenshareeventtopicjourneyaction

func (*Queueconversationscreenshareeventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Queueconversationscreenshareeventtopicjourneyactionmap ¶

type Queueconversationscreenshareeventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Queueconversationscreenshareeventtopicjourneyactionmap

func (*Queueconversationscreenshareeventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Queueconversationscreenshareeventtopicjourneycontext ¶

type Queueconversationscreenshareeventtopicjourneycontext struct {
	// Customer
	Customer *Queueconversationscreenshareeventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Queueconversationscreenshareeventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Queueconversationscreenshareeventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Queueconversationscreenshareeventtopicjourneycontext

func (*Queueconversationscreenshareeventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Queueconversationscreenshareeventtopicjourneycustomer ¶

type Queueconversationscreenshareeventtopicjourneycustomer struct {
	// Id
	Id *string `json:"id,omitempty"`

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Queueconversationscreenshareeventtopicjourneycustomer

func (*Queueconversationscreenshareeventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Queueconversationscreenshareeventtopicjourneycustomersession ¶

type Queueconversationscreenshareeventtopicjourneycustomersession struct {
	// Id
	Id *string `json:"id,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Queueconversationscreenshareeventtopicjourneycustomersession

func (*Queueconversationscreenshareeventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Queueconversationscreenshareeventtopicscoredagent ¶

type Queueconversationscreenshareeventtopicscoredagent struct {
	// Agent
	Agent *Queueconversationscreenshareeventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Queueconversationscreenshareeventtopicscoredagent

func (*Queueconversationscreenshareeventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Queueconversationscreenshareeventtopicscreenshareconversation ¶

type Queueconversationscreenshareeventtopicscreenshareconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Participants
	Participants *[]Queueconversationscreenshareeventtopicscreensharemediaparticipant `json:"participants,omitempty"`

	// OtherMediaUris
	OtherMediaUris *[]string `json:"otherMediaUris,omitempty"`
}

Queueconversationscreenshareeventtopicscreenshareconversation

func (*Queueconversationscreenshareeventtopicscreenshareconversation) String ¶

String returns a JSON representation of the model

type Queueconversationscreenshareeventtopicscreensharemediaparticipant ¶

type Queueconversationscreenshareeventtopicscreensharemediaparticipant 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 *Queueconversationscreenshareeventtopicurireference `json:"user,omitempty"`

	// Queue
	Queue *Queueconversationscreenshareeventtopicurireference `json:"queue,omitempty"`

	// Team
	Team *Queueconversationscreenshareeventtopicurireference `json:"team,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationscreenshareeventtopicerrorbody `json:"errorInfo,omitempty"`

	// Script
	Script *Queueconversationscreenshareeventtopicurireference `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 *Queueconversationscreenshareeventtopicurireference `json:"externalContact,omitempty"`

	// ExternalOrganization
	ExternalOrganization *Queueconversationscreenshareeventtopicurireference `json:"externalOrganization,omitempty"`

	// Wrapup
	Wrapup *Queueconversationscreenshareeventtopicwrapup `json:"wrapup,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Queueconversationscreenshareeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// Peer
	Peer *string `json:"peer,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// JourneyContext
	JourneyContext *Queueconversationscreenshareeventtopicjourneycontext `json:"journeyContext,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// Context
	Context *string `json:"context,omitempty"`

	// PeerCount
	PeerCount *int `json:"peerCount,omitempty"`

	// Sharing
	Sharing *bool `json:"sharing,omitempty"`
}

Queueconversationscreenshareeventtopicscreensharemediaparticipant

func (*Queueconversationscreenshareeventtopicscreensharemediaparticipant) String ¶

String returns a JSON representation of the model

type Queueconversationscreenshareeventtopicurireference ¶

type Queueconversationscreenshareeventtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Queueconversationscreenshareeventtopicurireference

func (*Queueconversationscreenshareeventtopicurireference) String ¶

String returns a JSON representation of the model

type Queueconversationscreenshareeventtopicwrapup ¶

type Queueconversationscreenshareeventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationscreenshareeventtopicwrapup

func (*Queueconversationscreenshareeventtopicwrapup) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicaddress ¶

type Queueconversationsocialexpressioneventtopicaddress struct {
	// Name
	Name *string `json:"name,omitempty"`

	// NameRaw
	NameRaw *string `json:"nameRaw,omitempty"`

	// AddressNormalized
	AddressNormalized *string `json:"addressNormalized,omitempty"`

	// AddressRaw
	AddressRaw *string `json:"addressRaw,omitempty"`

	// AddressDisplayable
	AddressDisplayable *string `json:"addressDisplayable,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopicaddress

func (*Queueconversationsocialexpressioneventtopicaddress) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicaftercallwork ¶

type Queueconversationsocialexpressioneventtopicaftercallwork struct {
	// State
	State *string `json:"state,omitempty"`

	// StartTime
	StartTime *time.Time `json:"startTime,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`
}

Queueconversationsocialexpressioneventtopicaftercallwork

func (*Queueconversationsocialexpressioneventtopicaftercallwork) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicattachment ¶

type Queueconversationsocialexpressioneventtopicattachment 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 *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopicattachment

func (*Queueconversationsocialexpressioneventtopicattachment) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopiccall ¶

type Queueconversationsocialexpressioneventtopiccall struct {
	// Id
	Id *string `json:"id,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Recording
	Recording *bool `json:"recording,omitempty"`

	// RecordingState
	RecordingState *string `json:"recordingState,omitempty"`

	// Muted
	Muted *bool `json:"muted,omitempty"`

	// Confined
	Confined *bool `json:"confined,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationsocialexpressioneventtopicerrordetails `json:"errorInfo,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// DocumentId
	DocumentId *string `json:"documentId,omitempty"`

	// Self
	Self *Queueconversationsocialexpressioneventtopicaddress `json:"self,omitempty"`

	// Other
	Other *Queueconversationsocialexpressioneventtopicaddress `json:"other,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// DisconnectReasons
	DisconnectReasons *[]Queueconversationsocialexpressioneventtopicdisconnectreason `json:"disconnectReasons,omitempty"`

	// FaxStatus
	FaxStatus *Queueconversationsocialexpressioneventtopicfaxstatus `json:"faxStatus,omitempty"`

	// UuiData
	UuiData *string `json:"uuiData,omitempty"`

	// Wrapup
	Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AgentAssistantId
	AgentAssistantId *string `json:"agentAssistantId,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopiccall

func (*Queueconversationsocialexpressioneventtopiccall) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopiccallback ¶

type Queueconversationsocialexpressioneventtopiccallback struct {
	// State
	State *string `json:"state,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// DialerPreview
	DialerPreview *Queueconversationsocialexpressioneventtopicdialerpreview `json:"dialerPreview,omitempty"`

	// Voicemail
	Voicemail *Queueconversationsocialexpressioneventtopicvoicemail `json:"voicemail,omitempty"`

	// CallbackNumbers
	CallbackNumbers *[]string `json:"callbackNumbers,omitempty"`

	// CallbackUserName
	CallbackUserName *string `json:"callbackUserName,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// ExternalCampaign
	ExternalCampaign *bool `json:"externalCampaign,omitempty"`

	// SkipEnabled
	SkipEnabled *bool `json:"skipEnabled,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// TimeoutSeconds
	TimeoutSeconds *int `json:"timeoutSeconds,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// CallbackScheduledTime
	CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"`

	// AutomatedCallbackConfigId
	AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"`

	// Wrapup
	Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// CallerId
	CallerId *string `json:"callerId,omitempty"`

	// CallerIdName
	CallerIdName *string `json:"callerIdName,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopiccallback

func (*Queueconversationsocialexpressioneventtopiccallback) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicchat ¶

type Queueconversationsocialexpressioneventtopicchat struct {
	// State
	State *string `json:"state,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// RoomId
	RoomId *string `json:"roomId,omitempty"`

	// AvatarImageUrl
	AvatarImageUrl *string `json:"avatarImageUrl,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// JourneyContext
	JourneyContext *Queueconversationsocialexpressioneventtopicjourneycontext `json:"journeyContext,omitempty"`

	// Wrapup
	Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopicchat

func (*Queueconversationsocialexpressioneventtopicchat) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopiccobrowse ¶

type Queueconversationsocialexpressioneventtopiccobrowse struct {
	// State
	State *string `json:"state,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Self
	Self *Queueconversationsocialexpressioneventtopicaddress `json:"self,omitempty"`

	// RoomId
	RoomId *string `json:"roomId,omitempty"`

	// CobrowseSessionId
	CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"`

	// CobrowseRole
	CobrowseRole *string `json:"cobrowseRole,omitempty"`

	// Controlling
	Controlling *[]string `json:"controlling,omitempty"`

	// ViewerUrl
	ViewerUrl *string `json:"viewerUrl,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// ProviderEventTime
	ProviderEventTime *time.Time `json:"providerEventTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Wrapup
	Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopiccobrowse

func (*Queueconversationsocialexpressioneventtopiccobrowse) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicconversation ¶

type Queueconversationsocialexpressioneventtopicconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// MaxParticipants
	MaxParticipants *int `json:"maxParticipants,omitempty"`

	// Participants
	Participants *[]Queueconversationsocialexpressioneventtopicparticipant `json:"participants,omitempty"`

	// RecordingState
	RecordingState *string `json:"recordingState,omitempty"`

	// Address
	Address *string `json:"address,omitempty"`

	// ExternalTag
	ExternalTag *string `json:"externalTag,omitempty"`
}

Queueconversationsocialexpressioneventtopicconversation

func (*Queueconversationsocialexpressioneventtopicconversation) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicconversationroutingdata ¶

type Queueconversationsocialexpressioneventtopicconversationroutingdata struct {
	// Queue
	Queue *Queueconversationsocialexpressioneventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Queueconversationsocialexpressioneventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Queueconversationsocialexpressioneventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Queueconversationsocialexpressioneventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Queueconversationsocialexpressioneventtopicconversationroutingdata

func (*Queueconversationsocialexpressioneventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicdialerpreview ¶

type Queueconversationsocialexpressioneventtopicdialerpreview 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 *[]Queueconversationsocialexpressioneventtopicphonenumbercolumn `json:"phoneNumberColumns,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopicdialerpreview

func (*Queueconversationsocialexpressioneventtopicdialerpreview) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicdisconnectreason ¶

type Queueconversationsocialexpressioneventtopicdisconnectreason struct {
	// VarType
	VarType *string `json:"type,omitempty"`

	// Code
	Code *int `json:"code,omitempty"`

	// Phrase
	Phrase *string `json:"phrase,omitempty"`
}

Queueconversationsocialexpressioneventtopicdisconnectreason

func (*Queueconversationsocialexpressioneventtopicdisconnectreason) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicemail ¶

type Queueconversationsocialexpressioneventtopicemail struct {
	// Id
	Id *string `json:"id,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// AutoGenerated
	AutoGenerated *bool `json:"autoGenerated,omitempty"`

	// Subject
	Subject *string `json:"subject,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// MessagesSent
	MessagesSent *int `json:"messagesSent,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationsocialexpressioneventtopicerrordetails `json:"errorInfo,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// MessageId
	MessageId *string `json:"messageId,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// DraftAttachments
	DraftAttachments *[]Queueconversationsocialexpressioneventtopicattachment `json:"draftAttachments,omitempty"`

	// Spam
	Spam *bool `json:"spam,omitempty"`

	// Wrapup
	Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopicemail

func (*Queueconversationsocialexpressioneventtopicemail) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicerrordetails ¶

type Queueconversationsocialexpressioneventtopicerrordetails struct {
	// Status
	Status *int `json:"status,omitempty"`

	// Code
	Code *string `json:"code,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"`

	// Uri
	Uri *string `json:"uri,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopicerrordetails

func (*Queueconversationsocialexpressioneventtopicerrordetails) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicfaxstatus ¶

type Queueconversationsocialexpressioneventtopicfaxstatus 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"`

	// BaudRate
	BaudRate *int `json:"baudRate,omitempty"`

	// PageErrors
	PageErrors *int `json:"pageErrors,omitempty"`

	// LineErrors
	LineErrors *int `json:"lineErrors,omitempty"`
}

Queueconversationsocialexpressioneventtopicfaxstatus

func (*Queueconversationsocialexpressioneventtopicfaxstatus) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicjourneyaction ¶

type Queueconversationsocialexpressioneventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Queueconversationsocialexpressioneventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Queueconversationsocialexpressioneventtopicjourneyaction

func (*Queueconversationsocialexpressioneventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicjourneyactionmap ¶

type Queueconversationsocialexpressioneventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Queueconversationsocialexpressioneventtopicjourneyactionmap

func (*Queueconversationsocialexpressioneventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicjourneycontext ¶

type Queueconversationsocialexpressioneventtopicjourneycontext struct {
	// Customer
	Customer *Queueconversationsocialexpressioneventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Queueconversationsocialexpressioneventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Queueconversationsocialexpressioneventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Queueconversationsocialexpressioneventtopicjourneycontext

func (*Queueconversationsocialexpressioneventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicjourneycustomer ¶

type Queueconversationsocialexpressioneventtopicjourneycustomer struct {
	// Id
	Id *string `json:"id,omitempty"`

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Queueconversationsocialexpressioneventtopicjourneycustomer

func (*Queueconversationsocialexpressioneventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicjourneycustomersession ¶

type Queueconversationsocialexpressioneventtopicjourneycustomersession struct {
	// Id
	Id *string `json:"id,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Queueconversationsocialexpressioneventtopicjourneycustomersession

func (*Queueconversationsocialexpressioneventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicmessage ¶

type Queueconversationsocialexpressioneventtopicmessage struct {
	// Id
	Id *string `json:"id,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationsocialexpressioneventtopicerrordetails `json:"errorInfo,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// ToAddress
	ToAddress *Queueconversationsocialexpressioneventtopicaddress `json:"toAddress,omitempty"`

	// FromAddress
	FromAddress *Queueconversationsocialexpressioneventtopicaddress `json:"fromAddress,omitempty"`

	// Messages
	Messages *[]Queueconversationsocialexpressioneventtopicmessagedetails `json:"messages,omitempty"`

	// MessagesTranscriptUri
	MessagesTranscriptUri *string `json:"messagesTranscriptUri,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// RecipientCountry
	RecipientCountry *string `json:"recipientCountry,omitempty"`

	// RecipientType
	RecipientType *string `json:"recipientType,omitempty"`

	// JourneyContext
	JourneyContext *Queueconversationsocialexpressioneventtopicjourneycontext `json:"journeyContext,omitempty"`

	// Wrapup
	Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopicmessage

func (*Queueconversationsocialexpressioneventtopicmessage) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicmessagedetails ¶

type Queueconversationsocialexpressioneventtopicmessagedetails struct {
	// MessageId
	MessageId *string `json:"messageId,omitempty"`

	// MessageTime
	MessageTime *time.Time `json:"messageTime,omitempty"`

	// MessageStatus
	MessageStatus *string `json:"messageStatus,omitempty"`

	// MessageSegmentCount
	MessageSegmentCount *int `json:"messageSegmentCount,omitempty"`

	// Media
	Media *[]Queueconversationsocialexpressioneventtopicmessagemedia `json:"media,omitempty"`

	// Stickers
	Stickers *[]Queueconversationsocialexpressioneventtopicmessagesticker `json:"stickers,omitempty"`
}

Queueconversationsocialexpressioneventtopicmessagedetails

func (*Queueconversationsocialexpressioneventtopicmessagedetails) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicmessagemedia ¶

type Queueconversationsocialexpressioneventtopicmessagemedia struct {
	// Url
	Url *string `json:"url,omitempty"`

	// MediaType
	MediaType *string `json:"mediaType,omitempty"`

	// ContentLengthBytes
	ContentLengthBytes *int `json:"contentLengthBytes,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`
}

Queueconversationsocialexpressioneventtopicmessagemedia

func (*Queueconversationsocialexpressioneventtopicmessagemedia) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicmessagesticker ¶

type Queueconversationsocialexpressioneventtopicmessagesticker struct {
	// Url
	Url *string `json:"url,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`
}

Queueconversationsocialexpressioneventtopicmessagesticker

func (*Queueconversationsocialexpressioneventtopicmessagesticker) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicparticipant ¶

type Queueconversationsocialexpressioneventtopicparticipant struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`

	// UserId
	UserId *string `json:"userId,omitempty"`

	// ExternalContactId
	ExternalContactId *string `json:"externalContactId,omitempty"`

	// ExternalOrganizationId
	ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// QueueId
	QueueId *string `json:"queueId,omitempty"`

	// GroupId
	GroupId *string `json:"groupId,omitempty"`

	// TeamId
	TeamId *string `json:"teamId,omitempty"`

	// Purpose
	Purpose *string `json:"purpose,omitempty"`

	// ConsultParticipantId
	ConsultParticipantId *string `json:"consultParticipantId,omitempty"`

	// Address
	Address *string `json:"address,omitempty"`

	// WrapupRequired
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupExpected
	WrapupExpected *bool `json:"wrapupExpected,omitempty"`

	// WrapupPrompt
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// WrapupTimeoutMs
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// Wrapup
	Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Queueconversationsocialexpressioneventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// AlertingTimeoutMs
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

	// MonitoredParticipantId
	MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"`

	// CoachedParticipantId
	CoachedParticipantId *string `json:"coachedParticipantId,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// Calls
	Calls *[]Queueconversationsocialexpressioneventtopiccall `json:"calls,omitempty"`

	// Callbacks
	Callbacks *[]Queueconversationsocialexpressioneventtopiccallback `json:"callbacks,omitempty"`

	// Chats
	Chats *[]Queueconversationsocialexpressioneventtopicchat `json:"chats,omitempty"`

	// Cobrowsesessions
	Cobrowsesessions *[]Queueconversationsocialexpressioneventtopiccobrowse `json:"cobrowsesessions,omitempty"`

	// Emails
	Emails *[]Queueconversationsocialexpressioneventtopicemail `json:"emails,omitempty"`

	// Messages
	Messages *[]Queueconversationsocialexpressioneventtopicmessage `json:"messages,omitempty"`

	// Screenshares
	Screenshares *[]Queueconversationsocialexpressioneventtopicscreenshare `json:"screenshares,omitempty"`

	// SocialExpressions
	SocialExpressions *[]Queueconversationsocialexpressioneventtopicsocialexpression `json:"socialExpressions,omitempty"`

	// Videos
	Videos *[]Queueconversationsocialexpressioneventtopicvideo `json:"videos,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopicparticipant

func (*Queueconversationsocialexpressioneventtopicparticipant) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicphonenumbercolumn ¶

type Queueconversationsocialexpressioneventtopicphonenumbercolumn struct {
	// ColumnName
	ColumnName *string `json:"columnName,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopicphonenumbercolumn

func (*Queueconversationsocialexpressioneventtopicphonenumbercolumn) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicscoredagent ¶

type Queueconversationsocialexpressioneventtopicscoredagent struct {
	// Agent
	Agent *Queueconversationsocialexpressioneventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Queueconversationsocialexpressioneventtopicscoredagent

func (*Queueconversationsocialexpressioneventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicscreenshare ¶

type Queueconversationsocialexpressioneventtopicscreenshare struct {
	// State
	State *string `json:"state,omitempty"`

	// Self
	Self *Queueconversationsocialexpressioneventtopicaddress `json:"self,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Context
	Context *string `json:"context,omitempty"`

	// Sharing
	Sharing *bool `json:"sharing,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Wrapup
	Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopicscreenshare

func (*Queueconversationsocialexpressioneventtopicscreenshare) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicsocialexpression ¶

type Queueconversationsocialexpressioneventtopicsocialexpression struct {
	// State
	State *string `json:"state,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// SocialMediaId
	SocialMediaId *string `json:"socialMediaId,omitempty"`

	// SocialMediaHub
	SocialMediaHub *string `json:"socialMediaHub,omitempty"`

	// SocialUserName
	SocialUserName *string `json:"socialUserName,omitempty"`

	// PreviewText
	PreviewText *string `json:"previewText,omitempty"`

	// RecordingId
	RecordingId *string `json:"recordingId,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Wrapup
	Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopicsocialexpression

func (*Queueconversationsocialexpressioneventtopicsocialexpression) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicurireference ¶

type Queueconversationsocialexpressioneventtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Queueconversationsocialexpressioneventtopicurireference

func (*Queueconversationsocialexpressioneventtopicurireference) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicvideo ¶

type Queueconversationsocialexpressioneventtopicvideo struct {
	// State
	State *string `json:"state,omitempty"`

	// Self
	Self *Queueconversationsocialexpressioneventtopicaddress `json:"self,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Context
	Context *string `json:"context,omitempty"`

	// AudioMuted
	AudioMuted *bool `json:"audioMuted,omitempty"`

	// VideoMuted
	VideoMuted *bool `json:"videoMuted,omitempty"`

	// SharingScreen
	SharingScreen *bool `json:"sharingScreen,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Msids
	Msids *[]string `json:"msids,omitempty"`

	// Wrapup
	Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopicvideo

func (*Queueconversationsocialexpressioneventtopicvideo) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicvoicemail ¶

type Queueconversationsocialexpressioneventtopicvoicemail struct {
	// Id
	Id *string `json:"id,omitempty"`

	// UploadStatus
	UploadStatus *string `json:"uploadStatus,omitempty"`
}

Queueconversationsocialexpressioneventtopicvoicemail

func (*Queueconversationsocialexpressioneventtopicvoicemail) String ¶

String returns a JSON representation of the model

type Queueconversationsocialexpressioneventtopicwrapup ¶

type Queueconversationsocialexpressioneventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationsocialexpressioneventtopicwrapup

func (*Queueconversationsocialexpressioneventtopicwrapup) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicaddress ¶

type Queueconversationvideoeventtopicaddress struct {
	// Name
	Name *string `json:"name,omitempty"`

	// NameRaw
	NameRaw *string `json:"nameRaw,omitempty"`

	// AddressNormalized
	AddressNormalized *string `json:"addressNormalized,omitempty"`

	// AddressRaw
	AddressRaw *string `json:"addressRaw,omitempty"`

	// AddressDisplayable
	AddressDisplayable *string `json:"addressDisplayable,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopicaddress

func (*Queueconversationvideoeventtopicaddress) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicaftercallwork ¶

type Queueconversationvideoeventtopicaftercallwork struct {
	// State
	State *string `json:"state,omitempty"`

	// StartTime
	StartTime *time.Time `json:"startTime,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`
}

Queueconversationvideoeventtopicaftercallwork

func (*Queueconversationvideoeventtopicaftercallwork) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicattachment ¶

type Queueconversationvideoeventtopicattachment 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 *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopicattachment

func (*Queueconversationvideoeventtopicattachment) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopiccall ¶

type Queueconversationvideoeventtopiccall struct {
	// Id
	Id *string `json:"id,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Recording
	Recording *bool `json:"recording,omitempty"`

	// RecordingState
	RecordingState *string `json:"recordingState,omitempty"`

	// Muted
	Muted *bool `json:"muted,omitempty"`

	// Confined
	Confined *bool `json:"confined,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationvideoeventtopicerrordetails `json:"errorInfo,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// DocumentId
	DocumentId *string `json:"documentId,omitempty"`

	// Self
	Self *Queueconversationvideoeventtopicaddress `json:"self,omitempty"`

	// Other
	Other *Queueconversationvideoeventtopicaddress `json:"other,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// DisconnectReasons
	DisconnectReasons *[]Queueconversationvideoeventtopicdisconnectreason `json:"disconnectReasons,omitempty"`

	// FaxStatus
	FaxStatus *Queueconversationvideoeventtopicfaxstatus `json:"faxStatus,omitempty"`

	// UuiData
	UuiData *string `json:"uuiData,omitempty"`

	// Wrapup
	Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AgentAssistantId
	AgentAssistantId *string `json:"agentAssistantId,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopiccall

func (*Queueconversationvideoeventtopiccall) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopiccallback ¶

type Queueconversationvideoeventtopiccallback struct {
	// State
	State *string `json:"state,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// DialerPreview
	DialerPreview *Queueconversationvideoeventtopicdialerpreview `json:"dialerPreview,omitempty"`

	// Voicemail
	Voicemail *Queueconversationvideoeventtopicvoicemail `json:"voicemail,omitempty"`

	// CallbackNumbers
	CallbackNumbers *[]string `json:"callbackNumbers,omitempty"`

	// CallbackUserName
	CallbackUserName *string `json:"callbackUserName,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// ExternalCampaign
	ExternalCampaign *bool `json:"externalCampaign,omitempty"`

	// SkipEnabled
	SkipEnabled *bool `json:"skipEnabled,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// TimeoutSeconds
	TimeoutSeconds *int `json:"timeoutSeconds,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// CallbackScheduledTime
	CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"`

	// AutomatedCallbackConfigId
	AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"`

	// Wrapup
	Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// CallerId
	CallerId *string `json:"callerId,omitempty"`

	// CallerIdName
	CallerIdName *string `json:"callerIdName,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopiccallback

func (*Queueconversationvideoeventtopiccallback) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicchat ¶

type Queueconversationvideoeventtopicchat struct {
	// State
	State *string `json:"state,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// RoomId
	RoomId *string `json:"roomId,omitempty"`

	// AvatarImageUrl
	AvatarImageUrl *string `json:"avatarImageUrl,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// JourneyContext
	JourneyContext *Queueconversationvideoeventtopicjourneycontext `json:"journeyContext,omitempty"`

	// Wrapup
	Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopicchat

func (*Queueconversationvideoeventtopicchat) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopiccobrowse ¶

type Queueconversationvideoeventtopiccobrowse struct {
	// State
	State *string `json:"state,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Self
	Self *Queueconversationvideoeventtopicaddress `json:"self,omitempty"`

	// RoomId
	RoomId *string `json:"roomId,omitempty"`

	// CobrowseSessionId
	CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"`

	// CobrowseRole
	CobrowseRole *string `json:"cobrowseRole,omitempty"`

	// Controlling
	Controlling *[]string `json:"controlling,omitempty"`

	// ViewerUrl
	ViewerUrl *string `json:"viewerUrl,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// ProviderEventTime
	ProviderEventTime *time.Time `json:"providerEventTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Wrapup
	Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopiccobrowse

func (*Queueconversationvideoeventtopiccobrowse) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicconversation ¶

type Queueconversationvideoeventtopicconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// MaxParticipants
	MaxParticipants *int `json:"maxParticipants,omitempty"`

	// Participants
	Participants *[]Queueconversationvideoeventtopicparticipant `json:"participants,omitempty"`

	// RecordingState
	RecordingState *string `json:"recordingState,omitempty"`

	// Address
	Address *string `json:"address,omitempty"`

	// ExternalTag
	ExternalTag *string `json:"externalTag,omitempty"`
}

Queueconversationvideoeventtopicconversation

func (*Queueconversationvideoeventtopicconversation) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicconversationroutingdata ¶

type Queueconversationvideoeventtopicconversationroutingdata struct {
	// Queue
	Queue *Queueconversationvideoeventtopicurireference `json:"queue,omitempty"`

	// Language
	Language *Queueconversationvideoeventtopicurireference `json:"language,omitempty"`

	// Priority
	Priority *int `json:"priority,omitempty"`

	// Skills
	Skills *[]Queueconversationvideoeventtopicurireference `json:"skills,omitempty"`

	// ScoredAgents
	ScoredAgents *[]Queueconversationvideoeventtopicscoredagent `json:"scoredAgents,omitempty"`
}

Queueconversationvideoeventtopicconversationroutingdata

func (*Queueconversationvideoeventtopicconversationroutingdata) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicdialerpreview ¶

type Queueconversationvideoeventtopicdialerpreview 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 *[]Queueconversationvideoeventtopicphonenumbercolumn `json:"phoneNumberColumns,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopicdialerpreview

func (*Queueconversationvideoeventtopicdialerpreview) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicdisconnectreason ¶

type Queueconversationvideoeventtopicdisconnectreason struct {
	// VarType
	VarType *string `json:"type,omitempty"`

	// Code
	Code *int `json:"code,omitempty"`

	// Phrase
	Phrase *string `json:"phrase,omitempty"`
}

Queueconversationvideoeventtopicdisconnectreason

func (*Queueconversationvideoeventtopicdisconnectreason) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicemail ¶

type Queueconversationvideoeventtopicemail struct {
	// Id
	Id *string `json:"id,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// AutoGenerated
	AutoGenerated *bool `json:"autoGenerated,omitempty"`

	// Subject
	Subject *string `json:"subject,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// MessagesSent
	MessagesSent *int `json:"messagesSent,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationvideoeventtopicerrordetails `json:"errorInfo,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// MessageId
	MessageId *string `json:"messageId,omitempty"`

	// Direction
	Direction *string `json:"direction,omitempty"`

	// DraftAttachments
	DraftAttachments *[]Queueconversationvideoeventtopicattachment `json:"draftAttachments,omitempty"`

	// Spam
	Spam *bool `json:"spam,omitempty"`

	// Wrapup
	Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopicemail

func (*Queueconversationvideoeventtopicemail) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicerrordetails ¶

type Queueconversationvideoeventtopicerrordetails struct {
	// Status
	Status *int `json:"status,omitempty"`

	// Code
	Code *string `json:"code,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"`

	// Uri
	Uri *string `json:"uri,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopicerrordetails

func (*Queueconversationvideoeventtopicerrordetails) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicfaxstatus ¶

type Queueconversationvideoeventtopicfaxstatus 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"`

	// BaudRate
	BaudRate *int `json:"baudRate,omitempty"`

	// PageErrors
	PageErrors *int `json:"pageErrors,omitempty"`

	// LineErrors
	LineErrors *int `json:"lineErrors,omitempty"`
}

Queueconversationvideoeventtopicfaxstatus

func (*Queueconversationvideoeventtopicfaxstatus) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicjourneyaction ¶

type Queueconversationvideoeventtopicjourneyaction struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ActionMap
	ActionMap *Queueconversationvideoeventtopicjourneyactionmap `json:"actionMap,omitempty"`
}

Queueconversationvideoeventtopicjourneyaction

func (*Queueconversationvideoeventtopicjourneyaction) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicjourneyactionmap ¶

type Queueconversationvideoeventtopicjourneyactionmap struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`
}

Queueconversationvideoeventtopicjourneyactionmap

func (*Queueconversationvideoeventtopicjourneyactionmap) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicjourneycontext ¶

type Queueconversationvideoeventtopicjourneycontext struct {
	// Customer
	Customer *Queueconversationvideoeventtopicjourneycustomer `json:"customer,omitempty"`

	// CustomerSession
	CustomerSession *Queueconversationvideoeventtopicjourneycustomersession `json:"customerSession,omitempty"`

	// TriggeringAction
	TriggeringAction *Queueconversationvideoeventtopicjourneyaction `json:"triggeringAction,omitempty"`
}

Queueconversationvideoeventtopicjourneycontext

func (*Queueconversationvideoeventtopicjourneycontext) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicjourneycustomer ¶

type Queueconversationvideoeventtopicjourneycustomer struct {
	// Id
	Id *string `json:"id,omitempty"`

	// IdType
	IdType *string `json:"idType,omitempty"`
}

Queueconversationvideoeventtopicjourneycustomer

func (*Queueconversationvideoeventtopicjourneycustomer) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicjourneycustomersession ¶

type Queueconversationvideoeventtopicjourneycustomersession struct {
	// Id
	Id *string `json:"id,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Queueconversationvideoeventtopicjourneycustomersession

func (*Queueconversationvideoeventtopicjourneycustomersession) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicmessage ¶

type Queueconversationvideoeventtopicmessage struct {
	// Id
	Id *string `json:"id,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// ErrorInfo
	ErrorInfo *Queueconversationvideoeventtopicerrordetails `json:"errorInfo,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// ToAddress
	ToAddress *Queueconversationvideoeventtopicaddress `json:"toAddress,omitempty"`

	// FromAddress
	FromAddress *Queueconversationvideoeventtopicaddress `json:"fromAddress,omitempty"`

	// Messages
	Messages *[]Queueconversationvideoeventtopicmessagedetails `json:"messages,omitempty"`

	// MessagesTranscriptUri
	MessagesTranscriptUri *string `json:"messagesTranscriptUri,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// RecipientCountry
	RecipientCountry *string `json:"recipientCountry,omitempty"`

	// RecipientType
	RecipientType *string `json:"recipientType,omitempty"`

	// JourneyContext
	JourneyContext *Queueconversationvideoeventtopicjourneycontext `json:"journeyContext,omitempty"`

	// Wrapup
	Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopicmessage

func (*Queueconversationvideoeventtopicmessage) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicmessagedetails ¶

type Queueconversationvideoeventtopicmessagedetails struct {
	// MessageId
	MessageId *string `json:"messageId,omitempty"`

	// MessageTime
	MessageTime *time.Time `json:"messageTime,omitempty"`

	// MessageStatus
	MessageStatus *string `json:"messageStatus,omitempty"`

	// MessageSegmentCount
	MessageSegmentCount *int `json:"messageSegmentCount,omitempty"`

	// Media
	Media *[]Queueconversationvideoeventtopicmessagemedia `json:"media,omitempty"`

	// Stickers
	Stickers *[]Queueconversationvideoeventtopicmessagesticker `json:"stickers,omitempty"`
}

Queueconversationvideoeventtopicmessagedetails

func (*Queueconversationvideoeventtopicmessagedetails) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicmessagemedia ¶

type Queueconversationvideoeventtopicmessagemedia struct {
	// Url
	Url *string `json:"url,omitempty"`

	// MediaType
	MediaType *string `json:"mediaType,omitempty"`

	// ContentLengthBytes
	ContentLengthBytes *int `json:"contentLengthBytes,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`
}

Queueconversationvideoeventtopicmessagemedia

func (*Queueconversationvideoeventtopicmessagemedia) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicmessagesticker ¶

type Queueconversationvideoeventtopicmessagesticker struct {
	// Url
	Url *string `json:"url,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`
}

Queueconversationvideoeventtopicmessagesticker

func (*Queueconversationvideoeventtopicmessagesticker) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicparticipant ¶

type Queueconversationvideoeventtopicparticipant struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// EndTime
	EndTime *time.Time `json:"endTime,omitempty"`

	// UserId
	UserId *string `json:"userId,omitempty"`

	// ExternalContactId
	ExternalContactId *string `json:"externalContactId,omitempty"`

	// ExternalOrganizationId
	ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// QueueId
	QueueId *string `json:"queueId,omitempty"`

	// GroupId
	GroupId *string `json:"groupId,omitempty"`

	// TeamId
	TeamId *string `json:"teamId,omitempty"`

	// Purpose
	Purpose *string `json:"purpose,omitempty"`

	// ConsultParticipantId
	ConsultParticipantId *string `json:"consultParticipantId,omitempty"`

	// Address
	Address *string `json:"address,omitempty"`

	// WrapupRequired
	WrapupRequired *bool `json:"wrapupRequired,omitempty"`

	// WrapupExpected
	WrapupExpected *bool `json:"wrapupExpected,omitempty"`

	// WrapupPrompt
	WrapupPrompt *string `json:"wrapupPrompt,omitempty"`

	// WrapupTimeoutMs
	WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"`

	// Wrapup
	Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"`

	// StartAcwTime
	StartAcwTime *time.Time `json:"startAcwTime,omitempty"`

	// EndAcwTime
	EndAcwTime *time.Time `json:"endAcwTime,omitempty"`

	// ConversationRoutingData
	ConversationRoutingData *Queueconversationvideoeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"`

	// AlertingTimeoutMs
	AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"`

	// MonitoredParticipantId
	MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"`

	// CoachedParticipantId
	CoachedParticipantId *string `json:"coachedParticipantId,omitempty"`

	// ScreenRecordingState
	ScreenRecordingState *string `json:"screenRecordingState,omitempty"`

	// FlaggedReason
	FlaggedReason *string `json:"flaggedReason,omitempty"`

	// Attributes
	Attributes *map[string]string `json:"attributes,omitempty"`

	// Calls
	Calls *[]Queueconversationvideoeventtopiccall `json:"calls,omitempty"`

	// Callbacks
	Callbacks *[]Queueconversationvideoeventtopiccallback `json:"callbacks,omitempty"`

	// Chats
	Chats *[]Queueconversationvideoeventtopicchat `json:"chats,omitempty"`

	// Cobrowsesessions
	Cobrowsesessions *[]Queueconversationvideoeventtopiccobrowse `json:"cobrowsesessions,omitempty"`

	// Emails
	Emails *[]Queueconversationvideoeventtopicemail `json:"emails,omitempty"`

	// Messages
	Messages *[]Queueconversationvideoeventtopicmessage `json:"messages,omitempty"`

	// Screenshares
	Screenshares *[]Queueconversationvideoeventtopicscreenshare `json:"screenshares,omitempty"`

	// SocialExpressions
	SocialExpressions *[]Queueconversationvideoeventtopicsocialexpression `json:"socialExpressions,omitempty"`

	// Videos
	Videos *[]Queueconversationvideoeventtopicvideo `json:"videos,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopicparticipant

func (*Queueconversationvideoeventtopicparticipant) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicphonenumbercolumn ¶

type Queueconversationvideoeventtopicphonenumbercolumn struct {
	// ColumnName
	ColumnName *string `json:"columnName,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopicphonenumbercolumn

func (*Queueconversationvideoeventtopicphonenumbercolumn) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicscoredagent ¶

type Queueconversationvideoeventtopicscoredagent struct {
	// Agent
	Agent *Queueconversationvideoeventtopicurireference `json:"agent,omitempty"`

	// Score
	Score *int `json:"score,omitempty"`
}

Queueconversationvideoeventtopicscoredagent

func (*Queueconversationvideoeventtopicscoredagent) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicscreenshare ¶

type Queueconversationvideoeventtopicscreenshare struct {
	// State
	State *string `json:"state,omitempty"`

	// Self
	Self *Queueconversationvideoeventtopicaddress `json:"self,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Context
	Context *string `json:"context,omitempty"`

	// Sharing
	Sharing *bool `json:"sharing,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Wrapup
	Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopicscreenshare

func (*Queueconversationvideoeventtopicscreenshare) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicsocialexpression ¶

type Queueconversationvideoeventtopicsocialexpression struct {
	// State
	State *string `json:"state,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// SocialMediaId
	SocialMediaId *string `json:"socialMediaId,omitempty"`

	// SocialMediaHub
	SocialMediaHub *string `json:"socialMediaHub,omitempty"`

	// SocialUserName
	SocialUserName *string `json:"socialUserName,omitempty"`

	// PreviewText
	PreviewText *string `json:"previewText,omitempty"`

	// RecordingId
	RecordingId *string `json:"recordingId,omitempty"`

	// Held
	Held *bool `json:"held,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// StartHoldTime
	StartHoldTime *time.Time `json:"startHoldTime,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Wrapup
	Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopicsocialexpression

func (*Queueconversationvideoeventtopicsocialexpression) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicurireference ¶

type Queueconversationvideoeventtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Queueconversationvideoeventtopicurireference

func (*Queueconversationvideoeventtopicurireference) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicvideo ¶

type Queueconversationvideoeventtopicvideo struct {
	// State
	State *string `json:"state,omitempty"`

	// Self
	Self *Queueconversationvideoeventtopicaddress `json:"self,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// Context
	Context *string `json:"context,omitempty"`

	// AudioMuted
	AudioMuted *bool `json:"audioMuted,omitempty"`

	// VideoMuted
	VideoMuted *bool `json:"videoMuted,omitempty"`

	// SharingScreen
	SharingScreen *bool `json:"sharingScreen,omitempty"`

	// Provider
	Provider *string `json:"provider,omitempty"`

	// ScriptId
	ScriptId *string `json:"scriptId,omitempty"`

	// PeerId
	PeerId *string `json:"peerId,omitempty"`

	// DisconnectType
	DisconnectType *string `json:"disconnectType,omitempty"`

	// ConnectedTime
	ConnectedTime *time.Time `json:"connectedTime,omitempty"`

	// DisconnectedTime
	DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"`

	// Msids
	Msids *[]string `json:"msids,omitempty"`

	// Wrapup
	Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"`

	// AfterCallWork
	AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"`

	// AfterCallWorkRequired
	AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopicvideo

func (*Queueconversationvideoeventtopicvideo) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicvoicemail ¶

type Queueconversationvideoeventtopicvoicemail struct {
	// Id
	Id *string `json:"id,omitempty"`

	// UploadStatus
	UploadStatus *string `json:"uploadStatus,omitempty"`
}

Queueconversationvideoeventtopicvoicemail

func (*Queueconversationvideoeventtopicvoicemail) String ¶

String returns a JSON representation of the model

type Queueconversationvideoeventtopicwrapup ¶

type Queueconversationvideoeventtopicwrapup 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 *interface{} `json:"additionalProperties,omitempty"`
}

Queueconversationvideoeventtopicwrapup

func (*Queueconversationvideoeventtopicwrapup) String ¶

String returns a JSON representation of the model

type Queueemailaddress ¶

type Queueemailaddress struct {
	// Domain
	Domain *Domainentityref `json:"domain,omitempty"`

	// Route
	Route *Inboundroute `json:"route,omitempty"`
}

Queueemailaddress

func (*Queueemailaddress) String ¶

func (o *Queueemailaddress) String() string

String returns a JSON representation of the model

type Queueentitylisting ¶

type Queueentitylisting struct {
	// Entities
	Entities *[]Queue `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Queueentitylisting

func (*Queueentitylisting) String ¶

func (o *Queueentitylisting) String() string

String returns a JSON representation of the model

type Queuemember ¶

type Queuemember struct {
	// Id - The queue member's id.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// User
	User *User `json:"user,omitempty"`

	// RingNumber
	RingNumber *int `json:"ringNumber,omitempty"`

	// Joined
	Joined *bool `json:"joined,omitempty"`

	// MemberBy
	MemberBy *string `json:"memberBy,omitempty"`

	// RoutingStatus
	RoutingStatus *Routingstatus `json:"routingStatus,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Queuemember

func (*Queuemember) String ¶

func (o *Queuemember) String() string

String returns a JSON representation of the model

type Queuememberentitylisting ¶

type Queuememberentitylisting struct {
	// Entities
	Entities *[]Queuemember `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Queuememberentitylisting

func (*Queuememberentitylisting) String ¶

func (o *Queuememberentitylisting) String() string

String returns a JSON representation of the model

type Queuemessagingaddresses ¶

type Queuemessagingaddresses struct {
	// SmsAddress
	SmsAddress *Domainentityref `json:"smsAddress,omitempty"`
}

Queuemessagingaddresses

func (*Queuemessagingaddresses) String ¶

func (o *Queuemessagingaddresses) String() string

String returns a JSON representation of the model

type Queueobservationdatacontainer ¶

type Queueobservationdatacontainer struct {
	// Group - A mapping from dimension to value
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Observationmetricdata `json:"data,omitempty"`
}

Queueobservationdatacontainer

func (*Queueobservationdatacontainer) String ¶

String returns a JSON representation of the model

type Queueobservationquery ¶

type Queueobservationquery struct {
	// Filter - Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters
	Filter *Queueobservationqueryfilter `json:"filter,omitempty"`

	// Metrics - Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
	Metrics *[]string `json:"metrics,omitempty"`

	// DetailMetrics - Metrics for which to include additional detailed observations
	DetailMetrics *[]string `json:"detailMetrics,omitempty"`
}

Queueobservationquery

func (*Queueobservationquery) String ¶

func (o *Queueobservationquery) String() string

String returns a JSON representation of the model

type Queueobservationqueryclause ¶

type Queueobservationqueryclause 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 *[]Queueobservationquerypredicate `json:"predicates,omitempty"`
}

Queueobservationqueryclause

func (*Queueobservationqueryclause) String ¶

func (o *Queueobservationqueryclause) String() string

String returns a JSON representation of the model

type Queueobservationqueryfilter ¶

type Queueobservationqueryfilter 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 *[]Queueobservationqueryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Queueobservationquerypredicate `json:"predicates,omitempty"`
}

Queueobservationqueryfilter

func (*Queueobservationqueryfilter) String ¶

func (o *Queueobservationqueryfilter) String() string

String returns a JSON representation of the model

type Queueobservationquerypredicate ¶

type Queueobservationquerypredicate 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"`
}

Queueobservationquerypredicate

func (*Queueobservationquerypredicate) String ¶

String returns a JSON representation of the model

type Queueobservationqueryresponse ¶

type Queueobservationqueryresponse struct {
	// SystemToOrganizationMappings - A mapping from system presence to a list of organization presence ids
	SystemToOrganizationMappings *map[string][]string `json:"systemToOrganizationMappings,omitempty"`

	// Results
	Results *[]Queueobservationdatacontainer `json:"results,omitempty"`
}

Queueobservationqueryresponse

func (*Queueobservationqueryresponse) String ¶

String returns a JSON representation of the model

type Queuereference ¶

type Queuereference 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"`
}

Queuereference

func (*Queuereference) String ¶

func (o *Queuereference) String() string

String returns a JSON representation of the model

type Queuerequest ¶

type Queuerequest struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The queue name
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Writabledivision `json:"division,omitempty"`

	// Description - The queue description.
	Description *string `json:"description,omitempty"`

	// DateCreated - The date the queue 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"`

	// DateModified - The date of the last modification to the queue. 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 ID of the user that last modified the queue.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the queue.
	CreatedBy *string `json:"createdBy,omitempty"`

	// MemberCount - The total number of members (joined or unjoined) in the queue.
	MemberCount *int `json:"memberCount,omitempty"`

	// JoinedMemberCount - The number of joined members in the queue.
	JoinedMemberCount *int `json:"joinedMemberCount,omitempty"`

	// MediaSettings - The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM
	MediaSettings *map[string]Mediasetting `json:"mediaSettings,omitempty"`

	// RoutingRules - The routing rules for the queue, used for routing to known or preferred agents.
	RoutingRules *[]Routingrule `json:"routingRules,omitempty"`

	// Bullseye - The bulls-eye settings for the queue.
	Bullseye *Bullseye `json:"bullseye,omitempty"`

	// AcwSettings - The ACW settings for the queue.
	AcwSettings *Acwsettings `json:"acwSettings,omitempty"`

	// SkillEvaluationMethod - The skill evaluation method to use when routing conversations.
	SkillEvaluationMethod *string `json:"skillEvaluationMethod,omitempty"`

	// QueueFlow - The in-queue flow to use for conversations waiting in queue.
	QueueFlow *Domainentityref `json:"queueFlow,omitempty"`

	// WhisperPrompt - The prompt used for whisper on the queue, if configured.
	WhisperPrompt *Domainentityref `json:"whisperPrompt,omitempty"`

	// AutoAnswerOnly - Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered.
	AutoAnswerOnly *bool `json:"autoAnswerOnly,omitempty"`

	// EnableTranscription - Indicates whether voice transcription is enabled for this queue.
	EnableTranscription *bool `json:"enableTranscription,omitempty"`

	// EnableManualAssignment - Indicates whether manual assignment is enabled for this queue.
	EnableManualAssignment *bool `json:"enableManualAssignment,omitempty"`

	// CallingPartyName - The name to use for caller identification for outbound calls from this queue.
	CallingPartyName *string `json:"callingPartyName,omitempty"`

	// CallingPartyNumber - The phone number to use for caller identification for outbound calls from this queue.
	CallingPartyNumber *string `json:"callingPartyNumber,omitempty"`

	// DefaultScripts - The default script Ids for the communication types.
	DefaultScripts *map[string]Script `json:"defaultScripts,omitempty"`

	// OutboundMessagingAddresses - The messaging addresses for the queue.
	OutboundMessagingAddresses *Queuemessagingaddresses `json:"outboundMessagingAddresses,omitempty"`

	// OutboundEmailAddress
	OutboundEmailAddress *Queueemailaddress `json:"outboundEmailAddress,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Queuerequest

func (*Queuerequest) String ¶

func (o *Queuerequest) String() string

String returns a JSON representation of the model

type Queueusereventtopicqueuemember ¶

type Queueusereventtopicqueuemember struct {
	// Id
	Id *string `json:"id,omitempty"`

	// User
	User *Queueusereventtopicuserreference `json:"user,omitempty"`

	// QueueId
	QueueId *string `json:"queueId,omitempty"`

	// Joined
	Joined *bool `json:"joined,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Queueusereventtopicqueuemember

func (*Queueusereventtopicqueuemember) String ¶

String returns a JSON representation of the model

type Queueusereventtopicuserreference ¶

type Queueusereventtopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Queueusereventtopicuserreference

func (*Queueusereventtopicuserreference) String ¶

String returns a JSON representation of the model

type Queueutilizationdiagnostic ¶

type Queueutilizationdiagnostic struct {
	// Queue - Identifier of the queue
	Queue *Domainentityref `json:"queue,omitempty"`

	// UsersInQueue - The number of users joined to the queue
	UsersInQueue *int `json:"usersInQueue,omitempty"`

	// ActiveUsersInQueue - The number of users active on the queue
	ActiveUsersInQueue *int `json:"activeUsersInQueue,omitempty"`

	// UsersOnQueue - The number of users with a status of on-queue
	UsersOnQueue *int `json:"usersOnQueue,omitempty"`

	// UsersNotUtilized - The number of users in the queue currently not engaged
	UsersNotUtilized *int `json:"usersNotUtilized,omitempty"`

	// UsersOnQueueWithStation - The number of users in the queue with a station
	UsersOnQueueWithStation *int `json:"usersOnQueueWithStation,omitempty"`

	// UsersOnACampaignCall - The number of users currently engaged in a campaign call
	UsersOnACampaignCall *int `json:"usersOnACampaignCall,omitempty"`

	// UsersOnDifferentEdgeGroup - The number of users whose station is homed to an edge different from the campaign
	UsersOnDifferentEdgeGroup *int `json:"usersOnDifferentEdgeGroup,omitempty"`

	// UsersOnANonCampaignCall - The number of users currently engaged in a communication that is not part of the campaign
	UsersOnANonCampaignCall *int `json:"usersOnANonCampaignCall,omitempty"`
}

Queueutilizationdiagnostic

func (*Queueutilizationdiagnostic) String ¶

func (o *Queueutilizationdiagnostic) String() string

String returns a JSON representation of the model

type Quickreply ¶

type Quickreply struct {
	// 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"`

	// Url - The location of the image file associated with quick reply
	Url *string `json:"url,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"`

	// IsSelected - Indicates if the quick reply option is selected by end customer
	IsSelected *bool `json:"isSelected,omitempty"`
}

Quickreply

func (*Quickreply) String ¶

func (o *Quickreply) String() string

String returns a JSON representation of the model

type Reaction ¶

type Reaction struct {
	// Data - Parameter for this reaction. For transfer_flow, this would be the outbound flow id.
	Data *string `json:"data,omitempty"`

	// Name - Name of the parameter for this reaction. For transfer_flow, this would be the outbound flow name.
	Name *string `json:"name,omitempty"`

	// ReactionType - The reaction to take for a given call analysis result.
	ReactionType *string `json:"reactionType,omitempty"`
}

Reaction

func (*Reaction) String ¶

func (o *Reaction) String() string

String returns a JSON representation of the model

type Recallentry ¶

type Recallentry struct {
	// NbrAttempts
	NbrAttempts *int `json:"nbrAttempts,omitempty"`

	// MinutesBetweenAttempts
	MinutesBetweenAttempts *int `json:"minutesBetweenAttempts,omitempty"`
}

Recallentry

func (*Recallentry) String ¶

func (o *Recallentry) String() string

String returns a JSON representation of the model

type Recipient ¶

type Recipient struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Flow - An automate flow object which defines the set of actions to be taken, when a message is received by this provisioned phone number.
	Flow *Flow `json:"flow,omitempty"`

	// DateCreated - Date this recipient 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"`

	// DateModified - Date this recipient was 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"`

	// CreatedBy - User that created this recipient
	CreatedBy *User `json:"createdBy,omitempty"`

	// ModifiedBy - User that modified this recipient
	ModifiedBy *User `json:"modifiedBy,omitempty"`

	// MessengerType - The messenger type for this recipient
	MessengerType *string `json:"messengerType,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Recipient

func (*Recipient) String ¶

func (o *Recipient) String() string

String returns a JSON representation of the model

type Recipientlisting ¶

type Recipientlisting struct {
	// Entities
	Entities *[]Recipient `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Recipientlisting

func (*Recipientlisting) String ¶

func (o *Recipientlisting) String() string

String returns a JSON representation of the model

type Record ¶

type Record struct {
	// Name - The name of the record.
	Name *string `json:"name,omitempty"`

	// VarType - The type of the record. (Example values:  MX, TXT, CNAME)
	VarType *string `json:"type,omitempty"`

	// Value - The value of the record.
	Value *string `json:"value,omitempty"`
}

Record

func (*Record) String ¶

func (o *Record) String() string

String returns a JSON representation of the model

type Recording ¶

type Recording struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ConversationId
	ConversationId *string `json:"conversationId,omitempty"`

	// Path
	Path *string `json:"path,omitempty"`

	// StartTime - The start time of the recording. Null when there is no playable media.
	StartTime *string `json:"startTime,omitempty"`

	// EndTime - The end time of the recording. Null when there is no playable media.
	EndTime *string `json:"endTime,omitempty"`

	// Media - The type of media that the recording is. At the moment that could be audio, chat, or email.
	Media *string `json:"media,omitempty"`

	// Annotations - Annotations that belong to the recording.
	Annotations *[]Annotation `json:"annotations,omitempty"`

	// Transcript - Represents a chat transcript
	Transcript *[]Chatmessage `json:"transcript,omitempty"`

	// EmailTranscript - Represents an email transcript
	EmailTranscript *[]Recordingemailmessage `json:"emailTranscript,omitempty"`

	// MessagingTranscript - Represents a messaging transcript
	MessagingTranscript *[]Recordingmessagingmessage `json:"messagingTranscript,omitempty"`

	// FileState - Represents the current file state for a recording. Examples: Uploading, Archived, etc
	FileState *string `json:"fileState,omitempty"`

	// RestoreExpirationTime - The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	RestoreExpirationTime *time.Time `json:"restoreExpirationTime,omitempty"`

	// MediaUris - The different mediaUris for the recording. Null when there is no playable media.
	MediaUris *map[string]Mediaresult `json:"mediaUris,omitempty"`

	// EstimatedTranscodeTimeMs
	EstimatedTranscodeTimeMs *int `json:"estimatedTranscodeTimeMs,omitempty"`

	// ActualTranscodeTimeMs
	ActualTranscodeTimeMs *int `json:"actualTranscodeTimeMs,omitempty"`

	// ArchiveDate - The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ArchiveDate *time.Time `json:"archiveDate,omitempty"`

	// ArchiveMedium - The type of archive medium used. Example: CloudArchive
	ArchiveMedium *string `json:"archiveMedium,omitempty"`

	// DeleteDate - The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DeleteDate *time.Time `json:"deleteDate,omitempty"`

	// ExportDate - The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ExportDate *time.Time `json:"exportDate,omitempty"`

	// ExportedDate - The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ExportedDate *time.Time `json:"exportedDate,omitempty"`

	// OutputDurationMs - Duration of transcoded media in milliseconds
	OutputDurationMs *int `json:"outputDurationMs,omitempty"`

	// OutputSizeInBytes - Size of transcoded media in bytes. 0 if there is no transcoded media.
	OutputSizeInBytes *int `json:"outputSizeInBytes,omitempty"`

	// MaxAllowedRestorationsForOrg - How many archive restorations the organization is allowed to have.
	MaxAllowedRestorationsForOrg *int `json:"maxAllowedRestorationsForOrg,omitempty"`

	// RemainingRestorationsAllowedForOrg - The remaining archive restorations the organization has.
	RemainingRestorationsAllowedForOrg *int `json:"remainingRestorationsAllowedForOrg,omitempty"`

	// SessionId - The session id represents an external resource id, such as email, call, chat, etc
	SessionId *string `json:"sessionId,omitempty"`

	// Users - The users participating in the conversation
	Users *[]User `json:"users,omitempty"`

	// RecordingFileRole - Role of the file recording. It can be either customer_experience or adhoc.
	RecordingFileRole *string `json:"recordingFileRole,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Recording

func (*Recording) String ¶

func (o *Recording) String() string

String returns a JSON representation of the model

type RecordingApi ¶

type RecordingApi struct {
	Configuration *Configuration
}

RecordingApi provides functions for API endpoints

func NewRecordingApi ¶

func NewRecordingApi() *RecordingApi

NewRecordingApi creates an API instance using the default configuration

func NewRecordingApiWithConfig ¶

func NewRecordingApiWithConfig(config *Configuration) *RecordingApi

NewRecordingApiWithConfig creates an API instance using the provided configuration

func (RecordingApi) DeleteConversationRecordingAnnotation ¶

func (a RecordingApi) DeleteConversationRecordingAnnotation(conversationId string, recordingId string, annotationId string) (*APIResponse, error)

DeleteConversationRecordingAnnotation invokes DELETE /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}

Delete annotation

func (RecordingApi) DeleteOrphanrecording ¶

func (a RecordingApi) DeleteOrphanrecording(orphanId string) (*Orphanrecording, *APIResponse, error)

DeleteOrphanrecording invokes DELETE /api/v2/orphanrecordings/{orphanId}

Deletes a single orphan recording

func (RecordingApi) DeleteRecordingCrossplatformMediaretentionpolicies ¶

func (a RecordingApi) DeleteRecordingCrossplatformMediaretentionpolicies(ids string) (*APIResponse, error)

DeleteRecordingCrossplatformMediaretentionpolicies invokes DELETE /api/v2/recording/crossplatform/mediaretentionpolicies

Delete media retention policies ¶

Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.

func (RecordingApi) DeleteRecordingCrossplatformMediaretentionpolicy ¶

func (a RecordingApi) DeleteRecordingCrossplatformMediaretentionpolicy(policyId string) (*APIResponse, error)

DeleteRecordingCrossplatformMediaretentionpolicy invokes DELETE /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}

Delete a media retention policy

func (RecordingApi) DeleteRecordingJob ¶

func (a RecordingApi) DeleteRecordingJob(jobId string) (*APIResponse, error)

DeleteRecordingJob invokes DELETE /api/v2/recording/jobs/{jobId}

Delete the recording bulk job

func (RecordingApi) DeleteRecordingMediaretentionpolicies ¶

func (a RecordingApi) DeleteRecordingMediaretentionpolicies(ids string) (*APIResponse, error)

DeleteRecordingMediaretentionpolicies invokes DELETE /api/v2/recording/mediaretentionpolicies

Delete media retention policies ¶

Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.

func (RecordingApi) DeleteRecordingMediaretentionpolicy ¶

func (a RecordingApi) DeleteRecordingMediaretentionpolicy(policyId string) (*APIResponse, error)

DeleteRecordingMediaretentionpolicy invokes DELETE /api/v2/recording/mediaretentionpolicies/{policyId}

Delete a media retention policy

func (RecordingApi) GetConversationRecording ¶

func (a RecordingApi) GetConversationRecording(conversationId string, recordingId string, formatId string, emailFormatId string, chatFormatId string, messageFormatId string, download bool, fileName string, locale string) (*Recording, *APIResponse, error)

GetConversationRecording invokes GET /api/v2/conversations/{conversationId}/recordings/{recordingId}

Gets a specific recording.

func (RecordingApi) GetConversationRecordingAnnotation ¶

func (a RecordingApi) GetConversationRecordingAnnotation(conversationId string, recordingId string, annotationId string) (*Annotation, *APIResponse, error)

GetConversationRecordingAnnotation invokes GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}

Get annotation

func (RecordingApi) GetConversationRecordingAnnotations ¶

func (a RecordingApi) GetConversationRecordingAnnotations(conversationId string, recordingId string) ([]Annotation, *APIResponse, error)

GetConversationRecordingAnnotations invokes GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations

Get annotations for recording

func (RecordingApi) GetConversationRecordingmetadata ¶

func (a RecordingApi) GetConversationRecordingmetadata(conversationId string) ([]Recordingmetadata, *APIResponse, error)

GetConversationRecordingmetadata invokes GET /api/v2/conversations/{conversationId}/recordingmetadata

Get recording metadata for a conversation. Does not return playable media.

func (RecordingApi) GetConversationRecordingmetadataRecordingId ¶

func (a RecordingApi) GetConversationRecordingmetadataRecordingId(conversationId string, recordingId string) (*Recordingmetadata, *APIResponse, error)

GetConversationRecordingmetadataRecordingId invokes GET /api/v2/conversations/{conversationId}/recordingmetadata/{recordingId}

Get metadata for a specific recording. Does not return playable media.

func (RecordingApi) GetConversationRecordings ¶

func (a RecordingApi) GetConversationRecordings(conversationId string, maxWaitMs int, formatId string) ([]Recording, *APIResponse, error)

GetConversationRecordings invokes GET /api/v2/conversations/{conversationId}/recordings

Get all of a Conversation&#39;s Recordings.

func (RecordingApi) GetOrphanrecording ¶

func (a RecordingApi) GetOrphanrecording(orphanId string) (*Orphanrecording, *APIResponse, error)

GetOrphanrecording invokes GET /api/v2/orphanrecordings/{orphanId}

Gets a single orphan recording

func (RecordingApi) GetOrphanrecordingMedia ¶

func (a RecordingApi) GetOrphanrecordingMedia(orphanId string, formatId string, emailFormatId string, chatFormatId string, messageFormatId string, download bool, fileName string, locale string) (*Recording, *APIResponse, error)

GetOrphanrecordingMedia invokes GET /api/v2/orphanrecordings/{orphanId}/media

Gets the media of a single orphan recording ¶

A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.

func (RecordingApi) GetOrphanrecordings ¶

func (a RecordingApi) GetOrphanrecordings(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, hasConversation bool, media string) (*Orphanrecordinglisting, *APIResponse, error)

GetOrphanrecordings invokes GET /api/v2/orphanrecordings

Gets all orphan recordings

func (RecordingApi) GetRecordingBatchrequest ¶

func (a RecordingApi) GetRecordingBatchrequest(jobId string) (*Batchdownloadjobstatusresult, *APIResponse, error)

GetRecordingBatchrequest invokes GET /api/v2/recording/batchrequests/{jobId}

Get the status and results for a batch request job, only the user that submitted the job may retrieve results

func (RecordingApi) GetRecordingCrossplatformMediaretentionpolicies ¶

func (a RecordingApi) GetRecordingCrossplatformMediaretentionpolicies(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, name string, enabled bool, summary bool, hasErrors bool) (*Policyentitylisting, *APIResponse, error)

GetRecordingCrossplatformMediaretentionpolicies invokes GET /api/v2/recording/crossplatform/mediaretentionpolicies

Gets media retention policy list with query options to filter on name and enabled.

for a less verbose response, add summary=true to this endpoint

func (RecordingApi) GetRecordingCrossplatformMediaretentionpolicy ¶

func (a RecordingApi) GetRecordingCrossplatformMediaretentionpolicy(policyId string) (*Crossplatformpolicy, *APIResponse, error)

GetRecordingCrossplatformMediaretentionpolicy invokes GET /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}

Get a media retention policy

func (RecordingApi) GetRecordingJob ¶

func (a RecordingApi) GetRecordingJob(jobId string) (*Recordingjob, *APIResponse, error)

GetRecordingJob invokes GET /api/v2/recording/jobs/{jobId}

Get the status of the job associated with the job id.

func (RecordingApi) GetRecordingJobs ¶

func (a RecordingApi) GetRecordingJobs(pageSize int, pageNumber int, sortBy string, state string, showOnlyMyJobs bool, jobType string) (*Recordingjobentitylisting, *APIResponse, error)

GetRecordingJobs invokes GET /api/v2/recording/jobs

Get the status of all jobs within the user&#39;s organization

func (RecordingApi) GetRecordingLocalkeysSetting ¶

func (a RecordingApi) GetRecordingLocalkeysSetting(settingsId string) (*Localencryptionconfiguration, *APIResponse, error)

GetRecordingLocalkeysSetting invokes GET /api/v2/recording/localkeys/settings/{settingsId}

Get the local encryption settings

func (RecordingApi) GetRecordingLocalkeysSettings ¶

func (a RecordingApi) GetRecordingLocalkeysSettings() (*Localencryptionconfigurationlisting, *APIResponse, error)

GetRecordingLocalkeysSettings invokes GET /api/v2/recording/localkeys/settings

gets a list local key settings data

func (RecordingApi) GetRecordingMediaretentionpolicies ¶

func (a RecordingApi) GetRecordingMediaretentionpolicies(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, name string, enabled bool, summary bool, hasErrors bool) (*Policyentitylisting, *APIResponse, error)

GetRecordingMediaretentionpolicies invokes GET /api/v2/recording/mediaretentionpolicies

Gets media retention policy list with query options to filter on name and enabled.

for a less verbose response, add summary=true to this endpoint

func (RecordingApi) GetRecordingMediaretentionpolicy ¶

func (a RecordingApi) GetRecordingMediaretentionpolicy(policyId string) (*Policy, *APIResponse, error)

GetRecordingMediaretentionpolicy invokes GET /api/v2/recording/mediaretentionpolicies/{policyId}

Get a media retention policy

func (RecordingApi) GetRecordingRecordingkeys ¶

func (a RecordingApi) GetRecordingRecordingkeys(pageSize int, pageNumber int) (*Encryptionkeyentitylisting, *APIResponse, error)

GetRecordingRecordingkeys invokes GET /api/v2/recording/recordingkeys

Get encryption key list

func (RecordingApi) GetRecordingRecordingkeysRotationschedule ¶

func (a RecordingApi) GetRecordingRecordingkeysRotationschedule() (*Keyrotationschedule, *APIResponse, error)

GetRecordingRecordingkeysRotationschedule invokes GET /api/v2/recording/recordingkeys/rotationschedule

Get key rotation schedule

func (RecordingApi) GetRecordingSettings ¶

func (a RecordingApi) GetRecordingSettings(createDefault bool) (*Recordingsettings, *APIResponse, error)

GetRecordingSettings invokes GET /api/v2/recording/settings

Get the Recording Settings for the Organization

func (RecordingApi) GetRecordingsScreensessions ¶

func (a RecordingApi) GetRecordingsScreensessions(pageSize int, pageNumber int) (*Screenrecordingsessionlisting, *APIResponse, error)

GetRecordingsScreensessions invokes GET /api/v2/recordings/screensessions

Retrieves a paged listing of screen recording sessions

func (RecordingApi) PatchRecordingCrossplatformMediaretentionpolicy ¶

func (a RecordingApi) PatchRecordingCrossplatformMediaretentionpolicy(policyId string, body Crossplatformpolicyupdate) (*Crossplatformpolicy, *APIResponse, error)

PatchRecordingCrossplatformMediaretentionpolicy invokes PATCH /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}

Patch a media retention policy

func (RecordingApi) PatchRecordingMediaretentionpolicy ¶

func (a RecordingApi) PatchRecordingMediaretentionpolicy(policyId string, body Policyupdate) (*Policy, *APIResponse, error)

PatchRecordingMediaretentionpolicy invokes PATCH /api/v2/recording/mediaretentionpolicies/{policyId}

Patch a media retention policy

func (RecordingApi) PatchRecordingsScreensession ¶

func (a RecordingApi) PatchRecordingsScreensession(recordingSessionId string, body Screenrecordingsessionrequest) (*APIResponse, error)

PatchRecordingsScreensession invokes PATCH /api/v2/recordings/screensessions/{recordingSessionId}

Update a screen recording session

func (RecordingApi) PostConversationRecordingAnnotations ¶

func (a RecordingApi) PostConversationRecordingAnnotations(conversationId string, recordingId string, body Annotation) (*Annotation, *APIResponse, error)

PostConversationRecordingAnnotations invokes POST /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations

Create annotation

func (RecordingApi) PostRecordingBatchrequests ¶

PostRecordingBatchrequests invokes POST /api/v2/recording/batchrequests

Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration.

func (RecordingApi) PostRecordingCrossplatformMediaretentionpolicies ¶

func (a RecordingApi) PostRecordingCrossplatformMediaretentionpolicies(body Crossplatformpolicycreate) (*Crossplatformpolicy, *APIResponse, error)

PostRecordingCrossplatformMediaretentionpolicies invokes POST /api/v2/recording/crossplatform/mediaretentionpolicies

Create media retention policy

func (RecordingApi) PostRecordingJobs ¶

func (a RecordingApi) PostRecordingJobs(body Recordingjobsquery) (*Recordingjob, *APIResponse, error)

PostRecordingJobs invokes POST /api/v2/recording/jobs

Create a recording bulk job

func (RecordingApi) PostRecordingLocalkeys ¶

func (a RecordingApi) PostRecordingLocalkeys(body Localencryptionkeyrequest) (*Encryptionkey, *APIResponse, error)

PostRecordingLocalkeys invokes POST /api/v2/recording/localkeys

create a local recording key

func (RecordingApi) PostRecordingLocalkeysSettings ¶

func (a RecordingApi) PostRecordingLocalkeysSettings(body Localencryptionconfiguration) (*Localencryptionconfiguration, *APIResponse, error)

PostRecordingLocalkeysSettings invokes POST /api/v2/recording/localkeys/settings

create settings for local key creation

func (RecordingApi) PostRecordingMediaretentionpolicies ¶

func (a RecordingApi) PostRecordingMediaretentionpolicies(body Policycreate) (*Policy, *APIResponse, error)

PostRecordingMediaretentionpolicies invokes POST /api/v2/recording/mediaretentionpolicies

Create media retention policy

func (RecordingApi) PostRecordingRecordingkeys ¶

func (a RecordingApi) PostRecordingRecordingkeys() (*Encryptionkey, *APIResponse, error)

PostRecordingRecordingkeys invokes POST /api/v2/recording/recordingkeys

Create encryption key

func (RecordingApi) PostRecordingsDeletionprotection ¶

func (a RecordingApi) PostRecordingsDeletionprotection(body Conversationdeletionprotectionquery) ([]Addressableentityref, *APIResponse, error)

PostRecordingsDeletionprotection invokes POST /api/v2/recordings/deletionprotection

Get a list of conversations with protected recordings

func (RecordingApi) PostRecordingsScreensessionsAcknowledge ¶

func (a RecordingApi) PostRecordingsScreensessionsAcknowledge(body Acknowledgescreenrecordingrequest) (*APIResponse, error)

PostRecordingsScreensessionsAcknowledge invokes POST /api/v2/recordings/screensessions/acknowledge

Acknowledge a screen recording.

func (RecordingApi) PostRecordingsScreensessionsMetadata ¶

func (a RecordingApi) PostRecordingsScreensessionsMetadata(body Screenrecordingmetadatarequest) (*APIResponse, error)

PostRecordingsScreensessionsMetadata invokes POST /api/v2/recordings/screensessions/metadata

Provide meta-data a screen recording.

func (RecordingApi) PutConversationRecording ¶

func (a RecordingApi) PutConversationRecording(conversationId string, recordingId string, body Recording) (*Recording, *APIResponse, error)

PutConversationRecording invokes PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}

Updates the retention records on a recording.

Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. The recording:recording:view permission is required for the recording, as well as either the recording:recording:editRetention or recording:screenRecording:editRetention permissions depending on the type of recording.

func (RecordingApi) PutConversationRecordingAnnotation ¶

func (a RecordingApi) PutConversationRecordingAnnotation(conversationId string, recordingId string, annotationId string, body Annotation) (*Annotation, *APIResponse, error)

PutConversationRecordingAnnotation invokes PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}

Update annotation

func (RecordingApi) PutOrphanrecording ¶

func (a RecordingApi) PutOrphanrecording(orphanId string, body Orphanupdaterequest) (*Recording, *APIResponse, error)

PutOrphanrecording invokes PUT /api/v2/orphanrecordings/{orphanId}

Updates an orphan recording to a regular recording with retention values ¶

If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api.

func (RecordingApi) PutRecordingCrossplatformMediaretentionpolicy ¶

func (a RecordingApi) PutRecordingCrossplatformMediaretentionpolicy(policyId string, body Crossplatformpolicy) (*Crossplatformpolicy, *APIResponse, error)

PutRecordingCrossplatformMediaretentionpolicy invokes PUT /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}

Update a media retention policy

func (RecordingApi) PutRecordingJob ¶

func (a RecordingApi) PutRecordingJob(jobId string, body Executerecordingjobsquery) (*Recordingjob, *APIResponse, error)

PutRecordingJob invokes PUT /api/v2/recording/jobs/{jobId}

Execute the recording bulk job.

A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recording&#39;s retention.

func (RecordingApi) PutRecordingLocalkeysSetting ¶

func (a RecordingApi) PutRecordingLocalkeysSetting(settingsId string, body Localencryptionconfiguration) (*Localencryptionconfiguration, *APIResponse, error)

PutRecordingLocalkeysSetting invokes PUT /api/v2/recording/localkeys/settings/{settingsId}

Update the local encryption settings

func (RecordingApi) PutRecordingMediaretentionpolicy ¶

func (a RecordingApi) PutRecordingMediaretentionpolicy(policyId string, body Policy) (*Policy, *APIResponse, error)

PutRecordingMediaretentionpolicy invokes PUT /api/v2/recording/mediaretentionpolicies/{policyId}

Update a media retention policy

func (RecordingApi) PutRecordingRecordingkeysRotationschedule ¶

func (a RecordingApi) PutRecordingRecordingkeysRotationschedule(body Keyrotationschedule) (*Keyrotationschedule, *APIResponse, error)

PutRecordingRecordingkeysRotationschedule invokes PUT /api/v2/recording/recordingkeys/rotationschedule

Update key rotation schedule

func (RecordingApi) PutRecordingSettings ¶

func (a RecordingApi) PutRecordingSettings(body Recordingsettings) (*Recordingsettings, *APIResponse, error)

PutRecordingSettings invokes PUT /api/v2/recording/settings

Update the Recording Settings for the Organization

func (RecordingApi) PutRecordingsDeletionprotection ¶

func (a RecordingApi) PutRecordingsDeletionprotection(protect bool, body Conversationdeletionprotectionquery) (*APIResponse, error)

PutRecordingsDeletionprotection invokes PUT /api/v2/recordings/deletionprotection

Apply or revoke recording protection for conversations

type Recordingarchiverestoretopicmediaresult ¶

type Recordingarchiverestoretopicmediaresult struct {
	// ChannelId
	ChannelId *string `json:"channelId,omitempty"`

	// WaveUri
	WaveUri *string `json:"waveUri,omitempty"`

	// MediaUri
	MediaUri *string `json:"mediaUri,omitempty"`

	// WaveformData
	WaveformData *[]float32 `json:"waveformData,omitempty"`
}

Recordingarchiverestoretopicmediaresult

func (*Recordingarchiverestoretopicmediaresult) String ¶

String returns a JSON representation of the model

type Recordingarchiverestoretopicrecording ¶

type Recordingarchiverestoretopicrecording struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ConversationId
	ConversationId *string `json:"conversationId,omitempty"`

	// FileState
	FileState *string `json:"fileState,omitempty"`

	// MediaUris
	MediaUris *[]Recordingarchiverestoretopicmediaresult `json:"mediaUris,omitempty"`

	// EstimatedTranscodeTimeMs
	EstimatedTranscodeTimeMs *float32 `json:"estimatedTranscodeTimeMs,omitempty"`

	// ActualTranscodeTimeMs
	ActualTranscodeTimeMs *float32 `json:"actualTranscodeTimeMs,omitempty"`
}

Recordingarchiverestoretopicrecording

func (*Recordingarchiverestoretopicrecording) String ¶

String returns a JSON representation of the model

type Recordingemailmessage ¶

type Recordingemailmessage struct {
	// HtmlBody
	HtmlBody *string `json:"htmlBody,omitempty"`

	// TextBody
	TextBody *string `json:"textBody,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// To
	To *[]Emailaddress `json:"to,omitempty"`

	// Cc
	Cc *[]Emailaddress `json:"cc,omitempty"`

	// Bcc
	Bcc *[]Emailaddress `json:"bcc,omitempty"`

	// From
	From *Emailaddress `json:"from,omitempty"`

	// Subject
	Subject *string `json:"subject,omitempty"`

	// Attachments
	Attachments *[]Emailattachment `json:"attachments,omitempty"`

	// Time - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Time *time.Time `json:"time,omitempty"`
}

Recordingemailmessage

func (*Recordingemailmessage) String ¶

func (o *Recordingemailmessage) String() string

String returns a JSON representation of the model

type Recordingeventmediaresult ¶

type Recordingeventmediaresult struct {
	// ChannelId
	ChannelId *string `json:"channelId,omitempty"`

	// WaveUri
	WaveUri *string `json:"waveUri,omitempty"`

	// MediaUri
	MediaUri *string `json:"mediaUri,omitempty"`

	// WaveformData
	WaveformData *[]float32 `json:"waveformData,omitempty"`
}

Recordingeventmediaresult

func (*Recordingeventmediaresult) String ¶

func (o *Recordingeventmediaresult) String() string

String returns a JSON representation of the model

type Recordingeventrecording ¶

type Recordingeventrecording struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ConversationId
	ConversationId *string `json:"conversationId,omitempty"`

	// FileState
	FileState *string `json:"fileState,omitempty"`

	// MediaUris
	MediaUris *[]Recordingeventmediaresult `json:"mediaUris,omitempty"`

	// EstimatedTranscodeTimeMs
	EstimatedTranscodeTimeMs *float32 `json:"estimatedTranscodeTimeMs,omitempty"`

	// ActualTranscodeTimeMs
	ActualTranscodeTimeMs *float32 `json:"actualTranscodeTimeMs,omitempty"`
}

Recordingeventrecording

func (*Recordingeventrecording) String ¶

func (o *Recordingeventrecording) String() string

String returns a JSON representation of the model

type Recordingjob ¶

type Recordingjob struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// State - The current state of the job.
	State *string `json:"state,omitempty"`

	// RecordingJobsQuery - Original query of the job.
	RecordingJobsQuery *Recordingjobsquery `json:"recordingJobsQuery,omitempty"`

	// DateCreated - Date when the job 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"`

	// TotalConversations - Total number of conversations affected.
	TotalConversations *int `json:"totalConversations,omitempty"`

	// TotalRecordings - Total number of recordings affected.
	TotalRecordings *int `json:"totalRecordings,omitempty"`

	// TotalProcessedRecordings - Total number of recordings have been processed.
	TotalProcessedRecordings *int `json:"totalProcessedRecordings,omitempty"`

	// PercentProgress - Progress in percentage based on the number of recordings
	PercentProgress *int `json:"percentProgress,omitempty"`

	// ErrorMessage - Error occurred during the job execution
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// User - Details of the user created the job
	User *Addressableentityref `json:"user,omitempty"`
}

Recordingjob

func (*Recordingjob) String ¶

func (o *Recordingjob) String() string

String returns a JSON representation of the model

type Recordingjobentitylisting ¶

type Recordingjobentitylisting struct {
	// Entities
	Entities *[]Recordingjob `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Recordingjobentitylisting

func (*Recordingjobentitylisting) String ¶

func (o *Recordingjobentitylisting) String() string

String returns a JSON representation of the model

type Recordingjobsquery ¶

type Recordingjobsquery struct {
	// Action - Operation to perform bulk task
	Action *string `json:"action,omitempty"`

	// ActionDate - The date when the action will be performed. If the operation will cause the delete date of a recording to be older than the export date, the export date will be adjusted to the delete date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ActionDate *time.Time `json:"actionDate,omitempty"`

	// IntegrationId - IntegrationId to Access AWS S3 bucket for bulk recording exports. This field is required and used only for EXPORT action.
	IntegrationId *string `json:"integrationId,omitempty"`

	// IncludeScreenRecordings - Include Screen recordings for export action, default value = true
	IncludeScreenRecordings *bool `json:"includeScreenRecordings,omitempty"`

	// ConversationQuery - Conversation Query. Note: After the recording is created, it might take up to 48 hours for the recording to be included in the submitted job query.
	ConversationQuery *Asyncconversationquery `json:"conversationQuery,omitempty"`
}

Recordingjobsquery

func (*Recordingjobsquery) String ¶

func (o *Recordingjobsquery) String() string

String returns a JSON representation of the model

type Recordingmessagingmessage ¶

type Recordingmessagingmessage struct {
	// From
	From *string `json:"from,omitempty"`

	// FromUser
	FromUser *User `json:"fromUser,omitempty"`

	// FromExternalContact
	FromExternalContact *Externalcontact `json:"fromExternalContact,omitempty"`

	// To
	To *string `json:"to,omitempty"`

	// Timestamp - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Timestamp *time.Time `json:"timestamp,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// MessageText
	MessageText *string `json:"messageText,omitempty"`

	// MessageMediaAttachments
	MessageMediaAttachments *[]Messagemediaattachment `json:"messageMediaAttachments,omitempty"`

	// MessageStickerAttachments
	MessageStickerAttachments *[]Messagestickerattachment `json:"messageStickerAttachments,omitempty"`
}

Recordingmessagingmessage

func (*Recordingmessagingmessage) String ¶

func (o *Recordingmessagingmessage) String() string

String returns a JSON representation of the model

type Recordingmetadata ¶

type Recordingmetadata struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ConversationId
	ConversationId *string `json:"conversationId,omitempty"`

	// Path
	Path *string `json:"path,omitempty"`

	// StartTime - The start time of the recording for screen recordings. Null for other types.
	StartTime *string `json:"startTime,omitempty"`

	// EndTime
	EndTime *string `json:"endTime,omitempty"`

	// Media - The type of media that the recording is. At the moment that could be audio, chat, email, or message.
	Media *string `json:"media,omitempty"`

	// Annotations - Annotations that belong to the recording. Populated when recording filestate is AVAILABLE.
	Annotations *[]Annotation `json:"annotations,omitempty"`

	// FileState - Represents the current file state for a recording. Examples: Uploading, Archived, etc
	FileState *string `json:"fileState,omitempty"`

	// RestoreExpirationTime - The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	RestoreExpirationTime *time.Time `json:"restoreExpirationTime,omitempty"`

	// ArchiveDate - The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ArchiveDate *time.Time `json:"archiveDate,omitempty"`

	// ArchiveMedium - The type of archive medium used. Example: CloudArchive
	ArchiveMedium *string `json:"archiveMedium,omitempty"`

	// DeleteDate - The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DeleteDate *time.Time `json:"deleteDate,omitempty"`

	// ExportDate - The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ExportDate *time.Time `json:"exportDate,omitempty"`

	// ExportedDate - The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ExportedDate *time.Time `json:"exportedDate,omitempty"`

	// MaxAllowedRestorationsForOrg - How many archive restorations the organization is allowed to have.
	MaxAllowedRestorationsForOrg *int `json:"maxAllowedRestorationsForOrg,omitempty"`

	// RemainingRestorationsAllowedForOrg - The remaining archive restorations the organization has.
	RemainingRestorationsAllowedForOrg *int `json:"remainingRestorationsAllowedForOrg,omitempty"`

	// SessionId - The session id represents an external resource id, such as email, call, chat, etc
	SessionId *string `json:"sessionId,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Recordingmetadata

func (*Recordingmetadata) String ¶

func (o *Recordingmetadata) String() string

String returns a JSON representation of the model

type Recordingsettings ¶

type Recordingsettings struct {
	// MaxSimultaneousStreams - Maximum number of simultaneous screen recording streams
	MaxSimultaneousStreams *int `json:"maxSimultaneousStreams,omitempty"`

	// MaxConfigurableScreenRecordingStreams - Upper limit that maxSimultaneousStreams can be configured
	MaxConfigurableScreenRecordingStreams *int `json:"maxConfigurableScreenRecordingStreams,omitempty"`
}

Recordingsettings

func (*Recordingsettings) String ¶

func (o *Recordingsettings) String() string

String returns a JSON representation of the model

type Recordingtranscodecompletetopicmediaresult ¶

type Recordingtranscodecompletetopicmediaresult struct {
	// ChannelId
	ChannelId *string `json:"channelId,omitempty"`

	// WaveUri
	WaveUri *string `json:"waveUri,omitempty"`

	// MediaUri
	MediaUri *string `json:"mediaUri,omitempty"`

	// WaveformData
	WaveformData *[]float32 `json:"waveformData,omitempty"`
}

Recordingtranscodecompletetopicmediaresult

func (*Recordingtranscodecompletetopicmediaresult) String ¶

String returns a JSON representation of the model

type Recordingtranscodecompletetopicrecording ¶

type Recordingtranscodecompletetopicrecording struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ConversationId
	ConversationId *string `json:"conversationId,omitempty"`

	// FileState
	FileState *string `json:"fileState,omitempty"`

	// MediaUris
	MediaUris *[]Recordingtranscodecompletetopicmediaresult `json:"mediaUris,omitempty"`

	// EstimatedTranscodeTimeMs
	EstimatedTranscodeTimeMs *float32 `json:"estimatedTranscodeTimeMs,omitempty"`

	// ActualTranscodeTimeMs
	ActualTranscodeTimeMs *float32 `json:"actualTranscodeTimeMs,omitempty"`
}

Recordingtranscodecompletetopicrecording

func (*Recordingtranscodecompletetopicrecording) String ¶

String returns a JSON representation of the model

type Regiontimezone ¶

type Regiontimezone struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Offset
	Offset *int `json:"offset,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Regiontimezone

func (*Regiontimezone) String ¶

func (o *Regiontimezone) String() string

String returns a JSON representation of the model

type Relationship ¶

type Relationship struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// User - The user associated with the external organization. When creating or updating a relationship, only User.id is required. User object is fully populated when expanding a note.
	User *User `json:"user,omitempty"`

	// ExternalOrganization - The external organization this relationship is attached to
	ExternalOrganization *Externalorganization `json:"externalOrganization,omitempty"`

	// Relationship - The relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant
	Relationship *string `json:"relationship,omitempty"`

	// ExternalDataSources - Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record.  Read-only, and only populated when requested via expand param.
	ExternalDataSources *[]Externaldatasource `json:"externalDataSources,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Relationship

func (*Relationship) String ¶

func (o *Relationship) String() string

String returns a JSON representation of the model

type Relationshiplisting ¶

type Relationshiplisting struct {
	// Entities
	Entities *[]Relationship `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Relationshiplisting

func (*Relationshiplisting) String ¶

func (o *Relationshiplisting) String() string

String returns a JSON representation of the model

type Replacementterm ¶

type Replacementterm struct {
	// VarType
	VarType *string `json:"type,omitempty"`

	// ExistingValue
	ExistingValue *string `json:"existingValue,omitempty"`

	// UpdatedValue
	UpdatedValue *string `json:"updatedValue,omitempty"`
}

Replacementterm

func (*Replacementterm) String ¶

func (o *Replacementterm) String() string

String returns a JSON representation of the model

type Replacerequest ¶

type Replacerequest struct {
	// ChangeNumber
	ChangeNumber *int `json:"changeNumber,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// AuthToken
	AuthToken *string `json:"authToken,omitempty"`
}

Replacerequest

func (*Replacerequest) String ¶

func (o *Replacerequest) String() string

String returns a JSON representation of the model

type Replaceresponse ¶

type Replaceresponse struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ChangeNumber
	ChangeNumber *int `json:"changeNumber,omitempty"`

	// UploadStatus
	UploadStatus *Domainentityref `json:"uploadStatus,omitempty"`

	// UploadDestinationUri
	UploadDestinationUri *string `json:"uploadDestinationUri,omitempty"`

	// UploadMethod
	UploadMethod *string `json:"uploadMethod,omitempty"`
}

Replaceresponse

func (*Replaceresponse) String ¶

func (o *Replaceresponse) String() string

String returns a JSON representation of the model

type Reportingdataexporttopicdataexportnotification ¶

type Reportingdataexporttopicdataexportnotification struct {
	// Id
	Id *string `json:"id,omitempty"`

	// RunId
	RunId *string `json:"runId,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`

	// ExportFormat
	ExportFormat *string `json:"exportFormat,omitempty"`

	// DownloadUrl
	DownloadUrl *string `json:"downloadUrl,omitempty"`

	// ViewType
	ViewType *string `json:"viewType,omitempty"`

	// ExportErrorMessagesType
	ExportErrorMessagesType *string `json:"exportErrorMessagesType,omitempty"`

	// Read
	Read *bool `json:"read,omitempty"`

	// CreatedDateTime
	CreatedDateTime *time.Time `json:"createdDateTime,omitempty"`

	// ModifiedDateTime
	ModifiedDateTime *time.Time `json:"modifiedDateTime,omitempty"`

	// PercentageComplete
	PercentageComplete *float32 `json:"percentageComplete,omitempty"`

	// EmailStatuses
	EmailStatuses *map[string]string `json:"emailStatuses,omitempty"`

	// EmailErrorDescription
	EmailErrorDescription *string `json:"emailErrorDescription,omitempty"`

	// ScheduleExpression
	ScheduleExpression *string `json:"scheduleExpression,omitempty"`
}

Reportingdataexporttopicdataexportnotification

func (*Reportingdataexporttopicdataexportnotification) String ¶

String returns a JSON representation of the model

type Reportingexportjoblisting ¶

type Reportingexportjoblisting struct {
	// Entities
	Entities *[]Reportingexportjobresponse `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Reportingexportjoblisting

func (*Reportingexportjoblisting) String ¶

func (o *Reportingexportjoblisting) String() string

String returns a JSON representation of the model

type Reportingexportjobrequest ¶

type Reportingexportjobrequest struct {
	// Name - The user supplied name of the export request
	Name *string `json:"name,omitempty"`

	// TimeZone - The requested timezone of the exported data. 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"`

	// ExportFormat - The requested format of the exported data
	ExportFormat *string `json:"exportFormat,omitempty"`

	// Interval - The time period used to limit the the exported data. 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"`

	// Period - The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
	Period *string `json:"period,omitempty"`

	// ViewType - The type of view export job to be created
	ViewType *string `json:"viewType,omitempty"`

	// Filter - Filters to apply to create the view
	Filter *Viewfilter `json:"filter,omitempty"`

	// Read - Indicates if the request has been marked as read
	Read *bool `json:"read,omitempty"`

	// Locale - The locale use for localization of the exported data, i.e. en-us, es-mx
	Locale *string `json:"locale,omitempty"`

	// HasFormatDurations - Indicates if durations are formatted in hh:mm:ss format instead of ms
	HasFormatDurations *bool `json:"hasFormatDurations,omitempty"`

	// HasSplitFilters - Indicates if filters will be split in aggregate detail exports
	HasSplitFilters *bool `json:"hasSplitFilters,omitempty"`

	// ExcludeEmptyRows - Excludes empty rows from the exports
	ExcludeEmptyRows *bool `json:"excludeEmptyRows,omitempty"`

	// HasSplitByMedia - Indicates if media type will be split in aggregate detail exports
	HasSplitByMedia *bool `json:"hasSplitByMedia,omitempty"`

	// HasSummaryRow - Indicates if summary row needs to be present in exports
	HasSummaryRow *bool `json:"hasSummaryRow,omitempty"`

	// CsvDelimiter - The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request
	CsvDelimiter *string `json:"csvDelimiter,omitempty"`

	// SelectedColumns - The list of ordered selected columns from the export view by the user
	SelectedColumns *[]Selectedcolumns `json:"selectedColumns,omitempty"`

	// HasCustomParticipantAttributes - Indicates if custom participant attributes will be exported
	HasCustomParticipantAttributes *bool `json:"hasCustomParticipantAttributes,omitempty"`

	// RecipientEmails - The list of email recipients for the exports
	RecipientEmails *[]string `json:"recipientEmails,omitempty"`
}

Reportingexportjobrequest

func (*Reportingexportjobrequest) String ¶

func (o *Reportingexportjobrequest) String() string

String returns a JSON representation of the model

type Reportingexportjobresponse ¶

type Reportingexportjobresponse struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// RunId - The unique run id of the export schedule execute
	RunId *string `json:"runId,omitempty"`

	// Status - The current status of the export request
	Status *string `json:"status,omitempty"`

	// TimeZone - The requested timezone of the exported data. 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"`

	// ExportFormat - The requested format of the exported data
	ExportFormat *string `json:"exportFormat,omitempty"`

	// Interval - The time period used to limit the the exported data. 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"`

	// DownloadUrl - The url to download the request if it's status is completed
	DownloadUrl *string `json:"downloadUrl,omitempty"`

	// ViewType - The type of view export job to be created
	ViewType *string `json:"viewType,omitempty"`

	// ExportErrorMessagesType - The error message in case the export request failed
	ExportErrorMessagesType *string `json:"exportErrorMessagesType,omitempty"`

	// Period - The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
	Period *string `json:"period,omitempty"`

	// Filter - Filters to apply to create the view
	Filter *Viewfilter `json:"filter,omitempty"`

	// Read - Indicates if the request has been marked as read
	Read *bool `json:"read,omitempty"`

	// CreatedDateTime - The created date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CreatedDateTime *time.Time `json:"createdDateTime,omitempty"`

	// ModifiedDateTime - The last modified date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ModifiedDateTime *time.Time `json:"modifiedDateTime,omitempty"`

	// Locale - The locale use for localization of the exported data, i.e. en-us, es-mx
	Locale *string `json:"locale,omitempty"`

	// PercentageComplete - The percentage of the job that has completed processing
	PercentageComplete *float64 `json:"percentageComplete,omitempty"`

	// HasFormatDurations - Indicates if durations are formatted in hh:mm:ss format instead of ms
	HasFormatDurations *bool `json:"hasFormatDurations,omitempty"`

	// HasSplitFilters - Indicates if filters will be split in aggregate detail exports
	HasSplitFilters *bool `json:"hasSplitFilters,omitempty"`

	// ExcludeEmptyRows - Excludes empty rows from the exports
	ExcludeEmptyRows *bool `json:"excludeEmptyRows,omitempty"`

	// HasSplitByMedia - Indicates if media type will be split in aggregate detail exports
	HasSplitByMedia *bool `json:"hasSplitByMedia,omitempty"`

	// HasSummaryRow - Indicates if summary row needs to be present in exports
	HasSummaryRow *bool `json:"hasSummaryRow,omitempty"`

	// CsvDelimiter - The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request
	CsvDelimiter *string `json:"csvDelimiter,omitempty"`

	// SelectedColumns - The list of ordered selected columns from the export view by the user
	SelectedColumns *[]Selectedcolumns `json:"selectedColumns,omitempty"`

	// HasCustomParticipantAttributes - Indicates if custom participant attributes will be exported
	HasCustomParticipantAttributes *bool `json:"hasCustomParticipantAttributes,omitempty"`

	// RecipientEmails - The list of email recipients for the exports
	RecipientEmails *[]string `json:"recipientEmails,omitempty"`

	// EmailStatuses - The status of individual email addresses as a map
	EmailStatuses *map[string]string `json:"emailStatuses,omitempty"`

	// EmailErrorDescription - The optional error message in case the export fail to email
	EmailErrorDescription *string `json:"emailErrorDescription,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Reportingexportjobresponse

func (*Reportingexportjobresponse) String ¶

func (o *Reportingexportjobresponse) String() string

String returns a JSON representation of the model

type Reportingexportmetadatajoblisting ¶

type Reportingexportmetadatajoblisting struct {
	// Entities
	Entities *[]Reportingexportmetadatajobresponse `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Reportingexportmetadatajoblisting

func (*Reportingexportmetadatajoblisting) String ¶

String returns a JSON representation of the model

type Reportingexportmetadatajobresponse ¶

type Reportingexportmetadatajobresponse struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ViewType - The view type of the export metadata
	ViewType *string `json:"viewType,omitempty"`

	// DateLimitations - The date limitations of the export metadata
	DateLimitations *string `json:"dateLimitations,omitempty"`

	// RequiredFilters - The list of required filters for the export metadata
	RequiredFilters *[]string `json:"requiredFilters,omitempty"`

	// SupportedFilters - The list of supported filters for the export metadata
	SupportedFilters *[]string `json:"supportedFilters,omitempty"`

	// RequiredColumnIds - The list of required column ids for the export metadata
	RequiredColumnIds *[]string `json:"requiredColumnIds,omitempty"`

	// DependentColumnIds - The list of dependent column ids for the export metadata
	DependentColumnIds *map[string][]string `json:"dependentColumnIds,omitempty"`

	// AvailableColumnIds - The list of available column ids for the export metadata
	AvailableColumnIds *[]string `json:"availableColumnIds,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Reportingexportmetadatajobresponse

func (*Reportingexportmetadatajobresponse) String ¶

String returns a JSON representation of the model

type Reportinginterval ¶

type Reportinginterval struct {
	// IntervalType - The granularity of the reporting interval period
	IntervalType *string `json:"intervalType,omitempty"`

	// IntervalValue - The value of the reporting interval period for a given interval type
	IntervalValue *int `json:"intervalValue,omitempty"`
}

Reportinginterval

func (*Reportinginterval) String ¶

func (o *Reportinginterval) String() string

String returns a JSON representation of the model

type Reportmetadata ¶

type Reportmetadata struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Title
	Title *string `json:"title,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Keywords
	Keywords *[]string `json:"keywords,omitempty"`

	// AvailableLocales
	AvailableLocales *[]string `json:"availableLocales,omitempty"`

	// Parameters
	Parameters *[]Parameter `json:"parameters,omitempty"`

	// ExampleUrl
	ExampleUrl *string `json:"exampleUrl,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Reportmetadata

func (*Reportmetadata) String ¶

func (o *Reportmetadata) String() string

String returns a JSON representation of the model

type Reportmetadataentitylisting ¶

type Reportmetadataentitylisting struct {
	// Entities
	Entities *[]Reportmetadata `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Reportmetadataentitylisting

func (*Reportmetadataentitylisting) String ¶

func (o *Reportmetadataentitylisting) String() string

String returns a JSON representation of the model

type Reportrunentry ¶

type Reportrunentry struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ReportId
	ReportId *string `json:"reportId,omitempty"`

	// RunTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	RunTime *time.Time `json:"runTime,omitempty"`

	// RunStatus
	RunStatus *string `json:"runStatus,omitempty"`

	// ErrorMessage
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// RunDurationMsec
	RunDurationMsec *int `json:"runDurationMsec,omitempty"`

	// ReportUrl
	ReportUrl *string `json:"reportUrl,omitempty"`

	// ReportFormat
	ReportFormat *string `json:"reportFormat,omitempty"`

	// ScheduleUri
	ScheduleUri *string `json:"scheduleUri,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Reportrunentry

func (*Reportrunentry) String ¶

func (o *Reportrunentry) String() string

String returns a JSON representation of the model

type Reportrunentryentitydomainlisting ¶

type Reportrunentryentitydomainlisting struct {
	// Entities
	Entities *[]Reportrunentry `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Reportrunentryentitydomainlisting

func (*Reportrunentryentitydomainlisting) String ¶

String returns a JSON representation of the model

type Reportschedule ¶

type Reportschedule struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// QuartzCronExpression - Quartz Cron Expression
	QuartzCronExpression *string `json:"quartzCronExpression,omitempty"`

	// NextFireTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	NextFireTime *time.Time `json:"nextFireTime,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"`

	// 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"`

	// Description
	Description *string `json:"description,omitempty"`

	// TimeZone
	TimeZone *string `json:"timeZone,omitempty"`

	// TimePeriod
	TimePeriod *string `json:"timePeriod,omitempty"`

	// Interval - 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"`

	// ReportFormat
	ReportFormat *string `json:"reportFormat,omitempty"`

	// Locale
	Locale *string `json:"locale,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// ReportId - Report ID
	ReportId *string `json:"reportId,omitempty"`

	// Parameters
	Parameters *map[string]interface{} `json:"parameters,omitempty"`

	// LastRun
	LastRun *Reportrunentry `json:"lastRun,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Reportschedule

func (*Reportschedule) String ¶

func (o *Reportschedule) String() string

String returns a JSON representation of the model

type Reportscheduleentitylisting ¶

type Reportscheduleentitylisting struct {
	// Entities
	Entities *[]Reportschedule `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Reportscheduleentitylisting

func (*Reportscheduleentitylisting) String ¶

func (o *Reportscheduleentitylisting) String() string

String returns a JSON representation of the model

type RequestLogHook ¶

type RequestLogHook func(*http.Request, int)

type Requestconfig ¶

type Requestconfig struct {
	// RequestUrlTemplate - URL that may include placeholders for requests to 3rd party service
	RequestUrlTemplate *string `json:"requestUrlTemplate,omitempty"`

	// RequestTemplate - Velocity template to define request body sent to 3rd party service.
	RequestTemplate *string `json:"requestTemplate,omitempty"`

	// RequestTemplateUri - URI to retrieve requestTemplate
	RequestTemplateUri *string `json:"requestTemplateUri,omitempty"`

	// RequestType - HTTP method to use for request
	RequestType *string `json:"requestType,omitempty"`

	// Headers - Headers to include in request in (Header Name, Value) pairs.
	Headers *map[string]string `json:"headers,omitempty"`
}

Requestconfig - Defines response components of the Action Request.

func (*Requestconfig) String ¶

func (o *Requestconfig) String() string

String returns a JSON representation of the model

type Requestmapping ¶

type Requestmapping struct {
	// Name - Name of the Integration Action Attribute to supply the value for
	Name *string `json:"name,omitempty"`

	// AttributeType - Type of the value supplied
	AttributeType *string `json:"attributeType,omitempty"`

	// MappingType - Method of finding value to use with Attribute
	MappingType *string `json:"mappingType,omitempty"`

	// Value - Value to supply for the specified Attribute
	Value *string `json:"value,omitempty"`
}

Requestmapping

func (*Requestmapping) String ¶

func (o *Requestmapping) String() string

String returns a JSON representation of the model

type Reschedulingmanagementunitresponse ¶

type Reschedulingmanagementunitresponse struct {
	// ManagementUnit - The management unit
	ManagementUnit *Managementunitreference `json:"managementUnit,omitempty"`

	// Applied - Whether the rescheduling run is applied for the given management unit
	Applied *bool `json:"applied,omitempty"`
}

Reschedulingmanagementunitresponse

func (*Reschedulingmanagementunitresponse) String ¶

String returns a JSON representation of the model

type Reschedulingoptionsrunresponse ¶

type Reschedulingoptionsrunresponse struct {
	// ExistingSchedule - The existing schedule to which this reschedule run applies
	ExistingSchedule *Buschedulereference `json:"existingSchedule,omitempty"`

	// StartDate - The start date of the period to reschedule. 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 period to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndDate *time.Time `json:"endDate,omitempty"`

	// ManagementUnits - Per-management unit rescheduling options
	ManagementUnits *[]Reschedulingmanagementunitresponse `json:"managementUnits,omitempty"`

	// AgentCount - The number of agents to be considered in the reschedule
	AgentCount *int `json:"agentCount,omitempty"`

	// ActivityCodeIds - The IDs of the activity codes being considered for reschedule
	ActivityCodeIds *[]string `json:"activityCodeIds,omitempty"`

	// DoNotChangeWeeklyPaidTime - Whether weekly paid time is allowed to be changed
	DoNotChangeWeeklyPaidTime *bool `json:"doNotChangeWeeklyPaidTime,omitempty"`

	// DoNotChangeDailyPaidTime - Whether daily paid time is allowed to be changed
	DoNotChangeDailyPaidTime *bool `json:"doNotChangeDailyPaidTime,omitempty"`

	// DoNotChangeShiftStartTimes - Whether shift start times are allowed to be changed
	DoNotChangeShiftStartTimes *bool `json:"doNotChangeShiftStartTimes,omitempty"`

	// DoNotChangeManuallyEditedShifts - Whether manually edited shifts are allowed to be changed
	DoNotChangeManuallyEditedShifts *bool `json:"doNotChangeManuallyEditedShifts,omitempty"`
}

Reschedulingoptionsrunresponse

func (*Reschedulingoptionsrunresponse) String ¶

String returns a JSON representation of the model

type Resolutiondetailqueryclause ¶

type Resolutiondetailqueryclause 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 *[]Resolutiondetailquerypredicate `json:"predicates,omitempty"`
}

Resolutiondetailqueryclause

func (*Resolutiondetailqueryclause) String ¶

func (o *Resolutiondetailqueryclause) String() string

String returns a JSON representation of the model

type Resolutiondetailqueryfilter ¶

type Resolutiondetailqueryfilter 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 *[]Resolutiondetailqueryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Resolutiondetailquerypredicate `json:"predicates,omitempty"`
}

Resolutiondetailqueryfilter

func (*Resolutiondetailqueryfilter) String ¶

func (o *Resolutiondetailqueryfilter) String() string

String returns a JSON representation of the model

type Resolutiondetailquerypredicate ¶

type Resolutiondetailquerypredicate struct {
	// VarType - Optional type, can usually be inferred
	VarType *string `json:"type,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 metric predicates
	Value *string `json:"value,omitempty"`

	// VarRange - Right hand side for metric predicates
	VarRange *Numericrange `json:"range,omitempty"`
}

Resolutiondetailquerypredicate

func (*Resolutiondetailquerypredicate) String ¶

String returns a JSON representation of the model

type Resourceconditionnode ¶

type Resourceconditionnode struct {
	// VariableName
	VariableName *string `json:"variableName,omitempty"`

	// Conjunction
	Conjunction *string `json:"conjunction,omitempty"`

	// Operator
	Operator *string `json:"operator,omitempty"`

	// Operands
	Operands *[]Resourceconditionvalue `json:"operands,omitempty"`

	// Terms
	Terms *[]Resourceconditionnode `json:"terms,omitempty"`
}

Resourceconditionnode

func (*Resourceconditionnode) String ¶

func (o *Resourceconditionnode) String() string

String returns a JSON representation of the model

type Resourceconditionvalue ¶

type Resourceconditionvalue struct {
	// VarType
	VarType *string `json:"type,omitempty"`

	// Value
	Value *string `json:"value,omitempty"`
}

Resourceconditionvalue

func (*Resourceconditionvalue) String ¶

func (o *Resourceconditionvalue) String() string

String returns a JSON representation of the model

type Resourcepermissionpolicy ¶

type Resourcepermissionpolicy struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Domain
	Domain *string `json:"domain,omitempty"`

	// EntityName
	EntityName *string `json:"entityName,omitempty"`

	// PolicyName
	PolicyName *string `json:"policyName,omitempty"`

	// PolicyDescription
	PolicyDescription *string `json:"policyDescription,omitempty"`

	// ActionSetKey
	ActionSetKey *string `json:"actionSetKey,omitempty"`

	// AllowConditions
	AllowConditions *bool `json:"allowConditions,omitempty"`

	// ResourceConditionNode
	ResourceConditionNode *Resourceconditionnode `json:"resourceConditionNode,omitempty"`

	// NamedResources
	NamedResources *[]string `json:"namedResources,omitempty"`

	// ResourceCondition
	ResourceCondition *string `json:"resourceCondition,omitempty"`

	// ActionSet
	ActionSet *[]string `json:"actionSet,omitempty"`
}

Resourcepermissionpolicy

func (*Resourcepermissionpolicy) String ¶

func (o *Resourcepermissionpolicy) String() string

String returns a JSON representation of the model

type Response ¶

type Response struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Version - Version number required for updates.
	Version *int `json:"version,omitempty"`

	// Libraries - One or more libraries response is associated with.
	Libraries *[]Domainentityref `json:"libraries,omitempty"`

	// Texts - One or more texts associated with the response.
	Texts *[]Responsetext `json:"texts,omitempty"`

	// CreatedBy - User that created the response
	CreatedBy *User `json:"createdBy,omitempty"`

	// DateCreated - The date and time the response 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"`

	// InteractionType - The interaction type for this response.
	InteractionType *string `json:"interactionType,omitempty"`

	// Substitutions - Details about any text substitutions used in the texts for this response.
	Substitutions *[]Responsesubstitution `json:"substitutions,omitempty"`

	// SubstitutionsSchema - Metadata about the text substitutions in json schema format.
	SubstitutionsSchema *Jsonschemadocument `json:"substitutionsSchema,omitempty"`

	// ResponseType - The response type represented by the response.
	ResponseType *string `json:"responseType,omitempty"`

	// MessagingTemplate - An optional messaging template definition for responseType.MessagingTemplate.
	MessagingTemplate *Messagingtemplate `json:"messagingTemplate,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Response - Contains information about a response.

func (*Response) String ¶

func (o *Response) String() string

String returns a JSON representation of the model

type ResponseManagementApi ¶

type ResponseManagementApi struct {
	Configuration *Configuration
}

ResponseManagementApi provides functions for API endpoints

func NewResponseManagementApi ¶

func NewResponseManagementApi() *ResponseManagementApi

NewResponseManagementApi creates an API instance using the default configuration

func NewResponseManagementApiWithConfig ¶

func NewResponseManagementApiWithConfig(config *Configuration) *ResponseManagementApi

NewResponseManagementApiWithConfig creates an API instance using the provided configuration

func (ResponseManagementApi) DeleteResponsemanagementLibrary ¶

func (a ResponseManagementApi) DeleteResponsemanagementLibrary(libraryId string) (*APIResponse, error)

DeleteResponsemanagementLibrary invokes DELETE /api/v2/responsemanagement/libraries/{libraryId}

Delete an existing response library.

This will remove any responses associated with the library.

func (ResponseManagementApi) DeleteResponsemanagementResponse ¶

func (a ResponseManagementApi) DeleteResponsemanagementResponse(responseId string) (*APIResponse, error)

DeleteResponsemanagementResponse invokes DELETE /api/v2/responsemanagement/responses/{responseId}

Delete an existing response.

This will remove the response from any libraries associated with it.

func (ResponseManagementApi) GetResponsemanagementLibraries ¶

func (a ResponseManagementApi) GetResponsemanagementLibraries(pageNumber int, pageSize int, messagingTemplateFilter string) (*Libraryentitylisting, *APIResponse, error)

GetResponsemanagementLibraries invokes GET /api/v2/responsemanagement/libraries

Gets a list of existing response libraries.

func (ResponseManagementApi) GetResponsemanagementLibrary ¶

func (a ResponseManagementApi) GetResponsemanagementLibrary(libraryId string) (*Library, *APIResponse, error)

GetResponsemanagementLibrary invokes GET /api/v2/responsemanagement/libraries/{libraryId}

Get details about an existing response library.

func (ResponseManagementApi) GetResponsemanagementResponse ¶

func (a ResponseManagementApi) GetResponsemanagementResponse(responseId string, expand string) (*Response, *APIResponse, error)

GetResponsemanagementResponse invokes GET /api/v2/responsemanagement/responses/{responseId}

Get details about an existing response.

func (ResponseManagementApi) GetResponsemanagementResponses ¶

func (a ResponseManagementApi) GetResponsemanagementResponses(libraryId string, pageNumber int, pageSize int, expand string) (*Responseentitylisting, *APIResponse, error)

GetResponsemanagementResponses invokes GET /api/v2/responsemanagement/responses

Gets a list of existing responses.

func (ResponseManagementApi) PostResponsemanagementLibraries ¶

func (a ResponseManagementApi) PostResponsemanagementLibraries(body Library) (*Library, *APIResponse, error)

PostResponsemanagementLibraries invokes POST /api/v2/responsemanagement/libraries

Create a response library.

func (ResponseManagementApi) PostResponsemanagementResponses ¶

func (a ResponseManagementApi) PostResponsemanagementResponses(body Response, expand string) (*Response, *APIResponse, error)

PostResponsemanagementResponses invokes POST /api/v2/responsemanagement/responses

Create a response.

func (ResponseManagementApi) PostResponsemanagementResponsesQuery ¶

func (a ResponseManagementApi) PostResponsemanagementResponsesQuery(body Responsequeryrequest) (*Responsequeryresults, *APIResponse, error)

PostResponsemanagementResponsesQuery invokes POST /api/v2/responsemanagement/responses/query

Query responses

func (ResponseManagementApi) PutResponsemanagementLibrary ¶

func (a ResponseManagementApi) PutResponsemanagementLibrary(libraryId string, body Library) (*Library, *APIResponse, error)

PutResponsemanagementLibrary invokes PUT /api/v2/responsemanagement/libraries/{libraryId}

Update an existing response library.

Fields that can be updated: name. The most recent version is required for updates.

func (ResponseManagementApi) PutResponsemanagementResponse ¶

func (a ResponseManagementApi) PutResponsemanagementResponse(responseId string, body Response, expand string) (*Response, *APIResponse, error)

PutResponsemanagementResponse invokes PUT /api/v2/responsemanagement/responses/{responseId}

Update an existing response.

Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.

type Responseconfig ¶

type Responseconfig struct {
	// TranslationMap - Map 'attribute name' and 'JSON path' pairs used to extract data from REST response.
	TranslationMap *map[string]string `json:"translationMap,omitempty"`

	// TranslationMapDefaults - Map 'attribute name' and 'default value' pairs used as fallback values if JSON path extraction fails for specified key.
	TranslationMapDefaults *map[string]string `json:"translationMapDefaults,omitempty"`

	// SuccessTemplate - Velocity template to build response to return from Action.
	SuccessTemplate *string `json:"successTemplate,omitempty"`

	// SuccessTemplateUri - URI to retrieve success template.
	SuccessTemplateUri *string `json:"successTemplateUri,omitempty"`
}

Responseconfig - Defines response components of the Action Request.

func (*Responseconfig) String ¶

func (o *Responseconfig) String() string

String returns a JSON representation of the model

type Responseentitylist ¶

type Responseentitylist struct {
	// Entities
	Entities *[]Response `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Responseentitylist - Query result list

func (*Responseentitylist) String ¶

func (o *Responseentitylist) String() string

String returns a JSON representation of the model

type Responseentitylisting ¶

type Responseentitylisting struct {
	// Entities
	Entities *[]Response `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Responseentitylisting

func (*Responseentitylisting) String ¶

func (o *Responseentitylisting) String() string

String returns a JSON representation of the model

type Responsefilter ¶

type Responsefilter struct {
	// Name - Field to filter on. Allowed values are 'name' and 'libraryId.
	Name *string `json:"name,omitempty"`

	// Operator - Filter operation: IN, EQUALS, NOTEQUALS.
	Operator *string `json:"operator,omitempty"`

	// Values - Values to filter on.
	Values *[]string `json:"values,omitempty"`
}

Responsefilter - Used to filter response queries

func (*Responsefilter) String ¶

func (o *Responsefilter) String() string

String returns a JSON representation of the model

type Responsequeryrequest ¶

type Responsequeryrequest struct {
	// QueryPhrase - Query phrase to search response text and name. If not set will match all.
	QueryPhrase *string `json:"queryPhrase,omitempty"`

	// PageSize - The maximum number of hits to return. Default: 25, Maximum: 500.
	PageSize *int `json:"pageSize,omitempty"`

	// Filters - Filter the query results.
	Filters *[]Responsefilter `json:"filters,omitempty"`
}

Responsequeryrequest - Used to query for responses

func (*Responsequeryrequest) String ¶

func (o *Responsequeryrequest) String() string

String returns a JSON representation of the model

type Responsequeryresults ¶

type Responsequeryresults struct {
	// Results - Contains the query results
	Results *Responseentitylist `json:"results,omitempty"`
}

Responsequeryresults - Used to return response query results

func (*Responsequeryresults) String ¶

func (o *Responsequeryresults) String() string

String returns a JSON representation of the model

type Responseset ¶

type Responseset struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the ResponseSet.
	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"`

	// Responses - Map of disposition identifiers to reactions. For example: {\"disposition.classification.callable.person\": {\"reactionType\": \"transfer\"}}.
	Responses *map[string]Reaction `json:"responses,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Responseset

func (*Responseset) String ¶

func (o *Responseset) String() string

String returns a JSON representation of the model

type Responsesetentitylisting ¶

type Responsesetentitylisting struct {
	// Entities
	Entities *[]Responseset `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Responsesetentitylisting

func (*Responsesetentitylisting) String ¶

func (o *Responsesetentitylisting) String() string

String returns a JSON representation of the model

type Responsesubstitution ¶

type Responsesubstitution struct {
	// Id - Response substitution identifier.
	Id *string `json:"id,omitempty"`

	// Description - Response substitution description.
	Description *string `json:"description,omitempty"`

	// DefaultValue - Response substitution default value.
	DefaultValue *string `json:"defaultValue,omitempty"`
}

Responsesubstitution - Contains information about the substitutions associated with a response.

func (*Responsesubstitution) String ¶

func (o *Responsesubstitution) String() string

String returns a JSON representation of the model

type Responsetext ¶

type Responsetext struct {
	// Content - Response text content.
	Content *string `json:"content,omitempty"`

	// ContentType - Response text content type.
	ContentType *string `json:"contentType,omitempty"`
}

Responsetext - Contains information about the text associated with a response.

func (*Responsetext) String ¶

func (o *Responsetext) String() string

String returns a JSON representation of the model

type Resterrordetail ¶

type Resterrordetail struct {
	// VarError - name of the error
	VarError *string `json:"error,omitempty"`

	// Details - additional information regarding the error
	Details *string `json:"details,omitempty"`
}

Resterrordetail

func (*Resterrordetail) String ¶

func (o *Resterrordetail) String() string

String returns a JSON representation of the model

type Retentionduration ¶

type Retentionduration struct {
	// ArchiveRetention
	ArchiveRetention *Archiveretention `json:"archiveRetention,omitempty"`

	// DeleteRetention
	DeleteRetention *Deleteretention `json:"deleteRetention,omitempty"`
}

Retentionduration

func (*Retentionduration) String ¶

func (o *Retentionduration) String() string

String returns a JSON representation of the model

type RetryConfiguration ¶

type RetryConfiguration struct {
	RetryWaitMin   time.Duration  `json:"retry_wait_min,omitempty"`
	RetryWaitMax   time.Duration  `json:"retry_wait_max,omitempty"`
	RetryMax       int            `json:"retry_max,omitempty"`
	RequestLogHook RequestLogHook `json:"request_log_hook,omitempty"`
}

RetryConfiguration has settings to configure the SDK retry logic

type Reversewhitepageslookupresult ¶

type Reversewhitepageslookupresult struct {
	// Contacts
	Contacts *[]Externalcontact `json:"contacts,omitempty"`

	// ExternalOrganizations
	ExternalOrganizations *[]Externalorganization `json:"externalOrganizations,omitempty"`
}

Reversewhitepageslookupresult

func (*Reversewhitepageslookupresult) String ¶

String returns a JSON representation of the model

type Ring ¶

type Ring struct {
	// ExpansionCriteria
	ExpansionCriteria *[]Expansioncriterium `json:"expansionCriteria,omitempty"`

	// Actions
	Actions *Actions `json:"actions,omitempty"`
}

Ring

func (*Ring) String ¶

func (o *Ring) String() string

String returns a JSON representation of the model

type Roledivision ¶

type Roledivision struct {
	// RoleId - Role to be associated with the given division which forms a grant
	RoleId *string `json:"roleId,omitempty"`

	// DivisionId - Division associated with the given role which forms a grant
	DivisionId *string `json:"divisionId,omitempty"`
}

Roledivision

func (*Roledivision) String ¶

func (o *Roledivision) String() string

String returns a JSON representation of the model

type Roledivisiongrants ¶

type Roledivisiongrants struct {
	// Grants - A list containing pairs of role and division IDs
	Grants *[]Roledivisionpair `json:"grants,omitempty"`
}

Roledivisiongrants

func (*Roledivisiongrants) String ¶

func (o *Roledivisiongrants) String() string

String returns a JSON representation of the model

type Roledivisionpair ¶

type Roledivisionpair struct {
	// RoleId - The ID of the role
	RoleId *string `json:"roleId,omitempty"`

	// DivisionId - The ID of the division
	DivisionId *string `json:"divisionId,omitempty"`
}

Roledivisionpair

func (*Roledivisionpair) String ¶

func (o *Roledivisionpair) String() string

String returns a JSON representation of the model

type Routepathrequest ¶

type Routepathrequest struct {
	// QueueId - The ID of the queue to associate with the route path
	QueueId *string `json:"queueId,omitempty"`

	// MediaType - The media type of the given queue to associate with the route path
	MediaType *string `json:"mediaType,omitempty"`

	// LanguageId - The ID of the language to associate with the route path
	LanguageId *string `json:"languageId,omitempty"`

	// SkillIds - The set of skill IDs to associate with the route path
	SkillIds *[]string `json:"skillIds,omitempty"`

	// SourcePlanningGroup - The planning group from which to copy route paths
	SourcePlanningGroup *Sourceplanninggrouprequest `json:"sourcePlanningGroup,omitempty"`
}

Routepathrequest - Route path configuration

func (*Routepathrequest) String ¶

func (o *Routepathrequest) String() string

String returns a JSON representation of the model

type Routepathresponse ¶

type Routepathresponse struct {
	// Queue - The ID of the queue associated with the route path
	Queue *Queuereference `json:"queue,omitempty"`

	// MediaType - The media type of the given queue associated with the route path
	MediaType *string `json:"mediaType,omitempty"`

	// Language - The ID of the language associated with the route path
	Language *Languagereference `json:"language,omitempty"`

	// Skills - The set of skills associated with the route path
	Skills *[]Routingskillreference `json:"skills,omitempty"`
}

Routepathresponse - Route path configuration

func (*Routepathresponse) String ¶

func (o *Routepathresponse) String() string

String returns a JSON representation of the model

type RoutingApi ¶

type RoutingApi struct {
	Configuration *Configuration
}

RoutingApi provides functions for API endpoints

func NewRoutingApi ¶

func NewRoutingApi() *RoutingApi

NewRoutingApi creates an API instance using the default configuration

func NewRoutingApiWithConfig ¶

func NewRoutingApiWithConfig(config *Configuration) *RoutingApi

NewRoutingApiWithConfig creates an API instance using the provided configuration

func (RoutingApi) DeleteRoutingAssessment ¶

func (a RoutingApi) DeleteRoutingAssessment(assessmentId string) (*APIResponse, error)

DeleteRoutingAssessment invokes DELETE /api/v2/routing/assessments/{assessmentId}

Delete single benefit assessment.

func (RoutingApi) DeleteRoutingEmailDomain ¶

func (a RoutingApi) DeleteRoutingEmailDomain(domainId string) (*APIResponse, error)

DeleteRoutingEmailDomain invokes DELETE /api/v2/routing/email/domains/{domainId}

Delete a domain

func (RoutingApi) DeleteRoutingEmailDomainRoute ¶

func (a RoutingApi) DeleteRoutingEmailDomainRoute(domainName string, routeId string) (*APIResponse, error)

DeleteRoutingEmailDomainRoute invokes DELETE /api/v2/routing/email/domains/{domainName}/routes/{routeId}

Delete a route

func (RoutingApi) DeleteRoutingPredictor ¶

func (a RoutingApi) DeleteRoutingPredictor(predictorId string) (*APIResponse, error)

DeleteRoutingPredictor invokes DELETE /api/v2/routing/predictors/{predictorId}

Delete single predictor.

func (RoutingApi) DeleteRoutingQueue ¶

func (a RoutingApi) DeleteRoutingQueue(queueId string, forceDelete bool) (*APIResponse, error)

DeleteRoutingQueue invokes DELETE /api/v2/routing/queues/{queueId}

Delete a queue

func (RoutingApi) DeleteRoutingQueueMember ¶

func (a RoutingApi) DeleteRoutingQueueMember(queueId string, memberId string) (*APIResponse, error)

DeleteRoutingQueueMember invokes DELETE /api/v2/routing/queues/{queueId}/members/{memberId}

Delete a queue member.

func (RoutingApi) DeleteRoutingQueueUser ¶

func (a RoutingApi) DeleteRoutingQueueUser(queueId string, memberId string) (*APIResponse, error)

DeleteRoutingQueueUser invokes DELETE /api/v2/routing/queues/{queueId}/users/{memberId}

DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.

func (RoutingApi) DeleteRoutingQueueWrapupcode ¶

func (a RoutingApi) DeleteRoutingQueueWrapupcode(queueId string, codeId string) (*APIResponse, error)

DeleteRoutingQueueWrapupcode invokes DELETE /api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}

Delete a wrap-up code from a queue

func (RoutingApi) DeleteRoutingSettings ¶

func (a RoutingApi) DeleteRoutingSettings() (*APIResponse, error)

DeleteRoutingSettings invokes DELETE /api/v2/routing/settings

Delete an organization&#39;s routing settings

func (RoutingApi) DeleteRoutingSkill ¶

func (a RoutingApi) DeleteRoutingSkill(skillId string) (*APIResponse, error)

DeleteRoutingSkill invokes DELETE /api/v2/routing/skills/{skillId}

Delete Routing Skill

func (RoutingApi) DeleteRoutingSmsAddress ¶

func (a RoutingApi) DeleteRoutingSmsAddress(addressId string) (*APIResponse, error)

DeleteRoutingSmsAddress invokes DELETE /api/v2/routing/sms/addresses/{addressId}

Delete an Address by Id for SMS

func (RoutingApi) DeleteRoutingSmsPhonenumber ¶

func (a RoutingApi) DeleteRoutingSmsPhonenumber(addressId string) (*APIResponse, error)

DeleteRoutingSmsPhonenumber invokes DELETE /api/v2/routing/sms/phonenumbers/{addressId}

Delete a phone number provisioned for SMS.

func (RoutingApi) DeleteRoutingUserUtilization ¶

func (a RoutingApi) DeleteRoutingUserUtilization(userId string) (*APIResponse, error)

DeleteRoutingUserUtilization invokes DELETE /api/v2/routing/users/{userId}/utilization

Delete the user&#39;s max utilization settings and revert to the organization-wide default.

func (RoutingApi) DeleteRoutingUtilization ¶

func (a RoutingApi) DeleteRoutingUtilization() (*APIResponse, error)

DeleteRoutingUtilization invokes DELETE /api/v2/routing/utilization

Delete the organization-wide max utilization settings and revert to the system default.

func (RoutingApi) DeleteRoutingWrapupcode ¶

func (a RoutingApi) DeleteRoutingWrapupcode(codeId string) (*APIResponse, error)

DeleteRoutingWrapupcode invokes DELETE /api/v2/routing/wrapupcodes/{codeId}

Delete wrap-up code

func (RoutingApi) DeleteUserRoutinglanguage ¶

func (a RoutingApi) DeleteUserRoutinglanguage(userId string, languageId string) (*APIResponse, error)

DeleteUserRoutinglanguage invokes DELETE /api/v2/users/{userId}/routinglanguages/{languageId}

Remove routing language from user

func (RoutingApi) DeleteUserRoutingskill ¶

func (a RoutingApi) DeleteUserRoutingskill(userId string, skillId string) (*APIResponse, error)

DeleteUserRoutingskill invokes DELETE /api/v2/users/{userId}/routingskills/{skillId}

Remove routing skill from user

func (RoutingApi) GetRoutingAssessment ¶

func (a RoutingApi) GetRoutingAssessment(assessmentId string) (*Benefitassessment, *APIResponse, error)

GetRoutingAssessment invokes GET /api/v2/routing/assessments/{assessmentId}

Retrieve a single benefit assessment.

func (RoutingApi) GetRoutingAssessments ¶

func (a RoutingApi) GetRoutingAssessments(before string, after string, limit string, pageSize string, queueId []string) (*Assessmentlisting, *APIResponse, error)

GetRoutingAssessments invokes GET /api/v2/routing/assessments

Retrieve all benefit assessments.

func (RoutingApi) GetRoutingAssessmentsJob ¶

func (a RoutingApi) GetRoutingAssessmentsJob(jobId string) (*Benefitassessmentjob, *APIResponse, error)

GetRoutingAssessmentsJob invokes GET /api/v2/routing/assessments/jobs/{jobId}

Retrieve a single benefit assessments job.

func (RoutingApi) GetRoutingAssessmentsJobs ¶

func (a RoutingApi) GetRoutingAssessmentsJobs(divisionId []string) (*Assessmentjoblisting, *APIResponse, error)

GetRoutingAssessmentsJobs invokes GET /api/v2/routing/assessments/jobs

Retrieve all benefit assessment jobs.

func (RoutingApi) GetRoutingEmailDomain ¶

func (a RoutingApi) GetRoutingEmailDomain(domainId string) (*Inbounddomain, *APIResponse, error)

GetRoutingEmailDomain invokes GET /api/v2/routing/email/domains/{domainId}

Get domain

func (RoutingApi) GetRoutingEmailDomainRoute ¶

func (a RoutingApi) GetRoutingEmailDomainRoute(domainName string, routeId string) (*Inboundroute, *APIResponse, error)

GetRoutingEmailDomainRoute invokes GET /api/v2/routing/email/domains/{domainName}/routes/{routeId}

Get a route

func (RoutingApi) GetRoutingEmailDomainRoutes ¶

func (a RoutingApi) GetRoutingEmailDomainRoutes(domainName string, pageSize int, pageNumber int, pattern string) (*Inboundrouteentitylisting, *APIResponse, error)

GetRoutingEmailDomainRoutes invokes GET /api/v2/routing/email/domains/{domainName}/routes

Get routes

func (RoutingApi) GetRoutingEmailDomains ¶

func (a RoutingApi) GetRoutingEmailDomains() (*Inbounddomainentitylisting, *APIResponse, error)

GetRoutingEmailDomains invokes GET /api/v2/routing/email/domains

Get domains

func (RoutingApi) GetRoutingEmailSetup ¶

func (a RoutingApi) GetRoutingEmailSetup() (*Emailsetup, *APIResponse, error)

GetRoutingEmailSetup invokes GET /api/v2/routing/email/setup

Get email setup

func (RoutingApi) GetRoutingLanguages ¶

func (a RoutingApi) GetRoutingLanguages(pageSize int, pageNumber int, sortOrder string, name string, id []string) (*Languageentitylisting, *APIResponse, error)

GetRoutingLanguages invokes GET /api/v2/routing/languages

Get the list of supported languages.

func (RoutingApi) GetRoutingMessageRecipient ¶

func (a RoutingApi) GetRoutingMessageRecipient(recipientId string) (*Recipient, *APIResponse, error)

GetRoutingMessageRecipient invokes GET /api/v2/routing/message/recipients/{recipientId}

Get a recipient

func (RoutingApi) GetRoutingMessageRecipients ¶

func (a RoutingApi) GetRoutingMessageRecipients(messengerType string, pageSize int, pageNumber int) (*Recipientlisting, *APIResponse, error)

GetRoutingMessageRecipients invokes GET /api/v2/routing/message/recipients

Get recipients

func (RoutingApi) GetRoutingPredictor ¶

func (a RoutingApi) GetRoutingPredictor(predictorId string) (*Predictor, *APIResponse, error)

GetRoutingPredictor invokes GET /api/v2/routing/predictors/{predictorId}

Retrieve a single predictor.

func (RoutingApi) GetRoutingPredictors ¶

func (a RoutingApi) GetRoutingPredictors(before string, after string, limit string, pageSize string, queueId []string) (*Predictorlisting, *APIResponse, error)

GetRoutingPredictors invokes GET /api/v2/routing/predictors

Retrieve all predictors.

func (RoutingApi) GetRoutingPredictorsKeyperformanceindicators ¶

func (a RoutingApi) GetRoutingPredictorsKeyperformanceindicators() ([]Keyperformanceindicator, *APIResponse, error)

GetRoutingPredictorsKeyperformanceindicators invokes GET /api/v2/routing/predictors/keyperformanceindicators

Get a list of Key Performance Indicators available for the predictors.

func (RoutingApi) GetRoutingQueue ¶

func (a RoutingApi) GetRoutingQueue(queueId string) (*Queue, *APIResponse, error)

GetRoutingQueue invokes GET /api/v2/routing/queues/{queueId}

Get details about this queue.

func (RoutingApi) GetRoutingQueueComparisonperiod ¶

func (a RoutingApi) GetRoutingQueueComparisonperiod(queueId string, comparisonPeriodId string) (*Comparisonperiod, *APIResponse, error)

GetRoutingQueueComparisonperiod invokes GET /api/v2/routing/queues/{queueId}/comparisonperiods/{comparisonPeriodId}

Get a Comparison Period.

func (RoutingApi) GetRoutingQueueComparisonperiods ¶

func (a RoutingApi) GetRoutingQueueComparisonperiods(queueId string) (*Comparisonperiodlisting, *APIResponse, error)

GetRoutingQueueComparisonperiods invokes GET /api/v2/routing/queues/{queueId}/comparisonperiods

Get list of comparison periods

func (RoutingApi) GetRoutingQueueEstimatedwaittime ¶

func (a RoutingApi) GetRoutingQueueEstimatedwaittime(queueId string, conversationId string) (*Estimatedwaittimepredictions, *APIResponse, error)

GetRoutingQueueEstimatedwaittime invokes GET /api/v2/routing/queues/{queueId}/estimatedwaittime

Get Estimated Wait Time

func (RoutingApi) GetRoutingQueueMediatypeEstimatedwaittime ¶

func (a RoutingApi) GetRoutingQueueMediatypeEstimatedwaittime(queueId string, mediaType string) (*Estimatedwaittimepredictions, *APIResponse, error)

GetRoutingQueueMediatypeEstimatedwaittime invokes GET /api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime

Get Estimated Wait Time

func (RoutingApi) GetRoutingQueueMembers ¶

func (a RoutingApi) GetRoutingQueueMembers(queueId string, pageSize int, pageNumber int, sortBy string, expand []string, joined bool, name string, profileSkills []string, skills []string, languages []string, routingStatus []string, presence []string) (*Queuememberentitylisting, *APIResponse, error)

GetRoutingQueueMembers invokes GET /api/v2/routing/queues/{queueId}/members

Get the members of this queue.

func (RoutingApi) GetRoutingQueueUsers ¶

func (a RoutingApi) GetRoutingQueueUsers(queueId string, pageSize int, pageNumber int, sortBy string, expand []string, joined bool, name string, profileSkills []string, skills []string, languages []string, routingStatus []string, presence []string) (*Queuememberentitylisting, *APIResponse, error)

GetRoutingQueueUsers invokes GET /api/v2/routing/queues/{queueId}/users

DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.

func (RoutingApi) GetRoutingQueueWrapupcodes ¶

func (a RoutingApi) GetRoutingQueueWrapupcodes(queueId string, pageSize int, pageNumber int) (*Wrapupcodeentitylisting, *APIResponse, error)

GetRoutingQueueWrapupcodes invokes GET /api/v2/routing/queues/{queueId}/wrapupcodes

Get the wrap-up codes for a queue

func (RoutingApi) GetRoutingQueues ¶

func (a RoutingApi) GetRoutingQueues(pageSize int, pageNumber int, sortBy string, name string, id []string, divisionId []string) (*Queueentitylisting, *APIResponse, error)

GetRoutingQueues invokes GET /api/v2/routing/queues

Get list of queues.

func (RoutingApi) GetRoutingQueuesDivisionviews ¶

func (a RoutingApi) GetRoutingQueuesDivisionviews(pageSize int, pageNumber int, sortBy string, sortOrder string, name string, id []string, divisionId []string) (*Queueentitylisting, *APIResponse, error)

GetRoutingQueuesDivisionviews invokes GET /api/v2/routing/queues/divisionviews

Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).

func (RoutingApi) GetRoutingQueuesDivisionviewsAll ¶

func (a RoutingApi) GetRoutingQueuesDivisionviewsAll(pageSize int, pageNumber int, sortBy string, sortOrder string) (*Queueentitylisting, *APIResponse, error)

GetRoutingQueuesDivisionviewsAll invokes GET /api/v2/routing/queues/divisionviews/all

Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.

func (RoutingApi) GetRoutingQueuesMe ¶

func (a RoutingApi) GetRoutingQueuesMe(joined bool, pageSize int, pageNumber int, sortBy string, sortOrder string) (*Userqueueentitylisting, *APIResponse, error)

GetRoutingQueuesMe invokes GET /api/v2/routing/queues/me

Get a paged listing of queues the user is a member of.

func (RoutingApi) GetRoutingSettings ¶

func (a RoutingApi) GetRoutingSettings() (*Routingsettings, *APIResponse, error)

GetRoutingSettings invokes GET /api/v2/routing/settings

Get an organization&#39;s routing settings

func (RoutingApi) GetRoutingSettingsContactcenter ¶

func (a RoutingApi) GetRoutingSettingsContactcenter() (*Contactcentersettings, *APIResponse, error)

GetRoutingSettingsContactcenter invokes GET /api/v2/routing/settings/contactcenter

Get Contact Center Settings

func (RoutingApi) GetRoutingSettingsTranscription ¶

func (a RoutingApi) GetRoutingSettingsTranscription() (*Transcriptionsettings, *APIResponse, error)

GetRoutingSettingsTranscription invokes GET /api/v2/routing/settings/transcription

Get Transcription Settings

func (RoutingApi) GetRoutingSkill ¶

func (a RoutingApi) GetRoutingSkill(skillId string) (*Routingskill, *APIResponse, error)

GetRoutingSkill invokes GET /api/v2/routing/skills/{skillId}

Get Routing Skill

func (RoutingApi) GetRoutingSkills ¶

func (a RoutingApi) GetRoutingSkills(pageSize int, pageNumber int, name string, id []string) (*Skillentitylisting, *APIResponse, error)

GetRoutingSkills invokes GET /api/v2/routing/skills

Get the list of routing skills.

func (RoutingApi) GetRoutingSmsAddress ¶

func (a RoutingApi) GetRoutingSmsAddress(addressId string) (*Smsaddress, *APIResponse, error)

GetRoutingSmsAddress invokes GET /api/v2/routing/sms/addresses/{addressId}

Get an Address by Id for SMS

func (RoutingApi) GetRoutingSmsAddresses ¶

func (a RoutingApi) GetRoutingSmsAddresses(pageSize int, pageNumber int) (*Smsaddressentitylisting, *APIResponse, error)

GetRoutingSmsAddresses invokes GET /api/v2/routing/sms/addresses

Get a list of Addresses for SMS

func (RoutingApi) GetRoutingSmsAvailablephonenumbers ¶

func (a RoutingApi) GetRoutingSmsAvailablephonenumbers(countryCode string, phoneNumberType string, region string, city string, areaCode string, pattern string, addressRequirement string) (*Smsavailablephonenumberentitylisting, *APIResponse, error)

GetRoutingSmsAvailablephonenumbers invokes GET /api/v2/routing/sms/availablephonenumbers

Get a list of available phone numbers for SMS provisioning.

This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.

func (RoutingApi) GetRoutingSmsPhonenumber ¶

func (a RoutingApi) GetRoutingSmsPhonenumber(addressId string) (*Smsphonenumber, *APIResponse, error)

GetRoutingSmsPhonenumber invokes GET /api/v2/routing/sms/phonenumbers/{addressId}

Get a phone number provisioned for SMS.

func (RoutingApi) GetRoutingSmsPhonenumbers ¶

func (a RoutingApi) GetRoutingSmsPhonenumbers(phoneNumber string, phoneNumberType string, phoneNumberStatus string, pageSize int, pageNumber int) (*Smsphonenumberentitylisting, *APIResponse, error)

GetRoutingSmsPhonenumbers invokes GET /api/v2/routing/sms/phonenumbers

Get a list of provisioned phone numbers.

func (RoutingApi) GetRoutingUserUtilization ¶

func (a RoutingApi) GetRoutingUserUtilization(userId string) (*Agentmaxutilization, *APIResponse, error)

GetRoutingUserUtilization invokes GET /api/v2/routing/users/{userId}/utilization

Get the user&#39;s max utilization settings. If not configured, the organization-wide default is returned.

func (RoutingApi) GetRoutingUtilization ¶

func (a RoutingApi) GetRoutingUtilization() (*Utilization, *APIResponse, error)

GetRoutingUtilization invokes GET /api/v2/routing/utilization

Get the organization-wide max utilization settings.

func (RoutingApi) GetRoutingWrapupcode ¶

func (a RoutingApi) GetRoutingWrapupcode(codeId string) (*Wrapupcode, *APIResponse, error)

GetRoutingWrapupcode invokes GET /api/v2/routing/wrapupcodes/{codeId}

Get details about this wrap-up code.

func (RoutingApi) GetRoutingWrapupcodes ¶

func (a RoutingApi) GetRoutingWrapupcodes(pageSize int, pageNumber int, sortBy string, sortOrder string, name string) (*Wrapupcodeentitylisting, *APIResponse, error)

GetRoutingWrapupcodes invokes GET /api/v2/routing/wrapupcodes

Get list of wrapup codes.

func (RoutingApi) GetUserQueues ¶

func (a RoutingApi) GetUserQueues(userId string, pageSize int, pageNumber int, joined bool, divisionId []string) (*Userqueueentitylisting, *APIResponse, error)

GetUserQueues invokes GET /api/v2/users/{userId}/queues

Get queues for user

func (RoutingApi) GetUserRoutinglanguages ¶

func (a RoutingApi) GetUserRoutinglanguages(userId string, pageSize int, pageNumber int, sortOrder string) (*Userlanguageentitylisting, *APIResponse, error)

GetUserRoutinglanguages invokes GET /api/v2/users/{userId}/routinglanguages

List routing language for user

func (RoutingApi) GetUserRoutingskills ¶

func (a RoutingApi) GetUserRoutingskills(userId string, pageSize int, pageNumber int, sortOrder string) (*Userskillentitylisting, *APIResponse, error)

GetUserRoutingskills invokes GET /api/v2/users/{userId}/routingskills

List routing skills for user

func (RoutingApi) PatchRoutingConversation ¶

func (a RoutingApi) PatchRoutingConversation(conversationId string, body Routingconversationattributes) (*Routingconversationattributes, *APIResponse, error)

PatchRoutingConversation invokes PATCH /api/v2/routing/conversations/{conversationId}

Update attributes of an in-queue conversation ¶

Returns an object indicating the updated values of all settable attributes. Supported attributes: priority (each point of priority is equivalent to one minute of time in queue).

func (RoutingApi) PatchRoutingEmailDomain ¶

func (a RoutingApi) PatchRoutingEmailDomain(domainId string, body Inbounddomainpatchrequest) (*Inbounddomain, *APIResponse, error)

PatchRoutingEmailDomain invokes PATCH /api/v2/routing/email/domains/{domainId}

Update domain settings

func (RoutingApi) PatchRoutingEmailDomainValidate ¶

func (a RoutingApi) PatchRoutingEmailDomainValidate(domainId string, body Inbounddomainpatchrequest) (*Inbounddomain, *APIResponse, error)

PatchRoutingEmailDomainValidate invokes PATCH /api/v2/routing/email/domains/{domainId}/validate

Validate domain settings

func (RoutingApi) PatchRoutingEmailOutboundDomain ¶

func (a RoutingApi) PatchRoutingEmailOutboundDomain(domainId string, body Outbounddomain) (*Outbounddomain, *APIResponse, error)

PatchRoutingEmailOutboundDomain invokes PATCH /api/v2/routing/email/outbound/domains/{domainId}

Request an update of the emails from /replyTo of an outbound domain

func (RoutingApi) PatchRoutingPredictor ¶

func (a RoutingApi) PatchRoutingPredictor(predictorId string, body Patchpredictorrequest) (*Predictor, *APIResponse, error)

PatchRoutingPredictor invokes PATCH /api/v2/routing/predictors/{predictorId}

Update single predictor.

func (RoutingApi) PatchRoutingQueueMember ¶

func (a RoutingApi) PatchRoutingQueueMember(queueId string, memberId string, body Queuemember) (*APIResponse, error)

PatchRoutingQueueMember invokes PATCH /api/v2/routing/queues/{queueId}/members/{memberId}

Update the ring number OR joined status for a queue member.

func (RoutingApi) PatchRoutingQueueMembers ¶

func (a RoutingApi) PatchRoutingQueueMembers(queueId string, body []Queuemember) (*Queuememberentitylisting, *APIResponse, error)

PatchRoutingQueueMembers invokes PATCH /api/v2/routing/queues/{queueId}/members

Join or unjoin a set of users for a queue

func (RoutingApi) PatchRoutingQueueUser ¶

func (a RoutingApi) PatchRoutingQueueUser(queueId string, memberId string, body Queuemember) (*APIResponse, error)

PatchRoutingQueueUser invokes PATCH /api/v2/routing/queues/{queueId}/users/{memberId}

DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.

func (RoutingApi) PatchRoutingQueueUsers ¶

func (a RoutingApi) PatchRoutingQueueUsers(queueId string, body []Queuemember) (*Queuememberentitylisting, *APIResponse, error)

PatchRoutingQueueUsers invokes PATCH /api/v2/routing/queues/{queueId}/users

DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.

func (RoutingApi) PatchRoutingSettingsContactcenter ¶

func (a RoutingApi) PatchRoutingSettingsContactcenter(body Contactcentersettings) (*APIResponse, error)

PatchRoutingSettingsContactcenter invokes PATCH /api/v2/routing/settings/contactcenter

Update Contact Center Settings

func (RoutingApi) PatchUserQueue ¶

func (a RoutingApi) PatchUserQueue(queueId string, userId string, body Userqueue) (*Userqueue, *APIResponse, error)

PatchUserQueue invokes PATCH /api/v2/users/{userId}/queues/{queueId}

Join or unjoin a queue for a user

func (RoutingApi) PatchUserQueues ¶

func (a RoutingApi) PatchUserQueues(userId string, body []Userqueue, divisionId []string) (*Userqueueentitylisting, *APIResponse, error)

PatchUserQueues invokes PATCH /api/v2/users/{userId}/queues

Join or unjoin a set of queues for a user

func (RoutingApi) PatchUserRoutinglanguage ¶

func (a RoutingApi) PatchUserRoutinglanguage(userId string, languageId string, body Userroutinglanguage) (*Userroutinglanguage, *APIResponse, error)

PatchUserRoutinglanguage invokes PATCH /api/v2/users/{userId}/routinglanguages/{languageId}

Update routing language proficiency or state.

func (RoutingApi) PatchUserRoutinglanguagesBulk ¶

func (a RoutingApi) PatchUserRoutinglanguagesBulk(userId string, body []Userroutinglanguagepost) (*Userlanguageentitylisting, *APIResponse, error)

PatchUserRoutinglanguagesBulk invokes PATCH /api/v2/users/{userId}/routinglanguages/bulk

Add bulk routing language to user. Max limit 50 languages

func (RoutingApi) PatchUserRoutingskillsBulk ¶

func (a RoutingApi) PatchUserRoutingskillsBulk(userId string, body []Userroutingskillpost) (*Userskillentitylisting, *APIResponse, error)

PatchUserRoutingskillsBulk invokes PATCH /api/v2/users/{userId}/routingskills/bulk

Bulk add routing skills to user

func (RoutingApi) PostAnalyticsQueuesObservationsQuery ¶

func (a RoutingApi) PostAnalyticsQueuesObservationsQuery(body Queueobservationquery) (*Queueobservationqueryresponse, *APIResponse, error)

PostAnalyticsQueuesObservationsQuery invokes POST /api/v2/analytics/queues/observations/query

Query for queue observations

func (RoutingApi) PostRoutingAssessments ¶

func (a RoutingApi) PostRoutingAssessments(body Createbenefitassessmentrequest) (*Benefitassessment, *APIResponse, error)

PostRoutingAssessments invokes POST /api/v2/routing/assessments

Create a benefit assessment.

func (RoutingApi) PostRoutingAssessmentsJobs ¶

func (a RoutingApi) PostRoutingAssessmentsJobs(body Createbenefitassessmentjobrequest) (*Benefitassessmentjob, *APIResponse, error)

PostRoutingAssessmentsJobs invokes POST /api/v2/routing/assessments/jobs

Create a benefit assessment job.

func (RoutingApi) PostRoutingEmailDomainRoutes ¶

func (a RoutingApi) PostRoutingEmailDomainRoutes(domainName string, body Inboundroute) (*Inboundroute, *APIResponse, error)

PostRoutingEmailDomainRoutes invokes POST /api/v2/routing/email/domains/{domainName}/routes

Create a route

func (RoutingApi) PostRoutingEmailDomainTestconnection ¶

func (a RoutingApi) PostRoutingEmailDomainTestconnection(domainId string, body Testmessage) (*Testmessage, *APIResponse, error)

PostRoutingEmailDomainTestconnection invokes POST /api/v2/routing/email/domains/{domainId}/testconnection

Tests the custom SMTP server integration connection set on this domain ¶

The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server.

func (RoutingApi) PostRoutingEmailDomains ¶

func (a RoutingApi) PostRoutingEmailDomains(body Inbounddomain) (*Inbounddomain, *APIResponse, error)

PostRoutingEmailDomains invokes POST /api/v2/routing/email/domains

Create a domain

func (RoutingApi) PostRoutingLanguages ¶

func (a RoutingApi) PostRoutingLanguages(body Language) (*Language, *APIResponse, error)

PostRoutingLanguages invokes POST /api/v2/routing/languages

Create Language

func (RoutingApi) PostRoutingPredictors ¶

func (a RoutingApi) PostRoutingPredictors(body Createpredictorrequest) (*Predictor, *APIResponse, error)

PostRoutingPredictors invokes POST /api/v2/routing/predictors

Create a predictor.

func (RoutingApi) PostRoutingQueueMembers ¶

func (a RoutingApi) PostRoutingQueueMembers(queueId string, body []Writableentity, delete bool) (*APIResponse, error)

PostRoutingQueueMembers invokes POST /api/v2/routing/queues/{queueId}/members

Bulk add or delete up to 100 queue members

func (RoutingApi) PostRoutingQueueUsers ¶

func (a RoutingApi) PostRoutingQueueUsers(queueId string, body []Writableentity, delete bool) (*APIResponse, error)

PostRoutingQueueUsers invokes POST /api/v2/routing/queues/{queueId}/users

DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.

func (RoutingApi) PostRoutingQueueWrapupcodes ¶

func (a RoutingApi) PostRoutingQueueWrapupcodes(queueId string, body []Wrapupcodereference) ([]Wrapupcode, *APIResponse, error)

PostRoutingQueueWrapupcodes invokes POST /api/v2/routing/queues/{queueId}/wrapupcodes

Add up to 100 wrap-up codes to a queue

func (RoutingApi) PostRoutingQueues ¶

func (a RoutingApi) PostRoutingQueues(body Createqueuerequest) (*Queue, *APIResponse, error)

PostRoutingQueues invokes POST /api/v2/routing/queues

Create a queue

func (RoutingApi) PostRoutingSkills ¶

func (a RoutingApi) PostRoutingSkills(body Routingskill) (*Routingskill, *APIResponse, error)

PostRoutingSkills invokes POST /api/v2/routing/skills

Create Skill

func (RoutingApi) PostRoutingSmsAddresses ¶

func (a RoutingApi) PostRoutingSmsAddresses(body Smsaddressprovision) (*Smsaddress, *APIResponse, error)

PostRoutingSmsAddresses invokes POST /api/v2/routing/sms/addresses

Provision an Address for SMS

func (RoutingApi) PostRoutingSmsPhonenumbers ¶

func (a RoutingApi) PostRoutingSmsPhonenumbers(body Smsphonenumberprovision) (*Smsphonenumber, *APIResponse, error)

PostRoutingSmsPhonenumbers invokes POST /api/v2/routing/sms/phonenumbers

Provision a phone number for SMS

func (RoutingApi) PostRoutingWrapupcodes ¶

func (a RoutingApi) PostRoutingWrapupcodes(body Wrapupcode) (*Wrapupcode, *APIResponse, error)

PostRoutingWrapupcodes invokes POST /api/v2/routing/wrapupcodes

Create a wrap-up code

func (RoutingApi) PostUserRoutinglanguages ¶

func (a RoutingApi) PostUserRoutinglanguages(userId string, body Userroutinglanguagepost) (*Userroutinglanguage, *APIResponse, error)

PostUserRoutinglanguages invokes POST /api/v2/users/{userId}/routinglanguages

Add routing language to user

func (RoutingApi) PostUserRoutingskills ¶

func (a RoutingApi) PostUserRoutingskills(userId string, body Userroutingskillpost) (*Userroutingskill, *APIResponse, error)

PostUserRoutingskills invokes POST /api/v2/users/{userId}/routingskills

Add routing skill to user

func (RoutingApi) PutRoutingEmailDomainRoute ¶

func (a RoutingApi) PutRoutingEmailDomainRoute(domainName string, routeId string, body Inboundroute) (*Inboundroute, *APIResponse, error)

PutRoutingEmailDomainRoute invokes PUT /api/v2/routing/email/domains/{domainName}/routes/{routeId}

Update a route

func (RoutingApi) PutRoutingMessageRecipient ¶

func (a RoutingApi) PutRoutingMessageRecipient(recipientId string, body Recipient) (*Recipient, *APIResponse, error)

PutRoutingMessageRecipient invokes PUT /api/v2/routing/message/recipients/{recipientId}

Update a recipient

func (RoutingApi) PutRoutingQueue ¶

func (a RoutingApi) PutRoutingQueue(queueId string, body Queuerequest) (*Queue, *APIResponse, error)

PutRoutingQueue invokes PUT /api/v2/routing/queues/{queueId}

Update a queue

func (RoutingApi) PutRoutingSettings ¶

func (a RoutingApi) PutRoutingSettings(body Routingsettings) (*Routingsettings, *APIResponse, error)

PutRoutingSettings invokes PUT /api/v2/routing/settings

Update an organization&#39;s routing settings

func (RoutingApi) PutRoutingSettingsTranscription ¶

func (a RoutingApi) PutRoutingSettingsTranscription(body Transcriptionsettings) (*Transcriptionsettings, *APIResponse, error)

PutRoutingSettingsTranscription invokes PUT /api/v2/routing/settings/transcription

Update Transcription Settings

func (RoutingApi) PutRoutingSmsPhonenumber ¶

func (a RoutingApi) PutRoutingSmsPhonenumber(addressId string, body Smsphonenumber) (*Smsphonenumber, *APIResponse, error)

PutRoutingSmsPhonenumber invokes PUT /api/v2/routing/sms/phonenumbers/{addressId}

Update a phone number provisioned for SMS.

func (RoutingApi) PutRoutingUserUtilization ¶

func (a RoutingApi) PutRoutingUserUtilization(userId string, body Utilization) (*Agentmaxutilization, *APIResponse, error)

PutRoutingUserUtilization invokes PUT /api/v2/routing/users/{userId}/utilization

Update the user&#39;s max utilization settings. Include only those media types requiring custom configuration.

func (RoutingApi) PutRoutingUtilization ¶

func (a RoutingApi) PutRoutingUtilization(body Utilization) (*Utilization, *APIResponse, error)

PutRoutingUtilization invokes PUT /api/v2/routing/utilization

Update the organization-wide max utilization settings. Include only those media types requiring custom configuration.

func (RoutingApi) PutRoutingWrapupcode ¶

func (a RoutingApi) PutRoutingWrapupcode(codeId string, body Wrapupcode) (*Wrapupcode, *APIResponse, error)

PutRoutingWrapupcode invokes PUT /api/v2/routing/wrapupcodes/{codeId}

Update wrap-up code

func (RoutingApi) PutUserRoutingskill ¶

func (a RoutingApi) PutUserRoutingskill(userId string, skillId string, body Userroutingskill) (*Userroutingskill, *APIResponse, error)

PutUserRoutingskill invokes PUT /api/v2/users/{userId}/routingskills/{skillId}

Update routing skill proficiency or state.

func (RoutingApi) PutUserRoutingskillsBulk ¶

func (a RoutingApi) PutUserRoutingskillsBulk(userId string, body []Userroutingskillpost) (*Userskillentitylisting, *APIResponse, error)

PutUserRoutingskillsBulk invokes PUT /api/v2/users/{userId}/routingskills/bulk

Replace all routing skills assigned to a user

type Routingconversationattributes ¶

type Routingconversationattributes struct {
	// Priority
	Priority *int `json:"priority,omitempty"`
}

Routingconversationattributes

func (*Routingconversationattributes) String ¶

String returns a JSON representation of the model

type Routingdata ¶

type Routingdata struct {
	// QueueId - The identifier of the routing queue
	QueueId *string `json:"queueId,omitempty"`

	// LanguageId - The identifier of a language to be considered in routing
	LanguageId *string `json:"languageId,omitempty"`

	// Priority - The priority for routing
	Priority *int `json:"priority,omitempty"`

	// SkillIds - A list of skill identifiers to be considered in routing
	SkillIds *[]string `json:"skillIds,omitempty"`

	// PreferredAgentIds - A list of agents to be preferred in routing
	PreferredAgentIds *[]string `json:"preferredAgentIds,omitempty"`

	// ScoredAgents - A list of scored agents for routing decisions
	ScoredAgents *[]Scoredagent `json:"scoredAgents,omitempty"`
}

Routingdata

func (*Routingdata) String ¶

func (o *Routingdata) String() string

String returns a JSON representation of the model

type Routingrule ¶

type Routingrule struct {
	// Operator - matching operator.  MEETS_THRESHOLD matches any agent with a score at or above the rule's threshold.  ANY matches all specified agents, regardless of score.
	Operator *string `json:"operator,omitempty"`

	// Threshold - threshold required for routing attempt (generally an agent score).  may be null for operator ANY.
	Threshold *int `json:"threshold,omitempty"`

	// WaitSeconds - seconds to wait in this rule before moving to the next
	WaitSeconds *float64 `json:"waitSeconds,omitempty"`
}

Routingrule

func (*Routingrule) String ¶

func (o *Routingrule) String() string

String returns a JSON representation of the model

type Routingsettings ¶

type Routingsettings struct {
	// ResetAgentScoreOnPresenceChange - Reset agent score when agent presence changes from off-queue to on-queue
	ResetAgentScoreOnPresenceChange *bool `json:"resetAgentScoreOnPresenceChange,omitempty"`
}

Routingsettings

func (*Routingsettings) String ¶

func (o *Routingsettings) String() string

String returns a JSON representation of the model

type Routingskill ¶

type Routingskill struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the skill.
	Name *string `json:"name,omitempty"`

	// DateModified - Date 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"`

	// State - The current state for this skill.
	State *string `json:"state,omitempty"`

	// Version - Required when updating. Version must be the current version. Only the system can assign version.
	Version *string `json:"version,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Routingskill

func (*Routingskill) String ¶

func (o *Routingskill) String() string

String returns a JSON representation of the model

type Routingskillreference ¶

type Routingskillreference 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"`
}

Routingskillreference

func (*Routingskillreference) String ¶

func (o *Routingskillreference) String() string

String returns a JSON representation of the model

type Routingstatus ¶

type Routingstatus struct {
	// UserId - The userId of the agent
	UserId *string `json:"userId,omitempty"`

	// Status - Indicates the Routing State of the agent.  A value of OFF_QUEUE will be returned if the specified user does not exist.
	Status *string `json:"status,omitempty"`

	// StartTime - The timestamp when the agent went into this state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	StartTime *time.Time `json:"startTime,omitempty"`
}

Routingstatus

func (*Routingstatus) String ¶

func (o *Routingstatus) String() string

String returns a JSON representation of the model

type Routingstatusdetailqueryclause ¶

type Routingstatusdetailqueryclause 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 *[]Routingstatusdetailquerypredicate `json:"predicates,omitempty"`
}

Routingstatusdetailqueryclause

func (*Routingstatusdetailqueryclause) String ¶

String returns a JSON representation of the model

type Routingstatusdetailqueryfilter ¶

type Routingstatusdetailqueryfilter 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 *[]Routingstatusdetailqueryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Routingstatusdetailquerypredicate `json:"predicates,omitempty"`
}

Routingstatusdetailqueryfilter

func (*Routingstatusdetailqueryfilter) String ¶

String returns a JSON representation of the model

type Routingstatusdetailquerypredicate ¶

type Routingstatusdetailquerypredicate 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"`
}

Routingstatusdetailquerypredicate

func (*Routingstatusdetailquerypredicate) String ¶

String returns a JSON representation of the model

type Ruleset ¶

type Ruleset struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the RuleSet.
	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 - A ContactList to provide user-interface suggestions for contact columns on relevant conditions and actions.
	ContactList *Domainentityref `json:"contactList,omitempty"`

	// Queue - A Queue to provide user-interface suggestions for wrap-up codes on relevant conditions and actions.
	Queue *Domainentityref `json:"queue,omitempty"`

	// Rules - The list of rules.
	Rules *[]Dialerrule `json:"rules,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Ruleset

func (*Ruleset) String ¶

func (o *Ruleset) String() string

String returns a JSON representation of the model

type Rulesetdiagnostic ¶

type Rulesetdiagnostic struct {
	// RuleSet - A campaign rule set
	RuleSet *Domainentityref `json:"ruleSet,omitempty"`

	// Warnings - Diagnostic warnings for the rule set
	Warnings *[]string `json:"warnings,omitempty"`
}

Rulesetdiagnostic

func (*Rulesetdiagnostic) String ¶

func (o *Rulesetdiagnostic) String() string

String returns a JSON representation of the model

type Rulesetentitylisting ¶

type Rulesetentitylisting struct {
	// Entities
	Entities *[]Ruleset `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Rulesetentitylisting

func (*Rulesetentitylisting) String ¶

func (o *Rulesetentitylisting) String() string

String returns a JSON representation of the model

type Runnowresponse ¶

type Runnowresponse struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Runnowresponse

func (*Runnowresponse) String ¶

func (o *Runnowresponse) String() string

String returns a JSON representation of the model

type SCIMApi ¶

type SCIMApi struct {
	Configuration *Configuration
}

SCIMApi provides functions for API endpoints

func NewSCIMApi ¶

func NewSCIMApi() *SCIMApi

NewSCIMApi creates an API instance using the default configuration

func NewSCIMApiWithConfig ¶

func NewSCIMApiWithConfig(config *Configuration) *SCIMApi

NewSCIMApiWithConfig creates an API instance using the provided configuration

func (SCIMApi) DeleteScimUser ¶

func (a SCIMApi) DeleteScimUser(userId string, ifMatch string) (*Empty, *APIResponse, error)

DeleteScimUser invokes DELETE /api/v2/scim/users/{userId}

Delete a user

func (SCIMApi) DeleteScimV2User ¶

func (a SCIMApi) DeleteScimV2User(userId string, ifMatch string) (*Empty, *APIResponse, error)

DeleteScimV2User invokes DELETE /api/v2/scim/v2/users/{userId}

Delete a user

func (SCIMApi) GetScimGroup ¶

func (a SCIMApi) GetScimGroup(groupId string, attributes []string, excludedAttributes []string, ifNoneMatch string) (*Scimv2group, *APIResponse, error)

GetScimGroup invokes GET /api/v2/scim/groups/{groupId}

Get a group

func (SCIMApi) GetScimGroups ¶

func (a SCIMApi) GetScimGroups(startIndex int, count int, attributes []string, excludedAttributes []string, filter string) (*Scimgrouplistresponse, *APIResponse, error)

GetScimGroups invokes GET /api/v2/scim/groups

Get a list of groups

func (SCIMApi) GetScimResourcetype ¶

func (a SCIMApi) GetScimResourcetype(resourceType string) (*Scimconfigresourcetype, *APIResponse, error)

GetScimResourcetype invokes GET /api/v2/scim/resourcetypes/{resourceType}

Get a resource type

func (SCIMApi) GetScimResourcetypes ¶

func (a SCIMApi) GetScimResourcetypes() (*Scimconfigresourcetypeslistresponse, *APIResponse, error)

GetScimResourcetypes invokes GET /api/v2/scim/resourcetypes

Get a list of resource types

func (SCIMApi) GetScimSchema ¶

func (a SCIMApi) GetScimSchema(schemaId string) (*Scimv2schemadefinition, *APIResponse, error)

GetScimSchema invokes GET /api/v2/scim/schemas/{schemaId}

Get a SCIM schema

func (SCIMApi) GetScimSchemas ¶

func (a SCIMApi) GetScimSchemas(filter string) (*Scimv2schemalistresponse, *APIResponse, error)

GetScimSchemas invokes GET /api/v2/scim/schemas

Get a list of SCIM schemas

func (SCIMApi) GetScimServiceproviderconfig ¶

func (a SCIMApi) GetScimServiceproviderconfig(ifNoneMatch string) (*Scimserviceproviderconfig, *APIResponse, error)

GetScimServiceproviderconfig invokes GET /api/v2/scim/serviceproviderconfig

Get a service provider&#39;s configuration

func (SCIMApi) GetScimUser ¶

func (a SCIMApi) GetScimUser(userId string, attributes []string, excludedAttributes []string, ifNoneMatch string) (*Scimv2user, *APIResponse, error)

GetScimUser invokes GET /api/v2/scim/users/{userId}

Get a user

func (SCIMApi) GetScimUsers ¶

func (a SCIMApi) GetScimUsers(startIndex int, count int, attributes []string, excludedAttributes []string, filter string) (*Scimuserlistresponse, *APIResponse, error)

GetScimUsers invokes GET /api/v2/scim/users

Get a list of users ¶

To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \&quot;active eq false\&quot;. By default, returns SCIM attributes \&quot;externalId\&quot;, \&quot;enterprise-user:manager\&quot;, and \&quot;roles\&quot;. To exclude these attributes, set the attributes parameter to \&quot;id,active\&quot; or the excludeAttributes parameter to \&quot;externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\&quot;.

func (SCIMApi) GetScimV2Group ¶

func (a SCIMApi) GetScimV2Group(groupId string, attributes []string, excludedAttributes []string, ifNoneMatch string) (*Scimv2group, *APIResponse, error)

GetScimV2Group invokes GET /api/v2/scim/v2/groups/{groupId}

Get a group

func (SCIMApi) GetScimV2Groups ¶

func (a SCIMApi) GetScimV2Groups(filter string, startIndex int, count int, attributes []string, excludedAttributes []string) (*Scimgrouplistresponse, *APIResponse, error)

GetScimV2Groups invokes GET /api/v2/scim/v2/groups

Get a list of groups

func (SCIMApi) GetScimV2Resourcetype ¶

func (a SCIMApi) GetScimV2Resourcetype(resourceType string) (*Scimconfigresourcetype, *APIResponse, error)

GetScimV2Resourcetype invokes GET /api/v2/scim/v2/resourcetypes/{resourceType}

Get a resource type

func (SCIMApi) GetScimV2Resourcetypes ¶

func (a SCIMApi) GetScimV2Resourcetypes() (*Scimconfigresourcetypeslistresponse, *APIResponse, error)

GetScimV2Resourcetypes invokes GET /api/v2/scim/v2/resourcetypes

Get a list of resource types

func (SCIMApi) GetScimV2Schema ¶

func (a SCIMApi) GetScimV2Schema(schemaId string) (*Scimv2schemadefinition, *APIResponse, error)

GetScimV2Schema invokes GET /api/v2/scim/v2/schemas/{schemaId}

Get a SCIM schema

func (SCIMApi) GetScimV2Schemas ¶

func (a SCIMApi) GetScimV2Schemas(filter string) (*Scimv2schemalistresponse, *APIResponse, error)

GetScimV2Schemas invokes GET /api/v2/scim/v2/schemas

Get a list of SCIM schemas

func (SCIMApi) GetScimV2Serviceproviderconfig ¶

func (a SCIMApi) GetScimV2Serviceproviderconfig(ifNoneMatch string) (*Scimserviceproviderconfig, *APIResponse, error)

GetScimV2Serviceproviderconfig invokes GET /api/v2/scim/v2/serviceproviderconfig

Get a service provider&#39;s configuration

func (SCIMApi) GetScimV2User ¶

func (a SCIMApi) GetScimV2User(userId string, attributes []string, excludedAttributes []string, ifNoneMatch string) (*Scimv2user, *APIResponse, error)

GetScimV2User invokes GET /api/v2/scim/v2/users/{userId}

Get a user

func (SCIMApi) GetScimV2Users ¶

func (a SCIMApi) GetScimV2Users(startIndex int, count int, attributes []string, excludedAttributes []string, filter string) (*Scimuserlistresponse, *APIResponse, error)

GetScimV2Users invokes GET /api/v2/scim/v2/users

Get a list of users ¶

To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \&quot;active eq false\&quot;. By default, returns SCIM attributes \&quot;externalId\&quot;, \&quot;enterprise-user:manager\&quot;, and \&quot;roles\&quot;. To exclude these attributes, set the attributes parameter to \&quot;id,active\&quot; or the excludeAttributes parameter to \&quot;externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\&quot;.

func (SCIMApi) PatchScimGroup ¶

func (a SCIMApi) PatchScimGroup(groupId string, body Scimv2patchrequest, ifMatch string) (*Scimv2group, *APIResponse, error)

PatchScimGroup invokes PATCH /api/v2/scim/groups/{groupId}

Modify a group

func (SCIMApi) PatchScimUser ¶

func (a SCIMApi) PatchScimUser(userId string, body Scimv2patchrequest, ifMatch string) (*Scimv2user, *APIResponse, error)

PatchScimUser invokes PATCH /api/v2/scim/users/{userId}

Modify a user

func (SCIMApi) PatchScimV2Group ¶

func (a SCIMApi) PatchScimV2Group(groupId string, body Scimv2patchrequest, ifMatch string) (*Scimv2group, *APIResponse, error)

PatchScimV2Group invokes PATCH /api/v2/scim/v2/groups/{groupId}

Modify a group

func (SCIMApi) PatchScimV2User ¶

func (a SCIMApi) PatchScimV2User(userId string, body Scimv2patchrequest, ifMatch string) (*Scimv2user, *APIResponse, error)

PatchScimV2User invokes PATCH /api/v2/scim/v2/users/{userId}

Modify a user

func (SCIMApi) PostScimUsers ¶

func (a SCIMApi) PostScimUsers(body Scimv2createuser) (*Scimv2user, *APIResponse, error)

PostScimUsers invokes POST /api/v2/scim/users

Create a user

func (SCIMApi) PostScimV2Users ¶

func (a SCIMApi) PostScimV2Users(body Scimv2createuser) (*Scimv2user, *APIResponse, error)

PostScimV2Users invokes POST /api/v2/scim/v2/users

Create a user

func (SCIMApi) PutScimGroup ¶

func (a SCIMApi) PutScimGroup(groupId string, body Scimv2group, ifMatch string) (*Scimv2group, *APIResponse, error)

PutScimGroup invokes PUT /api/v2/scim/groups/{groupId}

Replace a group

func (SCIMApi) PutScimUser ¶

func (a SCIMApi) PutScimUser(userId string, body Scimv2user, ifMatch string) (*Scimv2user, *APIResponse, error)

PutScimUser invokes PUT /api/v2/scim/users/{userId}

Replace a user

func (SCIMApi) PutScimV2Group ¶

func (a SCIMApi) PutScimV2Group(groupId string, body Scimv2group, ifMatch string) (*Scimv2group, *APIResponse, error)

PutScimV2Group invokes PUT /api/v2/scim/v2/groups/{groupId}

Replace a group

func (SCIMApi) PutScimV2User ¶

func (a SCIMApi) PutScimV2User(userId string, body Scimv2user, ifMatch string) (*Scimv2user, *APIResponse, error)

PutScimV2User invokes PUT /api/v2/scim/v2/users/{userId}

Replace a user

type Salesforce ¶

type Salesforce 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"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Salesforce

func (*Salesforce) String ¶

func (o *Salesforce) String() string

String returns a JSON representation of the model

type Scaleasgresponse ¶

type Scaleasgresponse struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// DesiredCapacity - Desired capacity for the ASG
	DesiredCapacity *int `json:"desiredCapacity,omitempty"`

	// MinSize - Minimum size for the ASG
	MinSize *int `json:"minSize,omitempty"`

	// MaxSize - Maximum size for the ASG
	MaxSize *int `json:"maxSize,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Scaleasgresponse

func (*Scaleasgresponse) String ¶

func (o *Scaleasgresponse) String() string

String returns a JSON representation of the model

type Schedule ¶

type Schedule struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// Start - Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS
	Start *time.Time `json:"start,omitempty"`

	// End - Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS
	End *time.Time `json:"end,omitempty"`

	// Rrule - An iCal Recurrence Rule (RRULE) string.
	Rrule *string `json:"rrule,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Schedule - Defines a period of time to perform a specific action. Each schedule must be associated with one or more schedule groups to be used.

func (*Schedule) String ¶

func (o *Schedule) String() string

String returns a JSON representation of the model

type Scheduleentitylisting ¶

type Scheduleentitylisting struct {
	// Entities
	Entities *[]Schedule `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Scheduleentitylisting

func (*Scheduleentitylisting) String ¶

func (o *Scheduleentitylisting) String() string

String returns a JSON representation of the model

type Schedulegenerationmessage ¶

type Schedulegenerationmessage struct {
	// VarType - The type of the message
	VarType *string `json:"type,omitempty"`

	// Arguments - The arguments describing the message
	Arguments *[]Schedulermessageargument `json:"arguments,omitempty"`
}

Schedulegenerationmessage

func (*Schedulegenerationmessage) String ¶

func (o *Schedulegenerationmessage) String() string

String returns a JSON representation of the model

type Schedulegenerationresult ¶

type Schedulegenerationresult struct {
	// Failed - Whether the schedule generation run failed
	Failed *bool `json:"failed,omitempty"`

	// RunId - The run ID for the schedule generation. Reference this when requesting support
	RunId *string `json:"runId,omitempty"`

	// MessageCount - The number of schedule generation messages for this schedule generation run
	MessageCount *int `json:"messageCount,omitempty"`

	// Messages - User facing messages related to the schedule generation run
	Messages *[]Schedulegenerationmessage `json:"messages,omitempty"`
}

Schedulegenerationresult

func (*Schedulegenerationresult) String ¶

func (o *Schedulegenerationresult) String() string

String returns a JSON representation of the model

type Schedulegenerationresultsummary ¶

type Schedulegenerationresultsummary struct {
	// Failed - Whether the schedule generation run failed
	Failed *bool `json:"failed,omitempty"`

	// RunId - The run ID for the schedule generation. Reference this when requesting support
	RunId *string `json:"runId,omitempty"`

	// MessageCount - The number of schedule generation messages for this schedule generation run
	MessageCount *int `json:"messageCount,omitempty"`
}

Schedulegenerationresultsummary

func (*Schedulegenerationresultsummary) String ¶

String returns a JSON representation of the model

type Schedulegenerationwarning ¶

type Schedulegenerationwarning struct {
	// UserId - ID of the user in the warning
	UserId *string `json:"userId,omitempty"`

	// UserNotLicensed - Whether the user does not have the appropriate license to be scheduled
	UserNotLicensed *bool `json:"userNotLicensed,omitempty"`

	// UnableToMeetMaxDays - Whether the number of scheduled days exceeded the maximum days to schedule defined in the agent work plan
	UnableToMeetMaxDays *bool `json:"unableToMeetMaxDays,omitempty"`

	// UnableToScheduleRequiredDays - Days indicated as required to work in agent work plan where no viable shift was found to schedule
	UnableToScheduleRequiredDays *[]string `json:"unableToScheduleRequiredDays,omitempty"`

	// UnableToMeetMinPaidForTheWeek - Whether the schedule did not meet the minimum paid time for the week defined in the agent work plan
	UnableToMeetMinPaidForTheWeek *bool `json:"unableToMeetMinPaidForTheWeek,omitempty"`

	// UnableToMeetMaxPaidForTheWeek - Whether the schedule exceeded the maximum paid time for the week defined in the agent work plan
	UnableToMeetMaxPaidForTheWeek *bool `json:"unableToMeetMaxPaidForTheWeek,omitempty"`

	// NoNeedDays - Days agent was scheduled but there was no need to meet. The scheduled days have no effect on service levels
	NoNeedDays *[]string `json:"noNeedDays,omitempty"`

	// ShiftsTooCloseTogether - Whether the schedule did not meet the minimum time between shifts defined in the agent work plan
	ShiftsTooCloseTogether *bool `json:"shiftsTooCloseTogether,omitempty"`
}

Schedulegenerationwarning - Schedule generation warning

func (*Schedulegenerationwarning) String ¶

func (o *Schedulegenerationwarning) String() string

String returns a JSON representation of the model

type Schedulegroup ¶

type Schedulegroup struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// TimeZone - The timezone the schedules are a part of.  This is not a schedule property to allow a schedule to be used in multiple timezones.
	TimeZone *string `json:"timeZone,omitempty"`

	// OpenSchedules - The schedules defining the hours an organization is open.
	OpenSchedules *[]Domainentityref `json:"openSchedules,omitempty"`

	// ClosedSchedules - The schedules defining the hours an organization is closed.
	ClosedSchedules *[]Domainentityref `json:"closedSchedules,omitempty"`

	// HolidaySchedules - The schedules defining the hours an organization is closed for the holidays.
	HolidaySchedules *[]Domainentityref `json:"holidaySchedules,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Schedulegroup - A group of schedules that define the operating hours of an organization.

func (*Schedulegroup) String ¶

func (o *Schedulegroup) String() string

String returns a JSON representation of the model

type Schedulegroupentitylisting ¶

type Schedulegroupentitylisting struct {
	// Entities
	Entities *[]Schedulegroup `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Schedulegroupentitylisting

func (*Schedulegroupentitylisting) String ¶

func (o *Schedulegroupentitylisting) String() string

String returns a JSON representation of the model

type Scheduleinterval ¶

type Scheduleinterval struct {
	// Start - The scheduled start time as an ISO-8601 string, i.e yyyy-MM-ddTHH:mm:ss.SSSZ
	Start *string `json:"start,omitempty"`

	// End - The scheduled end time as an ISO-8601 string, i.e. yyyy-MM-ddTHH:mm:ss.SSSZ
	End *string `json:"end,omitempty"`
}

Scheduleinterval

func (*Scheduleinterval) String ¶

func (o *Scheduleinterval) String() string

String returns a JSON representation of the model

type Schedulermessageargument ¶

type Schedulermessageargument struct {
	// VarType - The type of this message parameter
	VarType *string `json:"type,omitempty"`

	// Value - The value of this message parameter
	Value *string `json:"value,omitempty"`
}

Schedulermessageargument

func (*Schedulermessageargument) String ¶

func (o *Schedulermessageargument) String() string

String returns a JSON representation of the model

type Schedulingprocessingerror ¶

type Schedulingprocessingerror struct {
	// InternalErrorCode - An internal code representing the type of error. BadJson for 'Unable to parse json.' NotFound for 'Resource not found.' Fail for 'An unexpected server error occured.'
	InternalErrorCode *string `json:"internalErrorCode,omitempty"`

	// Description - A text description of the error
	Description *string `json:"description,omitempty"`
}

Schedulingprocessingerror

func (*Schedulingprocessingerror) String ¶

func (o *Schedulingprocessingerror) String() string

String returns a JSON representation of the model

type Schedulingsettingsrequest ¶

type Schedulingsettingsrequest struct {
	// MaxOccupancyPercentForDeferredWork - Max occupancy percent for deferred work
	MaxOccupancyPercentForDeferredWork *int `json:"maxOccupancyPercentForDeferredWork,omitempty"`

	// DefaultShrinkagePercent - Default shrinkage percent for scheduling
	DefaultShrinkagePercent *float64 `json:"defaultShrinkagePercent,omitempty"`

	// ShrinkageOverrides - Shrinkage overrides for scheduling
	ShrinkageOverrides *Shrinkageoverrides `json:"shrinkageOverrides,omitempty"`

	// PlanningPeriod - Planning period settings for scheduling
	PlanningPeriod *Valuewrapperplanningperiodsettings `json:"planningPeriod,omitempty"`

	// StartDayOfWeekend - Start day of weekend for scheduling
	StartDayOfWeekend *string `json:"startDayOfWeekend,omitempty"`
}

Schedulingsettingsrequest - Scheduling Settings

func (*Schedulingsettingsrequest) String ¶

func (o *Schedulingsettingsrequest) String() string

String returns a JSON representation of the model

type Schedulingsettingsresponse ¶

type Schedulingsettingsresponse struct {
	// MaxOccupancyPercentForDeferredWork - Max occupancy percent for deferred work
	MaxOccupancyPercentForDeferredWork *int `json:"maxOccupancyPercentForDeferredWork,omitempty"`

	// DefaultShrinkagePercent - Default shrinkage percent for scheduling
	DefaultShrinkagePercent *float64 `json:"defaultShrinkagePercent,omitempty"`

	// ShrinkageOverrides - Shrinkage overrides for scheduling
	ShrinkageOverrides *Shrinkageoverrides `json:"shrinkageOverrides,omitempty"`

	// PlanningPeriod - Planning period settings for scheduling
	PlanningPeriod *Planningperiodsettings `json:"planningPeriod,omitempty"`

	// StartDayOfWeekend - Start day of weekend for scheduling
	StartDayOfWeekend *string `json:"startDayOfWeekend,omitempty"`
}

Schedulingsettingsresponse - Scheduling Settings

func (*Schedulingsettingsresponse) String ¶

func (o *Schedulingsettingsresponse) String() string

String returns a JSON representation of the model

type Schedulingstatusresponse ¶

type Schedulingstatusresponse struct {
	// Id - The ID generated for the scheduling job.  Use to GET result when job is completed.
	Id *string `json:"id,omitempty"`

	// Status - The status of the scheduling job.
	Status *string `json:"status,omitempty"`

	// ErrorDetails - If the request could not be properly processed, error details will be given here.
	ErrorDetails *[]Schedulingprocessingerror `json:"errorDetails,omitempty"`

	// SchedulingResultUri - The uri of the scheduling result. It has a value if the status is 'Success'.
	SchedulingResultUri *string `json:"schedulingResultUri,omitempty"`

	// PercentComplete - The percentage of the job that is complete.
	PercentComplete *int `json:"percentComplete,omitempty"`
}

Schedulingstatusresponse

func (*Schedulingstatusresponse) String ¶

func (o *Schedulingstatusresponse) String() string

String returns a JSON representation of the model

type Schedulingtestingoptionsrequest ¶

type Schedulingtestingoptionsrequest struct {
	// FastScheduling - Whether to enable fast scheduling
	FastScheduling *bool `json:"fastScheduling,omitempty"`

	// DelayScheduling - Whether to force delayed scheduling
	DelayScheduling *bool `json:"delayScheduling,omitempty"`

	// FailScheduling - Whether to force scheduling to fail
	FailScheduling *bool `json:"failScheduling,omitempty"`

	// PopulateWarnings - Whether to populate warnings in the generated schedule
	PopulateWarnings *bool `json:"populateWarnings,omitempty"`
}

Schedulingtestingoptionsrequest

func (*Schedulingtestingoptionsrequest) String ¶

String returns a JSON representation of the model

type Schema ¶

type Schema struct {
	// Title - A core type's title
	Title *string `json:"title,omitempty"`

	// Description - A core type's description
	Description *string `json:"description,omitempty"`

	// VarType - An array of fundamental JSON Schema primitive types on which the core type is based
	VarType *[]string `json:"type,omitempty"`

	// Items - Denotes the type and pattern of the items in an enum core type
	Items *Items `json:"items,omitempty"`

	// Pattern - For the \"date\" and \"datetime\" core types, denotes the regex prescribing the allowable date/datetime format
	Pattern *string `json:"pattern,omitempty"`
}

Schema

func (*Schema) String ¶

func (o *Schema) String() string

String returns a JSON representation of the model

type Schemacategory ¶

type Schemacategory struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Schemacategory

func (*Schemacategory) String ¶

func (o *Schemacategory) String() string

String returns a JSON representation of the model

type Schemacategoryentitylisting ¶

type Schemacategoryentitylisting struct {
	// Entities
	Entities *[]Schemacategory `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Schemacategoryentitylisting

func (*Schemacategoryentitylisting) String ¶

func (o *Schemacategoryentitylisting) String() string

String returns a JSON representation of the model

type Schemaquantitylimits ¶

type Schemaquantitylimits struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// MinFieldNameCharacters - The minimum number of schema field name characters allowed.
	MinFieldNameCharacters *int `json:"minFieldNameCharacters,omitempty"`

	// MaxFieldNameCharacters - The maximum number of schema field name characters allowed.
	MaxFieldNameCharacters *int `json:"maxFieldNameCharacters,omitempty"`

	// MinFieldDescriptionCharacters - The minimum number of schema field description characters allowed.
	MinFieldDescriptionCharacters *int `json:"minFieldDescriptionCharacters,omitempty"`

	// MaxFieldDescriptionCharacters - The maximum number of schema field description characters allowed.
	MaxFieldDescriptionCharacters *int `json:"maxFieldDescriptionCharacters,omitempty"`

	// MinSchemaNameCharacters - The minimum number of schema name characters allowed.
	MinSchemaNameCharacters *int `json:"minSchemaNameCharacters,omitempty"`

	// MaxSchemaNameCharacters - The maximum number of schema name characters allowed.
	MaxSchemaNameCharacters *int `json:"maxSchemaNameCharacters,omitempty"`

	// MinSchemaDescriptionCharacters - The minimum number of schema description characters allowed.
	MinSchemaDescriptionCharacters *int `json:"minSchemaDescriptionCharacters,omitempty"`

	// MaxSchemaDescriptionCharacters - The maximum number of schema description characters allowed.
	MaxSchemaDescriptionCharacters *int `json:"maxSchemaDescriptionCharacters,omitempty"`

	// MaxNumberOfSchemasPerOrg - The maximum number of schema allowed per org.
	MaxNumberOfSchemasPerOrg *int `json:"maxNumberOfSchemasPerOrg,omitempty"`

	// MaxNumberOfFieldsPerSchema - The maximum number of schema fields allowed per schema.
	MaxNumberOfFieldsPerSchema *int `json:"maxNumberOfFieldsPerSchema,omitempty"`

	// MaxNumberOfFieldsPerOrg - The maximum number of schema fields allowed per organization across all of their schemas.
	MaxNumberOfFieldsPerOrg *int `json:"maxNumberOfFieldsPerOrg,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Schemaquantitylimits

func (*Schemaquantitylimits) String ¶

func (o *Schemaquantitylimits) String() string

String returns a JSON representation of the model

type Schemareferenceentitylisting ¶

type Schemareferenceentitylisting struct {
	// Entities
	Entities *[]Domainschemareference `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Schemareferenceentitylisting

func (*Schemareferenceentitylisting) String ¶

String returns a JSON representation of the model

type Scimconfigresourcetype ¶

type Scimconfigresourcetype struct {
	// Id - The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".
	Id *string `json:"id,omitempty"`

	// Schemas - The list of supported schemas.
	Schemas *[]string `json:"schemas,omitempty"`

	// Name - The name of the resource type.
	Name *string `json:"name,omitempty"`

	// Description - The description of the resource type.
	Description *string `json:"description,omitempty"`

	// Schema - The URI of the primary or base schema for the resource type.
	Schema *string `json:"schema,omitempty"`

	// SchemaExtensions - The list of schema extensions for the resource type.
	SchemaExtensions *[]Scimconfigresourcetypeschemaextension `json:"schemaExtensions,omitempty"`

	// Endpoint - The HTTP-addressable endpoint of the resource type. Appears after the base URL.
	Endpoint *string `json:"endpoint,omitempty"`

	// Meta - The metadata of the SCIM resource. Only \"location\" and \"resourceType\" are set for \"ResourceType\" resources.
	Meta *Scimmetadata `json:"meta,omitempty"`
}

Scimconfigresourcetype - Defines a SCIM resource.

func (*Scimconfigresourcetype) String ¶

func (o *Scimconfigresourcetype) String() string

String returns a JSON representation of the model

type Scimconfigresourcetypeschemaextension ¶

type Scimconfigresourcetypeschemaextension struct {
	// Schema - The URI of an extended schema, for example, \"urn:edu:2.0:Staff\". Must be equal to the \"id\" attribute of a schema.
	Schema *string `json:"schema,omitempty"`

	// Required - Indicates whether a schema extension is required.
	Required *bool `json:"required,omitempty"`
}

Scimconfigresourcetypeschemaextension - Defines a SCIM resource type's schema extension.

func (*Scimconfigresourcetypeschemaextension) String ¶

String returns a JSON representation of the model

type Scimconfigresourcetypeslistresponse ¶

type Scimconfigresourcetypeslistresponse struct {
	// TotalResults - The total number of results.
	TotalResults *int `json:"totalResults,omitempty"`

	// StartIndex - The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.
	StartIndex *int `json:"startIndex,omitempty"`

	// ItemsPerPage - The number of resources returned per page.
	ItemsPerPage *int `json:"itemsPerPage,omitempty"`

	// Resources - The list of requested resources.
	Resources *[]Scimconfigresourcetype `json:"Resources,omitempty"`

	// Schemas - The list of supported schemas.
	Schemas *[]string `json:"schemas,omitempty"`
}

Scimconfigresourcetypeslistresponse - Defines a response for a list of SCIM resource types.

func (*Scimconfigresourcetypeslistresponse) String ¶

String returns a JSON representation of the model

type Scimemail ¶

type Scimemail struct {
	// Value - The email address. Is immutable if \"type\" is set to \"other\".
	Value *string `json:"value,omitempty"`

	// VarType - The type of email address. \"value\" is immutable if \"type\" is set to \"other\".
	VarType *string `json:"type,omitempty"`

	// Primary - Indicates whether the email address is the primary email address.
	Primary *bool `json:"primary,omitempty"`
}

Scimemail - Defines a SCIM email address.

func (*Scimemail) String ¶

func (o *Scimemail) String() string

String returns a JSON representation of the model

type Scimerror ¶

type Scimerror struct {
	// Status - The HTTP status code returned for the SCIM error.
	Status *string `json:"status,omitempty"`

	// ScimType - The type of SCIM error when httpStatus is a \"400\" error.
	ScimType *string `json:"scimType,omitempty"`

	// Detail - The detailed description of the SCIM error.
	Detail *string `json:"detail,omitempty"`

	// Schemas - The list of schemas for the SCIM error.
	Schemas *[]string `json:"schemas,omitempty"`
}

Scimerror - Defines a SCIM error.

func (*Scimerror) String ¶

func (o *Scimerror) String() string

String returns a JSON representation of the model

type Scimgenesysuserexternalid ¶

type Scimgenesysuserexternalid struct {
	// Authority - Authority, or scope, of \"externalId\". Allows multiple external identifiers to be defined. Represents the source of the external identifier.
	Authority *string `json:"authority,omitempty"`

	// Value - Identifier of the user in an external system.
	Value *string `json:"value,omitempty"`
}

Scimgenesysuserexternalid - External Identifiers of user. The external identifier must be unique within the organization and the 'authority'

func (*Scimgenesysuserexternalid) String ¶

func (o *Scimgenesysuserexternalid) String() string

String returns a JSON representation of the model

type Scimgrouplistresponse ¶

type Scimgrouplistresponse struct {
	// TotalResults - The total number of results.
	TotalResults *int `json:"totalResults,omitempty"`

	// StartIndex - The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.
	StartIndex *int `json:"startIndex,omitempty"`

	// ItemsPerPage - The number of resources returned per page.
	ItemsPerPage *int `json:"itemsPerPage,omitempty"`

	// Resources - The list of requested resources. If \"count\" is 0, then the list will be empty.
	Resources *[]Scimv2group `json:"Resources,omitempty"`

	// Schemas - The list of supported schemas.
	Schemas *[]string `json:"schemas,omitempty"`
}

Scimgrouplistresponse - Defines a response for a list of SCIM groups.

func (*Scimgrouplistresponse) String ¶

func (o *Scimgrouplistresponse) String() string

String returns a JSON representation of the model

type Scimmetadata ¶

type Scimmetadata struct {
	// ResourceType - The type of SCIM resource.
	ResourceType *string `json:"resourceType,omitempty"`

	// LastModified - The last time that the resource was modified. Date time is represented as an \"ISO-8601 string\", for example, yyyy-MM-ddTHH:mm:ss.SSSZ. Not included with \"Schema\" and \"ResourceType\" resources.
	LastModified *time.Time `json:"lastModified,omitempty"`

	// Location - The URI of the resource.
	Location *string `json:"location,omitempty"`

	// Version - The version of the resource. Matches the ETag HTTP response header. Not included with \"Schema\" and \"ResourceType\" resources.
	Version *string `json:"version,omitempty"`
}

Scimmetadata - Defines the SCIM metadata.

func (*Scimmetadata) String ¶

func (o *Scimmetadata) String() string

String returns a JSON representation of the model

type Scimphonenumber ¶

type Scimphonenumber struct {
	// Value - The phone number in E.164 or tel URI format, for example, tel:+nnnnnnnn; ext=xxxxx.
	Value *string `json:"value,omitempty"`

	// VarType - The type of phone number.
	VarType *string `json:"type,omitempty"`

	// Primary - Indicates whether the phone number is the primary phone number.
	Primary *bool `json:"primary,omitempty"`
}

Scimphonenumber - Defines a SCIM phone number.

func (*Scimphonenumber) String ¶

func (o *Scimphonenumber) String() string

String returns a JSON representation of the model

type Scimserviceproviderconfig ¶

type Scimserviceproviderconfig struct {
	// Schemas - The list of supported schemas.
	Schemas *[]string `json:"schemas,omitempty"`

	// DocumentationUri - The HTTP-addressable URL that points to the service provider's documentation.
	DocumentationUri *string `json:"documentationUri,omitempty"`

	// Patch - The \"patch\" configuration options.
	Patch *Scimserviceproviderconfigsimplefeature `json:"patch,omitempty"`

	// Filter - The \"filter\" configuration options.
	Filter *Scimserviceproviderconfigfilterfeature `json:"filter,omitempty"`

	// Etag - The \"etag\" configuration options.
	Etag *Scimserviceproviderconfigsimplefeature `json:"etag,omitempty"`

	// Sort - The \"sort\" configuration options.
	Sort *Scimserviceproviderconfigsimplefeature `json:"sort,omitempty"`

	// Bulk - The \"bulk\" configuration options.
	Bulk *Scimserviceproviderconfigbulkfeature `json:"bulk,omitempty"`

	// ChangePassword - The \"changePassword\" configuration options.
	ChangePassword *Scimserviceproviderconfigsimplefeature `json:"changePassword,omitempty"`

	// AuthenticationSchemes - The list of supported authentication schemes.
	AuthenticationSchemes *[]Scimserviceproviderconfigauthenticationscheme `json:"authenticationSchemes,omitempty"`

	// Meta - The metadata of the SCIM resource.
	Meta *Scimmetadata `json:"meta,omitempty"`
}

Scimserviceproviderconfig - Defines a SCIM service provider's configuration.

func (*Scimserviceproviderconfig) String ¶

func (o *Scimserviceproviderconfig) String() string

String returns a JSON representation of the model

type Scimserviceproviderconfigauthenticationscheme ¶

type Scimserviceproviderconfigauthenticationscheme struct {
	// Name - The name of the authentication scheme, for example, HTTP Basic.
	Name *string `json:"name,omitempty"`

	// Description - The description of the authentication scheme.
	Description *string `json:"description,omitempty"`

	// SpecUri - The HTTP-addressable URL that points to the authentication scheme's specification.
	SpecUri *string `json:"specUri,omitempty"`

	// DocumentationUri - The HTTP-addressable URL that points to the authentication scheme's usage documentation.
	DocumentationUri *string `json:"documentationUri,omitempty"`

	// VarType - The type of authentication scheme.
	VarType *string `json:"type,omitempty"`

	// Primary - Indicates whether this authentication scheme is the primary method of authentication.
	Primary *bool `json:"primary,omitempty"`
}

Scimserviceproviderconfigauthenticationscheme - Defines an authentication scheme in the SCIM service provider's configuration.

func (*Scimserviceproviderconfigauthenticationscheme) String ¶

String returns a JSON representation of the model

type Scimserviceproviderconfigbulkfeature ¶

type Scimserviceproviderconfigbulkfeature struct {
	// Supported - Indicates whether configuration options are supported.
	Supported *bool `json:"supported,omitempty"`

	// MaxOperations - The maximum number of operations for each bulk request.
	MaxOperations *int `json:"maxOperations,omitempty"`

	// MaxPayloadSize - The maximum payload size.
	MaxPayloadSize *int `json:"maxPayloadSize,omitempty"`
}

Scimserviceproviderconfigbulkfeature - Defines a \"bulk\" request in the SCIM service provider's configuration.

func (*Scimserviceproviderconfigbulkfeature) String ¶

String returns a JSON representation of the model

type Scimserviceproviderconfigfilterfeature ¶

type Scimserviceproviderconfigfilterfeature struct {
	// Supported - Indicates whether configuration options are supported.
	Supported *bool `json:"supported,omitempty"`

	// MaxResults - The maximum number of results returned from a filtered query.
	MaxResults *int `json:"maxResults,omitempty"`
}

Scimserviceproviderconfigfilterfeature - Defines a \"filter\" request in the SCIM service provider's configuration.

func (*Scimserviceproviderconfigfilterfeature) String ¶

String returns a JSON representation of the model

type Scimserviceproviderconfigsimplefeature ¶

type Scimserviceproviderconfigsimplefeature struct {
	// Supported - Indicates whether configuration options are supported.
	Supported *bool `json:"supported,omitempty"`
}

Scimserviceproviderconfigsimplefeature - Defines a request in the SCIM service provider's configuration.

func (*Scimserviceproviderconfigsimplefeature) String ¶

String returns a JSON representation of the model

type Scimuserextensions ¶

type Scimuserextensions struct {
	// RoutingSkills - The list of routing skills assigned to a user. Maximum 50 skills.
	RoutingSkills *[]Scimuserroutingskill `json:"routingSkills,omitempty"`

	// RoutingLanguages - The list of routing languages assigned to a user. Maximum 50 languages.
	RoutingLanguages *[]Scimuserroutinglanguage `json:"routingLanguages,omitempty"`

	// ExternalIds - The list of external identifiers assigned to user. Always includes an immutable SCIM authority prefixed with \"x-pc:scimv2:v1\".
	ExternalIds *[]Scimgenesysuserexternalid `json:"externalIds,omitempty"`
}

Scimuserextensions - Genesys Cloud user extensions to SCIM RFC.

func (*Scimuserextensions) String ¶

func (o *Scimuserextensions) String() string

String returns a JSON representation of the model

type Scimuserlistresponse ¶

type Scimuserlistresponse struct {
	// TotalResults - The total number of results.
	TotalResults *int `json:"totalResults,omitempty"`

	// StartIndex - The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.
	StartIndex *int `json:"startIndex,omitempty"`

	// ItemsPerPage - The number of resources returned per page.
	ItemsPerPage *int `json:"itemsPerPage,omitempty"`

	// Resources - The list of requested resources. If \"count\" is 0, then the list will be empty.
	Resources *[]Scimv2user `json:"Resources,omitempty"`

	// Schemas - The list of supported schemas.
	Schemas *[]string `json:"schemas,omitempty"`
}

Scimuserlistresponse - Defines a response for a list of SCIM users.

func (*Scimuserlistresponse) String ¶

func (o *Scimuserlistresponse) String() string

String returns a JSON representation of the model

type Scimuserrole ¶

type Scimuserrole struct {
	// Value - The role of the Genesys Cloud user.
	Value *string `json:"value,omitempty"`
}

Scimuserrole - Defines a user role.

func (*Scimuserrole) String ¶

func (o *Scimuserrole) String() string

String returns a JSON representation of the model

type Scimuserroutinglanguage ¶

type Scimuserroutinglanguage struct {
	// Name - The case-sensitive name of a routing language configured in Genesys Cloud.
	Name *string `json:"name,omitempty"`

	// Proficiency - A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings.
	Proficiency *float64 `json:"proficiency,omitempty"`
}

Scimuserroutinglanguage - The routing language assigned to a user.

func (*Scimuserroutinglanguage) String ¶

func (o *Scimuserroutinglanguage) String() string

String returns a JSON representation of the model

type Scimuserroutingskill ¶

type Scimuserroutingskill struct {
	// Name - The case-sensitive name of a routing skill configured in Genesys Cloud.
	Name *string `json:"name,omitempty"`

	// Proficiency - A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings.
	Proficiency *float64 `json:"proficiency,omitempty"`
}

Scimuserroutingskill - The routing skill assigned to a user.

func (*Scimuserroutingskill) String ¶

func (o *Scimuserroutingskill) String() string

String returns a JSON representation of the model

type Scimv2createuser ¶

type Scimv2createuser struct {
	// Schemas - The list of supported schemas.
	Schemas *[]string `json:"schemas,omitempty"`

	// Active - Indicates whether the user's administrative status is active.
	Active *bool `json:"active,omitempty"`

	// UserName - The user's Genesys Cloud email address. Must be unique.
	UserName *string `json:"userName,omitempty"`

	// DisplayName - The display name of the user.
	DisplayName *string `json:"displayName,omitempty"`

	// Password - The new password for the Genesys Cloud user. Does not return an existing password. When creating a user, if a password is not supplied, then a password will be randomly generated that is 40 characters in length and contains five characters from each of the password policy groups.
	Password *string `json:"password,omitempty"`

	// Title - The user's title.
	Title *string `json:"title,omitempty"`

	// PhoneNumbers - The list of the user's phone numbers.
	PhoneNumbers *[]Scimphonenumber `json:"phoneNumbers,omitempty"`

	// Emails - The list of the user's email addresses.
	Emails *[]Scimemail `json:"emails,omitempty"`

	// ExternalId - The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\".
	ExternalId *string `json:"externalId,omitempty"`

	// Groups - The list of groups that the user is a member of.
	Groups *[]Scimv2groupreference `json:"groups,omitempty"`

	// Roles - The list of roles assigned to the user.
	Roles *[]Scimuserrole `json:"roles,omitempty"`

	// UrnIetfParamsScimSchemasExtensionEnterprise20User - The URI of the schema for the enterprise user.
	UrnIetfParamsScimSchemasExtensionEnterprise20User *Scimv2enterpriseuser `json:"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,omitempty"`

	// UrnIetfParamsScimSchemasExtensionGenesysPurecloud20User - The URI of the schema for the Genesys Cloud user.
	UrnIetfParamsScimSchemasExtensionGenesysPurecloud20User *Scimuserextensions `json:"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User,omitempty"`
}

Scimv2createuser - Defines the creation of a SCIM user.

func (*Scimv2createuser) String ¶

func (o *Scimv2createuser) String() string

String returns a JSON representation of the model

type Scimv2enterpriseuser ¶

type Scimv2enterpriseuser struct {
	// Division - The division that the user belongs to.
	Division *string `json:"division,omitempty"`

	// Department - The department that the user belongs to.
	Department *string `json:"department,omitempty"`

	// Manager - The user's manager.
	Manager *Manager `json:"manager,omitempty"`

	// EmployeeNumber - The user's employee number.
	EmployeeNumber *string `json:"employeeNumber,omitempty"`
}

Scimv2enterpriseuser - Defines a SCIM enterprise user.

func (*Scimv2enterpriseuser) String ¶

func (o *Scimv2enterpriseuser) String() string

String returns a JSON representation of the model

type Scimv2group ¶

type Scimv2group struct {
	// Id - The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".
	Id *string `json:"id,omitempty"`

	// Schemas - The list of supported schemas.
	Schemas *[]string `json:"schemas,omitempty"`

	// DisplayName - The display name of the group.
	DisplayName *string `json:"displayName,omitempty"`

	// ExternalId - The external ID of the group. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\".
	ExternalId *string `json:"externalId,omitempty"`

	// Members - The list of members in the group.
	Members *[]Scimv2memberreference `json:"members,omitempty"`

	// Meta - The metadata of the SCIM resource.
	Meta *Scimmetadata `json:"meta,omitempty"`
}

Scimv2group - Defines a SCIM group.

func (*Scimv2group) String ¶

func (o *Scimv2group) String() string

String returns a JSON representation of the model

type Scimv2groupreference ¶

type Scimv2groupreference struct {
	// VarType - The type of SCIM resource.
	VarType *string `json:"type,omitempty"`

	// Value - The ID of the group member. Can be \"userId\" or \"groupId\".
	Value *string `json:"value,omitempty"`

	// Ref - The reference URI of the SCIM resource.
	Ref *string `json:"$ref,omitempty"`
}

Scimv2groupreference - Defines a reference to SCIM groups.

func (*Scimv2groupreference) String ¶

func (o *Scimv2groupreference) String() string

String returns a JSON representation of the model

type Scimv2memberreference ¶

type Scimv2memberreference struct {
	// VarType - The type of SCIM resource.
	VarType *string `json:"type,omitempty"`

	// Value - The ID of the group member. Can be \"userId\" or \"groupId\".
	Value *string `json:"value,omitempty"`

	// Ref - The reference URI of the SCIM resource.
	Ref *string `json:"$ref,omitempty"`
}

Scimv2memberreference - Defines a reference to SCIM group members.

func (*Scimv2memberreference) String ¶

func (o *Scimv2memberreference) String() string

String returns a JSON representation of the model

type Scimv2patchoperation ¶

type Scimv2patchoperation struct {
	// Op - The PATCH operation to perform.
	Op *string `json:"op,omitempty"`

	// Path - The attribute path that describes the target of the operation. Required for a \"remove\" operation.
	Path *string `json:"path,omitempty"`

	// Value - The value to set in the path.
	Value *Jsonnode `json:"value,omitempty"`
}

Scimv2patchoperation - Defines a SCIM PATCH operation. The path and value follow very specific rules based on operation types. See section 3.5.2 \"Modifying with PATCH\" in RFC 7644 for details.

func (*Scimv2patchoperation) String ¶

func (o *Scimv2patchoperation) String() string

String returns a JSON representation of the model

type Scimv2patchrequest ¶

type Scimv2patchrequest struct {
	// Schemas - The list of schemas used in the PATCH request.
	Schemas *[]string `json:"schemas,omitempty"`

	// Operations - The list of operations to perform for the PATCH request.
	Operations *[]Scimv2patchoperation `json:"Operations,omitempty"`
}

Scimv2patchrequest - Defines a SCIM PATCH request. See section 3.5.2 \"Modifying with PATCH\" in RFC 7644 for details.

func (*Scimv2patchrequest) String ¶

func (o *Scimv2patchrequest) String() string

String returns a JSON representation of the model

type Scimv2schemaattribute ¶

type Scimv2schemaattribute struct {
	// Name - The name of the attribute.
	Name *string `json:"name,omitempty"`

	// VarType - The data type of the attribute.
	VarType *string `json:"type,omitempty"`

	// SubAttributes - The list of subattributes for an attribute of the type \"complex\". Uses the same schema as \"attributes\".
	SubAttributes *[]Scimv2schemaattribute `json:"subAttributes,omitempty"`

	// MultiValued - Indicates whether an attribute contains multiple values.
	MultiValued *bool `json:"multiValued,omitempty"`

	// Description - The description of the attribute.
	Description *string `json:"description,omitempty"`

	// Required - Indicates whether an attribute is required.
	Required *bool `json:"required,omitempty"`

	// CanonicalValues - The list of standard values that service providers may use. Service providers may ignore unsupported values.
	CanonicalValues *[]string `json:"canonicalValues,omitempty"`

	// CaseExact - Indicates whether a string attribute is case-sensitive. If set to \"true\", the server preserves case sensitivity. If set to \"false\", the server may change the case. The server also uses case sensitivity when evaluating filters. See section 3.4.2.2 \"Filtering\" in RFC 7644 for details.
	CaseExact *bool `json:"caseExact,omitempty"`

	// Mutability - The circumstances under which an attribute can be defined or redefined. The default is \"readWrite\".
	Mutability *string `json:"mutability,omitempty"`

	// Returned - The circumstances under which an attribute and its values are returned in response to a GET, PUT, POST, or PATCH request.
	Returned *string `json:"returned,omitempty"`

	// Uniqueness - The method by which the service provider enforces the uniqueness of an attribute value. A server can reject a value by returning the HTTP response code 400 (Bad Request). A client can enforce uniqueness to a greater degree than the server provider enforces. For example, a client could make a value unique even though the server has \"uniqueness\" set to \"none\".
	Uniqueness *string `json:"uniqueness,omitempty"`

	// ReferenceTypes - The list of SCIM resource types that may be referenced. Only applies when \"type\" is set to \"reference\".
	ReferenceTypes *[]string `json:"referenceTypes,omitempty"`
}

Scimv2schemaattribute - A complex type that defines service provider attributes or subattributes and their qualities.

func (*Scimv2schemaattribute) String ¶

func (o *Scimv2schemaattribute) String() string

String returns a JSON representation of the model

type Scimv2schemadefinition ¶

type Scimv2schemadefinition struct {
	// Id - The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".
	Id *string `json:"id,omitempty"`

	// Name - The name of the schema.
	Name *string `json:"name,omitempty"`

	// Description - The description of the schema.
	Description *string `json:"description,omitempty"`

	// Attributes - The list of service provider attributes.
	Attributes *[]Scimv2schemaattribute `json:"attributes,omitempty"`

	// Meta - The metadata of the SCIM resource. Only \"location\" and \"resourceType\" are set for \"Schema\" resources.
	Meta *Scimmetadata `json:"meta,omitempty"`
}

Scimv2schemadefinition - Defines a SCIM schema.

func (*Scimv2schemadefinition) String ¶

func (o *Scimv2schemadefinition) String() string

String returns a JSON representation of the model

type Scimv2schemalistresponse ¶

type Scimv2schemalistresponse struct {
	// TotalResults - The total number of results.
	TotalResults *int `json:"totalResults,omitempty"`

	// StartIndex - The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.
	StartIndex *int `json:"startIndex,omitempty"`

	// ItemsPerPage - The number of resources returned per page.
	ItemsPerPage *int `json:"itemsPerPage,omitempty"`

	// Resources - The list of requested resources.
	Resources *[]Scimv2schemadefinition `json:"Resources,omitempty"`

	// Schemas - The list of supported schemas.
	Schemas *[]string `json:"schemas,omitempty"`
}

Scimv2schemalistresponse - Defines the list response for SCIM resource types.

func (*Scimv2schemalistresponse) String ¶

func (o *Scimv2schemalistresponse) String() string

String returns a JSON representation of the model

type Scimv2user ¶

type Scimv2user struct {
	// Id - The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".
	Id *string `json:"id,omitempty"`

	// Schemas - The list of supported schemas.
	Schemas *[]string `json:"schemas,omitempty"`

	// Active - Indicates whether the user's administrative status is active.
	Active *bool `json:"active,omitempty"`

	// UserName - The user's Genesys Cloud email address. Must be unique.
	UserName *string `json:"userName,omitempty"`

	// DisplayName - The display name of the user.
	DisplayName *string `json:"displayName,omitempty"`

	// Password - The new password for the Genesys Cloud user. Does not return an existing password. When creating a user, if a password is not supplied, then a password will be randomly generated that is 40 characters in length and contains five characters from each of the password policy groups.
	Password *string `json:"password,omitempty"`

	// Title - The user's title.
	Title *string `json:"title,omitempty"`

	// PhoneNumbers - The list of the user's phone numbers.
	PhoneNumbers *[]Scimphonenumber `json:"phoneNumbers,omitempty"`

	// Emails - The list of the user's email addresses.
	Emails *[]Scimemail `json:"emails,omitempty"`

	// ExternalId - The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\".
	ExternalId *string `json:"externalId,omitempty"`

	// Groups - The list of groups that the user is a member of.
	Groups *[]Scimv2groupreference `json:"groups,omitempty"`

	// Roles - The list of roles assigned to the user.
	Roles *[]Scimuserrole `json:"roles,omitempty"`

	// UrnIetfParamsScimSchemasExtensionEnterprise20User - The URI of the schema for the enterprise user.
	UrnIetfParamsScimSchemasExtensionEnterprise20User *Scimv2enterpriseuser `json:"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,omitempty"`

	// UrnIetfParamsScimSchemasExtensionGenesysPurecloud20User - The URI of the schema for the Genesys Cloud user.
	UrnIetfParamsScimSchemasExtensionGenesysPurecloud20User *Scimuserextensions `json:"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User,omitempty"`

	// Meta - The metadata of the SCIM resource.
	Meta *Scimmetadata `json:"meta,omitempty"`
}

Scimv2user - Defines a SCIM user.

func (*Scimv2user) String ¶

func (o *Scimv2user) String() string

String returns a JSON representation of the model

type Scorablesurvey ¶

type Scorablesurvey struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// SurveyForm - Survey form used for this survey.
	SurveyForm *Surveyform `json:"surveyForm,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`

	// Answers
	Answers *Surveyscoringset `json:"answers,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Scorablesurvey

func (*Scorablesurvey) String ¶

func (o *Scorablesurvey) String() string

String returns a JSON representation of the model

type Scoredagent ¶

type Scoredagent struct {
	// Agent - The agent
	Agent *Addressableentityref `json:"agent,omitempty"`

	// Score - Agent's score for the current conversation, from 0 - 100, higher being better
	Score *int `json:"score,omitempty"`
}

Scoredagent

func (*Scoredagent) String ¶

func (o *Scoredagent) String() string

String returns a JSON representation of the model

type Screenrecordingmetadata ¶

type Screenrecordingmetadata struct {
	// TrackId
	TrackId *string `json:"trackId,omitempty"`

	// MediaId
	MediaId *string `json:"mediaId,omitempty"`

	// ScreenId
	ScreenId *string `json:"screenId,omitempty"`

	// OriginX
	OriginX *int `json:"originX,omitempty"`

	// OriginY
	OriginY *int `json:"originY,omitempty"`

	// Primary
	Primary *bool `json:"primary,omitempty"`

	// Main
	Main *bool `json:"main,omitempty"`
}

Screenrecordingmetadata

func (*Screenrecordingmetadata) String ¶

func (o *Screenrecordingmetadata) String() string

String returns a JSON representation of the model

type Screenrecordingmetadatarequest ¶

type Screenrecordingmetadatarequest struct {
	// ParticipantJid
	ParticipantJid *string `json:"participantJid,omitempty"`

	// RoomId
	RoomId *string `json:"roomId,omitempty"`

	// MetaData
	MetaData *[]Screenrecordingmetadata `json:"metaData,omitempty"`
}

Screenrecordingmetadatarequest

func (*Screenrecordingmetadatarequest) String ¶

String returns a JSON representation of the model

type Screenrecordingsession ¶

type Screenrecordingsession 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"`

	// CommunicationId - The id of the communication that is being recorded on the conversation
	CommunicationId *string `json:"communicationId,omitempty"`

	// Conversation
	Conversation *Conversation `json:"conversation,omitempty"`

	// 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"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Screenrecordingsession

func (*Screenrecordingsession) String ¶

func (o *Screenrecordingsession) String() string

String returns a JSON representation of the model

type Screenrecordingsessionlisting ¶

type Screenrecordingsessionlisting struct {
	// Entities
	Entities *[]Screenrecordingsession `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Screenrecordingsessionlisting

func (*Screenrecordingsessionlisting) String ¶

String returns a JSON representation of the model

type Screenrecordingsessionrequest ¶

type Screenrecordingsessionrequest struct {
	// State - The screen recording session's state.  Values can be: 'stopped'
	State *string `json:"state,omitempty"`

	// ArchiveDate - The screen recording session's archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ArchiveDate *time.Time `json:"archiveDate,omitempty"`

	// DeleteDate - The screen recording session's delete date. Must be greater than archiveDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DeleteDate *time.Time `json:"deleteDate,omitempty"`
}

Screenrecordingsessionrequest

func (*Screenrecordingsessionrequest) String ¶

String returns a JSON representation of the model

type Screenshare ¶

type Screenshare 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"`

	// Context - The room id context (xmpp jid) for the conference session.
	Context *string `json:"context,omitempty"`

	// Sharing - Indicates whether this participant is sharing their screen.
	Sharing *bool `json:"sharing,omitempty"`

	// PeerCount - The number of peer participants from the perspective of the participant in the conference.
	PeerCount *int `json:"peerCount,omitempty"`

	// DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
	DisconnectType *string `json:"disconnectType,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 screen share.
	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"`
}

Screenshare

func (*Screenshare) String ¶

func (o *Screenshare) String() string

String returns a JSON representation of the model

type Script ¶

type Script struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// VersionId
	VersionId *string `json:"versionId,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"`

	// 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"`

	// PublishedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	PublishedDate *time.Time `json:"publishedDate,omitempty"`

	// VersionDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	VersionDate *time.Time `json:"versionDate,omitempty"`

	// StartPageId
	StartPageId *string `json:"startPageId,omitempty"`

	// StartPageName
	StartPageName *string `json:"startPageName,omitempty"`

	// Features
	Features *interface{} `json:"features,omitempty"`

	// Variables
	Variables *interface{} `json:"variables,omitempty"`

	// CustomActions
	CustomActions *interface{} `json:"customActions,omitempty"`

	// Pages
	Pages *[]Page `json:"pages,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Script

func (*Script) String ¶

func (o *Script) String() string

String returns a JSON representation of the model

type Scriptentitylisting ¶

type Scriptentitylisting struct {
	// Entities
	Entities *[]Script `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Scriptentitylisting

func (*Scriptentitylisting) String ¶

func (o *Scriptentitylisting) String() string

String returns a JSON representation of the model

type ScriptsApi ¶

type ScriptsApi struct {
	Configuration *Configuration
}

ScriptsApi provides functions for API endpoints

func NewScriptsApi ¶

func NewScriptsApi() *ScriptsApi

NewScriptsApi creates an API instance using the default configuration

func NewScriptsApiWithConfig ¶

func NewScriptsApiWithConfig(config *Configuration) *ScriptsApi

NewScriptsApiWithConfig creates an API instance using the provided configuration

func (ScriptsApi) GetScript ¶

func (a ScriptsApi) GetScript(scriptId string) (*Script, *APIResponse, error)

GetScript invokes GET /api/v2/scripts/{scriptId}

Get a script

func (ScriptsApi) GetScriptPage ¶

func (a ScriptsApi) GetScriptPage(scriptId string, pageId string, scriptDataVersion string) (*Page, *APIResponse, error)

GetScriptPage invokes GET /api/v2/scripts/{scriptId}/pages/{pageId}

Get a page

func (ScriptsApi) GetScriptPages ¶

func (a ScriptsApi) GetScriptPages(scriptId string, scriptDataVersion string) ([]Page, *APIResponse, error)

GetScriptPages invokes GET /api/v2/scripts/{scriptId}/pages

Get the list of pages

func (ScriptsApi) GetScripts ¶

func (a ScriptsApi) GetScripts(pageSize int, pageNumber int, expand string, name string, feature string, flowId string, sortBy string, sortOrder string, scriptDataVersion string) (*Scriptentitylisting, *APIResponse, error)

GetScripts invokes GET /api/v2/scripts

Get the list of scripts

func (ScriptsApi) GetScriptsPublished ¶

func (a ScriptsApi) GetScriptsPublished(pageSize int, pageNumber int, expand string, name string, feature string, flowId string, scriptDataVersion string) (*Scriptentitylisting, *APIResponse, error)

GetScriptsPublished invokes GET /api/v2/scripts/published

Get the published scripts.

func (ScriptsApi) GetScriptsPublishedScriptId ¶

func (a ScriptsApi) GetScriptsPublishedScriptId(scriptId string, scriptDataVersion string) (*Script, *APIResponse, error)

GetScriptsPublishedScriptId invokes GET /api/v2/scripts/published/{scriptId}

Get the published script.

func (ScriptsApi) GetScriptsPublishedScriptIdPage ¶

func (a ScriptsApi) GetScriptsPublishedScriptIdPage(scriptId string, pageId string, scriptDataVersion string) (*Page, *APIResponse, error)

GetScriptsPublishedScriptIdPage invokes GET /api/v2/scripts/published/{scriptId}/pages/{pageId}

Get the published page.

func (ScriptsApi) GetScriptsPublishedScriptIdPages ¶

func (a ScriptsApi) GetScriptsPublishedScriptIdPages(scriptId string, scriptDataVersion string) ([]Page, *APIResponse, error)

GetScriptsPublishedScriptIdPages invokes GET /api/v2/scripts/published/{scriptId}/pages

Get the list of published pages

func (ScriptsApi) GetScriptsPublishedScriptIdVariables ¶

func (a ScriptsApi) GetScriptsPublishedScriptIdVariables(scriptId string, input string, output string, varType string, scriptDataVersion string) (*interface{}, *APIResponse, error)

GetScriptsPublishedScriptIdVariables invokes GET /api/v2/scripts/published/{scriptId}/variables

Get the published variables

func (ScriptsApi) GetScriptsUploadStatus ¶

func (a ScriptsApi) GetScriptsUploadStatus(uploadId string, longPoll bool) (*Importscriptstatusresponse, *APIResponse, error)

GetScriptsUploadStatus invokes GET /api/v2/scripts/uploads/{uploadId}/status

Get the upload status of an imported script

func (ScriptsApi) PostScriptExport ¶

func (a ScriptsApi) PostScriptExport(scriptId string, body Exportscriptrequest) (*Exportscriptresponse, *APIResponse, error)

PostScriptExport invokes POST /api/v2/scripts/{scriptId}/export

Export a script via download service.

type SearchApi ¶

type SearchApi struct {
	Configuration *Configuration
}

SearchApi provides functions for API endpoints

func NewSearchApi ¶

func NewSearchApi() *SearchApi

NewSearchApi creates an API instance using the default configuration

func NewSearchApiWithConfig ¶

func NewSearchApiWithConfig(config *Configuration) *SearchApi

NewSearchApiWithConfig creates an API instance using the provided configuration

func (SearchApi) GetDocumentationGknSearch ¶

func (a SearchApi) GetDocumentationGknSearch(q64 string) (*Gkndocumentationsearchresponse, *APIResponse, error)

GetDocumentationGknSearch invokes GET /api/v2/documentation/gkn/search

Search gkn documentation using the q64 value returned from a previous search

func (SearchApi) GetDocumentationSearch ¶

func (a SearchApi) GetDocumentationSearch(q64 string) (*Documentationsearchresponse, *APIResponse, error)

GetDocumentationSearch invokes GET /api/v2/documentation/search

Search documentation using the q64 value returned from a previous search

func (SearchApi) GetGroupsSearch ¶

func (a SearchApi) GetGroupsSearch(q64 string, expand []string) (*Groupssearchresponse, *APIResponse, error)

GetGroupsSearch invokes GET /api/v2/groups/search

Search groups using the q64 value returned from a previous search

func (SearchApi) GetLocationsSearch ¶

func (a SearchApi) GetLocationsSearch(q64 string, expand []string) (*Locationssearchresponse, *APIResponse, error)

GetLocationsSearch invokes GET /api/v2/locations/search

Search locations using the q64 value returned from a previous search

func (SearchApi) GetSearch ¶

func (a SearchApi) GetSearch(q64 string, expand []string, profile bool) (*Jsonnodesearchresponse, *APIResponse, error)

GetSearch invokes GET /api/v2/search

Search using the q64 value returned from a previous search.

func (SearchApi) GetSearchSuggest ¶

func (a SearchApi) GetSearchSuggest(q64 string, expand []string, profile bool) (*Jsonnodesearchresponse, *APIResponse, error)

GetSearchSuggest invokes GET /api/v2/search/suggest

Suggest resources using the q64 value returned from a previous suggest query.

func (SearchApi) GetUsersSearch ¶

func (a SearchApi) GetUsersSearch(q64 string, expand []string, integrationPresenceSource string) (*Userssearchresponse, *APIResponse, error)

GetUsersSearch invokes GET /api/v2/users/search

Search users using the q64 value returned from a previous search

func (SearchApi) GetVoicemailSearch ¶

func (a SearchApi) GetVoicemailSearch(q64 string, expand []string) (*Voicemailssearchresponse, *APIResponse, error)

GetVoicemailSearch invokes GET /api/v2/voicemail/search

Search voicemails using the q64 value returned from a previous search

func (SearchApi) PostAnalyticsConversationsTranscriptsQuery ¶

PostAnalyticsConversationsTranscriptsQuery invokes POST /api/v2/analytics/conversations/transcripts/query

Search resources.

func (SearchApi) PostDocumentationGknSearch ¶

PostDocumentationGknSearch invokes POST /api/v2/documentation/gkn/search

Search gkn documentation

func (SearchApi) PostDocumentationSearch ¶

PostDocumentationSearch invokes POST /api/v2/documentation/search

Search documentation

func (SearchApi) PostGroupsSearch ¶

func (a SearchApi) PostGroupsSearch(body Groupsearchrequest) (*Groupssearchresponse, *APIResponse, error)

PostGroupsSearch invokes POST /api/v2/groups/search

Search groups

func (SearchApi) PostKnowledgeKnowledgebaseSearch ¶

func (a SearchApi) PostKnowledgeKnowledgebaseSearch(knowledgeBaseId string, body Knowledgesearchrequest) (*Knowledgesearchresponse, *APIResponse, error)

PostKnowledgeKnowledgebaseSearch invokes POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search

Search Documents

func (SearchApi) PostLocationsSearch ¶

func (a SearchApi) PostLocationsSearch(body Locationsearchrequest) (*Locationssearchresponse, *APIResponse, error)

PostLocationsSearch invokes POST /api/v2/locations/search

Search locations

func (SearchApi) PostSearch ¶

func (a SearchApi) PostSearch(body Searchrequest, profile bool) (*Jsonnodesearchresponse, *APIResponse, error)

PostSearch invokes POST /api/v2/search

Search resources.

func (SearchApi) PostSearchSuggest ¶

func (a SearchApi) PostSearchSuggest(body Suggestsearchrequest, profile bool) (*Jsonnodesearchresponse, *APIResponse, error)

PostSearchSuggest invokes POST /api/v2/search/suggest

Suggest resources.

func (SearchApi) PostSpeechandtextanalyticsTranscriptsSearch ¶

func (a SearchApi) PostSpeechandtextanalyticsTranscriptsSearch(body Transcriptsearchrequest) (*Jsonsearchresponse, *APIResponse, error)

PostSpeechandtextanalyticsTranscriptsSearch invokes POST /api/v2/speechandtextanalytics/transcripts/search

Search resources.

func (SearchApi) PostUsersSearch ¶

func (a SearchApi) PostUsersSearch(body Usersearchrequest) (*Userssearchresponse, *APIResponse, error)

PostUsersSearch invokes POST /api/v2/users/search

Search users

func (SearchApi) PostVoicemailSearch ¶

PostVoicemailSearch invokes POST /api/v2/voicemail/search

Search voicemails

type Searchaggregation ¶

type Searchaggregation struct {
	// Field - The field used for aggregation
	Field *string `json:"field,omitempty"`

	// Name - The name of the aggregation. The response aggregation uses this name.
	Name *string `json:"name,omitempty"`

	// VarType - The type of aggregation to perform
	VarType *string `json:"type,omitempty"`

	// Value - A value to use for aggregation
	Value *string `json:"value,omitempty"`

	// Size - The number aggregations results to return out of the entire result set
	Size *int `json:"size,omitempty"`

	// Order - The order in which aggregation results are sorted
	Order *[]string `json:"order,omitempty"`
}

Searchaggregation

func (*Searchaggregation) String ¶

func (o *Searchaggregation) String() string

String returns a JSON representation of the model

type Searchcriteria ¶

type Searchcriteria struct {
	// EndValue - The end value of the range. This field is used for range search types.
	EndValue *string `json:"endValue,omitempty"`

	// Values - A list of values for the search to match against
	Values *[]string `json:"values,omitempty"`

	// StartValue - The start value of the range. This field is used for range search types.
	StartValue *string `json:"startValue,omitempty"`

	// Fields - Field names to search against
	Fields *[]string `json:"fields,omitempty"`

	// Value - A value for the search to match against
	Value *string `json:"value,omitempty"`

	// Operator - How to apply this search criteria against other criteria
	Operator *string `json:"operator,omitempty"`

	// Group - Groups multiple conditions
	Group *[]Searchcriteria `json:"group,omitempty"`

	// DateFormat - Set date format for criteria values when using date range search type.  Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX.
	DateFormat *string `json:"dateFormat,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Searchcriteria

func (*Searchcriteria) String ¶

func (o *Searchcriteria) String() string

String returns a JSON representation of the model

type Searchrequest ¶

type Searchrequest struct {
	// SortOrder - The sort order for results
	SortOrder *string `json:"sortOrder,omitempty"`

	// SortBy - The field in the resource that you want to sort the results by
	SortBy *string `json:"sortBy,omitempty"`

	// PageSize - The number of results per page
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The page of resources you want to retrieve
	PageNumber *int `json:"pageNumber,omitempty"`

	// Sort - Multi-value sort order, list of multiple sort values
	Sort *[]Searchsort `json:"sort,omitempty"`

	// ReturnFields - A List of strings.  Possible values are any field in the resource you are searching on.  The other option is to use ALL_FIELDS, when this is provided all fields in the resource will be returned in the search results.
	ReturnFields *[]string `json:"returnFields,omitempty"`

	// Expand - Provides more details about a specified resource
	Expand *[]string `json:"expand,omitempty"`

	// Types - Resource domain type to search
	Types *[]string `json:"types,omitempty"`

	// Query - The search criteria
	Query *[]Searchcriteria `json:"query,omitempty"`

	// Aggregations - Aggregation criteria
	Aggregations *[]Searchaggregation `json:"aggregations,omitempty"`
}

Searchrequest

func (*Searchrequest) String ¶

func (o *Searchrequest) String() string

String returns a JSON representation of the model

type Searchshifttraderesponse ¶

type Searchshifttraderesponse struct {
	// Trade - A trade which matches search criteria
	Trade *Shifttraderesponse `json:"trade,omitempty"`

	// MatchingReceivingShiftIds - IDs of shifts which match the search criteria
	MatchingReceivingShiftIds *[]string `json:"matchingReceivingShiftIds,omitempty"`

	// Preview - A preview of what the shift trade would look like if matched
	Preview *Shifttradepreviewresponse `json:"preview,omitempty"`
}

Searchshifttraderesponse

func (*Searchshifttraderesponse) String ¶

func (o *Searchshifttraderesponse) String() string

String returns a JSON representation of the model

type Searchshifttradesrequest ¶

type Searchshifttradesrequest struct {
	// ReceivingScheduleId - The ID of the schedule for which to search for available shift trades
	ReceivingScheduleId *string `json:"receivingScheduleId,omitempty"`

	// ReceivingShiftIds - The IDs of shifts that the receiving user would potentially be willing to trade. If empty, only returns one sided trades (pick up a shift)
	ReceivingShiftIds *[]string `json:"receivingShiftIds,omitempty"`
}

Searchshifttradesrequest

func (*Searchshifttradesrequest) String ¶

func (o *Searchshifttradesrequest) String() string

String returns a JSON representation of the model

type Searchshifttradesresponse ¶

type Searchshifttradesresponse struct {
	// Trades - The shift trades that match the search criteria
	Trades *[]Searchshifttraderesponse `json:"trades,omitempty"`
}

Searchshifttradesresponse

func (*Searchshifttradesresponse) String ¶

func (o *Searchshifttradesresponse) String() string

String returns a JSON representation of the model

type Searchsort ¶

type Searchsort struct {
	// SortOrder - The sort order for results
	SortOrder *string `json:"sortOrder,omitempty"`

	// SortBy - The field in the resource that you want to sort the results by
	SortBy *string `json:"sortBy,omitempty"`
}

Searchsort

func (*Searchsort) String ¶

func (o *Searchsort) String() string

String returns a JSON representation of the model

type Section ¶

type Section struct {
	// FieldList
	FieldList *[]Fieldlist `json:"fieldList,omitempty"`

	// InstructionText
	InstructionText *string `json:"instructionText,omitempty"`

	// Key
	Key *string `json:"key,omitempty"`

	// State
	State *string `json:"state,omitempty"`
}

Section

func (*Section) String ¶

func (o *Section) String() string

String returns a JSON representation of the model

type Securesession ¶

type Securesession struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Flow - The flow to execute securely
	Flow *Domainentityref `json:"flow,omitempty"`

	// UserData - Customer-provided data
	UserData *string `json:"userData,omitempty"`

	// State - The current state of a secure session
	State *string `json:"state,omitempty"`

	// SourceParticipantId - Unique identifier for the participant initiating the secure session.
	SourceParticipantId *string `json:"sourceParticipantId,omitempty"`

	// Disconnect - If true, disconnect the agent after creating the session
	Disconnect *bool `json:"disconnect,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Securesession

func (*Securesession) String ¶

func (o *Securesession) String() string

String returns a JSON representation of the model

type Securesessionentitylisting ¶

type Securesessionentitylisting struct {
	// Entities
	Entities *[]Securesession `json:"entities,omitempty"`
}

Securesessionentitylisting

func (*Securesessionentitylisting) String ¶

func (o *Securesessionentitylisting) String() string

String returns a JSON representation of the model

type Securityprofile ¶

type Securityprofile struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Permissions
	Permissions *[]string `json:"permissions,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Securityprofile

func (*Securityprofile) String ¶

func (o *Securityprofile) String() string

String returns a JSON representation of the model

type Securityprofileentitylisting ¶

type Securityprofileentitylisting struct {
	// Entities
	Entities *[]Securityprofile `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Securityprofileentitylisting

func (*Securityprofileentitylisting) String ¶

String returns a JSON representation of the model

type Segment ¶

type Segment struct {
	// StartTime - The timestamp when this segment began. 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 timestamp when this 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"`

	// VarType - The activity taking place for the participant in the segment.
	VarType *string `json:"type,omitempty"`

	// HowEnded - A description of the event that ended the segment.
	HowEnded *string `json:"howEnded,omitempty"`

	// DisconnectType - A description of the event that disconnected the segment
	DisconnectType *string `json:"disconnectType,omitempty"`
}

Segment

func (*Segment) String ¶

func (o *Segment) String() string

String returns a JSON representation of the model

type Segmentdetailqueryclause ¶

type Segmentdetailqueryclause 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 *[]Segmentdetailquerypredicate `json:"predicates,omitempty"`
}

Segmentdetailqueryclause

func (*Segmentdetailqueryclause) String ¶

func (o *Segmentdetailqueryclause) String() string

String returns a JSON representation of the model

type Segmentdetailqueryfilter ¶

type Segmentdetailqueryfilter 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 *[]Segmentdetailqueryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Segmentdetailquerypredicate `json:"predicates,omitempty"`
}

Segmentdetailqueryfilter

func (*Segmentdetailqueryfilter) String ¶

func (o *Segmentdetailqueryfilter) String() string

String returns a JSON representation of the model

type Segmentdetailquerypredicate ¶

type Segmentdetailquerypredicate 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"`

	// PropertyType - Left hand side for property predicates
	PropertyType *string `json:"propertyType,omitempty"`

	// Property - Left hand side for property predicates
	Property *string `json:"property,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, metric, or property predicates
	Value *string `json:"value,omitempty"`

	// VarRange - Right hand side for dimension, metric, or property predicates
	VarRange *Numericrange `json:"range,omitempty"`
}

Segmentdetailquerypredicate

func (*Segmentdetailquerypredicate) String ¶

func (o *Segmentdetailquerypredicate) String() string

String returns a JSON representation of the model

type Segmentlisting ¶

type Segmentlisting struct {
	// Entities
	Entities *[]Journeysegment `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Segmentlisting

func (*Segmentlisting) String ¶

func (o *Segmentlisting) String() string

String returns a JSON representation of the model

type Selectedcolumns ¶

type Selectedcolumns struct {
	// ColumnOrder - Indicates the order/position of the selected column
	ColumnOrder *int `json:"columnOrder,omitempty"`

	// ColumnName - Indicates enum name of the column from the export view
	ColumnName *string `json:"columnName,omitempty"`
}

Selectedcolumns

func (*Selectedcolumns) String ¶

func (o *Selectedcolumns) String() string

String returns a JSON representation of the model

type Sendagentlessoutboundmessagerequest ¶

type Sendagentlessoutboundmessagerequest struct {
	// FromAddress - The messaging address of the sender of the message. For an SMS messenger type, this must be a currently provisioned SMS phone number. For a WhatsApp messenger type use the provisioned WhatsApp integration’s ID
	FromAddress *string `json:"fromAddress,omitempty"`

	// ToAddress - The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234.
	ToAddress *string `json:"toAddress,omitempty"`

	// ToAddressMessengerType - The recipient messaging address messenger type. Currently SMS is the only one supported. WhatsApp will be supported in a future release.
	ToAddressMessengerType *string `json:"toAddressMessengerType,omitempty"`

	// TextBody - The text of the message to send. This field is required in the case of SMS messenger type
	TextBody *string `json:"textBody,omitempty"`

	// MessagingTemplate - The messaging template to use in the case of WhatsApp messenger type. This field is required when using WhatsApp messenger type
	MessagingTemplate *Messagingtemplaterequest `json:"messagingTemplate,omitempty"`
}

Sendagentlessoutboundmessagerequest

func (*Sendagentlessoutboundmessagerequest) String ¶

String returns a JSON representation of the model

type Sendagentlessoutboundmessageresponse ¶

type Sendagentlessoutboundmessageresponse struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// ConversationId - The identifier of the conversation.
	ConversationId *string `json:"conversationId,omitempty"`

	// FromAddress - The sender of the message.
	FromAddress *string `json:"fromAddress,omitempty"`

	// ToAddress - The recipient of the message.
	ToAddress *string `json:"toAddress,omitempty"`

	// MessengerType - Type of messenger.
	MessengerType *string `json:"messengerType,omitempty"`

	// TextBody - The body of the text message.
	TextBody *string `json:"textBody,omitempty"`

	// MessagingTemplate - The messaging template sent
	MessagingTemplate *Messagingtemplaterequest `json:"messagingTemplate,omitempty"`

	// Timestamp - The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Timestamp *time.Time `json:"timestamp,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`

	// User - Details of the user created the job
	User *Addressableentityref `json:"user,omitempty"`
}

Sendagentlessoutboundmessageresponse

func (*Sendagentlessoutboundmessageresponse) String ¶

String returns a JSON representation of the model

type Sequenceschedule ¶

type Sequenceschedule 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 CampaignSequence.
	Intervals *[]Scheduleinterval `json:"intervals,omitempty"`

	// TimeZone - The time zone for this SequenceSchedule. For example, Africa/Abidjan.
	TimeZone *string `json:"timeZone,omitempty"`

	// Sequence - The CampaignSequence that this SequenceSchedule is for.
	Sequence *Domainentityref `json:"sequence,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Sequenceschedule

func (*Sequenceschedule) String ¶

func (o *Sequenceschedule) String() string

String returns a JSON representation of the model

type Serverdate ¶

type Serverdate struct {
	// CurrentDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CurrentDate *time.Time `json:"currentDate,omitempty"`
}

Serverdate

func (*Serverdate) String ¶

func (o *Serverdate) String() string

String returns a JSON representation of the model

type Servicecontext ¶

type Servicecontext struct {
	// Name - Unused field for the purpose of ensuring a Swagger definition is created for a class with only @JsonIgnore members.
	Name *string `json:"name,omitempty"`
}

Servicecontext

func (*Servicecontext) String ¶

func (o *Servicecontext) String() string

String returns a JSON representation of the model

type Servicegoaltemplate ¶

type Servicegoaltemplate struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// ServiceLevel - Service level targets for this service goal template
	ServiceLevel *Buservicelevel `json:"serviceLevel,omitempty"`

	// AverageSpeedOfAnswer - Average speed of answer targets for this service goal template
	AverageSpeedOfAnswer *Buaveragespeedofanswer `json:"averageSpeedOfAnswer,omitempty"`

	// AbandonRate - Abandon rate targets for this service goal template
	AbandonRate *Buabandonrate `json:"abandonRate,omitempty"`

	// Metadata - Version metadata for the service goal template
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Servicegoaltemplate - Service Goal Template

func (*Servicegoaltemplate) String ¶

func (o *Servicegoaltemplate) String() string

String returns a JSON representation of the model

type Servicegoaltemplatelist ¶

type Servicegoaltemplatelist struct {
	// Entities
	Entities *[]Servicegoaltemplate `json:"entities,omitempty"`
}

Servicegoaltemplatelist - List of service goal templates

func (*Servicegoaltemplatelist) String ¶

func (o *Servicegoaltemplatelist) String() string

String returns a JSON representation of the model

type Servicegoaltemplatereference ¶

type Servicegoaltemplatereference 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"`
}

Servicegoaltemplatereference

func (*Servicegoaltemplatereference) String ¶

String returns a JSON representation of the model

type Servicelevel ¶

type Servicelevel struct {
	// Percentage - The desired Service Level. A value between 0 and 1.
	Percentage *float64 `json:"percentage,omitempty"`

	// DurationMs - Service Level target in milliseconds.
	DurationMs *int `json:"durationMs,omitempty"`
}

Servicelevel

func (*Servicelevel) String ¶

func (o *Servicelevel) String() string

String returns a JSON representation of the model

type Setuuidatarequest ¶

type Setuuidatarequest struct {
	// UuiData - The value of the uuiData to set.
	UuiData *string `json:"uuiData,omitempty"`
}

Setuuidatarequest

func (*Setuuidatarequest) String ¶

func (o *Setuuidatarequest) String() string

String returns a JSON representation of the model

type Setwrapperdayofweek ¶

type Setwrapperdayofweek struct {
	// Values
	Values *[]string `json:"values,omitempty"`
}

Setwrapperdayofweek

func (*Setwrapperdayofweek) String ¶

func (o *Setwrapperdayofweek) String() string

String returns a JSON representation of the model

type Setwrapperroutepathrequest ¶

type Setwrapperroutepathrequest struct {
	// Values
	Values *[]Routepathrequest `json:"values,omitempty"`
}

Setwrapperroutepathrequest

func (*Setwrapperroutepathrequest) String ¶

func (o *Setwrapperroutepathrequest) String() string

String returns a JSON representation of the model

type Share ¶

type Share struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// SharedEntityType
	SharedEntityType *string `json:"sharedEntityType,omitempty"`

	// SharedEntity
	SharedEntity *Domainentityref `json:"sharedEntity,omitempty"`

	// MemberType
	MemberType *string `json:"memberType,omitempty"`

	// Member
	Member *Domainentityref `json:"member,omitempty"`

	// SharedBy
	SharedBy *Domainentityref `json:"sharedBy,omitempty"`

	// Workspace
	Workspace *Domainentityref `json:"workspace,omitempty"`

	// User
	User *User `json:"user,omitempty"`

	// Group
	Group *Group `json:"group,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Share

func (*Share) String ¶

func (o *Share) String() string

String returns a JSON representation of the model

type Sharedentity ¶

type Sharedentity struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Sharedentity

func (*Sharedentity) String ¶

func (o *Sharedentity) String() string

String returns a JSON representation of the model

type Sharedresponse ¶

type Sharedresponse struct {
	// Id
	Id *string `json:"id,omitempty"`

	// DownloadUri
	DownloadUri *string `json:"downloadUri,omitempty"`

	// ViewUri
	ViewUri *string `json:"viewUri,omitempty"`

	// Document
	Document *Document `json:"document,omitempty"`

	// Share
	Share *Share `json:"share,omitempty"`
}

Sharedresponse

func (*Sharedresponse) String ¶

func (o *Sharedresponse) String() string

String returns a JSON representation of the model

type Shareentitylisting ¶

type Shareentitylisting struct {
	// Entities
	Entities *[]Share `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Shareentitylisting

func (*Shareentitylisting) String ¶

func (o *Shareentitylisting) String() string

String returns a JSON representation of the model

type Shiftstartvariance ¶

type Shiftstartvariance struct {
	// ApplicableDays - Days for which shift start variance is configured
	ApplicableDays *[]string `json:"applicableDays,omitempty"`

	// MaxShiftStartVarianceMinutes - Maximum variance in minutes across shift starts
	MaxShiftStartVarianceMinutes *int `json:"maxShiftStartVarianceMinutes,omitempty"`
}

Shiftstartvariance - Variance in minutes among start times of shifts in work plan

func (*Shiftstartvariance) String ¶

func (o *Shiftstartvariance) String() string

String returns a JSON representation of the model

type Shifttradeactivitypreviewresponse ¶

type Shifttradeactivitypreviewresponse struct {
	// StartDate - The start date and 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 in minutes of this activity
	LengthMinutes *int `json:"lengthMinutes,omitempty"`

	// ActivityCodeId - The ID of the activity code for this activity
	ActivityCodeId *string `json:"activityCodeId,omitempty"`

	// CountsAsPaidTime - Whether this activity counts as paid time
	CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"`
}

Shifttradeactivitypreviewresponse

func (*Shifttradeactivitypreviewresponse) String ¶

String returns a JSON representation of the model

type Shifttradeactivityrule ¶

type Shifttradeactivityrule struct {
	// ActivityCategory - The activity category to which to apply this rule
	ActivityCategory *string `json:"activityCategory,omitempty"`

	// Action - The action this rule invokes
	Action *string `json:"action,omitempty"`

	// ActivityCodeIdReplacement - The activity code ID with which to replace activities belonging to the original category if applicable (required if action == Replace, must be a default activity code ID)
	ActivityCodeIdReplacement *string `json:"activityCodeIdReplacement,omitempty"`
}

Shifttradeactivityrule

func (*Shifttradeactivityrule) String ¶

func (o *Shifttradeactivityrule) String() string

String returns a JSON representation of the model

type Shifttradelistresponse ¶

type Shifttradelistresponse struct {
	// Entities
	Entities *[]Shifttraderesponse `json:"entities,omitempty"`
}

Shifttradelistresponse

func (*Shifttradelistresponse) String ¶

func (o *Shifttradelistresponse) String() string

String returns a JSON representation of the model

type Shifttradematchessummaryresponse ¶

type Shifttradematchessummaryresponse struct {
	// Entities
	Entities *[]Weekshifttradematchessummaryresponse `json:"entities,omitempty"`
}

Shifttradematchessummaryresponse

func (*Shifttradematchessummaryresponse) String ¶

String returns a JSON representation of the model

type Shifttradematchreviewresponse ¶

type Shifttradematchreviewresponse struct {
	// InitiatingUser - Details for the initiatingUser side of the shift trade
	InitiatingUser *Shifttradematchreviewuserresponse `json:"initiatingUser,omitempty"`

	// ReceivingUser - Details for the receivingUser side of the shift trade
	ReceivingUser *Shifttradematchreviewuserresponse `json:"receivingUser,omitempty"`

	// Violations - Constraint violations introduced after being matched that would normally disallow a trade, but which can still be overridden by the shift trade administrator
	Violations *[]Shifttradematchviolation `json:"violations,omitempty"`

	// AdminReviewViolations - Constraint violations associated with this shift trade which require shift trade administrator review
	AdminReviewViolations *[]Shifttradematchviolation `json:"adminReviewViolations,omitempty"`
}

Shifttradematchreviewresponse

func (*Shifttradematchreviewresponse) String ¶

String returns a JSON representation of the model

type Shifttradematchreviewuserresponse ¶

type Shifttradematchreviewuserresponse struct {
	// WeeklyMinimumPaidMinutes - The minimum weekly paid minutes for this user per the work plan tied to the agent schedule
	WeeklyMinimumPaidMinutes *int `json:"weeklyMinimumPaidMinutes,omitempty"`

	// WeeklyMaximumPaidMinutes - The maximum weekly paid minutes for this user per the work plan tied to the agent schedule
	WeeklyMaximumPaidMinutes *int `json:"weeklyMaximumPaidMinutes,omitempty"`

	// PreTradeSchedulePaidMinutes - The paid minutes on the week schedule for this user prior to the shift trade
	PreTradeSchedulePaidMinutes *int `json:"preTradeSchedulePaidMinutes,omitempty"`

	// PostTradeSchedulePaidMinutes - The paid minutes on the week schedule for this user if the shift trade is approved
	PostTradeSchedulePaidMinutes *int `json:"postTradeSchedulePaidMinutes,omitempty"`

	// PostTradeNewShift - Preview of what the shift will look like for the opposite side of this trade after the match is approved
	PostTradeNewShift *Shifttradepreviewresponse `json:"postTradeNewShift,omitempty"`
}

Shifttradematchreviewuserresponse

func (*Shifttradematchreviewuserresponse) String ¶

String returns a JSON representation of the model

type Shifttradematchviolation ¶

type Shifttradematchviolation struct {
	// VarType - The type of constraint violation
	VarType *string `json:"type,omitempty"`

	// Params - Clarifying user params for constructing helpful error messages
	Params *map[string]string `json:"params,omitempty"`
}

Shifttradematchviolation

func (*Shifttradematchviolation) String ¶

func (o *Shifttradematchviolation) String() string

String returns a JSON representation of the model

type Shifttradenotification ¶

type Shifttradenotification struct {
	// WeekDate - The start date of the schedule with which this trade is associated
	WeekDate *string `json:"weekDate,omitempty"`

	// TradeId - The ID of the shift trade
	TradeId *string `json:"tradeId,omitempty"`

	// OneSided - Whether this is a one sided shift trade
	OneSided *bool `json:"oneSided,omitempty"`

	// NewState - The new state of the shift trade, null if there was no change
	NewState *string `json:"newState,omitempty"`

	// InitiatingUser - The user who initiated the shift trade
	InitiatingUser *Userreference `json:"initiatingUser,omitempty"`

	// InitiatingShiftDate - The start date and time of the initiating shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	InitiatingShiftDate *time.Time `json:"initiatingShiftDate,omitempty"`

	// ReceivingUser - The user on the receiving side of this shift trade (null if not matched)
	ReceivingUser *Userreference `json:"receivingUser,omitempty"`

	// ReceivingShiftDate - The start date and time of the receiving shift (null if not matched or if one-sided. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ReceivingShiftDate *time.Time `json:"receivingShiftDate,omitempty"`
}

Shifttradenotification

func (*Shifttradenotification) String ¶

func (o *Shifttradenotification) String() string

String returns a JSON representation of the model

type Shifttradepreviewresponse ¶

type Shifttradepreviewresponse struct {
	// Activities - List of activities that will make up the new shift if this shift trade is approved
	Activities *[]Shifttradeactivitypreviewresponse `json:"activities,omitempty"`
}

Shifttradepreviewresponse

func (*Shifttradepreviewresponse) String ¶

func (o *Shifttradepreviewresponse) String() string

String returns a JSON representation of the model

type Shifttraderesponse ¶

type Shifttraderesponse struct {
	// Id - The ID of this shift trade
	Id *string `json:"id,omitempty"`

	// WeekDate - The start week date of the associated schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	WeekDate *time.Time `json:"weekDate,omitempty"`

	// Schedule - A reference to the associated schedule
	Schedule *Buschedulereferenceformuroute `json:"schedule,omitempty"`

	// State - The state of this shift trade
	State *string `json:"state,omitempty"`

	// InitiatingUser - The user who initiated this trade
	InitiatingUser *Userreference `json:"initiatingUser,omitempty"`

	// InitiatingShiftId - The ID of the shift offered for trade by the initiating user
	InitiatingShiftId *string `json:"initiatingShiftId,omitempty"`

	// InitiatingShiftStart - The start date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	InitiatingShiftStart *time.Time `json:"initiatingShiftStart,omitempty"`

	// InitiatingShiftEnd - The end date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	InitiatingShiftEnd *time.Time `json:"initiatingShiftEnd,omitempty"`

	// ReceivingUser - The user matching the trade, or if the state is not Matched, the user to whom the trade request was sent
	ReceivingUser *Userreference `json:"receivingUser,omitempty"`

	// ReceivingShiftId - The ID of the shift being exchanged for the initiating shift, null if the receiving user is picking up a shift
	ReceivingShiftId *string `json:"receivingShiftId,omitempty"`

	// ReceivingShiftStart - The start date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ReceivingShiftStart *time.Time `json:"receivingShiftStart,omitempty"`

	// ReceivingShiftEnd - The end date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ReceivingShiftEnd *time.Time `json:"receivingShiftEnd,omitempty"`

	// Expiration - When this shift trade offer will expire if not matched or approved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Expiration *time.Time `json:"expiration,omitempty"`

	// OneSided - Whether this is a one-sided shift trade (e.g. the initiating user is not asking for a shift in return)
	OneSided *bool `json:"oneSided,omitempty"`

	// AcceptableIntervals
	AcceptableIntervals *[]string `json:"acceptableIntervals,omitempty"`

	// ReviewedBy - The user who reviewed this shift trade
	ReviewedBy *Userreference `json:"reviewedBy,omitempty"`

	// ReviewedDate - The timestamp when this shift trade was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ReviewedDate *time.Time `json:"reviewedDate,omitempty"`

	// Metadata - Version data for this trade
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Shifttraderesponse

func (*Shifttraderesponse) String ¶

func (o *Shifttraderesponse) String() string

String returns a JSON representation of the model

type Shifttradesettings ¶

type Shifttradesettings struct {
	// Enabled - Whether shift trading is enabled for this management unit
	Enabled *bool `json:"enabled,omitempty"`

	// AutoReview - Whether automatic shift trade review is enabled according to the rules defined in for this management unit
	AutoReview *bool `json:"autoReview,omitempty"`

	// AllowDirectTrades - Whether direct shift trades between agents are allowed
	AllowDirectTrades *bool `json:"allowDirectTrades,omitempty"`

	// MinHoursInFuture - The minimum number of hours in the future shift trades are allowed
	MinHoursInFuture *int `json:"minHoursInFuture,omitempty"`

	// UnequalPaid - How to handle shift trades which involve unequal paid times
	UnequalPaid *string `json:"unequalPaid,omitempty"`

	// OneSided - How to handle one-sided shift trades
	OneSided *string `json:"oneSided,omitempty"`

	// WeeklyMinPaidViolations - How to handle shift trades which result in violations of weekly minimum paid time constraint
	WeeklyMinPaidViolations *string `json:"weeklyMinPaidViolations,omitempty"`

	// WeeklyMaxPaidViolations - How to handle shift trades which result in violations of weekly maximum paid time constraint
	WeeklyMaxPaidViolations *string `json:"weeklyMaxPaidViolations,omitempty"`

	// RequiresMatchingQueues - Whether to constrain shift trades to agents with matching queues
	RequiresMatchingQueues *bool `json:"requiresMatchingQueues,omitempty"`

	// RequiresMatchingLanguages - Whether to constrain shift trades to agents with matching languages
	RequiresMatchingLanguages *bool `json:"requiresMatchingLanguages,omitempty"`

	// RequiresMatchingSkills - Whether to constrain shift trades to agents with matching skills
	RequiresMatchingSkills *bool `json:"requiresMatchingSkills,omitempty"`

	// RequiresMatchingPlanningGroups - Whether to constrain shift trades to agents with matching planning groups
	RequiresMatchingPlanningGroups *bool `json:"requiresMatchingPlanningGroups,omitempty"`

	// ActivityCategoryRules - Rules that specify what to do with activity categories that are part of a shift defined in a trade
	ActivityCategoryRules *[]Shifttradeactivityrule `json:"activityCategoryRules,omitempty"`
}

Shifttradesettings

func (*Shifttradesettings) String ¶

func (o *Shifttradesettings) String() string

String returns a JSON representation of the model

type Shorttermforecastingsettings ¶

type Shorttermforecastingsettings struct {
	// DefaultHistoryWeeks - The number of weeks to consider by default when generating a volume forecast
	DefaultHistoryWeeks *int `json:"defaultHistoryWeeks,omitempty"`
}

Shorttermforecastingsettings - Short Term Forecasting Settings

func (*Shorttermforecastingsettings) String ¶

String returns a JSON representation of the model

type Shorttermforecastreference ¶

type Shorttermforecastreference 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"`

	// WeekDate - The weekDate of the short term forecast in yyyy-MM-dd format
	WeekDate *string `json:"weekDate,omitempty"`

	// Description - The description of the short term forecast
	Description *string `json:"description,omitempty"`
}

Shorttermforecastreference - A pointer to a short term forecast

func (*Shorttermforecastreference) String ¶

func (o *Shorttermforecastreference) String() string

String returns a JSON representation of the model

type Shrinkageoverride ¶

type Shrinkageoverride struct {
	// IntervalIndex - Index of shrinkage override interval. Starting index is 0 and indexes are based on 15 minute intervals for a 7 day week
	IntervalIndex *int `json:"intervalIndex,omitempty"`

	// ShrinkagePercent - Shrinkage override percent. Setting a null value will reset the interval to the default
	ShrinkagePercent *float64 `json:"shrinkagePercent,omitempty"`
}

Shrinkageoverride

func (*Shrinkageoverride) String ¶

func (o *Shrinkageoverride) String() string

String returns a JSON representation of the model

type Shrinkageoverrides ¶

type Shrinkageoverrides struct {
	// Clear - Set true to clear the shrinkage interval overrides
	Clear *bool `json:"clear,omitempty"`

	// Values - List of interval shrinkage overrides
	Values *[]Shrinkageoverride `json:"values,omitempty"`
}

Shrinkageoverrides

func (*Shrinkageoverrides) String ¶

func (o *Shrinkageoverrides) String() string

String returns a JSON representation of the model

type Signedurlresponse ¶

type Signedurlresponse struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Url - Url of the downloaded pcap file
	Url *string `json:"url,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Signedurlresponse

func (*Signedurlresponse) String ¶

func (o *Signedurlresponse) String() string

String returns a JSON representation of the model

type Singleworkdayaveragepoints ¶

type Singleworkdayaveragepoints struct {
	// DateWorkday - Queried target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateWorkday *time.Time `json:"dateWorkday,omitempty"`

	// Division - The targeted division for the average points
	Division *Division `json:"division,omitempty"`

	// AveragePoints - The average points per agent earned within the division
	AveragePoints *float64 `json:"averagePoints,omitempty"`
}

Singleworkdayaveragepoints

func (*Singleworkdayaveragepoints) String ¶

func (o *Singleworkdayaveragepoints) String() string

String returns a JSON representation of the model

type Singleworkdayaveragevalues ¶

type Singleworkdayaveragevalues struct {
	// DateWorkday - The targeted workday for average value query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateWorkday *time.Time `json:"dateWorkday,omitempty"`

	// Division - The targeted division for the metrics
	Division *Division `json:"division,omitempty"`

	// User - The targeted user for the metrics
	User *Userreference `json:"user,omitempty"`

	// Timezone - The time zone used for aggregating metric values
	Timezone *string `json:"timezone,omitempty"`

	// Results - The metric value averages
	Results *[]Workdayvaluesmetricitem `json:"results,omitempty"`
}

Singleworkdayaveragevalues

func (*Singleworkdayaveragevalues) String ¶

func (o *Singleworkdayaveragevalues) String() string

String returns a JSON representation of the model

type Sipdownloadresponse ¶

type Sipdownloadresponse struct {
	// DownloadId - unique id of the downloaded file
	DownloadId *string `json:"downloadId,omitempty"`

	// DocumentId - Document id of pcap file
	DocumentId *string `json:"documentId,omitempty"`
}

Sipdownloadresponse

func (*Sipdownloadresponse) String ¶

func (o *Sipdownloadresponse) String() string

String returns a JSON representation of the model

type Sipsearchpublicrequest ¶

type Sipsearchpublicrequest struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// CallId - unique identification of the placed call
	CallId *string `json:"callId,omitempty"`

	// ToUser - SIP user to who the call was placed
	ToUser *string `json:"toUser,omitempty"`

	// FromUser - SIP user who placed the call
	FromUser *string `json:"fromUser,omitempty"`

	// ConversationId - Unique identification of the conversation
	ConversationId *string `json:"conversationId,omitempty"`

	// ParticipantId - Unique identification of the participant
	ParticipantId *string `json:"participantId,omitempty"`

	// DateStart - Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateStart *time.Time `json:"dateStart,omitempty"`

	// DateEnd - End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateEnd *time.Time `json:"dateEnd,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Sipsearchpublicrequest

func (*Sipsearchpublicrequest) String ¶

func (o *Sipsearchpublicrequest) String() string

String returns a JSON representation of the model

type Sipsearchresult ¶

type Sipsearchresult struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Status - Status of the search request
	Status *int `json:"status,omitempty"`

	// Sid - Session id associated to the search request
	Sid *string `json:"sid,omitempty"`

	// Auth - Auth token used for this search request
	Auth *string `json:"auth,omitempty"`

	// Message - Any messages returned from homer as part of the response
	Message *string `json:"message,omitempty"`

	// Data - Homer search data that is returned
	Data *[]Homerrecord `json:"data,omitempty"`

	// Count - Number of records returned
	Count *int `json:"count,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Sipsearchresult

func (*Sipsearchresult) String ¶

func (o *Sipsearchresult) String() string

String returns a JSON representation of the model

type Site ¶

type Site struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// PrimarySites
	PrimarySites *[]Domainentityref `json:"primarySites,omitempty"`

	// SecondarySites
	SecondarySites *[]Domainentityref `json:"secondarySites,omitempty"`

	// PrimaryEdges
	PrimaryEdges *[]Edge `json:"primaryEdges,omitempty"`

	// SecondaryEdges
	SecondaryEdges *[]Edge `json:"secondaryEdges,omitempty"`

	// Addresses
	Addresses *[]Contact `json:"addresses,omitempty"`

	// Edges
	Edges *[]Edge `json:"edges,omitempty"`

	// EdgeAutoUpdateConfig - Recurrance rule, time zone, and start/end settings for automatic edge updates for this site
	EdgeAutoUpdateConfig *Edgeautoupdateconfig `json:"edgeAutoUpdateConfig,omitempty"`

	// MediaRegionsUseLatencyBased
	MediaRegionsUseLatencyBased *bool `json:"mediaRegionsUseLatencyBased,omitempty"`

	// Location - Location
	Location *Locationdefinition `json:"location,omitempty"`

	// Managed
	Managed *bool `json:"managed,omitempty"`

	// NtpSettings - Network Time Protocol settings for the site
	NtpSettings *Ntpsettings `json:"ntpSettings,omitempty"`

	// MediaModel - Media model for the site
	MediaModel *string `json:"mediaModel,omitempty"`

	// CoreSite - Is this site a core site
	CoreSite *bool `json:"coreSite,omitempty"`

	// SiteConnections - The site connections
	SiteConnections *[]Siteconnection `json:"siteConnections,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Site

func (*Site) String ¶

func (o *Site) String() string

String returns a JSON representation of the model

type Siteconnection ¶

type Siteconnection struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// Managed
	Managed *bool `json:"managed,omitempty"`

	// VarType - Connection method from site to site (Direct, Indirect, CloudProxy
	VarType *string `json:"type,omitempty"`

	// Enabled - Indicates if the current site is linked
	Enabled *bool `json:"enabled,omitempty"`

	// MediaModel - Media model for the current site.
	MediaModel *string `json:"mediaModel,omitempty"`

	// EdgeList - All of the edges to which the site connects
	EdgeList *[]Connectededge `json:"edgeList,omitempty"`

	// CoreSite - The core site
	CoreSite *bool `json:"coreSite,omitempty"`

	// PrimaryCoreSites - List of site ids names and selfUris for the primary core sites
	PrimaryCoreSites *[]Domainentityref `json:"primaryCoreSites,omitempty"`

	// SecondaryCoreSites - List of site ids names and selfUris for the secondary core sites
	SecondaryCoreSites *[]Domainentityref `json:"secondaryCoreSites,omitempty"`
}

Siteconnection

func (*Siteconnection) String ¶

func (o *Siteconnection) String() string

String returns a JSON representation of the model

type Siteentitylisting ¶

type Siteentitylisting struct {
	// Entities
	Entities *[]Site `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Siteentitylisting

func (*Siteentitylisting) String ¶

func (o *Siteentitylisting) String() string

String returns a JSON representation of the model

type Skillentitylisting ¶

type Skillentitylisting struct {
	// Entities
	Entities *[]Routingskill `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Skillentitylisting

func (*Skillentitylisting) String ¶

func (o *Skillentitylisting) String() string

String returns a JSON representation of the model

type Skillstoremove ¶

type Skillstoremove struct {
	// Name
	Name *string `json:"name,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`
}

Skillstoremove

func (*Skillstoremove) String ¶

func (o *Skillstoremove) String() string

String returns a JSON representation of the model

type Smsaddress ¶

type Smsaddress struct {
	// Id - The id of this address.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Street - The number and street address where this address is located.
	Street *string `json:"street,omitempty"`

	// City - The city in which this address is in
	City *string `json:"city,omitempty"`

	// Region - The state or region this address is in
	Region *string `json:"region,omitempty"`

	// PostalCode - The postal code this address is in
	PostalCode *string `json:"postalCode,omitempty"`

	// CountryCode - The ISO country code of this address
	CountryCode *string `json:"countryCode,omitempty"`

	// Validated - In some countries, addresses are validated to comply with local regulation. In those countries, if the address you provide does not pass validation, it will not be accepted as an Address. This value will be true if the Address has been validated, or false for countries that don't require validation or if the Address is non-compliant.
	Validated *bool `json:"validated,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Smsaddress

func (*Smsaddress) String ¶

func (o *Smsaddress) String() string

String returns a JSON representation of the model

type Smsaddressentitylisting ¶

type Smsaddressentitylisting struct {
	// Entities
	Entities *[]Smsaddress `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Smsaddressentitylisting

func (*Smsaddressentitylisting) String ¶

func (o *Smsaddressentitylisting) String() string

String returns a JSON representation of the model

type Smsaddressprovision ¶

type Smsaddressprovision struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - Name associated with this address
	Name *string `json:"name,omitempty"`

	// Street - The number and street address where this address is located.
	Street *string `json:"street,omitempty"`

	// City - The city in which this address is in
	City *string `json:"city,omitempty"`

	// Region - The state or region this address is in
	Region *string `json:"region,omitempty"`

	// PostalCode - The postal code this address is in
	PostalCode *string `json:"postalCode,omitempty"`

	// CountryCode - The ISO country code of this address
	CountryCode *string `json:"countryCode,omitempty"`

	// AutoCorrectAddress - This is used when the address is created. If the value is not set or true, then the system will, if necessary, auto-correct the address you provide. Set this value to false if the system should not auto-correct the address.
	AutoCorrectAddress *bool `json:"autoCorrectAddress,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Smsaddressprovision

func (*Smsaddressprovision) String ¶

func (o *Smsaddressprovision) String() string

String returns a JSON representation of the model

type Smsavailablephonenumber ¶

type Smsavailablephonenumber struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// PhoneNumber - A phone number available for provisioning in E.164 format. E.g. +13175555555 or +34234234234
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// CountryCode - The ISO 3166-1 alpha-2 country code of the country this phone number is associated with.
	CountryCode *string `json:"countryCode,omitempty"`

	// Region - The region/province/state the phone number is associated with.
	Region *string `json:"region,omitempty"`

	// City - The city the phone number is associated with.
	City *string `json:"city,omitempty"`

	// Capabilities - The capabilities of the phone number available for provisioning.
	Capabilities *[]string `json:"capabilities,omitempty"`

	// PhoneNumberType - The type of phone number available for provisioning.
	PhoneNumberType *string `json:"phoneNumberType,omitempty"`

	// AddressRequirement - The address requirement needed for provisioning this number. If there is a requirement, the address must be the residence or place of business of the individual or entity using the phone number.
	AddressRequirement *string `json:"addressRequirement,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Smsavailablephonenumber

func (*Smsavailablephonenumber) String ¶

func (o *Smsavailablephonenumber) String() string

String returns a JSON representation of the model

type Smsavailablephonenumberentitylisting ¶

type Smsavailablephonenumberentitylisting struct {
	// Entities
	Entities *[]Smsavailablephonenumber `json:"entities,omitempty"`
}

Smsavailablephonenumberentitylisting

func (*Smsavailablephonenumberentitylisting) String ¶

String returns a JSON representation of the model

type Smsconfig ¶

type Smsconfig struct {
	// MessageColumn - The Contact List column specifying the message to send to the contact.
	MessageColumn *string `json:"messageColumn,omitempty"`

	// PhoneColumn - The Contact List column specifying the phone number to send a message to.
	PhoneColumn *string `json:"phoneColumn,omitempty"`

	// SenderSmsPhoneNumber - A reference to the SMS Phone Number that will be used as the sender of a message.
	SenderSmsPhoneNumber *Smsphonenumberref `json:"senderSmsPhoneNumber,omitempty"`
}

Smsconfig

func (*Smsconfig) String ¶

func (o *Smsconfig) String() string

String returns a JSON representation of the model

type Smsphonenumber ¶

type Smsphonenumber struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// PhoneNumber - A phone number provisioned for SMS communications in E.164 format. E.g. +13175555555 or +34234234234
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// PhoneNumberType - Type of the phone number provisioned.
	PhoneNumberType *string `json:"phoneNumberType,omitempty"`

	// ProvisionedThroughPureCloud - Is set to false, if the phone number is provisioned through a SMS provider, outside of PureCloud
	ProvisionedThroughPureCloud *bool `json:"provisionedThroughPureCloud,omitempty"`

	// PhoneNumberStatus - Status of the provisioned phone number.
	PhoneNumberStatus *string `json:"phoneNumberStatus,omitempty"`

	// Capabilities - The capabilities of the phone number available for provisioning.
	Capabilities *[]string `json:"capabilities,omitempty"`

	// CountryCode - The ISO 3166-1 alpha-2 country code of the country this phone number is associated with.
	CountryCode *string `json:"countryCode,omitempty"`

	// DateCreated - Date this phone number was provisioned. 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 - Date this phone number was 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"`

	// CreatedBy - User that provisioned this phone number
	CreatedBy *User `json:"createdBy,omitempty"`

	// ModifiedBy - User that last modified this phone number
	ModifiedBy *User `json:"modifiedBy,omitempty"`

	// Version - Version number required for updates.
	Version *int `json:"version,omitempty"`

	// PurchaseDate - Date this phone number was purchased, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	PurchaseDate *time.Time `json:"purchaseDate,omitempty"`

	// CancellationDate - Contract end date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CancellationDate *time.Time `json:"cancellationDate,omitempty"`

	// RenewalDate - Contract renewal date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	RenewalDate *time.Time `json:"renewalDate,omitempty"`

	// AutoRenewable - Renewal time period of this phone number, if the phoneNumberType is shortcode.
	AutoRenewable *string `json:"autoRenewable,omitempty"`

	// AddressId - The id of an address attached to this phone number.
	AddressId *Smsaddress `json:"addressId,omitempty"`

	// ShortCodeBillingType - BillingType of this phone number, if the phoneNumberType is shortcode.
	ShortCodeBillingType *string `json:"shortCodeBillingType,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Smsphonenumber

func (*Smsphonenumber) String ¶

func (o *Smsphonenumber) String() string

String returns a JSON representation of the model

type Smsphonenumberentitylisting ¶

type Smsphonenumberentitylisting struct {
	// Entities
	Entities *[]Smsphonenumber `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Smsphonenumberentitylisting

func (*Smsphonenumberentitylisting) String ¶

func (o *Smsphonenumberentitylisting) String() string

String returns a JSON representation of the model

type Smsphonenumberprovision ¶

type Smsphonenumberprovision struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// PhoneNumber - A phone number to be used for SMS communications. E.g. +13175555555 or +34234234234
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// PhoneNumberType - Type of the phone number provisioned.
	PhoneNumberType *string `json:"phoneNumberType,omitempty"`

	// CountryCode - The ISO 3166-1 alpha-2 country code of the country this phone number is associated with.
	CountryCode *string `json:"countryCode,omitempty"`

	// AddressId - The id of an address added on your account. Due to regulatory requirements in some countries, an address may be required when provisioning a sms number. In those cases you should provide the provisioned sms address id here
	AddressId *string `json:"addressId,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Smsphonenumberprovision

func (*Smsphonenumberprovision) String ¶

func (o *Smsphonenumberprovision) String() string

String returns a JSON representation of the model

type Smsphonenumberref ¶

type Smsphonenumberref struct {
	// PhoneNumber - A phone number provisioned for SMS communications in E.164 format. E.g. +13175555555 or +34234234234
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`
}

Smsphonenumberref

func (*Smsphonenumberref) String ¶

func (o *Smsphonenumberref) String() string

String returns a JSON representation of the model

type Socialexpression ¶

type Socialexpression 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"`

	// SocialMediaId - A globally unique identifier for the social media.
	SocialMediaId *string `json:"socialMediaId,omitempty"`

	// SocialMediaHub - The social network of the communication
	SocialMediaHub *string `json:"socialMediaHub,omitempty"`

	// SocialUserName - The user name for the communication.
	SocialUserName *string `json:"socialUserName,omitempty"`

	// PreviewText - The text preview of the communication contents
	PreviewText *string `json:"previewText,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"`

	// 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 social expression.
	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"`

	// 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"`
}

Socialexpression

func (*Socialexpression) String ¶

func (o *Socialexpression) String() string

String returns a JSON representation of the model

type Socialhandle ¶

type Socialhandle struct {
	// VarType
	VarType *string `json:"type,omitempty"`

	// Value
	Value *string `json:"value,omitempty"`
}

Socialhandle

func (*Socialhandle) String ¶

func (o *Socialhandle) String() string

String returns a JSON representation of the model

type Sortitem ¶

type Sortitem struct {
	// Name
	Name *string `json:"name,omitempty"`

	// Ascending
	Ascending *bool `json:"ascending,omitempty"`
}

Sortitem

func (*Sortitem) String ¶

func (o *Sortitem) String() string

String returns a JSON representation of the model

type Sourceplanninggrouprequest ¶

type Sourceplanninggrouprequest struct {
	// Id - The ID of the planning group
	Id *string `json:"id,omitempty"`

	// Metadata - Version metadata for the planning group
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Sourceplanninggrouprequest - Source planning group

func (*Sourceplanninggrouprequest) String ¶

func (o *Sourceplanninggrouprequest) String() string

String returns a JSON representation of the model

type SpeechTextAnalyticsApi ¶

type SpeechTextAnalyticsApi struct {
	Configuration *Configuration
}

SpeechTextAnalyticsApi provides functions for API endpoints

func NewSpeechTextAnalyticsApi ¶

func NewSpeechTextAnalyticsApi() *SpeechTextAnalyticsApi

NewSpeechTextAnalyticsApi creates an API instance using the default configuration

func NewSpeechTextAnalyticsApiWithConfig ¶

func NewSpeechTextAnalyticsApiWithConfig(config *Configuration) *SpeechTextAnalyticsApi

NewSpeechTextAnalyticsApiWithConfig creates an API instance using the provided configuration

func (SpeechTextAnalyticsApi) DeleteSpeechandtextanalyticsProgram ¶

func (a SpeechTextAnalyticsApi) DeleteSpeechandtextanalyticsProgram(programId string, forceDelete bool) (*APIResponse, error)

DeleteSpeechandtextanalyticsProgram invokes DELETE /api/v2/speechandtextanalytics/programs/{programId}

Delete a Speech &amp; Text Analytics program by id

func (SpeechTextAnalyticsApi) DeleteSpeechandtextanalyticsTopic ¶

func (a SpeechTextAnalyticsApi) DeleteSpeechandtextanalyticsTopic(topicId string) (*APIResponse, error)

DeleteSpeechandtextanalyticsTopic invokes DELETE /api/v2/speechandtextanalytics/topics/{topicId}

Delete a Speech &amp; Text Analytics topic by id

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsConversation ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsConversation(conversationId string) (*Conversationmetrics, *APIResponse, error)

GetSpeechandtextanalyticsConversation invokes GET /api/v2/speechandtextanalytics/conversations/{conversationId}

Get Speech and Text Analytics for a specific conversation

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsConversationCommunicationTranscripturl ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsConversationCommunicationTranscripturl(conversationId string, communicationId string) (*Transcripturl, *APIResponse, error)

GetSpeechandtextanalyticsConversationCommunicationTranscripturl invokes GET /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl

Get the pre-signed S3 URL for the transcript of a specific communication of a conversation

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsDialects ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsDialects() ([]interface{}, *APIResponse, error)

GetSpeechandtextanalyticsDialects invokes GET /api/v2/speechandtextanalytics/dialects

Get list of supported Speech &amp; Text Analytics dialects

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgram ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgram(programId string) (*Program, *APIResponse, error)

GetSpeechandtextanalyticsProgram invokes GET /api/v2/speechandtextanalytics/programs/{programId}

Get a Speech &amp; Text Analytics program by id

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgramMappings ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgramMappings(programId string) (*Programmappings, *APIResponse, error)

GetSpeechandtextanalyticsProgramMappings invokes GET /api/v2/speechandtextanalytics/programs/{programId}/mappings

Get Speech &amp; Text Analytics program mappings to queues and flows by id

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsPrograms ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsPrograms(nextPage string, pageSize int) (*Programsentitylisting, *APIResponse, error)

GetSpeechandtextanalyticsPrograms invokes GET /api/v2/speechandtextanalytics/programs

Get the list of Speech &amp; Text Analytics programs

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgramsGeneralJob ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgramsGeneralJob(jobId string) (*Generalprogramjob, *APIResponse, error)

GetSpeechandtextanalyticsProgramsGeneralJob invokes GET /api/v2/speechandtextanalytics/programs/general/jobs/{jobId}

Get a Speech &amp; Text Analytics general program job by id

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgramsMappings ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgramsMappings(nextPage string, pageSize int) (*Programsmappingsentitylisting, *APIResponse, error)

GetSpeechandtextanalyticsProgramsMappings invokes GET /api/v2/speechandtextanalytics/programs/mappings

Get the list of Speech &amp; Text Analytics programs mappings to queues and flows

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgramsPublishjob ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgramsPublishjob(jobId string) (*Programjob, *APIResponse, error)

GetSpeechandtextanalyticsProgramsPublishjob invokes GET /api/v2/speechandtextanalytics/programs/publishjobs/{jobId}

Get a Speech &amp; Text Analytics publish programs job by id

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgramsUnpublished ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgramsUnpublished(nextPage string, pageSize int) (*Unpublishedprogramsentitylisting, *APIResponse, error)

GetSpeechandtextanalyticsProgramsUnpublished invokes GET /api/v2/speechandtextanalytics/programs/unpublished

Get the list of Speech &amp; Text Analytics unpublished programs

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsSettings ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsSettings() (*Speechtextanalyticssettingsresponse, *APIResponse, error)

GetSpeechandtextanalyticsSettings invokes GET /api/v2/speechandtextanalytics/settings

Get Speech And Text Analytics Settings

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsTopic ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsTopic(topicId string) (*Topic, *APIResponse, error)

GetSpeechandtextanalyticsTopic invokes GET /api/v2/speechandtextanalytics/topics/{topicId}

Get a Speech &amp; Text Analytics topic by id

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsTopics ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsTopics(nextPage string, pageSize int) (*Topicsentitylisting, *APIResponse, error)

GetSpeechandtextanalyticsTopics invokes GET /api/v2/speechandtextanalytics/topics

Get the list of Speech &amp; Text Analytics topics

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsTopicsGeneral ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsTopicsGeneral(dialect string) (*Generaltopicsentitylisting, *APIResponse, error)

GetSpeechandtextanalyticsTopicsGeneral invokes GET /api/v2/speechandtextanalytics/topics/general

Get the Speech &amp; Text Analytics general topics for a given dialect

func (SpeechTextAnalyticsApi) GetSpeechandtextanalyticsTopicsPublishjob ¶

func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsTopicsPublishjob(jobId string) (*Topicjob, *APIResponse, error)

GetSpeechandtextanalyticsTopicsPublishjob invokes GET /api/v2/speechandtextanalytics/topics/publishjobs/{jobId}

Get a Speech &amp; Text Analytics publish topics job by id

func (SpeechTextAnalyticsApi) PatchSpeechandtextanalyticsSettings ¶

PatchSpeechandtextanalyticsSettings invokes PATCH /api/v2/speechandtextanalytics/settings

Patch Speech And Text Analytics Settings

func (SpeechTextAnalyticsApi) PostSpeechandtextanalyticsPrograms ¶

func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsPrograms(body Programrequest) (*Program, *APIResponse, error)

PostSpeechandtextanalyticsPrograms invokes POST /api/v2/speechandtextanalytics/programs

Create new Speech &amp; Text Analytics program

func (SpeechTextAnalyticsApi) PostSpeechandtextanalyticsProgramsGeneralJobs ¶

func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsProgramsGeneralJobs(body Generalprogramjobrequest) (*Generalprogramjob, *APIResponse, error)

PostSpeechandtextanalyticsProgramsGeneralJobs invokes POST /api/v2/speechandtextanalytics/programs/general/jobs

Create new Speech &amp; Text Analytics general program job

func (SpeechTextAnalyticsApi) PostSpeechandtextanalyticsProgramsPublishjobs ¶

func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsProgramsPublishjobs(body Programjobrequest) (*Programjob, *APIResponse, error)

PostSpeechandtextanalyticsProgramsPublishjobs invokes POST /api/v2/speechandtextanalytics/programs/publishjobs

Create new Speech &amp; Text Analytics publish programs job

func (SpeechTextAnalyticsApi) PostSpeechandtextanalyticsTopics ¶

func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsTopics(body Topicrequest) (*Topic, *APIResponse, error)

PostSpeechandtextanalyticsTopics invokes POST /api/v2/speechandtextanalytics/topics

Create new Speech &amp; Text Analytics topic

func (SpeechTextAnalyticsApi) PostSpeechandtextanalyticsTopicsPublishjobs ¶

func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsTopicsPublishjobs(body Topicjobrequest) (*Topicjob, *APIResponse, error)

PostSpeechandtextanalyticsTopicsPublishjobs invokes POST /api/v2/speechandtextanalytics/topics/publishjobs

Create new Speech &amp; Text Analytics publish topics job

func (SpeechTextAnalyticsApi) PostSpeechandtextanalyticsTranscriptsSearch ¶

func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsTranscriptsSearch(body Transcriptsearchrequest) (*Jsonsearchresponse, *APIResponse, error)

PostSpeechandtextanalyticsTranscriptsSearch invokes POST /api/v2/speechandtextanalytics/transcripts/search

Search resources.

func (SpeechTextAnalyticsApi) PutSpeechandtextanalyticsProgram ¶

func (a SpeechTextAnalyticsApi) PutSpeechandtextanalyticsProgram(programId string, body Programrequest) (*Program, *APIResponse, error)

PutSpeechandtextanalyticsProgram invokes PUT /api/v2/speechandtextanalytics/programs/{programId}

Update existing Speech &amp; Text Analytics program

func (SpeechTextAnalyticsApi) PutSpeechandtextanalyticsProgramMappings ¶

func (a SpeechTextAnalyticsApi) PutSpeechandtextanalyticsProgramMappings(programId string, body Programmappingsrequest) (*Programmappings, *APIResponse, error)

PutSpeechandtextanalyticsProgramMappings invokes PUT /api/v2/speechandtextanalytics/programs/{programId}/mappings

Set Speech &amp; Text Analytics program mappings to queues and flows

func (SpeechTextAnalyticsApi) PutSpeechandtextanalyticsSettings ¶

PutSpeechandtextanalyticsSettings invokes PUT /api/v2/speechandtextanalytics/settings

Update Speech And Text Analytics Settings

func (SpeechTextAnalyticsApi) PutSpeechandtextanalyticsTopic ¶

func (a SpeechTextAnalyticsApi) PutSpeechandtextanalyticsTopic(topicId string, body Topicrequest) (*Topic, *APIResponse, error)

PutSpeechandtextanalyticsTopic invokes PUT /api/v2/speechandtextanalytics/topics/{topicId}

Update existing Speech &amp; Text Analytics topic

type Speechtextanalyticssettingsrequest ¶

type Speechtextanalyticssettingsrequest struct {
	// DefaultProgramId - Setting to choose name for the default program for topic detection
	DefaultProgramId *string `json:"defaultProgramId,omitempty"`

	// ExpectedDialects - Setting to choose expected dialects
	ExpectedDialects *[]string `json:"expectedDialects,omitempty"`
}

Speechtextanalyticssettingsrequest

func (*Speechtextanalyticssettingsrequest) String ¶

String returns a JSON representation of the model

type Speechtextanalyticssettingsresponse ¶

type Speechtextanalyticssettingsresponse struct {
	// DefaultProgram - Setting to choose name for the default program for topic detection
	DefaultProgram *Addressableentityref `json:"defaultProgram,omitempty"`

	// ExpectedDialects - Setting to choose expected dialects
	ExpectedDialects *[]string `json:"expectedDialects,omitempty"`
}

Speechtextanalyticssettingsresponse

func (*Speechtextanalyticssettingsresponse) String ¶

String returns a JSON representation of the model

type Stateventcampaigntopicdatum ¶

type Stateventcampaigntopicdatum struct {
	// Interval
	Interval *string `json:"interval,omitempty"`

	// Metrics
	Metrics *[]Stateventcampaigntopicmetric `json:"metrics,omitempty"`
}

Stateventcampaigntopicdatum

func (*Stateventcampaigntopicdatum) String ¶

func (o *Stateventcampaigntopicdatum) String() string

String returns a JSON representation of the model

type Stateventcampaigntopicmetric ¶

type Stateventcampaigntopicmetric struct {
	// Metric
	Metric *string `json:"metric,omitempty"`

	// Qualifier
	Qualifier *string `json:"qualifier,omitempty"`

	// Stats
	Stats *map[string]float32 `json:"stats,omitempty"`
}

Stateventcampaigntopicmetric

func (*Stateventcampaigntopicmetric) String ¶

String returns a JSON representation of the model

type Stateventcampaigntopicstatsnotification ¶

type Stateventcampaigntopicstatsnotification struct {
	// Group
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Stateventcampaigntopicdatum `json:"data,omitempty"`
}

Stateventcampaigntopicstatsnotification

func (*Stateventcampaigntopicstatsnotification) String ¶

String returns a JSON representation of the model

type Stateventflowoutcometopicdatum ¶

type Stateventflowoutcometopicdatum struct {
	// Interval
	Interval *string `json:"interval,omitempty"`

	// Metrics
	Metrics *[]Stateventflowoutcometopicmetric `json:"metrics,omitempty"`
}

Stateventflowoutcometopicdatum

func (*Stateventflowoutcometopicdatum) String ¶

String returns a JSON representation of the model

type Stateventflowoutcometopicmetric ¶

type Stateventflowoutcometopicmetric struct {
	// Metric
	Metric *string `json:"metric,omitempty"`

	// Qualifier
	Qualifier *string `json:"qualifier,omitempty"`

	// Stats
	Stats *map[string]float32 `json:"stats,omitempty"`
}

Stateventflowoutcometopicmetric

func (*Stateventflowoutcometopicmetric) String ¶

String returns a JSON representation of the model

type Stateventflowoutcometopicstatsnotification ¶

type Stateventflowoutcometopicstatsnotification struct {
	// Group
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Stateventflowoutcometopicdatum `json:"data,omitempty"`
}

Stateventflowoutcometopicstatsnotification

func (*Stateventflowoutcometopicstatsnotification) String ¶

String returns a JSON representation of the model

type Stateventflowtopicdatum ¶

type Stateventflowtopicdatum struct {
	// Interval
	Interval *string `json:"interval,omitempty"`

	// Metrics
	Metrics *[]Stateventflowtopicmetric `json:"metrics,omitempty"`
}

Stateventflowtopicdatum

func (*Stateventflowtopicdatum) String ¶

func (o *Stateventflowtopicdatum) String() string

String returns a JSON representation of the model

type Stateventflowtopicmetric ¶

type Stateventflowtopicmetric struct {
	// Metric
	Metric *string `json:"metric,omitempty"`

	// Qualifier
	Qualifier *string `json:"qualifier,omitempty"`

	// Stats
	Stats *map[string]float32 `json:"stats,omitempty"`
}

Stateventflowtopicmetric

func (*Stateventflowtopicmetric) String ¶

func (o *Stateventflowtopicmetric) String() string

String returns a JSON representation of the model

type Stateventflowtopicstatsnotification ¶

type Stateventflowtopicstatsnotification struct {
	// Group
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Stateventflowtopicdatum `json:"data,omitempty"`
}

Stateventflowtopicstatsnotification

func (*Stateventflowtopicstatsnotification) String ¶

String returns a JSON representation of the model

type Stateventqueuetopicdatum ¶

type Stateventqueuetopicdatum struct {
	// Interval
	Interval *string `json:"interval,omitempty"`

	// Metrics
	Metrics *[]Stateventqueuetopicmetric `json:"metrics,omitempty"`
}

Stateventqueuetopicdatum

func (*Stateventqueuetopicdatum) String ¶

func (o *Stateventqueuetopicdatum) String() string

String returns a JSON representation of the model

type Stateventqueuetopicmetric ¶

type Stateventqueuetopicmetric struct {
	// Metric
	Metric *string `json:"metric,omitempty"`

	// Qualifier
	Qualifier *string `json:"qualifier,omitempty"`

	// Stats
	Stats *map[string]float32 `json:"stats,omitempty"`
}

Stateventqueuetopicmetric

func (*Stateventqueuetopicmetric) String ¶

func (o *Stateventqueuetopicmetric) String() string

String returns a JSON representation of the model

type Stateventqueuetopicstatsnotification ¶

type Stateventqueuetopicstatsnotification struct {
	// Group
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Stateventqueuetopicdatum `json:"data,omitempty"`
}

Stateventqueuetopicstatsnotification

func (*Stateventqueuetopicstatsnotification) String ¶

String returns a JSON representation of the model

type Stateventusertopicdatum ¶

type Stateventusertopicdatum struct {
	// Interval
	Interval *string `json:"interval,omitempty"`

	// Metrics
	Metrics *[]Stateventusertopicmetric `json:"metrics,omitempty"`
}

Stateventusertopicdatum

func (*Stateventusertopicdatum) String ¶

func (o *Stateventusertopicdatum) String() string

String returns a JSON representation of the model

type Stateventusertopicmetric ¶

type Stateventusertopicmetric struct {
	// Metric
	Metric *string `json:"metric,omitempty"`

	// Qualifier
	Qualifier *string `json:"qualifier,omitempty"`

	// Stats
	Stats *map[string]float32 `json:"stats,omitempty"`
}

Stateventusertopicmetric

func (*Stateventusertopicmetric) String ¶

func (o *Stateventusertopicmetric) String() string

String returns a JSON representation of the model

type Stateventusertopicstatsnotification ¶

type Stateventusertopicstatsnotification struct {
	// Group
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Stateventusertopicdatum `json:"data,omitempty"`
}

Stateventusertopicstatsnotification

func (*Stateventusertopicstatsnotification) String ¶

String returns a JSON representation of the model

type Stateventwrapupcodetopicdatum ¶

type Stateventwrapupcodetopicdatum struct {
	// Interval
	Interval *string `json:"interval,omitempty"`

	// Metrics
	Metrics *[]Stateventwrapupcodetopicmetric `json:"metrics,omitempty"`
}

Stateventwrapupcodetopicdatum

func (*Stateventwrapupcodetopicdatum) String ¶

String returns a JSON representation of the model

type Stateventwrapupcodetopicmetric ¶

type Stateventwrapupcodetopicmetric struct {
	// Metric
	Metric *string `json:"metric,omitempty"`

	// Qualifier
	Qualifier *string `json:"qualifier,omitempty"`

	// Stats
	Stats *map[string]float32 `json:"stats,omitempty"`
}

Stateventwrapupcodetopicmetric

func (*Stateventwrapupcodetopicmetric) String ¶

String returns a JSON representation of the model

type Stateventwrapupcodetopicstatsnotification ¶

type Stateventwrapupcodetopicstatsnotification struct {
	// Group
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Stateventwrapupcodetopicdatum `json:"data,omitempty"`
}

Stateventwrapupcodetopicstatsnotification

func (*Stateventwrapupcodetopicstatsnotification) String ¶

String returns a JSON representation of the model

type Station ¶

type Station 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"`

	// Status
	Status *string `json:"status,omitempty"`

	// UserId - The Id of the user currently logged in and associated with the station.
	UserId *string `json:"userId,omitempty"`

	// WebRtcUserId - The Id of the user configured for the station if it is of type inin_webrtc_softphone. Empty if station type is not inin_webrtc_softphone.
	WebRtcUserId *string `json:"webRtcUserId,omitempty"`

	// PrimaryEdge
	PrimaryEdge *Domainentityref `json:"primaryEdge,omitempty"`

	// SecondaryEdge
	SecondaryEdge *Domainentityref `json:"secondaryEdge,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// LineAppearanceId
	LineAppearanceId *string `json:"lineAppearanceId,omitempty"`

	// WebRtcMediaDscp - The default or configured value of media dscp for the station. Empty if station type is not inin_webrtc_softphone.
	WebRtcMediaDscp *int `json:"webRtcMediaDscp,omitempty"`

	// WebRtcPersistentEnabled - The default or configured value of persistent connection setting for the station. Empty if station type is not inin_webrtc_softphone.
	WebRtcPersistentEnabled *bool `json:"webRtcPersistentEnabled,omitempty"`

	// WebRtcForceTurn - Whether the station is configured to require TURN for routing WebRTC calls. Empty if station type is not inin_webrtc_softphone.
	WebRtcForceTurn *bool `json:"webRtcForceTurn,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Station

func (*Station) String ¶

func (o *Station) String() string

String returns a JSON representation of the model

type Stationentitylisting ¶

type Stationentitylisting struct {
	// Entities
	Entities *[]Station `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Stationentitylisting

func (*Stationentitylisting) String ¶

func (o *Stationentitylisting) String() string

String returns a JSON representation of the model

type StationsApi ¶

type StationsApi struct {
	Configuration *Configuration
}

StationsApi provides functions for API endpoints

func NewStationsApi ¶

func NewStationsApi() *StationsApi

NewStationsApi creates an API instance using the default configuration

func NewStationsApiWithConfig ¶

func NewStationsApiWithConfig(config *Configuration) *StationsApi

NewStationsApiWithConfig creates an API instance using the provided configuration

func (StationsApi) DeleteStationAssociateduser ¶

func (a StationsApi) DeleteStationAssociateduser(stationId string) (*APIResponse, error)

DeleteStationAssociateduser invokes DELETE /api/v2/stations/{stationId}/associateduser

Unassigns the user assigned to this station

func (StationsApi) GetStation ¶

func (a StationsApi) GetStation(stationId string) (*Station, *APIResponse, error)

GetStation invokes GET /api/v2/stations/{stationId}

Get station.

func (StationsApi) GetStations ¶

func (a StationsApi) GetStations(pageSize int, pageNumber int, sortBy string, name string, userSelectable string, webRtcUserId string, id string, lineAppearanceId string) (*Stationentitylisting, *APIResponse, error)

GetStations invokes GET /api/v2/stations

Get the list of available stations.

func (StationsApi) GetStationsSettings ¶

func (a StationsApi) GetStationsSettings() (*Stationsettings, *APIResponse, error)

GetStationsSettings invokes GET /api/v2/stations/settings

Get an organization&#39;s StationSettings

func (StationsApi) PatchStationsSettings ¶

func (a StationsApi) PatchStationsSettings(body Stationsettings) (*Stationsettings, *APIResponse, error)

PatchStationsSettings invokes PATCH /api/v2/stations/settings

Patch an organization&#39;s StationSettings

type Stationsettings ¶

type Stationsettings struct {
	// FreeSeatingConfiguration - Configuration options for free-seating
	FreeSeatingConfiguration *Freeseatingconfiguration `json:"freeSeatingConfiguration,omitempty"`
}

Stationsettings - Organization settings for stations

func (*Stationsettings) String ¶

func (o *Stationsettings) String() string

String returns a JSON representation of the model

type Statisticalresponse ¶

type Statisticalresponse struct {
	// Interval
	Interval *string `json:"interval,omitempty"`

	// Metrics
	Metrics *[]Aggregatemetricdata `json:"metrics,omitempty"`

	// Views
	Views *[]Aggregateviewdata `json:"views,omitempty"`
}

Statisticalresponse

func (*Statisticalresponse) String ¶

func (o *Statisticalresponse) String() string

String returns a JSON representation of the model

type Statisticalsummary ¶

type Statisticalsummary struct {
	// Max
	Max *float32 `json:"max,omitempty"`

	// Min
	Min *float32 `json:"min,omitempty"`

	// Count
	Count *int `json:"count,omitempty"`

	// CountNegative
	CountNegative *int `json:"countNegative,omitempty"`

	// CountPositive
	CountPositive *int `json:"countPositive,omitempty"`

	// Sum
	Sum *float32 `json:"sum,omitempty"`

	// Current
	Current *float32 `json:"current,omitempty"`

	// Ratio
	Ratio *float32 `json:"ratio,omitempty"`

	// Numerator
	Numerator *float32 `json:"numerator,omitempty"`

	// Denominator
	Denominator *float32 `json:"denominator,omitempty"`

	// Target
	Target *float32 `json:"target,omitempty"`
}

Statisticalsummary

func (*Statisticalsummary) String ¶

func (o *Statisticalsummary) String() string

String returns a JSON representation of the model

type Statuschange ¶

type Statuschange struct {
	// DateStatusChanged - The date of this status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateStatusChanged *time.Time `json:"dateStatusChanged,omitempty"`

	// Status - The status the change request transitioned to
	Status *string `json:"status,omitempty"`

	// PreviousStatus - The status the change request transitioned from
	PreviousStatus *string `json:"previousStatus,omitempty"`

	// Message - A short message describing the status change
	Message *string `json:"message,omitempty"`

	// ChangedBy - If applicable, the user who updated the change request to this status
	ChangedBy *string `json:"changedBy,omitempty"`

	// RejectReason - The reason for rejecting the limit override request
	RejectReason *string `json:"rejectReason,omitempty"`
}

Statuschange

func (*Statuschange) String ¶

func (o *Statuschange) String() string

String returns a JSON representation of the model

type Streetaddress ¶

type Streetaddress struct {
	// Country - 2 Letter Country code, like US or GB
	Country *string `json:"country,omitempty"`

	// A1 - State or Province
	A1 *string `json:"A1,omitempty"`

	// A3 - City or township
	A3 *string `json:"A3,omitempty"`

	// RD
	RD *string `json:"RD,omitempty"`

	// HNO
	HNO *string `json:"HNO,omitempty"`

	// LOC
	LOC *string `json:"LOC,omitempty"`

	// NAM
	NAM *string `json:"NAM,omitempty"`

	// PC
	PC *string `json:"PC,omitempty"`
}

Streetaddress

func (*Streetaddress) String ¶

func (o *Streetaddress) String() string

String returns a JSON representation of the model

type Subjectdivisiongrants ¶

type Subjectdivisiongrants struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Divisions
	Divisions *[]Division `json:"divisions,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Subjectdivisiongrants

func (*Subjectdivisiongrants) String ¶

func (o *Subjectdivisiongrants) String() string

String returns a JSON representation of the model

type Subjectdivisiongrantsentitylisting ¶

type Subjectdivisiongrantsentitylisting struct {
	// Entities
	Entities *[]Subjectdivisiongrants `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Subjectdivisiongrantsentitylisting

func (*Subjectdivisiongrantsentitylisting) String ¶

String returns a JSON representation of the model

type Subjectdivisions ¶

type Subjectdivisions struct {
	// SubjectIds - A collection of subject IDs to associate with the given divisions
	SubjectIds *[]string `json:"subjectIds,omitempty"`

	// DivisionIds - A collection of division IDs to associate with the given subjects
	DivisionIds *[]string `json:"divisionIds,omitempty"`
}

Subjectdivisions

func (*Subjectdivisions) String ¶

func (o *Subjectdivisions) String() string

String returns a JSON representation of the model

type Subscriberresponse ¶

type Subscriberresponse struct {
	// MessageReturned - Suggested valid addresses
	MessageReturned *[]string `json:"messageReturned,omitempty"`

	// Status - http status
	Status *string `json:"status,omitempty"`
}

Subscriberresponse

func (*Subscriberresponse) String ¶

func (o *Subscriberresponse) String() string

String returns a JSON representation of the model

type Subscriptionoverviewusage ¶

type Subscriptionoverviewusage struct {
	// Name - Product charge name
	Name *string `json:"name,omitempty"`

	// PartNumber - Product part number
	PartNumber *string `json:"partNumber,omitempty"`

	// Grouping - UI grouping key
	Grouping *string `json:"grouping,omitempty"`

	// UnitOfMeasureType - UI unit of measure
	UnitOfMeasureType *string `json:"unitOfMeasureType,omitempty"`

	// UsageQuantity - Usage count for specified period
	UsageQuantity *string `json:"usageQuantity,omitempty"`

	// OveragePrice - Price for usage / overage charge
	OveragePrice *string `json:"overagePrice,omitempty"`

	// PrepayQuantity - Items prepaid for specified period
	PrepayQuantity *string `json:"prepayQuantity,omitempty"`

	// PrepayPrice - Price for prepay charge
	PrepayPrice *string `json:"prepayPrice,omitempty"`

	// UsageNotes - Notes about the usage/charge item
	UsageNotes *string `json:"usageNotes,omitempty"`

	// IsCancellable - Indicates whether the item is cancellable
	IsCancellable *bool `json:"isCancellable,omitempty"`

	// BundleQuantity - Quantity multiplier for this charge
	BundleQuantity *string `json:"bundleQuantity,omitempty"`

	// IsThirdParty - A charge from a third party entity
	IsThirdParty *bool `json:"isThirdParty,omitempty"`
}

Subscriptionoverviewusage

func (*Subscriptionoverviewusage) String ¶

func (o *Subscriptionoverviewusage) String() string

String returns a JSON representation of the model

type SuggestApi ¶

type SuggestApi struct {
	Configuration *Configuration
}

SuggestApi provides functions for API endpoints

func NewSuggestApi ¶

func NewSuggestApi() *SuggestApi

NewSuggestApi creates an API instance using the default configuration

func NewSuggestApiWithConfig ¶

func NewSuggestApiWithConfig(config *Configuration) *SuggestApi

NewSuggestApiWithConfig creates an API instance using the provided configuration

func (SuggestApi) GetSearch ¶

func (a SuggestApi) GetSearch(q64 string, expand []string, profile bool) (*Jsonnodesearchresponse, *APIResponse, error)

GetSearch invokes GET /api/v2/search

Search using the q64 value returned from a previous search.

func (SuggestApi) GetSearchSuggest ¶

func (a SuggestApi) GetSearchSuggest(q64 string, expand []string, profile bool) (*Jsonnodesearchresponse, *APIResponse, error)

GetSearchSuggest invokes GET /api/v2/search/suggest

Suggest resources using the q64 value returned from a previous suggest query.

func (SuggestApi) PostSearch ¶

func (a SuggestApi) PostSearch(body Searchrequest, profile bool) (*Jsonnodesearchresponse, *APIResponse, error)

PostSearch invokes POST /api/v2/search

Search resources.

func (SuggestApi) PostSearchSuggest ¶

func (a SuggestApi) PostSearchSuggest(body Suggestsearchrequest, profile bool) (*Jsonnodesearchresponse, *APIResponse, error)

PostSearchSuggest invokes POST /api/v2/search/suggest

Suggest resources.

type Suggestsearchcriteria ¶

type Suggestsearchcriteria struct {
	// EndValue - The end value of the range. This field is used for range search types.
	EndValue *string `json:"endValue,omitempty"`

	// Values - A list of values for the search to match against
	Values *[]string `json:"values,omitempty"`

	// StartValue - The start value of the range. This field is used for range search types.
	StartValue *string `json:"startValue,omitempty"`

	// Fields - Field names to search against
	Fields *[]string `json:"fields,omitempty"`

	// Value - A value for the search to match against
	Value *string `json:"value,omitempty"`

	// Operator - How to apply this search criteria against other criteria
	Operator *string `json:"operator,omitempty"`

	// Group - Groups multiple conditions
	Group *[]Suggestsearchcriteria `json:"group,omitempty"`

	// DateFormat - Set date format for criteria values when using date range search type.  Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX.
	DateFormat *string `json:"dateFormat,omitempty"`
}

Suggestsearchcriteria

func (*Suggestsearchcriteria) String ¶

func (o *Suggestsearchcriteria) String() string

String returns a JSON representation of the model

type Suggestsearchrequest ¶

type Suggestsearchrequest struct {
	// Expand - Provides more details about a specified resource
	Expand *[]string `json:"expand,omitempty"`

	// Types - Resource domain type to search
	Types *[]string `json:"types,omitempty"`

	// Query - Suggest query
	Query *[]Suggestsearchcriteria `json:"query,omitempty"`
}

Suggestsearchrequest

func (*Suggestsearchrequest) String ¶

func (o *Suggestsearchrequest) String() string

String returns a JSON representation of the model

type Supportedcontentreference ¶

type Supportedcontentreference struct {
	// Id - The SupportedContent unique identifier associated with this integration
	Id *string `json:"id,omitempty"`

	// Name - The SupportedContent profile name
	Name *string `json:"name,omitempty"`

	// SelfUri - The SupportedContent profile URI
	SelfUri *string `json:"selfUri,omitempty"`

	// MediaTypes - Media types definition for the supported content
	MediaTypes *Mediatypes `json:"mediaTypes,omitempty"`
}

Supportedcontentreference - Reference to supported content profile associated with the integration

func (*Supportedcontentreference) String ¶

func (o *Supportedcontentreference) String() string

String returns a JSON representation of the model

type Supportedlanguage ¶

type Supportedlanguage struct {
	// Language - Architect supported language tag, e.g. en-us, es-us
	Language *string `json:"language,omitempty"`

	// IsDefault - Whether or not this language is the default language
	IsDefault *bool `json:"isDefault,omitempty"`
}

Supportedlanguage

func (*Supportedlanguage) String ¶

func (o *Supportedlanguage) String() string

String returns a JSON representation of the model

type Survey ¶

type Survey struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Conversation
	Conversation *Conversation `json:"conversation,omitempty"`

	// SurveyForm - Survey form used for this survey.
	SurveyForm *Surveyform `json:"surveyForm,omitempty"`

	// Agent
	Agent *Domainentityref `json:"agent,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`

	// Queue
	Queue *Queuereference `json:"queue,omitempty"`

	// Answers
	Answers *Surveyscoringset `json:"answers,omitempty"`

	// CompletedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	CompletedDate *time.Time `json:"completedDate,omitempty"`

	// SurveyErrorDetails - Additional information about what happened when the survey is in Error status.
	SurveyErrorDetails *Surveyerrordetails `json:"surveyErrorDetails,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Survey

func (*Survey) String ¶

func (o *Survey) String() string

String returns a JSON representation of the model

type Surveyaggregatedatacontainer ¶

type Surveyaggregatedatacontainer struct {
	// Group - A mapping from dimension to value
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Statisticalresponse `json:"data,omitempty"`
}

Surveyaggregatedatacontainer

func (*Surveyaggregatedatacontainer) String ¶

String returns a JSON representation of the model

type Surveyaggregatequeryclause ¶

type Surveyaggregatequeryclause 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 *[]Surveyaggregatequerypredicate `json:"predicates,omitempty"`
}

Surveyaggregatequeryclause

func (*Surveyaggregatequeryclause) String ¶

func (o *Surveyaggregatequeryclause) String() string

String returns a JSON representation of the model

type Surveyaggregatequeryfilter ¶

type Surveyaggregatequeryfilter 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 *[]Surveyaggregatequeryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Surveyaggregatequerypredicate `json:"predicates,omitempty"`
}

Surveyaggregatequeryfilter

func (*Surveyaggregatequeryfilter) String ¶

func (o *Surveyaggregatequeryfilter) String() string

String returns a JSON representation of the model

type Surveyaggregatequerypredicate ¶

type Surveyaggregatequerypredicate 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"`
}

Surveyaggregatequerypredicate

func (*Surveyaggregatequerypredicate) String ¶

String returns a JSON representation of the model

type Surveyaggregatequeryresponse ¶

type Surveyaggregatequeryresponse struct {
	// Results
	Results *[]Surveyaggregatedatacontainer `json:"results,omitempty"`
}

Surveyaggregatequeryresponse

func (*Surveyaggregatequeryresponse) String ¶

String returns a JSON representation of the model

type Surveyaggregationquery ¶

type Surveyaggregationquery 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 *Surveyaggregatequeryfilter `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 *[]Surveyaggregationview `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"`
}

Surveyaggregationquery

func (*Surveyaggregationquery) String ¶

func (o *Surveyaggregationquery) String() string

String returns a JSON representation of the model

type Surveyaggregationview ¶

type Surveyaggregationview 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"`
}

Surveyaggregationview

func (*Surveyaggregationview) String ¶

func (o *Surveyaggregationview) String() string

String returns a JSON representation of the model

type Surveyassignment ¶

type Surveyassignment struct {
	// SurveyForm - The survey form used for this survey.
	SurveyForm *Publishedsurveyformreference `json:"surveyForm,omitempty"`

	// Flow - The URI reference to the flow associated with this survey.
	Flow *Domainentityref `json:"flow,omitempty"`

	// InviteTimeInterval - An ISO 8601 repeated interval consisting of the number of repetitions, the start datetime, and the interval (e.g. R2/2018-03-01T13:00:00Z/P1M10DT2H30M). Total duration must not exceed 90 days.
	InviteTimeInterval *string `json:"inviteTimeInterval,omitempty"`

	// SendingUser - User together with sendingDomain used to send email, null to use no-reply
	SendingUser *string `json:"sendingUser,omitempty"`

	// SendingDomain - Validated email domain, required
	SendingDomain *string `json:"sendingDomain,omitempty"`
}

Surveyassignment

func (*Surveyassignment) String ¶

func (o *Surveyassignment) String() string

String returns a JSON representation of the model

type Surveydetailqueryclause ¶

type Surveydetailqueryclause 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 *[]Surveydetailquerypredicate `json:"predicates,omitempty"`
}

Surveydetailqueryclause

func (*Surveydetailqueryclause) String ¶

func (o *Surveydetailqueryclause) String() string

String returns a JSON representation of the model

type Surveydetailqueryfilter ¶

type Surveydetailqueryfilter 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 *[]Surveydetailqueryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Surveydetailquerypredicate `json:"predicates,omitempty"`
}

Surveydetailqueryfilter

func (*Surveydetailqueryfilter) String ¶

func (o *Surveydetailqueryfilter) String() string

String returns a JSON representation of the model

type Surveydetailquerypredicate ¶

type Surveydetailquerypredicate 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"`
}

Surveydetailquerypredicate

func (*Surveydetailquerypredicate) String ¶

func (o *Surveydetailquerypredicate) String() string

String returns a JSON representation of the model

type Surveyerrordetails ¶

type Surveyerrordetails struct {
	// FlowDiagnosticInfo - Additional information about any errors that occurred in the survey invite flow.
	FlowDiagnosticInfo *Flowdiagnosticinfo `json:"flowDiagnosticInfo,omitempty"`

	// SurveyErrorReason - An error code indicating the reason for the survey failure.
	SurveyErrorReason *string `json:"surveyErrorReason,omitempty"`
}

Surveyerrordetails

func (*Surveyerrordetails) String ¶

func (o *Surveyerrordetails) String() string

String returns a JSON representation of the model

type Surveyform ¶

type Surveyform struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The survey form name
	Name *string `json:"name,omitempty"`

	// ModifiedDate - Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ModifiedDate *time.Time `json:"modifiedDate,omitempty"`

	// Published - Is this form published
	Published *bool `json:"published,omitempty"`

	// Disabled - Is this form disabled
	Disabled *bool `json:"disabled,omitempty"`

	// ContextId - Unique Id for all versions of this form
	ContextId *string `json:"contextId,omitempty"`

	// Language - Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW
	Language *string `json:"language,omitempty"`

	// Header - Markdown text for the top of the form.
	Header *string `json:"header,omitempty"`

	// Footer - Markdown text for the bottom of the form.
	Footer *string `json:"footer,omitempty"`

	// QuestionGroups - A list of question groups
	QuestionGroups *[]Surveyquestiongroup `json:"questionGroups,omitempty"`

	// PublishedVersions - List of published version of this form
	PublishedVersions *Domainentitylistingsurveyform `json:"publishedVersions,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Surveyform

func (*Surveyform) String ¶

func (o *Surveyform) String() string

String returns a JSON representation of the model

type Surveyformandscoringset ¶

type Surveyformandscoringset struct {
	// SurveyForm
	SurveyForm *Surveyform `json:"surveyForm,omitempty"`

	// Answers
	Answers *Surveyscoringset `json:"answers,omitempty"`
}

Surveyformandscoringset

func (*Surveyformandscoringset) String ¶

func (o *Surveyformandscoringset) String() string

String returns a JSON representation of the model

type Surveyformentitylisting ¶

type Surveyformentitylisting struct {
	// Entities
	Entities *[]Surveyform `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Surveyformentitylisting

func (*Surveyformentitylisting) String ¶

func (o *Surveyformentitylisting) String() string

String returns a JSON representation of the model

type Surveyquestion ¶

type Surveyquestion struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Text
	Text *string `json:"text,omitempty"`

	// HelpText
	HelpText *string `json:"helpText,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// NaEnabled
	NaEnabled *bool `json:"naEnabled,omitempty"`

	// VisibilityCondition
	VisibilityCondition *Visibilitycondition `json:"visibilityCondition,omitempty"`

	// AnswerOptions - Options from which to choose an answer for this question. Only used by Multiple Choice type questions.
	AnswerOptions *[]Answeroption `json:"answerOptions,omitempty"`

	// MaxResponseCharacters - How many characters are allowed in the text response to this question. Used by NPS and Free Text question types.
	MaxResponseCharacters *int `json:"maxResponseCharacters,omitempty"`

	// ExplanationPrompt - Prompt for details explaining the chosen NPS score. Used by NPS questions.
	ExplanationPrompt *string `json:"explanationPrompt,omitempty"`
}

Surveyquestion

func (*Surveyquestion) String ¶

func (o *Surveyquestion) String() string

String returns a JSON representation of the model

type Surveyquestiongroup ¶

type Surveyquestiongroup struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// NaEnabled
	NaEnabled *bool `json:"naEnabled,omitempty"`

	// Questions
	Questions *[]Surveyquestion `json:"questions,omitempty"`

	// VisibilityCondition
	VisibilityCondition *Visibilitycondition `json:"visibilityCondition,omitempty"`
}

Surveyquestiongroup

func (*Surveyquestiongroup) String ¶

func (o *Surveyquestiongroup) String() string

String returns a JSON representation of the model

type Surveyquestiongroupscore ¶

type Surveyquestiongroupscore struct {
	// QuestionGroupId
	QuestionGroupId *string `json:"questionGroupId,omitempty"`

	// TotalScore - Score of all questions in the group
	TotalScore *float32 `json:"totalScore,omitempty"`

	// MaxTotalScore - Maximum possible score of all questions in the group
	MaxTotalScore *float32 `json:"maxTotalScore,omitempty"`

	// MarkedNA
	MarkedNA *bool `json:"markedNA,omitempty"`

	// QuestionScores
	QuestionScores *[]Surveyquestionscore `json:"questionScores,omitempty"`
}

Surveyquestiongroupscore

func (*Surveyquestiongroupscore) String ¶

func (o *Surveyquestiongroupscore) String() string

String returns a JSON representation of the model

type Surveyquestionscore ¶

type Surveyquestionscore struct {
	// QuestionId
	QuestionId *string `json:"questionId,omitempty"`

	// AnswerId
	AnswerId *string `json:"answerId,omitempty"`

	// Score - Unweighted score of the question
	Score *int `json:"score,omitempty"`

	// MarkedNA
	MarkedNA *bool `json:"markedNA,omitempty"`

	// NpsScore
	NpsScore *int `json:"npsScore,omitempty"`

	// NpsTextAnswer
	NpsTextAnswer *string `json:"npsTextAnswer,omitempty"`

	// FreeTextAnswer
	FreeTextAnswer *string `json:"freeTextAnswer,omitempty"`
}

Surveyquestionscore

func (*Surveyquestionscore) String ¶

func (o *Surveyquestionscore) String() string

String returns a JSON representation of the model

type Surveyscoringset ¶

type Surveyscoringset struct {
	// TotalScore
	TotalScore *float32 `json:"totalScore,omitempty"`

	// NpsScore
	NpsScore *int `json:"npsScore,omitempty"`

	// QuestionGroupScores
	QuestionGroupScores *[]Surveyquestiongroupscore `json:"questionGroupScores,omitempty"`
}

Surveyscoringset

func (*Surveyscoringset) String ¶

func (o *Surveyscoringset) String() string

String returns a JSON representation of the model

type Systemmessagesystemmessage ¶

type Systemmessagesystemmessage struct {
	// ChannelId
	ChannelId *string `json:"channelId,omitempty"`

	// SystemTopicType
	SystemTopicType *string `json:"systemTopicType,omitempty"`

	// CorrelationId
	CorrelationId *string `json:"correlationId,omitempty"`

	// OrganizationId
	OrganizationId *string `json:"organizationId,omitempty"`

	// UserId
	UserId *string `json:"userId,omitempty"`

	// OauthClientId
	OauthClientId *string `json:"oauthClientId,omitempty"`

	// Reason
	Reason *string `json:"reason,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// Data
	Data *interface{} `json:"data,omitempty"`
}

Systemmessagesystemmessage

func (*Systemmessagesystemmessage) String ¶

func (o *Systemmessagesystemmessage) String() string

String returns a JSON representation of the model

type Systempresence ¶

type Systempresence struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Systempresence

func (*Systempresence) String ¶

func (o *Systempresence) String() string

String returns a JSON representation of the model

type Systemprompt ¶

type Systemprompt struct {
	// Id - The system prompt identifier
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Resources
	Resources *[]Systempromptasset `json:"resources,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Systemprompt

func (*Systemprompt) String ¶

func (o *Systemprompt) String() string

String returns a JSON representation of the model

type Systempromptasset ¶

type Systempromptasset struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// PromptId
	PromptId *string `json:"promptId,omitempty"`

	// Language - The asset resource language
	Language *string `json:"language,omitempty"`

	// DurationSeconds
	DurationSeconds *float64 `json:"durationSeconds,omitempty"`

	// MediaUri
	MediaUri *string `json:"mediaUri,omitempty"`

	// TtsString
	TtsString *string `json:"ttsString,omitempty"`

	// Text
	Text *string `json:"text,omitempty"`

	// UploadUri
	UploadUri *string `json:"uploadUri,omitempty"`

	// UploadStatus
	UploadStatus *string `json:"uploadStatus,omitempty"`

	// HasDefault
	HasDefault *bool `json:"hasDefault,omitempty"`

	// LanguageDefault
	LanguageDefault *bool `json:"languageDefault,omitempty"`

	// Tags
	Tags *map[string][]string `json:"tags,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Systempromptasset

func (*Systempromptasset) String ¶

func (o *Systempromptasset) String() string

String returns a JSON representation of the model

type Systempromptassetentitylisting ¶

type Systempromptassetentitylisting struct {
	// Entities
	Entities *[]Systempromptasset `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Systempromptassetentitylisting

func (*Systempromptassetentitylisting) String ¶

String returns a JSON representation of the model

type Systempromptentitylisting ¶

type Systempromptentitylisting struct {
	// Entities
	Entities *[]Systemprompt `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Systempromptentitylisting

func (*Systempromptentitylisting) String ¶

func (o *Systempromptentitylisting) String() string

String returns a JSON representation of the model

type Tagqueryrequest ¶

type Tagqueryrequest struct {
	// Query
	Query *string `json:"query,omitempty"`

	// PageNumber
	PageNumber *int `json:"pageNumber,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`
}

Tagqueryrequest

func (*Tagqueryrequest) String ¶

func (o *Tagqueryrequest) String() string

String returns a JSON representation of the model

type Tagvalue ¶

type Tagvalue struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The workspace tag name.
	Name *string `json:"name,omitempty"`

	// InUse
	InUse *bool `json:"inUse,omitempty"`

	// Acl
	Acl *[]string `json:"acl,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Tagvalue

func (*Tagvalue) String ¶

func (o *Tagvalue) String() string

String returns a JSON representation of the model

type Tagvalueentitylisting ¶

type Tagvalueentitylisting struct {
	// Entities
	Entities *[]Tagvalue `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Tagvalueentitylisting

func (*Tagvalueentitylisting) String ¶

func (o *Tagvalueentitylisting) String() string

String returns a JSON representation of the model

type Team ¶

type Team struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The team name
	Name *string `json:"name,omitempty"`

	// Division - The division to which this entity belongs.
	Division *Division `json:"division,omitempty"`

	// Description - Team information.
	Description *string `json:"description,omitempty"`

	// DateModified - Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// MemberCount - Number of members in a team
	MemberCount *int `json:"memberCount,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Team

func (*Team) String ¶

func (o *Team) String() string

String returns a JSON representation of the model

type TelephonyApi ¶

type TelephonyApi struct {
	Configuration *Configuration
}

TelephonyApi provides functions for API endpoints

func NewTelephonyApi ¶

func NewTelephonyApi() *TelephonyApi

NewTelephonyApi creates an API instance using the default configuration

func NewTelephonyApiWithConfig ¶

func NewTelephonyApiWithConfig(config *Configuration) *TelephonyApi

NewTelephonyApiWithConfig creates an API instance using the provided configuration

func (TelephonyApi) GetTelephonySiptraces ¶

func (a TelephonyApi) GetTelephonySiptraces(dateStart time.Time, dateEnd time.Time, callId string, toUser string, fromUser string, conversationId string) (*Sipsearchresult, *APIResponse, error)

GetTelephonySiptraces invokes GET /api/v2/telephony/siptraces

Fetch SIP metadata ¶

Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected

func (TelephonyApi) GetTelephonySiptracesDownloadDownloadId ¶

func (a TelephonyApi) GetTelephonySiptracesDownloadDownloadId(downloadId string) (*Signedurlresponse, *APIResponse, error)

GetTelephonySiptracesDownloadDownloadId invokes GET /api/v2/telephony/siptraces/download/{downloadId}

Get signed S3 URL for a pcap download

func (TelephonyApi) PostTelephonySiptracesDownload ¶

func (a TelephonyApi) PostTelephonySiptracesDownload(sIPSearchPublicRequest Sipsearchpublicrequest) (*Sipdownloadresponse, *APIResponse, error)

PostTelephonySiptracesDownload invokes POST /api/v2/telephony/siptraces/download

Request a download of a pcap file to S3

type TelephonyProvidersEdgeApi ¶

type TelephonyProvidersEdgeApi struct {
	Configuration *Configuration
}

TelephonyProvidersEdgeApi provides functions for API endpoints

func NewTelephonyProvidersEdgeApi ¶

func NewTelephonyProvidersEdgeApi() *TelephonyProvidersEdgeApi

NewTelephonyProvidersEdgeApi creates an API instance using the default configuration

func NewTelephonyProvidersEdgeApiWithConfig ¶

func NewTelephonyProvidersEdgeApiWithConfig(config *Configuration) *TelephonyProvidersEdgeApi

NewTelephonyProvidersEdgeApiWithConfig creates an API instance using the provided configuration

func (TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdge ¶

func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdge(edgeId string) (*APIResponse, error)

DeleteTelephonyProvidersEdge invokes DELETE /api/v2/telephony/providers/edges/{edgeId}

Delete a edge.

func (TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgeLogicalinterface ¶

func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgeLogicalinterface(edgeId string, interfaceId string) (*APIResponse, error)

DeleteTelephonyProvidersEdgeLogicalinterface invokes DELETE /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}

Delete an edge logical interface

func (TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgeSoftwareupdate ¶

func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgeSoftwareupdate(edgeId string) (*APIResponse, error)

DeleteTelephonyProvidersEdgeSoftwareupdate invokes DELETE /api/v2/telephony/providers/edges/{edgeId}/softwareupdate

Cancels any in-progress update for this edge.

func (TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesCertificateauthority ¶

func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesCertificateauthority(certificateId string) (*APIResponse, error)

DeleteTelephonyProvidersEdgesCertificateauthority invokes DELETE /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}

Delete a certificate authority.

func (TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesDidpool ¶

func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesDidpool(didPoolId string) (*APIResponse, error)

DeleteTelephonyProvidersEdgesDidpool invokes DELETE /api/v2/telephony/providers/edges/didpools/{didPoolId}

Delete a DID Pool by ID.

func (TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesEdgegroup ¶

func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesEdgegroup(edgeGroupId string) (*APIResponse, error)

DeleteTelephonyProvidersEdgesEdgegroup invokes DELETE /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}

Delete an edge group.

func (TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesExtensionpool ¶

func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesExtensionpool(extensionPoolId string) (*APIResponse, error)

DeleteTelephonyProvidersEdgesExtensionpool invokes DELETE /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}

Delete an extension pool by ID

func (TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesOutboundroute ¶

func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesOutboundroute(outboundRouteId string) (*APIResponse, error)

DeleteTelephonyProvidersEdgesOutboundroute invokes DELETE /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}

Delete Outbound Route

func (TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesPhone ¶

func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesPhone(phoneId string) (*APIResponse, error)

DeleteTelephonyProvidersEdgesPhone invokes DELETE /api/v2/telephony/providers/edges/phones/{phoneId}

Delete a Phone by ID

func (TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesPhonebasesetting ¶

func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesPhonebasesetting(phoneBaseId string) (*APIResponse, error)

DeleteTelephonyProvidersEdgesPhonebasesetting invokes DELETE /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}

Delete a Phone Base Settings by ID

func (TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesSite ¶

func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesSite(siteId string) (*APIResponse, error)

DeleteTelephonyProvidersEdgesSite invokes DELETE /api/v2/telephony/providers/edges/sites/{siteId}

Delete a Site by ID

func (TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesSiteOutboundroute ¶

func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesSiteOutboundroute(siteId string, outboundRouteId string) (*APIResponse, error)

DeleteTelephonyProvidersEdgesSiteOutboundroute invokes DELETE /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}

Delete Outbound Route

func (TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesTrunkbasesetting ¶

func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId string) (*APIResponse, error)

DeleteTelephonyProvidersEdgesTrunkbasesetting invokes DELETE /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}

Delete a Trunk Base Settings object by ID

func (TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnext ¶

func (a TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnext(pageSize int, pageNumber int) (*Schemacategoryentitylisting, *APIResponse, error)

GetConfigurationSchemasEdgesVnext invokes GET /api/v2/configuration/schemas/edges/vnext

Lists available schema categories (Deprecated)

func (TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnextSchemaCategory ¶

func (a TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnextSchemaCategory(schemaCategory string, pageSize int, pageNumber int) (*Schemareferenceentitylisting, *APIResponse, error)

GetConfigurationSchemasEdgesVnextSchemaCategory invokes GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}

List schemas of a specific category (Deprecated)

func (TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnextSchemaCategorySchemaType ¶

func (a TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnextSchemaCategorySchemaType(schemaCategory string, schemaType string, pageSize int, pageNumber int) (*Schemareferenceentitylisting, *APIResponse, error)

GetConfigurationSchemasEdgesVnextSchemaCategorySchemaType invokes GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}

List schemas of a specific category (Deprecated)

func (TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaId ¶

func (a TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaId(schemaCategory string, schemaType string, schemaId string) (*Organization, *APIResponse, error)

GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaId invokes GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}

Get a json schema (Deprecated)

func (TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaIdExtensionTypeMetadataId ¶

func (a TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaIdExtensionTypeMetadataId(schemaCategory string, schemaType string, schemaId string, extensionType string, metadataId string, varType string) (*Organization, *APIResponse, error)

GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaIdExtensionTypeMetadataId invokes GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId}

Get metadata for a schema (Deprecated)

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdge ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdge(edgeId string, expand []string) (*Edge, *APIResponse, error)

GetTelephonyProvidersEdge invokes GET /api/v2/telephony/providers/edges/{edgeId}

Get edge.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeDiagnosticNslookup ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeDiagnosticNslookup(edgeId string) (*Edgenetworkdiagnosticresponse, *APIResponse, error)

GetTelephonyProvidersEdgeDiagnosticNslookup invokes GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup

Get networking-related information from an Edge for a target IP or host.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeDiagnosticPing ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeDiagnosticPing(edgeId string) (*Edgenetworkdiagnosticresponse, *APIResponse, error)

GetTelephonyProvidersEdgeDiagnosticPing invokes GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping

Get networking-related information from an Edge for a target IP or host.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeDiagnosticRoute ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeDiagnosticRoute(edgeId string) (*Edgenetworkdiagnosticresponse, *APIResponse, error)

GetTelephonyProvidersEdgeDiagnosticRoute invokes GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/route

Get networking-related information from an Edge for a target IP or host.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeDiagnosticTracepath ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeDiagnosticTracepath(edgeId string) (*Edgenetworkdiagnosticresponse, *APIResponse, error)

GetTelephonyProvidersEdgeDiagnosticTracepath invokes GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath

Get networking-related information from an Edge for a target IP or host.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLine ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLine(edgeId string, lineId string) (*Edgeline, *APIResponse, error)

GetTelephonyProvidersEdgeLine invokes GET /api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}

Get line

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLines ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLines(edgeId string, pageSize int, pageNumber int) (*Edgelineentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgeLines invokes GET /api/v2/telephony/providers/edges/{edgeId}/lines

Get the list of lines.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLogicalinterface ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLogicalinterface(edgeId string, interfaceId string, expand []string) (*Domainlogicalinterface, *APIResponse, error)

GetTelephonyProvidersEdgeLogicalinterface invokes GET /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}

Get an edge logical interface

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLogicalinterfaces ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLogicalinterfaces(edgeId string, expand []string) (*Logicalinterfaceentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgeLogicalinterfaces invokes GET /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces

Get edge logical interfaces.

Retrieve a list of all configured logical interfaces from a specific edge.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLogsJob ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLogsJob(edgeId string, jobId string) (*Edgelogsjob, *APIResponse, error)

GetTelephonyProvidersEdgeLogsJob invokes GET /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}

Get an Edge logs job.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeMetrics ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeMetrics(edgeId string) (*Edgemetrics, *APIResponse, error)

GetTelephonyProvidersEdgeMetrics invokes GET /api/v2/telephony/providers/edges/{edgeId}/metrics

Get the edge metrics.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgePhysicalinterface ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgePhysicalinterface(edgeId string, interfaceId string) (*Domainphysicalinterface, *APIResponse, error)

GetTelephonyProvidersEdgePhysicalinterface invokes GET /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}

Get edge physical interface.

Retrieve a physical interface from a specific edge.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgePhysicalinterfaces ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgePhysicalinterfaces(edgeId string) (*Physicalinterfaceentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgePhysicalinterfaces invokes GET /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces

Retrieve a list of all configured physical interfaces from a specific edge.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeSetuppackage ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeSetuppackage(edgeId string) (*Vmpairinginfo, *APIResponse, error)

GetTelephonyProvidersEdgeSetuppackage invokes GET /api/v2/telephony/providers/edges/{edgeId}/setuppackage

Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeSoftwareupdate ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeSoftwareupdate(edgeId string) (*Domainedgesoftwareupdatedto, *APIResponse, error)

GetTelephonyProvidersEdgeSoftwareupdate invokes GET /api/v2/telephony/providers/edges/{edgeId}/softwareupdate

Gets software update status information about any edge.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeSoftwareversions ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeSoftwareversions(edgeId string) (*Domainedgesoftwareversiondtoentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgeSoftwareversions invokes GET /api/v2/telephony/providers/edges/{edgeId}/softwareversions

Gets all the available software versions for this edge.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeTrunks ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeTrunks(edgeId string, pageNumber int, pageSize int, sortBy string, sortOrder string, trunkBaseId string, trunkType string) (*Trunkentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgeTrunks invokes GET /api/v2/telephony/providers/edges/{edgeId}/trunks

Get the list of available trunks for the given Edge.

Trunks are created by assigning trunk base settings to an Edge or Edge Group.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdges ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdges(pageSize int, pageNumber int, name string, siteId string, edgeGroupId string, sortBy string, managed bool) (*Edgeentitylisting, *APIResponse, error)

GetTelephonyProvidersEdges invokes GET /api/v2/telephony/providers/edges

Get the list of edges.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesAvailablelanguages ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesAvailablelanguages() (*Availablelanguagelist, *APIResponse, error)

GetTelephonyProvidersEdgesAvailablelanguages invokes GET /api/v2/telephony/providers/edges/availablelanguages

Get the list of available languages.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesCertificateauthorities ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesCertificateauthorities() (*Certificateauthorityentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesCertificateauthorities invokes GET /api/v2/telephony/providers/edges/certificateauthorities

Get the list of certificate authorities.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesCertificateauthority ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesCertificateauthority(certificateId string) (*Domaincertificateauthority, *APIResponse, error)

GetTelephonyProvidersEdgesCertificateauthority invokes GET /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}

Get a certificate authority.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDid ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDid(didId string) (*Did, *APIResponse, error)

GetTelephonyProvidersEdgesDid invokes GET /api/v2/telephony/providers/edges/dids/{didId}

Get a DID by ID.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDidpool ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDidpool(didPoolId string) (*Didpool, *APIResponse, error)

GetTelephonyProvidersEdgesDidpool invokes GET /api/v2/telephony/providers/edges/didpools/{didPoolId}

Get a DID Pool by ID.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDidpools ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDidpools(pageSize int, pageNumber int, sortBy string, id []string) (*Didpoolentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesDidpools invokes GET /api/v2/telephony/providers/edges/didpools

Get a listing of DID Pools

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDidpoolsDids ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDidpoolsDids(varType string, id []string, numberMatch string, pageSize int, pageNumber int, sortOrder string) (*Didnumberentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesDidpoolsDids invokes GET /api/v2/telephony/providers/edges/didpools/dids

Get a listing of unassigned and/or assigned numbers in a set of DID Pools.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDids ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDids(pageSize int, pageNumber int, sortBy string, sortOrder string, phoneNumber string, ownerId string, didPoolId string, id []string) (*Didentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesDids invokes GET /api/v2/telephony/providers/edges/dids

Get a listing of DIDs

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesEdgegroup ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesEdgegroup(edgeGroupId string, expand []string) (*Edgegroup, *APIResponse, error)

GetTelephonyProvidersEdgesEdgegroup invokes GET /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}

Get edge group.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesEdgegroupEdgetrunkbase ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesEdgegroupEdgetrunkbase(edgegroupId string, edgetrunkbaseId string) (*Edgetrunkbase, *APIResponse, error)

GetTelephonyProvidersEdgesEdgegroupEdgetrunkbase invokes GET /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}

Gets the edge trunk base associated with the edge group

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesEdgegroups ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesEdgegroups(pageSize int, pageNumber int, name string, sortBy string, managed bool) (*Edgegroupentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesEdgegroups invokes GET /api/v2/telephony/providers/edges/edgegroups

Get the list of edge groups.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesEdgeversionreport ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesEdgeversionreport() (*Edgeversionreport, *APIResponse, error)

GetTelephonyProvidersEdgesEdgeversionreport invokes GET /api/v2/telephony/providers/edges/edgeversionreport

Get the edge version report.

The report will not have consistent data about the edge version(s) until all edges have been reset.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesExtension ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesExtension(extensionId string) (*Extension, *APIResponse, error)

GetTelephonyProvidersEdgesExtension invokes GET /api/v2/telephony/providers/edges/extensions/{extensionId}

Get an extension by ID.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesExtensionpool ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesExtensionpool(extensionPoolId string) (*Extensionpool, *APIResponse, error)

GetTelephonyProvidersEdgesExtensionpool invokes GET /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}

Get an extension pool by ID

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesExtensionpools ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesExtensionpools(pageSize int, pageNumber int, sortBy string, number string) (*Extensionpoolentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesExtensionpools invokes GET /api/v2/telephony/providers/edges/extensionpools

Get a listing of extension pools

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesExtensions ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesExtensions(pageSize int, pageNumber int, sortBy string, sortOrder string, number string) (*Extensionentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesExtensions invokes GET /api/v2/telephony/providers/edges/extensions

Get a listing of extensions

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLine ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLine(lineId string) (*Line, *APIResponse, error)

GetTelephonyProvidersEdgesLine invokes GET /api/v2/telephony/providers/edges/lines/{lineId}

Get a Line by ID

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLinebasesetting ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLinebasesetting(lineBaseId string) (*Linebase, *APIResponse, error)

GetTelephonyProvidersEdgesLinebasesetting invokes GET /api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}

Get a line base settings object by ID

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLinebasesettings ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLinebasesettings(pageNumber int, pageSize int, sortBy string, sortOrder string, expand []string) (*Linebaseentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesLinebasesettings invokes GET /api/v2/telephony/providers/edges/linebasesettings

Get a listing of line base settings objects

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLines ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLines(pageSize int, pageNumber int, name string, sortBy string, expand []string) (*Lineentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesLines invokes GET /api/v2/telephony/providers/edges/lines

Get a list of Lines

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLinesTemplate ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLinesTemplate(lineBaseSettingsId string) (*Line, *APIResponse, error)

GetTelephonyProvidersEdgesLinesTemplate invokes GET /api/v2/telephony/providers/edges/lines/template

Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLogicalinterfaces ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLogicalinterfaces(edgeIds string, expand []string) (*Logicalinterfaceentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesLogicalinterfaces invokes GET /api/v2/telephony/providers/edges/logicalinterfaces

Get edge logical interfaces.

Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesMetrics ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesMetrics(edgeIds string) ([]Edgemetrics, *APIResponse, error)

GetTelephonyProvidersEdgesMetrics invokes GET /api/v2/telephony/providers/edges/metrics

Get the metrics for a list of edges.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesOutboundroute ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesOutboundroute(outboundRouteId string) (*Outboundroute, *APIResponse, error)

GetTelephonyProvidersEdgesOutboundroute invokes GET /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}

Get outbound route

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesOutboundroutes ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesOutboundroutes(pageSize int, pageNumber int, name string, siteId string, externalTrunkBasesIds string, sortBy string) (*Outboundrouteentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesOutboundroutes invokes GET /api/v2/telephony/providers/edges/outboundroutes

Get outbound routes

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhone ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhone(phoneId string) (*Phone, *APIResponse, error)

GetTelephonyProvidersEdgesPhone invokes GET /api/v2/telephony/providers/edges/phones/{phoneId}

Get a Phone by ID

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonebasesetting ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonebasesetting(phoneBaseId string) (*Phonebase, *APIResponse, error)

GetTelephonyProvidersEdgesPhonebasesetting invokes GET /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}

Get a Phone Base Settings object by ID

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonebasesettings ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonebasesettings(pageSize int, pageNumber int, sortBy string, sortOrder string, expand []string, name string) (*Phonebaseentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesPhonebasesettings invokes GET /api/v2/telephony/providers/edges/phonebasesettings

Get a list of Phone Base Settings objects

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases(pageSize int, pageNumber int) (*Phonemetabaseentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases invokes GET /api/v2/telephony/providers/edges/phonebasesettings/availablemetabases

Get a list of available makes and models to create a new Phone Base Settings

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonebasesettingsTemplate ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonebasesettingsTemplate(phoneMetabaseId string) (*Phonebase, *APIResponse, error)

GetTelephonyProvidersEdgesPhonebasesettingsTemplate invokes GET /api/v2/telephony/providers/edges/phonebasesettings/template

Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhones ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhones(pageNumber int, pageSize int, sortBy string, sortOrder string, siteId string, webRtcUserId string, phoneBaseSettingsId string, linesLoggedInUserId string, linesDefaultForUserId string, phoneHardwareId string, linesId string, linesName string, name string, statusOperationalStatus string, secondaryStatusOperationalStatus string, expand []string, fields []string) (*Phoneentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesPhones invokes GET /api/v2/telephony/providers/edges/phones

Get a list of Phone Instances

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonesTemplate ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonesTemplate(phoneBaseSettingsId string) (*Phone, *APIResponse, error)

GetTelephonyProvidersEdgesPhonesTemplate invokes GET /api/v2/telephony/providers/edges/phones/template

Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhysicalinterfaces ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhysicalinterfaces(edgeIds string) (*Physicalinterfaceentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesPhysicalinterfaces invokes GET /api/v2/telephony/providers/edges/physicalinterfaces

Get physical interfaces for edges.

Retrieves a list of all configured physical interfaces for a list of edges. Only 100 edges can be requested at a time.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSite ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSite(siteId string) (*Site, *APIResponse, error)

GetTelephonyProvidersEdgesSite invokes GET /api/v2/telephony/providers/edges/sites/{siteId}

Get a Site by ID.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteNumberplan ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteNumberplan(siteId string, numberPlanId string) (*Numberplan, *APIResponse, error)

GetTelephonyProvidersEdgesSiteNumberplan invokes GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}

Get a Number Plan by ID.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteNumberplans ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteNumberplans(siteId string) ([]Numberplan, *APIResponse, error)

GetTelephonyProvidersEdgesSiteNumberplans invokes GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans

Get the list of Number Plans for this Site. Only fetches the first 200 records.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteNumberplansClassifications ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteNumberplansClassifications(siteId string, classification string) ([]string, *APIResponse, error)

GetTelephonyProvidersEdgesSiteNumberplansClassifications invokes GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications

Get a list of Classifications for this Site

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteOutboundroute ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteOutboundroute(siteId string, outboundRouteId string) (*Outboundroutebase, *APIResponse, error)

GetTelephonyProvidersEdgesSiteOutboundroute invokes GET /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}

Get an outbound route

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteOutboundroutes ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteOutboundroutes(siteId string, pageSize int, pageNumber int, name string, externalTrunkBasesIds string, sortBy string) (*Outboundroutebaseentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesSiteOutboundroutes invokes GET /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes

Get outbound routes

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSites ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSites(pageSize int, pageNumber int, sortBy string, sortOrder string, name string, locationId string, managed bool) (*Siteentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesSites invokes GET /api/v2/telephony/providers/edges/sites

Get the list of Sites.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTimezones ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTimezones(pageSize int, pageNumber int) (*Timezoneentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesTimezones invokes GET /api/v2/telephony/providers/edges/timezones

Get a list of Edge-compatible time zones

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunk ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunk(trunkId string) (*Trunk, *APIResponse, error)

GetTelephonyProvidersEdgesTrunk invokes GET /api/v2/telephony/providers/edges/trunks/{trunkId}

Get a Trunk by ID

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkMetrics ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkMetrics(trunkId string) (*Trunkmetrics, *APIResponse, error)

GetTelephonyProvidersEdgesTrunkMetrics invokes GET /api/v2/telephony/providers/edges/trunks/{trunkId}/metrics

Get the trunk metrics.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkbasesetting ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId string, ignoreHidden bool) (*Trunkbase, *APIResponse, error)

GetTelephonyProvidersEdgesTrunkbasesetting invokes GET /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}

Get a Trunk Base Settings object by ID ¶

Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkbasesettings ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkbasesettings(pageNumber int, pageSize int, sortBy string, sortOrder string, recordingEnabled bool, ignoreHidden bool, managed bool, expand []string, name string) (*Trunkbaseentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesTrunkbasesettings invokes GET /api/v2/telephony/providers/edges/trunkbasesettings

Get Trunk Base Settings listing ¶

Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases(varType string, pageSize int, pageNumber int) (*Trunkmetabaseentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases invokes GET /api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases

Get a list of available makes and models to create a new Trunk Base Settings

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkbasesettingsTemplate ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkbasesettingsTemplate(trunkMetabaseId string) (*Trunkbase, *APIResponse, error)

GetTelephonyProvidersEdgesTrunkbasesettingsTemplate invokes GET /api/v2/telephony/providers/edges/trunkbasesettings/template

Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunks ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunks(pageNumber int, pageSize int, sortBy string, sortOrder string, edgeId string, trunkBaseId string, trunkType string) (*Trunkentitylisting, *APIResponse, error)

GetTelephonyProvidersEdgesTrunks invokes GET /api/v2/telephony/providers/edges/trunks

Get the list of available trunks.

Trunks are created by assigning trunk base settings to an Edge or Edge Group.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunksMetrics ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunksMetrics(trunkIds string) ([]Trunkmetrics, *APIResponse, error)

GetTelephonyProvidersEdgesTrunksMetrics invokes GET /api/v2/telephony/providers/edges/trunks/metrics

Get the metrics for a list of trunks.

func (TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkswithrecording ¶

func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkswithrecording(trunkType string) (*Trunkrecordingenabledcount, *APIResponse, error)

GetTelephonyProvidersEdgesTrunkswithrecording invokes GET /api/v2/telephony/providers/edges/trunkswithrecording

Get Counts of trunks that have recording disabled or enabled

func (TelephonyProvidersEdgeApi) PatchTelephonyProvidersEdgesAutoscalinggroupCapacity ¶

func (a TelephonyProvidersEdgeApi) PatchTelephonyProvidersEdgesAutoscalinggroupCapacity(asgId string, body Asgscalerequest) (*Scaleasgresponse, *APIResponse, error)

PatchTelephonyProvidersEdgesAutoscalinggroupCapacity invokes PATCH /api/v2/telephony/providers/edges/autoscalinggroups/{asgId}/capacity

Scales the ASG to match the desired capacity

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeDiagnosticNslookup ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeDiagnosticNslookup(edgeId string, body Edgenetworkdiagnosticrequest) (*Edgenetworkdiagnostic, *APIResponse, error)

PostTelephonyProvidersEdgeDiagnosticNslookup invokes POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup

Nslookup request command to collect networking-related information from an Edge for a target IP or host.

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeDiagnosticPing ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeDiagnosticPing(edgeId string, body Edgenetworkdiagnosticrequest) (*Edgenetworkdiagnostic, *APIResponse, error)

PostTelephonyProvidersEdgeDiagnosticPing invokes POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping

Ping Request command to collect networking-related information from an Edge for a target IP or host.

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeDiagnosticRoute ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeDiagnosticRoute(edgeId string, body Edgenetworkdiagnosticrequest) (*Edgenetworkdiagnostic, *APIResponse, error)

PostTelephonyProvidersEdgeDiagnosticRoute invokes POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/route

Route request command to collect networking-related information from an Edge for a target IP or host.

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeDiagnosticTracepath ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeDiagnosticTracepath(edgeId string, body Edgenetworkdiagnosticrequest) (*Edgenetworkdiagnostic, *APIResponse, error)

PostTelephonyProvidersEdgeDiagnosticTracepath invokes POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath

Tracepath request command to collect networking-related information from an Edge for a target IP or host.

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeLogicalinterfaces ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeLogicalinterfaces(edgeId string, body Domainlogicalinterface) (*Domainlogicalinterface, *APIResponse, error)

PostTelephonyProvidersEdgeLogicalinterfaces invokes POST /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces

Create an edge logical interface.

Create

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeLogsJobUpload ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeLogsJobUpload(edgeId string, jobId string, body Edgelogsjobuploadrequest) (*APIResponse, error)

PostTelephonyProvidersEdgeLogsJobUpload invokes POST /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload

Request that the specified fileIds be uploaded from the Edge.

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeLogsJobs ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeLogsJobs(edgeId string, body Edgelogsjobrequest) (*Edgelogsjobresponse, *APIResponse, error)

PostTelephonyProvidersEdgeLogsJobs invokes POST /api/v2/telephony/providers/edges/{edgeId}/logs/jobs

Create a job to upload a list of Edge logs.

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeReboot ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeReboot(edgeId string, body Edgerebootparameters) (*string, *APIResponse, error)

PostTelephonyProvidersEdgeReboot invokes POST /api/v2/telephony/providers/edges/{edgeId}/reboot

Reboot an Edge

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeSoftwareupdate ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeSoftwareupdate(edgeId string, body Domainedgesoftwareupdatedto) (*Domainedgesoftwareupdatedto, *APIResponse, error)

PostTelephonyProvidersEdgeSoftwareupdate invokes POST /api/v2/telephony/providers/edges/{edgeId}/softwareupdate

Starts a software update for this edge.

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeStatuscode ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeStatuscode(edgeId string, body Edgeservicestaterequest) (*string, *APIResponse, error)

PostTelephonyProvidersEdgeStatuscode invokes POST /api/v2/telephony/providers/edges/{edgeId}/statuscode

Take an Edge in or out of service

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeUnpair ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeUnpair(edgeId string) (*string, *APIResponse, error)

PostTelephonyProvidersEdgeUnpair invokes POST /api/v2/telephony/providers/edges/{edgeId}/unpair

Unpair an Edge

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdges ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdges(body Edge) (*Edge, *APIResponse, error)

PostTelephonyProvidersEdges invokes POST /api/v2/telephony/providers/edges

Create an edge.

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesAddressvalidation ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesAddressvalidation(body Validateaddressrequest) (*Validateaddressresponse, *APIResponse, error)

PostTelephonyProvidersEdgesAddressvalidation invokes POST /api/v2/telephony/providers/edges/addressvalidation

Validates a street address

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesCertificateauthorities ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesCertificateauthorities(body Domaincertificateauthority) (*Domaincertificateauthority, *APIResponse, error)

PostTelephonyProvidersEdgesCertificateauthorities invokes POST /api/v2/telephony/providers/edges/certificateauthorities

Create a certificate authority.

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesDidpools ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesDidpools(body Didpool) (*Didpool, *APIResponse, error)

PostTelephonyProvidersEdgesDidpools invokes POST /api/v2/telephony/providers/edges/didpools

Create a new DID pool

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesEdgegroups ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesEdgegroups(body Edgegroup) (*Edgegroup, *APIResponse, error)

PostTelephonyProvidersEdgesEdgegroups invokes POST /api/v2/telephony/providers/edges/edgegroups

Create an edge group.

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesExtensionpools ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesExtensionpools(body Extensionpool) (*Extensionpool, *APIResponse, error)

PostTelephonyProvidersEdgesExtensionpools invokes POST /api/v2/telephony/providers/edges/extensionpools

Create a new extension pool

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesOutboundroutes ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesOutboundroutes(body Outboundroute) (*Outboundroute, *APIResponse, error)

PostTelephonyProvidersEdgesOutboundroutes invokes POST /api/v2/telephony/providers/edges/outboundroutes

Create outbound rule

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesPhoneReboot ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesPhoneReboot(phoneId string) (*APIResponse, error)

PostTelephonyProvidersEdgesPhoneReboot invokes POST /api/v2/telephony/providers/edges/phones/{phoneId}/reboot

Reboot a Phone

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesPhonebasesettings ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesPhonebasesettings(body Phonebase) (*Phonebase, *APIResponse, error)

PostTelephonyProvidersEdgesPhonebasesettings invokes POST /api/v2/telephony/providers/edges/phonebasesettings

Create a new Phone Base Settings object

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesPhones ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesPhones(body Phone) (*Phone, *APIResponse, error)

PostTelephonyProvidersEdgesPhones invokes POST /api/v2/telephony/providers/edges/phones

Create a new Phone

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesPhonesReboot ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesPhonesReboot(body Phonesreboot) (*APIResponse, error)

PostTelephonyProvidersEdgesPhonesReboot invokes POST /api/v2/telephony/providers/edges/phones/reboot

Reboot Multiple Phones

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesSiteOutboundroutes ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesSiteOutboundroutes(siteId string, body Outboundroutebase) (*Outboundroutebase, *APIResponse, error)

PostTelephonyProvidersEdgesSiteOutboundroutes invokes POST /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes

Create outbound route

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesSiteRebalance ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesSiteRebalance(siteId string) (*APIResponse, error)

PostTelephonyProvidersEdgesSiteRebalance invokes POST /api/v2/telephony/providers/edges/sites/{siteId}/rebalance

Triggers the rebalance operation.

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesSites ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesSites(body Site) (*Site, *APIResponse, error)

PostTelephonyProvidersEdgesSites invokes POST /api/v2/telephony/providers/edges/sites

Create a Site.

func (TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesTrunkbasesettings ¶

func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesTrunkbasesettings(body Trunkbase) (*Trunkbase, *APIResponse, error)

PostTelephonyProvidersEdgesTrunkbasesettings invokes POST /api/v2/telephony/providers/edges/trunkbasesettings

Create a Trunk Base Settings object

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdge ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdge(edgeId string, body Edge) (*Edge, *APIResponse, error)

PutTelephonyProvidersEdge invokes PUT /api/v2/telephony/providers/edges/{edgeId}

Update a edge.

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgeLine ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgeLine(edgeId string, lineId string, body Edgeline) (*Edgeline, *APIResponse, error)

PutTelephonyProvidersEdgeLine invokes PUT /api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}

Update a line.

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgeLogicalinterface ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgeLogicalinterface(edgeId string, interfaceId string, body Domainlogicalinterface) (*Domainlogicalinterface, *APIResponse, error)

PutTelephonyProvidersEdgeLogicalinterface invokes PUT /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}

Update an edge logical interface.

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesCertificateauthority ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesCertificateauthority(certificateId string, body Domaincertificateauthority) (*Domaincertificateauthority, *APIResponse, error)

PutTelephonyProvidersEdgesCertificateauthority invokes PUT /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}

Update a certificate authority.

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesDid ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesDid(didId string, body Did) (*Did, *APIResponse, error)

PutTelephonyProvidersEdgesDid invokes PUT /api/v2/telephony/providers/edges/dids/{didId}

Update a DID by ID.

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesDidpool ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesDidpool(didPoolId string, body Didpool) (*Didpool, *APIResponse, error)

PutTelephonyProvidersEdgesDidpool invokes PUT /api/v2/telephony/providers/edges/didpools/{didPoolId}

Update a DID Pool by ID.

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesEdgegroup ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesEdgegroup(edgeGroupId string, body Edgegroup) (*Edgegroup, *APIResponse, error)

PutTelephonyProvidersEdgesEdgegroup invokes PUT /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}

Update an edge group.

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesEdgegroupEdgetrunkbase ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesEdgegroupEdgetrunkbase(edgegroupId string, edgetrunkbaseId string, body Edgetrunkbase) (*Edgetrunkbase, *APIResponse, error)

PutTelephonyProvidersEdgesEdgegroupEdgetrunkbase invokes PUT /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}

Update the edge trunk base associated with the edge group

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesExtension ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesExtension(extensionId string, body Extension) (*Extension, *APIResponse, error)

PutTelephonyProvidersEdgesExtension invokes PUT /api/v2/telephony/providers/edges/extensions/{extensionId}

Update an extension by ID.

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesExtensionpool ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesExtensionpool(extensionPoolId string, body Extensionpool) (*Extensionpool, *APIResponse, error)

PutTelephonyProvidersEdgesExtensionpool invokes PUT /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}

Update an extension pool by ID

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesOutboundroute ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesOutboundroute(outboundRouteId string, body Outboundroute) (*Outboundroute, *APIResponse, error)

PutTelephonyProvidersEdgesOutboundroute invokes PUT /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}

Update outbound route

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesPhone ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesPhone(phoneId string, body Phone) (*Phone, *APIResponse, error)

PutTelephonyProvidersEdgesPhone invokes PUT /api/v2/telephony/providers/edges/phones/{phoneId}

Update a Phone by ID

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesPhonebasesetting ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesPhonebasesetting(phoneBaseId string, body Phonebase) (*Phonebase, *APIResponse, error)

PutTelephonyProvidersEdgesPhonebasesetting invokes PUT /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}

Update a Phone Base Settings by ID

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesSite ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesSite(siteId string, body Site) (*Site, *APIResponse, error)

PutTelephonyProvidersEdgesSite invokes PUT /api/v2/telephony/providers/edges/sites/{siteId}

Update a Site by ID.

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesSiteNumberplans ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesSiteNumberplans(siteId string, body []Numberplan) ([]Numberplan, *APIResponse, error)

PutTelephonyProvidersEdgesSiteNumberplans invokes PUT /api/v2/telephony/providers/edges/sites/{siteId}/numberplans

Update the list of Number Plans. A user can update maximum 200 number plans at a time.

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesSiteOutboundroute ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesSiteOutboundroute(siteId string, outboundRouteId string, body Outboundroutebase) (*Outboundroutebase, *APIResponse, error)

PutTelephonyProvidersEdgesSiteOutboundroute invokes PUT /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}

Update outbound route

func (TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesTrunkbasesetting ¶

func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId string, body Trunkbase) (*Trunkbase, *APIResponse, error)

PutTelephonyProvidersEdgesTrunkbasesetting invokes PUT /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}

Update a Trunk Base Settings object by ID

type Templateparameter ¶

type Templateparameter struct {
	// Id - Response substitution identifier
	Id *string `json:"id,omitempty"`

	// Value - Response substitution value
	Value *string `json:"value,omitempty"`
}

Templateparameter

func (*Templateparameter) String ¶

func (o *Templateparameter) String() string

String returns a JSON representation of the model

type Termattribute ¶

type Termattribute struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Termattribute

func (*Termattribute) String ¶

func (o *Termattribute) String() string

String returns a JSON representation of the model

type Testexecutionoperationresult ¶

type Testexecutionoperationresult struct {
	// Step - The step number to indicate the order in which the operation was performed
	Step *int `json:"step,omitempty"`

	// Name - Name of the operation performed
	Name *string `json:"name,omitempty"`

	// Success - Indicated whether or not the operation was successful
	Success *bool `json:"success,omitempty"`

	// Result - The result of the operation
	Result *interface{} `json:"result,omitempty"`

	// VarError - Error that occurred during the operation
	VarError *Errorbody `json:"error,omitempty"`
}

Testexecutionoperationresult

func (*Testexecutionoperationresult) String ¶

String returns a JSON representation of the model

type Testexecutionresult ¶

type Testexecutionresult struct {
	// Operations - Execution operations performed as part of the test
	Operations *[]Testexecutionoperationresult `json:"operations,omitempty"`

	// VarError - The final error encountered during the test that resulted in test failure
	VarError *Errorbody `json:"error,omitempty"`

	// FinalResult - The final result of the test. This is the response that would be returned during normal action execution
	FinalResult *interface{} `json:"finalResult,omitempty"`

	// Success - Indicates whether or not the test was a success
	Success *bool `json:"success,omitempty"`
}

Testexecutionresult

func (*Testexecutionresult) String ¶

func (o *Testexecutionresult) String() string

String returns a JSON representation of the model

type Testmessage ¶

type Testmessage struct {
	// Id - After the message has been sent, this is the value of the Message-ID email header.
	Id *string `json:"id,omitempty"`

	// To - The recipients of the email message.
	To *[]Emailaddress `json:"to,omitempty"`

	// From - The sender of the email message.
	From *Emailaddress `json:"from,omitempty"`

	// Subject - The subject of the email message.
	Subject *string `json:"subject,omitempty"`

	// TextBody - The text body of the email message.
	TextBody *string `json:"textBody,omitempty"`

	// HtmlBody - The html body of the email message
	HtmlBody *string `json:"htmlBody,omitempty"`

	// Time - The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Time *time.Time `json:"time,omitempty"`
}

Testmessage

func (*Testmessage) String ¶

func (o *Testmessage) String() string

String returns a JSON representation of the model

type TextbotsApi ¶

type TextbotsApi struct {
	Configuration *Configuration
}

TextbotsApi provides functions for API endpoints

func NewTextbotsApi ¶

func NewTextbotsApi() *TextbotsApi

NewTextbotsApi creates an API instance using the default configuration

func NewTextbotsApiWithConfig ¶

func NewTextbotsApiWithConfig(config *Configuration) *TextbotsApi

NewTextbotsApiWithConfig creates an API instance using the provided configuration

func (TextbotsApi) PostTextbotsBotsExecute ¶

func (a TextbotsApi) PostTextbotsBotsExecute(postTextRequest Posttextrequest) (*Posttextresponse, *APIResponse, error)

PostTextbotsBotsExecute invokes POST /api/v2/textbots/bots/execute

Send an intent to a bot to start a dialog/interact with it via text

This will either start a bot with the given id or relay a communication to an existing bot session.

type Textmessagelisting ¶

type Textmessagelisting struct {
	// Entities
	Entities *[]Messagedata `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Textmessagelisting

func (*Textmessagelisting) String ¶

func (o *Textmessagelisting) String() string

String returns a JSON representation of the model

type Textstyleproperties ¶

type Textstyleproperties struct {
	// Color - Color of the text. (eg. #FFFFFF)
	Color *string `json:"color,omitempty"`

	// Font - Font of the text. (eg. Helvetica)
	Font *string `json:"font,omitempty"`

	// FontSize - Font size of the text. (eg. '12')
	FontSize *string `json:"fontSize,omitempty"`

	// TextAlign - Text alignment.
	TextAlign *string `json:"textAlign,omitempty"`
}

Textstyleproperties

func (*Textstyleproperties) String ¶

func (o *Textstyleproperties) String() string

String returns a JSON representation of the model

type Ticker ¶

type Ticker struct {
	// Symbol - The ticker symbol for this organization. Example: ININ, AAPL, MSFT, etc.
	Symbol *string `json:"symbol,omitempty"`

	// Exchange - The exchange for this ticker symbol. Examples: NYSE, FTSE, NASDAQ, etc.
	Exchange *string `json:"exchange,omitempty"`
}

Ticker

func (*Ticker) String ¶

func (o *Ticker) String() string

String returns a JSON representation of the model

type Timeallowed ¶

type Timeallowed struct {
	// TimeSlots
	TimeSlots *[]Timeslot `json:"timeSlots,omitempty"`

	// TimeZoneId
	TimeZoneId *string `json:"timeZoneId,omitempty"`

	// Empty
	Empty *bool `json:"empty,omitempty"`
}

Timeallowed

func (*Timeallowed) String ¶

func (o *Timeallowed) String() string

String returns a JSON representation of the model

type Timeinterval ¶

type Timeinterval struct {
	// Months
	Months *int `json:"months,omitempty"`

	// Weeks
	Weeks *int `json:"weeks,omitempty"`

	// Days
	Days *int `json:"days,omitempty"`

	// Hours
	Hours *int `json:"hours,omitempty"`
}

Timeinterval

func (*Timeinterval) String ¶

func (o *Timeinterval) String() string

String returns a JSON representation of the model

type Timeoffrequest ¶

type Timeoffrequest struct {
	// Id - The id of the time off request
	Id *string `json:"id,omitempty"`

	// User - The user that the time off request belongs to
	User *Userreference `json:"user,omitempty"`

	// IsFullDayRequest - Whether this is a full day request (false means partial day)
	IsFullDayRequest *bool `json:"isFullDayRequest,omitempty"`

	// MarkedAsRead - Whether this request has been marked as read by the agent
	MarkedAsRead *bool `json:"markedAsRead,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"`

	// Status - The status of this time off request
	Status *string `json:"status,omitempty"`

	// PartialDayStartDateTimes - A set of start date-times in ISO-8601 format for partial day requests.  Will be not empty if isFullDayRequest == false
	PartialDayStartDateTimes *[]time.Time `json:"partialDayStartDateTimes,omitempty"`

	// FullDayManagementUnitDates - A set of dates in yyyy-MM-dd format.  Should be interpreted in the management unit's configured time zone.  Will be not empty if isFullDayRequest == true
	FullDayManagementUnitDates *[]string `json:"fullDayManagementUnitDates,omitempty"`

	// DailyDurationMinutes - The daily duration of this time off request in minutes
	DailyDurationMinutes *int `json:"dailyDurationMinutes,omitempty"`

	// Notes - Notes about the time off request
	Notes *string `json:"notes,omitempty"`

	// SubmittedBy - The user who submitted this time off request
	SubmittedBy *Userreference `json:"submittedBy,omitempty"`

	// SubmittedDate - The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	SubmittedDate *time.Time `json:"submittedDate,omitempty"`

	// ReviewedBy - The user who reviewed this time off request
	ReviewedBy *Userreference `json:"reviewedBy,omitempty"`

	// ReviewedDate - The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ReviewedDate *time.Time `json:"reviewedDate,omitempty"`

	// Metadata - The version metadata of the time off request
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Timeoffrequest

func (*Timeoffrequest) String ¶

func (o *Timeoffrequest) String() string

String returns a JSON representation of the model

type Timeoffrequestlist ¶

type Timeoffrequestlist struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// TimeOffRequests
	TimeOffRequests *[]Timeoffrequestresponse `json:"timeOffRequests,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Timeoffrequestlist

func (*Timeoffrequestlist) String ¶

func (o *Timeoffrequestlist) String() string

String returns a JSON representation of the model

type Timeoffrequestlisting ¶

type Timeoffrequestlisting struct {
	// Entities - List of time off request look up objects
	Entities *[]Timeoffrequest `json:"entities,omitempty"`
}

Timeoffrequestlisting

func (*Timeoffrequestlisting) String ¶

func (o *Timeoffrequestlisting) String() string

String returns a JSON representation of the model

type Timeoffrequestnotification ¶

type Timeoffrequestnotification struct {
	// TimeOffRequestId - The ID of this time off request
	TimeOffRequestId *string `json:"timeOffRequestId,omitempty"`

	// User - The user associated with this time off request
	User *Userreference `json:"user,omitempty"`

	// IsFullDayRequest - Whether this is a full day request (false means partial day)
	IsFullDayRequest *bool `json:"isFullDayRequest,omitempty"`

	// Status - The status of this time off request
	Status *string `json:"status,omitempty"`

	// PartialDayStartDateTimes - A set of start date-times in ISO-8601 format for partial day requests.  Will be not empty if isFullDayRequest == false
	PartialDayStartDateTimes *[]time.Time `json:"partialDayStartDateTimes,omitempty"`

	// FullDayManagementUnitDates - A set of dates in yyyy-MM-dd format.  Should be interpreted in the management unit's configured time zone.  Will be not empty if isFullDayRequest == true
	FullDayManagementUnitDates *[]string `json:"fullDayManagementUnitDates,omitempty"`
}

Timeoffrequestnotification

func (*Timeoffrequestnotification) String ¶

func (o *Timeoffrequestnotification) String() string

String returns a JSON representation of the model

type Timeoffrequestquerybody ¶

type Timeoffrequestquerybody struct {
	// UserIds - The set of user ids to filter time off requests
	UserIds *[]string `json:"userIds,omitempty"`

	// Statuses - The set of statuses to filter time off requests
	Statuses *[]string `json:"statuses,omitempty"`

	// DateRange - The inclusive range of dates to filter time off requests
	DateRange *Daterange `json:"dateRange,omitempty"`
}

Timeoffrequestquerybody

func (*Timeoffrequestquerybody) String ¶

func (o *Timeoffrequestquerybody) String() string

String returns a JSON representation of the model

type Timeoffrequestresponse ¶

type Timeoffrequestresponse struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// User - The user associated with this time off request
	User *Userreference `json:"user,omitempty"`

	// IsFullDayRequest - Whether this is a full day request (false means partial day)
	IsFullDayRequest *bool `json:"isFullDayRequest,omitempty"`

	// MarkedAsRead - Whether this request has been marked as read by the agent
	MarkedAsRead *bool `json:"markedAsRead,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"`

	// Status - The status of this time off request
	Status *string `json:"status,omitempty"`

	// PartialDayStartDateTimes - A set of start date-times in ISO-8601 format for partial day requests.  Will be not empty if isFullDayRequest == false
	PartialDayStartDateTimes *[]time.Time `json:"partialDayStartDateTimes,omitempty"`

	// FullDayManagementUnitDates - A set of dates in yyyy-MM-dd format.  Should be interpreted in the management unit's configured time zone.  Will be not empty if isFullDayRequest == true
	FullDayManagementUnitDates *[]string `json:"fullDayManagementUnitDates,omitempty"`

	// DailyDurationMinutes - The daily duration of this time off request in minutes
	DailyDurationMinutes *int `json:"dailyDurationMinutes,omitempty"`

	// Notes - Notes about the time off request
	Notes *string `json:"notes,omitempty"`

	// SubmittedBy - The user who submitted this time off request
	SubmittedBy *Userreference `json:"submittedBy,omitempty"`

	// SubmittedDate - The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	SubmittedDate *time.Time `json:"submittedDate,omitempty"`

	// ReviewedBy - The user who reviewed this time off request
	ReviewedBy *Userreference `json:"reviewedBy,omitempty"`

	// ReviewedDate - The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ReviewedDate *time.Time `json:"reviewedDate,omitempty"`

	// ModifiedBy - The user who last modified this TimeOffRequestResponse
	ModifiedBy *Userreference `json:"modifiedBy,omitempty"`

	// ModifiedDate - The timestamp when this request 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"`

	// Metadata - The version metadata of the time off request
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Timeoffrequestresponse

func (*Timeoffrequestresponse) String ¶

func (o *Timeoffrequestresponse) String() string

String returns a JSON representation of the model

type Timeoffrequestsettings ¶

type Timeoffrequestsettings struct {
	// SubmissionRangeEnforced - Whether to enforce a submission range for agent time off requests
	SubmissionRangeEnforced *bool `json:"submissionRangeEnforced,omitempty"`

	// SubmissionEarliestDaysFromNow - The earliest number of days from now for which an agent can submit a time off request.  Use negative numbers to indicate days in the past
	SubmissionEarliestDaysFromNow *int `json:"submissionEarliestDaysFromNow,omitempty"`

	// SubmissionLatestDaysFromNow - The latest number of days from now for which an agent can submit a time off request
	SubmissionLatestDaysFromNow *int `json:"submissionLatestDaysFromNow,omitempty"`
}

Timeoffrequestsettings - Time Off Request Settings

func (*Timeoffrequestsettings) String ¶

func (o *Timeoffrequestsettings) String() string

String returns a JSON representation of the model

type Timeslot ¶

type Timeslot struct {
	// StartTime - start time in xx:xx:xx.xxx format
	StartTime *string `json:"startTime,omitempty"`

	// StopTime - stop time in xx:xx:xx.xxx format
	StopTime *string `json:"stopTime,omitempty"`

	// Day - Day for this time slot, Monday = 1 ... Sunday = 7
	Day *int `json:"day,omitempty"`
}

Timeslot

func (*Timeslot) String ¶

func (o *Timeslot) String() string

String returns a JSON representation of the model

type Timezoneentitylisting ¶

type Timezoneentitylisting struct {
	// Entities
	Entities *[]Regiontimezone `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Timezoneentitylisting

func (*Timezoneentitylisting) String ¶

func (o *Timezoneentitylisting) String() string

String returns a JSON representation of the model

type Timezonemappingpreview ¶

type Timezonemappingpreview struct {
	// ContactList - The associated ContactList
	ContactList *Domainentityref `json:"contactList,omitempty"`

	// ContactsPerTimeZone - The number of contacts per time zone that mapped to only that time zone
	ContactsPerTimeZone *map[string]int `json:"contactsPerTimeZone,omitempty"`

	// ContactsMappedUsingZipCode - The number of contacts per time zone that mapped to only that time zone and were mapped using the zip code column
	ContactsMappedUsingZipCode *map[string]int `json:"contactsMappedUsingZipCode,omitempty"`

	// ContactsMappedToASingleZone - The total number of contacts that mapped to a single time zone
	ContactsMappedToASingleZone *int `json:"contactsMappedToASingleZone,omitempty"`

	// ContactsMappedToASingleZoneUsingZipCode - The total number of contacts that mapped to a single time zone and were mapped using the zip code column
	ContactsMappedToASingleZoneUsingZipCode *int `json:"contactsMappedToASingleZoneUsingZipCode,omitempty"`

	// ContactsMappedToMultipleZones - The total number of contacts that mapped to multiple time zones
	ContactsMappedToMultipleZones *int `json:"contactsMappedToMultipleZones,omitempty"`

	// ContactsMappedToMultipleZonesUsingZipCode - The total number of contacts that mapped to multiple time zones and were mapped using the zip code column
	ContactsMappedToMultipleZonesUsingZipCode *int `json:"contactsMappedToMultipleZonesUsingZipCode,omitempty"`

	// ContactsInDefaultWindow - The total number of contacts that will be dialed during the default window
	ContactsInDefaultWindow *int `json:"contactsInDefaultWindow,omitempty"`

	// ContactListSize - The total number of contacts in the contact list
	ContactListSize *int `json:"contactListSize,omitempty"`
}

Timezonemappingpreview

func (*Timezonemappingpreview) String ¶

func (o *Timezonemappingpreview) String() string

String returns a JSON representation of the model

type Tokeninfo ¶

type Tokeninfo struct {
	// Organization - The current organization
	Organization *Namedentity `json:"organization,omitempty"`

	// HomeOrganization - The token's home organization
	HomeOrganization *Namedentity `json:"homeOrganization,omitempty"`

	// AuthorizedScope - The list of scopes authorized for the OAuth client
	AuthorizedScope *[]string `json:"authorizedScope,omitempty"`

	// ClonedUser - Only present when a user is a clone of trustee user in the trustor org.
	ClonedUser *Tokeninfocloneduser `json:"clonedUser,omitempty"`

	// OAuthClient
	OAuthClient *Orgoauthclient `json:"OAuthClient,omitempty"`
}

Tokeninfo

func (*Tokeninfo) String ¶

func (o *Tokeninfo) String() string

String returns a JSON representation of the model

type Tokeninfocloneduser ¶

type Tokeninfocloneduser struct {
	// Id - User id of the original native user
	Id *string `json:"id,omitempty"`

	// Organization - Organization of the original native user
	Organization *Entity `json:"organization,omitempty"`
}

Tokeninfocloneduser

func (*Tokeninfocloneduser) String ¶

func (o *Tokeninfocloneduser) String() string

String returns a JSON representation of the model

type TokensApi ¶

type TokensApi struct {
	Configuration *Configuration
}

TokensApi provides functions for API endpoints

func NewTokensApi ¶

func NewTokensApi() *TokensApi

NewTokensApi creates an API instance using the default configuration

func NewTokensApiWithConfig ¶

func NewTokensApiWithConfig(config *Configuration) *TokensApi

NewTokensApiWithConfig creates an API instance using the provided configuration

func (TokensApi) DeleteToken ¶

func (a TokensApi) DeleteToken(userId string) (*APIResponse, error)

DeleteToken invokes DELETE /api/v2/tokens/{userId}

Delete all auth tokens for the specified user.

func (TokensApi) DeleteTokensMe ¶

func (a TokensApi) DeleteTokensMe() (*APIResponse, error)

DeleteTokensMe invokes DELETE /api/v2/tokens/me

Delete auth token used to make the request.

func (TokensApi) GetTokensMe ¶

func (a TokensApi) GetTokensMe() (*Tokeninfo, *APIResponse, error)

GetTokensMe invokes GET /api/v2/tokens/me

Fetch information about the current token

type Topic ¶

type Topic 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"`

	// Published
	Published *bool `json:"published,omitempty"`

	// Strictness
	Strictness *string `json:"strictness,omitempty"`

	// Programs
	Programs *[]Baseprogramentity `json:"programs,omitempty"`

	// Tags
	Tags *[]string `json:"tags,omitempty"`

	// Dialect
	Dialect *string `json:"dialect,omitempty"`

	// Participants
	Participants *string `json:"participants,omitempty"`

	// Phrases
	Phrases *[]Phrase `json:"phrases,omitempty"`

	// ModifiedBy
	ModifiedBy *Addressableentityref `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"`

	// PublishedBy
	PublishedBy *Addressableentityref `json:"publishedBy,omitempty"`

	// DatePublished - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DatePublished *time.Time `json:"datePublished,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Topic

func (*Topic) String ¶

func (o *Topic) String() string

String returns a JSON representation of the model

type Topicjob ¶

type Topicjob struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// Topics
	Topics *[]Basetopicentitiy `json:"topics,omitempty"`

	// CreatedBy
	CreatedBy *Addressableentityref `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"`

	// 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"`
}

Topicjob

func (*Topicjob) String ¶

func (o *Topicjob) String() string

String returns a JSON representation of the model

type Topicjobrequest ¶

type Topicjobrequest struct {
	// TopicIds - The ids of the topics used for this job
	TopicIds *[]string `json:"topicIds,omitempty"`
}

Topicjobrequest

func (*Topicjobrequest) String ¶

func (o *Topicjobrequest) String() string

String returns a JSON representation of the model

type Topicrequest ¶

type Topicrequest struct {
	// Name - The topic name
	Name *string `json:"name,omitempty"`

	// Description - The topic description
	Description *string `json:"description,omitempty"`

	// Strictness - The topic strictness, default value is 72
	Strictness *string `json:"strictness,omitempty"`

	// ProgramIds - The ids of programs associated to the topic
	ProgramIds *[]string `json:"programIds,omitempty"`

	// Tags - The topic tags
	Tags *[]string `json:"tags,omitempty"`

	// Dialect - The topic dialect
	Dialect *string `json:"dialect,omitempty"`

	// Participants - The topic participants, default value is All
	Participants *string `json:"participants,omitempty"`

	// Phrases - The topic phrases
	Phrases *[]Phrase `json:"phrases,omitempty"`
}

Topicrequest

func (*Topicrequest) String ¶

func (o *Topicrequest) String() string

String returns a JSON representation of the model

type Topicsentitylisting ¶

type Topicsentitylisting struct {
	// Entities
	Entities *[]Listedtopic `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Topicsentitylisting

func (*Topicsentitylisting) String ¶

func (o *Topicsentitylisting) String() string

String returns a JSON representation of the model

type Traininglisting ¶

type Traininglisting struct {
	// Entities
	Entities *[]Knowledgetraining `json:"entities,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`
}

Traininglisting

func (*Traininglisting) String ¶

func (o *Traininglisting) String() string

String returns a JSON representation of the model

type Transcriptaggregatedatacontainer ¶

type Transcriptaggregatedatacontainer struct {
	// Group - A mapping from dimension to value
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Statisticalresponse `json:"data,omitempty"`
}

Transcriptaggregatedatacontainer

func (*Transcriptaggregatedatacontainer) String ¶

String returns a JSON representation of the model

type Transcriptaggregatequeryclause ¶

type Transcriptaggregatequeryclause 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 *[]Transcriptaggregatequerypredicate `json:"predicates,omitempty"`
}

Transcriptaggregatequeryclause

func (*Transcriptaggregatequeryclause) String ¶

String returns a JSON representation of the model

type Transcriptaggregatequeryfilter ¶

type Transcriptaggregatequeryfilter 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 *[]Transcriptaggregatequeryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Transcriptaggregatequerypredicate `json:"predicates,omitempty"`
}

Transcriptaggregatequeryfilter

func (*Transcriptaggregatequeryfilter) String ¶

String returns a JSON representation of the model

type Transcriptaggregatequerypredicate ¶

type Transcriptaggregatequerypredicate 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"`
}

Transcriptaggregatequerypredicate

func (*Transcriptaggregatequerypredicate) String ¶

String returns a JSON representation of the model

type Transcriptaggregatequeryresponse ¶

type Transcriptaggregatequeryresponse struct {
	// Results
	Results *[]Transcriptaggregatedatacontainer `json:"results,omitempty"`
}

Transcriptaggregatequeryresponse

func (*Transcriptaggregatequeryresponse) String ¶

String returns a JSON representation of the model

type Transcriptaggregationquery ¶

type Transcriptaggregationquery 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 *Transcriptaggregatequeryfilter `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 *[]Transcriptaggregationview `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"`
}

Transcriptaggregationquery

func (*Transcriptaggregationquery) String ¶

func (o *Transcriptaggregationquery) String() string

String returns a JSON representation of the model

type Transcriptaggregationview ¶

type Transcriptaggregationview 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"`
}

Transcriptaggregationview

func (*Transcriptaggregationview) String ¶

func (o *Transcriptaggregationview) String() string

String returns a JSON representation of the model

type Transcriptconversationdetailsearchcriteria ¶

type Transcriptconversationdetailsearchcriteria struct {
	// EndValue - The end value of the range. This field is used for range search types.
	EndValue *string `json:"endValue,omitempty"`

	// Values - A list of values for the search to match against
	Values *[]string `json:"values,omitempty"`

	// StartValue - The start value of the range. This field is used for range search types.
	StartValue *string `json:"startValue,omitempty"`

	// Fields - Field names to search against
	Fields *[]string `json:"fields,omitempty"`

	// Value - A value for the search to match against
	Value *string `json:"value,omitempty"`

	// Operator - How to apply this search criteria against other criteria
	Operator *string `json:"operator,omitempty"`

	// Group - Groups multiple conditions
	Group *[]Transcriptconversationdetailsearchcriteria `json:"group,omitempty"`

	// DateFormat - Set date format for criteria values when using date range search type.  Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX.
	DateFormat *string `json:"dateFormat,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Transcriptconversationdetailsearchcriteria

func (*Transcriptconversationdetailsearchcriteria) String ¶

String returns a JSON representation of the model

type Transcriptconversationdetailsearchrequest ¶

type Transcriptconversationdetailsearchrequest struct {
	// SortOrder - The sort order for results
	SortOrder *string `json:"sortOrder,omitempty"`

	// SortBy - The field in the resource that you want to sort the results by
	SortBy *string `json:"sortBy,omitempty"`

	// PageSize - The number of results per page
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The page of resources you want to retrieve
	PageNumber *int `json:"pageNumber,omitempty"`

	// Sort - Multi-value sort order, list of multiple sort values
	Sort *[]Searchsort `json:"sort,omitempty"`

	// Types - Resource domain type to search
	Types *[]string `json:"types,omitempty"`

	// Query - The search criteria
	Query *[]Transcriptconversationdetailsearchcriteria `json:"query,omitempty"`
}

Transcriptconversationdetailsearchrequest

func (*Transcriptconversationdetailsearchrequest) String ¶

String returns a JSON representation of the model

type Transcriptionsettings ¶

type Transcriptionsettings struct {
	// Transcription - Setting to enable/disable transcription capability
	Transcription *string `json:"transcription,omitempty"`

	// TranscriptionConfidenceThreshold - Configure confidence threshold. The possible values are from 1 to 100.
	TranscriptionConfidenceThreshold *int `json:"transcriptionConfidenceThreshold,omitempty"`

	// ContentSearchEnabled - Setting to enable/disable content search
	ContentSearchEnabled *bool `json:"contentSearchEnabled,omitempty"`
}

Transcriptionsettings

func (*Transcriptionsettings) String ¶

func (o *Transcriptionsettings) String() string

String returns a JSON representation of the model

type Transcriptiontopictranscriptalternative ¶

type Transcriptiontopictranscriptalternative struct {
	// Confidence
	Confidence *float32 `json:"confidence,omitempty"`

	// OffsetMs
	OffsetMs *int `json:"offsetMs,omitempty"`

	// DurationMs
	DurationMs *int `json:"durationMs,omitempty"`

	// Transcript
	Transcript *string `json:"transcript,omitempty"`

	// Words
	Words *[]Transcriptiontopictranscriptword `json:"words,omitempty"`
}

Transcriptiontopictranscriptalternative

func (*Transcriptiontopictranscriptalternative) String ¶

String returns a JSON representation of the model

type Transcriptiontopictranscriptionmessage ¶

type Transcriptiontopictranscriptionmessage struct {
	// EventTime
	EventTime *time.Time `json:"eventTime,omitempty"`

	// OrganizationId
	OrganizationId *string `json:"organizationId,omitempty"`

	// ConversationId
	ConversationId *string `json:"conversationId,omitempty"`

	// CommunicationId
	CommunicationId *string `json:"communicationId,omitempty"`

	// SessionStartTimeMs
	SessionStartTimeMs *int `json:"sessionStartTimeMs,omitempty"`

	// TranscriptionStartTimeMs
	TranscriptionStartTimeMs *int `json:"transcriptionStartTimeMs,omitempty"`

	// Transcripts
	Transcripts *[]Transcriptiontopictranscriptresult `json:"transcripts,omitempty"`

	// Status
	Status *Transcriptiontopictranscriptionrequeststatus `json:"status,omitempty"`
}

Transcriptiontopictranscriptionmessage

func (*Transcriptiontopictranscriptionmessage) String ¶

String returns a JSON representation of the model

type Transcriptiontopictranscriptionrequeststatus ¶

type Transcriptiontopictranscriptionrequeststatus struct {
	// OffsetMs
	OffsetMs *int `json:"offsetMs,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`
}

Transcriptiontopictranscriptionrequeststatus

func (*Transcriptiontopictranscriptionrequeststatus) String ¶

String returns a JSON representation of the model

type Transcriptiontopictranscriptresult ¶

type Transcriptiontopictranscriptresult struct {
	// UtteranceId
	UtteranceId *string `json:"utteranceId,omitempty"`

	// IsFinal
	IsFinal *bool `json:"isFinal,omitempty"`

	// Channel
	Channel *string `json:"channel,omitempty"`

	// Alternatives
	Alternatives *[]Transcriptiontopictranscriptalternative `json:"alternatives,omitempty"`

	// AgentAssistantId
	AgentAssistantId *string `json:"agentAssistantId,omitempty"`

	// EngineId
	EngineId *string `json:"engineId,omitempty"`

	// Dialect
	Dialect *string `json:"dialect,omitempty"`

	// SpeechTextAnalyticsProgramId
	SpeechTextAnalyticsProgramId *string `json:"speechTextAnalyticsProgramId,omitempty"`

	// AgentAssistEnabled
	AgentAssistEnabled *bool `json:"agentAssistEnabled,omitempty"`

	// VoiceTranscriptionEnabled
	VoiceTranscriptionEnabled *bool `json:"voiceTranscriptionEnabled,omitempty"`
}

Transcriptiontopictranscriptresult

func (*Transcriptiontopictranscriptresult) String ¶

String returns a JSON representation of the model

type Transcriptiontopictranscriptword ¶

type Transcriptiontopictranscriptword struct {
	// Confidence
	Confidence *float32 `json:"confidence,omitempty"`

	// StartTimeMs
	StartTimeMs *int `json:"startTimeMs,omitempty"`

	// OffsetMs
	OffsetMs *int `json:"offsetMs,omitempty"`

	// DurationMs
	DurationMs *int `json:"durationMs,omitempty"`

	// Word
	Word *string `json:"word,omitempty"`
}

Transcriptiontopictranscriptword

func (*Transcriptiontopictranscriptword) String ¶

String returns a JSON representation of the model

type Transcripts ¶

type Transcripts struct {
	// ExactMatch - List of transcript contents which needs to satisfy exact match criteria
	ExactMatch *[]string `json:"exactMatch,omitempty"`

	// Contains - List of transcript contents which needs to satisfy contains criteria
	Contains *[]string `json:"contains,omitempty"`

	// DoesNotContain - List of transcript contents which needs to satisfy does not contain criteria
	DoesNotContain *[]string `json:"doesNotContain,omitempty"`
}

Transcripts

func (*Transcripts) String ¶

func (o *Transcripts) String() string

String returns a JSON representation of the model

type Transcriptsearchcriteria ¶

type Transcriptsearchcriteria struct {
	// EndValue - The end value of the range. This field is used for range search types.
	EndValue *string `json:"endValue,omitempty"`

	// Values - A list of values for the search to match against
	Values *[]string `json:"values,omitempty"`

	// StartValue - The start value of the range. This field is used for range search types.
	StartValue *string `json:"startValue,omitempty"`

	// Fields - Field names to search against
	Fields *[]string `json:"fields,omitempty"`

	// Value - A value for the search to match against
	Value *string `json:"value,omitempty"`

	// Operator - How to apply this search criteria against other criteria
	Operator *string `json:"operator,omitempty"`

	// Group - Groups multiple conditions
	Group *[]Transcriptsearchcriteria `json:"group,omitempty"`

	// DateFormat - Set date format for criteria values when using date range search type.  Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX.
	DateFormat *string `json:"dateFormat,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Transcriptsearchcriteria

func (*Transcriptsearchcriteria) String ¶

func (o *Transcriptsearchcriteria) String() string

String returns a JSON representation of the model

type Transcriptsearchrequest ¶

type Transcriptsearchrequest struct {
	// SortOrder - The sort order for results
	SortOrder *string `json:"sortOrder,omitempty"`

	// SortBy - The field in the resource that you want to sort the results by
	SortBy *string `json:"sortBy,omitempty"`

	// PageSize - The number of results per page
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The page of resources you want to retrieve
	PageNumber *int `json:"pageNumber,omitempty"`

	// Sort - Multi-value sort order, list of multiple sort values
	Sort *[]Searchsort `json:"sort,omitempty"`

	// ReturnFields
	ReturnFields *[]string `json:"returnFields,omitempty"`

	// Types - Resource domain type to search
	Types *[]string `json:"types,omitempty"`

	// Query - The search criteria
	Query *[]Transcriptsearchcriteria `json:"query,omitempty"`
}

Transcriptsearchrequest

func (*Transcriptsearchrequest) String ¶

func (o *Transcriptsearchrequest) String() string

String returns a JSON representation of the model

type Transcripturl ¶

type Transcripturl struct {
	// Url - The pre-signed S3 URL of the transcript
	Url *string `json:"url,omitempty"`
}

Transcripturl

func (*Transcripturl) String ¶

func (o *Transcripturl) String() string

String returns a JSON representation of the model

type Transferrequest ¶

type Transferrequest struct {
	// UserId - The user ID of the transfer target.
	UserId *string `json:"userId,omitempty"`

	// Address - The phone number or address of the transfer target.
	Address *string `json:"address,omitempty"`

	// UserName - The user name of the transfer target.
	UserName *string `json:"userName,omitempty"`

	// QueueId - The queue ID of the transfer target.
	QueueId *string `json:"queueId,omitempty"`

	// Voicemail - If true, transfer to the voicemail inbox of the participant that is being replaced.
	Voicemail *bool `json:"voicemail,omitempty"`
}

Transferrequest

func (*Transferrequest) String ¶

func (o *Transferrequest) String() string

String returns a JSON representation of the model

type Trunk ¶

type Trunk struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// TrunkType - The type of this trunk.
	TrunkType *string `json:"trunkType,omitempty"`

	// Edge - The Edge using this trunk.
	Edge *Domainentityref `json:"edge,omitempty"`

	// TrunkBase - The trunk base configuration used on this trunk.
	TrunkBase *Domainentityref `json:"trunkBase,omitempty"`

	// TrunkMetabase - The metabase used to create this trunk.
	TrunkMetabase *Domainentityref `json:"trunkMetabase,omitempty"`

	// EdgeGroup - The edge group associated with this trunk.
	EdgeGroup *Domainentityref `json:"edgeGroup,omitempty"`

	// InService - True if this trunk is in-service.  This comes from the trunk_enabled property of the referenced trunk base.
	InService *bool `json:"inService,omitempty"`

	// Enabled - True if the Edge used by this trunk is in-service
	Enabled *bool `json:"enabled,omitempty"`

	// LogicalInterface - The Logical Interface on the Edge to which the trunk is assigned.
	LogicalInterface *Domainentityref `json:"logicalInterface,omitempty"`

	// ConnectedStatus - The connected status of the trunk
	ConnectedStatus *Trunkconnectedstatus `json:"connectedStatus,omitempty"`

	// OptionsStatus - The trunk optionsStatus
	OptionsStatus *[]Trunkmetricsoptions `json:"optionsStatus,omitempty"`

	// RegistersStatus - The trunk registersStatus
	RegistersStatus *[]Trunkmetricsregisters `json:"registersStatus,omitempty"`

	// IpStatus - The trunk ipStatus
	IpStatus *Trunkmetricsnetworktypeip `json:"ipStatus,omitempty"`

	// OptionsEnabledStatus - Returns Enabled when the trunk base supports the availability interval and it has a value greater than 0.
	OptionsEnabledStatus *string `json:"optionsEnabledStatus,omitempty"`

	// RegistersEnabledStatus - Returns Enabled when the trunk base supports the registration interval and it has a value greater than 0.
	RegistersEnabledStatus *string `json:"registersEnabledStatus,omitempty"`

	// Family - The IP Network Family of the trunk
	Family *int `json:"family,omitempty"`

	// ProxyAddressList - The list of proxy addresses (ports if provided) for the trunk
	ProxyAddressList *[]string `json:"proxyAddressList,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Trunk

func (*Trunk) String ¶

func (o *Trunk) String() string

String returns a JSON representation of the model

type Trunkbase ¶

type Trunkbase struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the entity.
	Name *string `json:"name,omitempty"`

	// Description - The resource's description.
	Description *string `json:"description,omitempty"`

	// Version - The current version of the resource.
	Version *int `json:"version,omitempty"`

	// DateCreated - The date the resource 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"`

	// DateModified - The date of the last modification to the resource. 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 ID of the user that last modified the resource.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// State - Indicates if the resource is active, inactive, or deleted.
	State *string `json:"state,omitempty"`

	// ModifiedByApp - The application that last modified the resource.
	ModifiedByApp *string `json:"modifiedByApp,omitempty"`

	// CreatedByApp - The application that created the resource.
	CreatedByApp *string `json:"createdByApp,omitempty"`

	// TrunkMetabase - The meta-base this trunk is based on.
	TrunkMetabase *Domainentityref `json:"trunkMetabase,omitempty"`

	// Properties
	Properties *map[string]interface{} `json:"properties,omitempty"`

	// TrunkType - The type of this trunk base.
	TrunkType *string `json:"trunkType,omitempty"`

	// Managed - Is this trunk being managed remotely. This property is synchronized with the managed property of the Edge Group to which it is assigned.
	Managed *bool `json:"managed,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Trunkbase

func (*Trunkbase) String ¶

func (o *Trunkbase) String() string

String returns a JSON representation of the model

type Trunkbaseassignment ¶

type Trunkbaseassignment struct {
	// Family - The address family to use with the trunk base settings. 2=IPv4, 23=IPv6
	Family *int `json:"family,omitempty"`

	// TrunkBase - A trunk base settings reference.
	TrunkBase *Trunkbase `json:"trunkBase,omitempty"`
}

Trunkbaseassignment

func (*Trunkbaseassignment) String ¶

func (o *Trunkbaseassignment) String() string

String returns a JSON representation of the model

type Trunkbaseentitylisting ¶

type Trunkbaseentitylisting struct {
	// Entities
	Entities *[]Trunkbase `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Trunkbaseentitylisting

func (*Trunkbaseentitylisting) String ¶

func (o *Trunkbaseentitylisting) String() string

String returns a JSON representation of the model

type Trunkconnectedstatus ¶

type Trunkconnectedstatus struct {
	// Connected
	Connected *bool `json:"connected,omitempty"`

	// ConnectedStateTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ConnectedStateTime *time.Time `json:"connectedStateTime,omitempty"`
}

Trunkconnectedstatus

func (*Trunkconnectedstatus) String ¶

func (o *Trunkconnectedstatus) String() string

String returns a JSON representation of the model

type Trunkentitylisting ¶

type Trunkentitylisting struct {
	// Entities
	Entities *[]Trunk `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Trunkentitylisting

func (*Trunkentitylisting) String ¶

func (o *Trunkentitylisting) String() string

String returns a JSON representation of the model

type Trunkerrorinfo ¶

type Trunkerrorinfo struct {
	// Text
	Text *string `json:"text,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Details
	Details *Trunkerrorinfodetails `json:"details,omitempty"`
}

Trunkerrorinfo

func (*Trunkerrorinfo) String ¶

func (o *Trunkerrorinfo) String() string

String returns a JSON representation of the model

type Trunkerrorinfodetails ¶

type Trunkerrorinfodetails struct {
	// Code
	Code *string `json:"code,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// Hostname
	Hostname *string `json:"hostname,omitempty"`
}

Trunkerrorinfodetails

func (*Trunkerrorinfodetails) String ¶

func (o *Trunkerrorinfodetails) String() string

String returns a JSON representation of the model

type Trunkinstancetopictrunk ¶

type Trunkinstancetopictrunk struct {
	// Id
	Id *string `json:"id,omitempty"`

	// ConnectedStatus
	ConnectedStatus *Trunkinstancetopictrunkconnectedstatus `json:"connectedStatus,omitempty"`

	// OptionsStatus
	OptionsStatus *[]Trunkinstancetopictrunkmetricsoptions `json:"optionsStatus,omitempty"`

	// RegistersStatus
	RegistersStatus *[]Trunkinstancetopictrunkmetricsregisters `json:"registersStatus,omitempty"`

	// IpStatus
	IpStatus *Trunkinstancetopictrunkmetricsnetworktypeip `json:"ipStatus,omitempty"`
}

Trunkinstancetopictrunk

func (*Trunkinstancetopictrunk) String ¶

func (o *Trunkinstancetopictrunk) String() string

String returns a JSON representation of the model

type Trunkinstancetopictrunkconnectedstatus ¶

type Trunkinstancetopictrunkconnectedstatus struct {
	// Connected
	Connected *bool `json:"connected,omitempty"`

	// ConnectedStateTime
	ConnectedStateTime *time.Time `json:"connectedStateTime,omitempty"`
}

Trunkinstancetopictrunkconnectedstatus

func (*Trunkinstancetopictrunkconnectedstatus) String ¶

String returns a JSON representation of the model

type Trunkinstancetopictrunkerrorinfo ¶

type Trunkinstancetopictrunkerrorinfo struct {
	// Text
	Text *string `json:"text,omitempty"`

	// Code
	Code *string `json:"code,omitempty"`

	// Details
	Details *Trunkinstancetopictrunkerrorinfodetails `json:"details,omitempty"`
}

Trunkinstancetopictrunkerrorinfo

func (*Trunkinstancetopictrunkerrorinfo) String ¶

String returns a JSON representation of the model

type Trunkinstancetopictrunkerrorinfodetails ¶

type Trunkinstancetopictrunkerrorinfodetails struct {
	// Code
	Code *string `json:"code,omitempty"`

	// Message
	Message *string `json:"message,omitempty"`

	// Hostname
	Hostname *string `json:"hostname,omitempty"`
}

Trunkinstancetopictrunkerrorinfodetails

func (*Trunkinstancetopictrunkerrorinfodetails) String ¶

String returns a JSON representation of the model

type Trunkinstancetopictrunkmetricsnetworktypeip ¶

type Trunkinstancetopictrunkmetricsnetworktypeip struct {
	// Address
	Address *string `json:"address,omitempty"`

	// ErrorInfo
	ErrorInfo *Trunkinstancetopictrunkerrorinfo `json:"errorInfo,omitempty"`
}

Trunkinstancetopictrunkmetricsnetworktypeip

func (*Trunkinstancetopictrunkmetricsnetworktypeip) String ¶

String returns a JSON representation of the model

type Trunkinstancetopictrunkmetricsoptions ¶

type Trunkinstancetopictrunkmetricsoptions struct {
	// ProxyAddress
	ProxyAddress *string `json:"proxyAddress,omitempty"`

	// OptionState
	OptionState *bool `json:"optionState,omitempty"`

	// OptionStateTime
	OptionStateTime *time.Time `json:"optionStateTime,omitempty"`

	// ErrorInfo
	ErrorInfo *Trunkinstancetopictrunkerrorinfo `json:"errorInfo,omitempty"`
}

Trunkinstancetopictrunkmetricsoptions

func (*Trunkinstancetopictrunkmetricsoptions) String ¶

String returns a JSON representation of the model

type Trunkinstancetopictrunkmetricsregisters ¶

type Trunkinstancetopictrunkmetricsregisters struct {
	// ProxyAddress
	ProxyAddress *string `json:"proxyAddress,omitempty"`

	// RegisterState
	RegisterState *bool `json:"registerState,omitempty"`

	// RegisterStateTime
	RegisterStateTime *time.Time `json:"registerStateTime,omitempty"`

	// ErrorInfo
	ErrorInfo *Trunkinstancetopictrunkerrorinfo `json:"errorInfo,omitempty"`
}

Trunkinstancetopictrunkmetricsregisters

func (*Trunkinstancetopictrunkmetricsregisters) String ¶

String returns a JSON representation of the model

type Trunkmetabaseentitylisting ¶

type Trunkmetabaseentitylisting struct {
	// Entities
	Entities *[]Metabase `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Trunkmetabaseentitylisting

func (*Trunkmetabaseentitylisting) String ¶

func (o *Trunkmetabaseentitylisting) String() string

String returns a JSON representation of the model

type Trunkmetrics ¶

type Trunkmetrics struct {
	// EventTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EventTime *time.Time `json:"eventTime,omitempty"`

	// LogicalInterface
	LogicalInterface *Domainentityref `json:"logicalInterface,omitempty"`

	// Trunk
	Trunk *Domainentityref `json:"trunk,omitempty"`

	// Calls
	Calls *Trunkmetricscalls `json:"calls,omitempty"`

	// Qos
	Qos *Trunkmetricsqos `json:"qos,omitempty"`
}

Trunkmetrics

func (*Trunkmetrics) String ¶

func (o *Trunkmetrics) String() string

String returns a JSON representation of the model

type Trunkmetricscalls ¶

type Trunkmetricscalls struct {
	// InboundCallCount
	InboundCallCount *int `json:"inboundCallCount,omitempty"`

	// OutboundCallCount
	OutboundCallCount *int `json:"outboundCallCount,omitempty"`
}

Trunkmetricscalls

func (*Trunkmetricscalls) String ¶

func (o *Trunkmetricscalls) String() string

String returns a JSON representation of the model

type Trunkmetricsnetworktypeip ¶

type Trunkmetricsnetworktypeip struct {
	// Address - Assigned IP Address for the interface
	Address *string `json:"address,omitempty"`

	// ErrorInfo - Information about the error.
	ErrorInfo *Trunkerrorinfo `json:"errorInfo,omitempty"`
}

Trunkmetricsnetworktypeip

func (*Trunkmetricsnetworktypeip) String ¶

func (o *Trunkmetricsnetworktypeip) String() string

String returns a JSON representation of the model

type Trunkmetricsoptions ¶

type Trunkmetricsoptions struct {
	// ProxyAddress - Server proxy address that this options array element represents.
	ProxyAddress *string `json:"proxyAddress,omitempty"`

	// OptionState
	OptionState *bool `json:"optionState,omitempty"`

	// OptionStateTime - ISO 8601 format UTC absolute date & time of the last change of the option state.
	OptionStateTime *time.Time `json:"optionStateTime,omitempty"`

	// ErrorInfo
	ErrorInfo *Trunkerrorinfo `json:"errorInfo,omitempty"`
}

Trunkmetricsoptions

func (*Trunkmetricsoptions) String ¶

func (o *Trunkmetricsoptions) String() string

String returns a JSON representation of the model

type Trunkmetricsqos ¶

type Trunkmetricsqos struct {
	// MismatchCount - Total number of QoS mismatches over the course of the last 24-hour period (sliding window).
	MismatchCount *int `json:"mismatchCount,omitempty"`
}

Trunkmetricsqos

func (*Trunkmetricsqos) String ¶

func (o *Trunkmetricsqos) String() string

String returns a JSON representation of the model

type Trunkmetricsregisters ¶

type Trunkmetricsregisters struct {
	// ProxyAddress - Server proxy address that this registers array element represents.
	ProxyAddress *string `json:"proxyAddress,omitempty"`

	// RegisterState - True if last REGISTER message had positive response; false if error response or no response.
	RegisterState *bool `json:"registerState,omitempty"`

	// RegisterStateTime - ISO 8601 format UTC absolute date & time of the last change of the register state.
	RegisterStateTime *time.Time `json:"registerStateTime,omitempty"`

	// ErrorInfo
	ErrorInfo *Trunkerrorinfo `json:"errorInfo,omitempty"`
}

Trunkmetricsregisters

func (*Trunkmetricsregisters) String ¶

func (o *Trunkmetricsregisters) String() string

String returns a JSON representation of the model

type Trunkmetricstopictrunkmetrics ¶

type Trunkmetricstopictrunkmetrics struct {
	// Calls
	Calls *Trunkmetricstopictrunkmetricscalls `json:"calls,omitempty"`

	// Qos
	Qos *Trunkmetricstopictrunkmetricsqos `json:"qos,omitempty"`

	// Trunk
	Trunk *Trunkmetricstopicurireference `json:"trunk,omitempty"`
}

Trunkmetricstopictrunkmetrics

func (*Trunkmetricstopictrunkmetrics) String ¶

String returns a JSON representation of the model

type Trunkmetricstopictrunkmetricscalls ¶

type Trunkmetricstopictrunkmetricscalls struct {
	// InboundCallCount
	InboundCallCount *int `json:"inboundCallCount,omitempty"`

	// OutboundCallCount
	OutboundCallCount *int `json:"outboundCallCount,omitempty"`
}

Trunkmetricstopictrunkmetricscalls

func (*Trunkmetricstopictrunkmetricscalls) String ¶

String returns a JSON representation of the model

type Trunkmetricstopictrunkmetricsqos ¶

type Trunkmetricstopictrunkmetricsqos struct {
	// MismatchCount
	MismatchCount *int `json:"mismatchCount,omitempty"`
}

Trunkmetricstopictrunkmetricsqos

func (*Trunkmetricstopictrunkmetricsqos) String ¶

String returns a JSON representation of the model

type Trunkmetricstopicurireference ¶

type Trunkmetricstopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Trunkmetricstopicurireference

func (*Trunkmetricstopicurireference) String ¶

String returns a JSON representation of the model

type Trunkrecordingenabledcount ¶

type Trunkrecordingenabledcount struct {
	// EnabledCount - The amount of trunks that have recording enabled
	EnabledCount *int `json:"enabledCount,omitempty"`

	// DisabledCount - The amount of trunks that do not have recording enabled
	DisabledCount *int `json:"disabledCount,omitempty"`
}

Trunkrecordingenabledcount

func (*Trunkrecordingenabledcount) String ¶

func (o *Trunkrecordingenabledcount) String() string

String returns a JSON representation of the model

type Trustcreate ¶

type Trustcreate struct {
	// PairingId - The pairing Id created by the trustee. This is required to prove that the trustee agrees to the relationship.  Not required when creating a default pairing with Customer Care.
	PairingId *string `json:"pairingId,omitempty"`

	// Enabled - If disabled no trustee user will have access, even if they were previously added.
	Enabled *bool `json:"enabled,omitempty"`

	// Users - The list of users and their roles to which access will be granted. The users are from the trustee and the roles are from the trustor. If no users are specified, at least one group is required.
	Users *[]Trustmembercreate `json:"users,omitempty"`

	// Groups - The list of groups and their roles to which access will be granted. The groups are from the trustee and the roles are from the trustor. If no groups are specified, at least one user is required.
	Groups *[]Trustmembercreate `json:"groups,omitempty"`

	// DateExpired - The expiration date of the trust. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateExpired *time.Time `json:"dateExpired,omitempty"`
}

Trustcreate

func (*Trustcreate) String ¶

func (o *Trustcreate) String() string

String returns a JSON representation of the model

type Trustee ¶

type Trustee struct {
	// Id - Organization Id for this trust.
	Id *string `json:"id,omitempty"`

	// Enabled - If disabled no trustee user will have access, even if they were previously added.
	Enabled *bool `json:"enabled,omitempty"`

	// UsesDefaultRole - Denotes if trustee uses admin role by default.
	UsesDefaultRole *bool `json:"usesDefaultRole,omitempty"`

	// DateCreated - Date Trust 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"`

	// DateExpired - The expiration date of the trust. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateExpired *time.Time `json:"dateExpired,omitempty"`

	// CreatedBy - User that created trust.
	CreatedBy *Orguser `json:"createdBy,omitempty"`

	// Organization - Organization associated with this trust.
	Organization *Organization `json:"organization,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Trustee

func (*Trustee) String ¶

func (o *Trustee) String() string

String returns a JSON representation of the model

type Trusteeauditqueryrequest ¶

type Trusteeauditqueryrequest struct {
	// TrusteeOrganizationIds - Limit returned audits to these trustee organizationIds.
	TrusteeOrganizationIds *[]string `json:"trusteeOrganizationIds,omitempty"`

	// TrusteeUserIds - Limit returned audits to these trustee userIds.
	TrusteeUserIds *[]string `json:"trusteeUserIds,omitempty"`

	// StartDate - Starting date/time for the audit search. ISO-8601 formatted date-time, UTC.
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - Ending date/time for the audit search. ISO-8601 formatted date-time, UTC.
	EndDate *time.Time `json:"endDate,omitempty"`

	// QueryPhrase - Word or phrase to look for in audit bodies.
	QueryPhrase *string `json:"queryPhrase,omitempty"`

	// Facets - Facet information to be returned with the query results.
	Facets *[]Facet `json:"facets,omitempty"`

	// Filters - Additional custom filters to be applied to the query.
	Filters *[]Filter `json:"filters,omitempty"`
}

Trusteeauditqueryrequest

func (*Trusteeauditqueryrequest) String ¶

func (o *Trusteeauditqueryrequest) String() string

String returns a JSON representation of the model

type Trusteeauthorization ¶

type Trusteeauthorization struct {
	// Permissions - Permissions that the trustee user has in the trustor organization
	Permissions *[]string `json:"permissions,omitempty"`
}

Trusteeauthorization

func (*Trusteeauthorization) String ¶

func (o *Trusteeauthorization) String() string

String returns a JSON representation of the model

type Trusteebillingoverview ¶

type Trusteebillingoverview struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Organization - Organization
	Organization *Namedentity `json:"organization,omitempty"`

	// Currency - The currency type.
	Currency *string `json:"currency,omitempty"`

	// EnabledProducts - The charge short names for products enabled during the specified period.
	EnabledProducts *[]string `json:"enabledProducts,omitempty"`

	// SubscriptionType - The subscription type.
	SubscriptionType *string `json:"subscriptionType,omitempty"`

	// RampPeriodStartDate - Date-time the ramp period starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	RampPeriodStartDate *time.Time `json:"rampPeriodStartDate,omitempty"`

	// RampPeriodEndDate - Date-time the ramp period ends. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	RampPeriodEndDate *time.Time `json:"rampPeriodEndDate,omitempty"`

	// BillingPeriodStartDate - Date-time the billing period started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	BillingPeriodStartDate *time.Time `json:"billingPeriodStartDate,omitempty"`

	// BillingPeriodEndDate - Date-time the billing period ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	BillingPeriodEndDate *time.Time `json:"billingPeriodEndDate,omitempty"`

	// Usages - Usages for the specified period.
	Usages *[]Subscriptionoverviewusage `json:"usages,omitempty"`

	// ContractAmendmentDate - Date-time the contract was last amended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ContractAmendmentDate *time.Time `json:"contractAmendmentDate,omitempty"`

	// ContractEffectiveDate - Date-time the contract became effective. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ContractEffectiveDate *time.Time `json:"contractEffectiveDate,omitempty"`

	// ContractEndDate - Date-time the contract ends. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ContractEndDate *time.Time `json:"contractEndDate,omitempty"`

	// MinimumMonthlyAmount - Minimum amount that will be charged for the month
	MinimumMonthlyAmount *string `json:"minimumMonthlyAmount,omitempty"`

	// InRampPeriod
	InRampPeriod *bool `json:"inRampPeriod,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Trusteebillingoverview

func (*Trusteebillingoverview) String ¶

func (o *Trusteebillingoverview) String() string

String returns a JSON representation of the model

type Trustentitylisting ¶

type Trustentitylisting struct {
	// Entities
	Entities *[]Trustee `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Trustentitylisting

func (*Trustentitylisting) String ¶

func (o *Trustentitylisting) String() string

String returns a JSON representation of the model

type Trustgroup ¶

type Trustgroup struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The group name.
	Name *string `json:"name,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// DateModified - Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateModified *time.Time `json:"dateModified,omitempty"`

	// MemberCount - Number of members.
	MemberCount *int `json:"memberCount,omitempty"`

	// State - Active, inactive, or deleted state.
	State *string `json:"state,omitempty"`

	// Version - Current version for this resource.
	Version *int `json:"version,omitempty"`

	// VarType - Type of group.
	VarType *string `json:"type,omitempty"`

	// Images
	Images *[]Userimage `json:"images,omitempty"`

	// Addresses
	Addresses *[]Groupcontact `json:"addresses,omitempty"`

	// RulesVisible - Are membership rules visible to the person requesting to view the group
	RulesVisible *bool `json:"rulesVisible,omitempty"`

	// Visibility - Who can view this group
	Visibility *string `json:"visibility,omitempty"`

	// Owners - Owners of the group
	Owners *[]User `json:"owners,omitempty"`

	// DateCreated - The date on which the trusted group was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// CreatedBy - The user that added trusted group.
	CreatedBy *Orguser `json:"createdBy,omitempty"`
}

Trustgroup

func (*Trustgroup) String ¶

func (o *Trustgroup) String() string

String returns a JSON representation of the model

type Trustmembercreate ¶

type Trustmembercreate struct {
	// Id - Trustee User or Group Id
	Id *string `json:"id,omitempty"`

	// RoleIds - The list of roles to be granted to this user or group. Roles will be granted in all divisions.
	RoleIds *[]string `json:"roleIds,omitempty"`

	// RoleDivisions - The list of trustor organization roles granting this user or group access paired with the divisions for those roles.
	RoleDivisions *Roledivisiongrants `json:"roleDivisions,omitempty"`
}

Trustmembercreate

func (*Trustmembercreate) String ¶

func (o *Trustmembercreate) String() string

String returns a JSON representation of the model

type Trustor ¶

type Trustor struct {
	// Id - Organization Id for this trust.
	Id *string `json:"id,omitempty"`

	// Enabled - If disabled no trustee user will have access, even if they were previously added.
	Enabled *bool `json:"enabled,omitempty"`

	// DateCreated - Date Trust 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"`

	// CreatedBy - User that created trust.
	CreatedBy *Orguser `json:"createdBy,omitempty"`

	// Organization - Organization associated with this trust.
	Organization *Organization `json:"organization,omitempty"`

	// Authorization - Authorization for the trustee user has in this trustor organization
	Authorization *Trusteeauthorization `json:"authorization,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Trustor

func (*Trustor) String ¶

func (o *Trustor) String() string

String returns a JSON representation of the model

type Trustorauditqueryrequest ¶

type Trustorauditqueryrequest struct {
	// TrustorOrganizationId - Limit returned audits to this trustor organizationId.
	TrustorOrganizationId *string `json:"trustorOrganizationId,omitempty"`

	// TrusteeUserIds - Limit returned audits to these trustee userIds.
	TrusteeUserIds *[]string `json:"trusteeUserIds,omitempty"`

	// StartDate - Starting date/time for the audit search. ISO-8601 formatted date-time, UTC.
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - Ending date/time for the audit search. ISO-8601 formatted date-time, UTC.
	EndDate *time.Time `json:"endDate,omitempty"`

	// QueryPhrase - Word or phrase to look for in audit bodies.
	QueryPhrase *string `json:"queryPhrase,omitempty"`

	// Facets - Facet information to be returned with the query results.
	Facets *[]Facet `json:"facets,omitempty"`

	// Filters - Additional custom filters to be applied to the query.
	Filters *[]Filter `json:"filters,omitempty"`
}

Trustorauditqueryrequest

func (*Trustorauditqueryrequest) String ¶

func (o *Trustorauditqueryrequest) String() string

String returns a JSON representation of the model

type Trustorentitylisting ¶

type Trustorentitylisting struct {
	// Entities
	Entities *[]Trustor `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Trustorentitylisting

func (*Trustorentitylisting) String ¶

func (o *Trustorentitylisting) String() string

String returns a JSON representation of the model

type Trustrequest ¶

type Trustrequest struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// CreatedBy - User who created this request.
	CreatedBy *Orguser `json:"createdBy,omitempty"`

	// DateCreated - Date request was created. There is a 48 hour expiration on all requests. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// Trustee - Trustee organization who generated this request.
	Trustee *Organization `json:"trustee,omitempty"`

	// Users - The list of trustee users that are requesting access.
	Users *[]Orguser `json:"users,omitempty"`

	// Groups - The list of trustee groups that are requesting access.
	Groups *[]Trustgroup `json:"groups,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Trustrequest

func (*Trustrequest) String ¶

func (o *Trustrequest) String() string

String returns a JSON representation of the model

type Trustrequestcreate ¶

type Trustrequestcreate struct {
	// UserIds - The list of trustee users that are requesting access. If no users are specified, at least one group is required.
	UserIds *[]string `json:"userIds,omitempty"`

	// GroupIds - The list of trustee groups that are requesting access. If no groups are specified, at least one user is required.
	GroupIds *[]string `json:"groupIds,omitempty"`
}

Trustrequestcreate

func (*Trustrequestcreate) String ¶

func (o *Trustrequestcreate) String() string

String returns a JSON representation of the model

type Trustupdate ¶

type Trustupdate struct {
	// Enabled - If disabled no trustee user will have access, even if they were previously added.
	Enabled *bool `json:"enabled,omitempty"`

	// DateExpired - The expiration date of the trust. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateExpired *time.Time `json:"dateExpired,omitempty"`
}

Trustupdate

func (*Trustupdate) String ¶

func (o *Trustupdate) String() string

String returns a JSON representation of the model

type Trustuser ¶

type Trustuser 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"`

	// Chat
	Chat *Chat `json:"chat,omitempty"`

	// Department
	Department *string `json:"department,omitempty"`

	// Email
	Email *string `json:"email,omitempty"`

	// PrimaryContactInfo - Auto populated from addresses.
	PrimaryContactInfo *[]Contact `json:"primaryContactInfo,omitempty"`

	// Addresses - Email addresses and phone numbers for this user
	Addresses *[]Contact `json:"addresses,omitempty"`

	// State - The current state for this user.
	State *string `json:"state,omitempty"`

	// Title
	Title *string `json:"title,omitempty"`

	// Username
	Username *string `json:"username,omitempty"`

	// Manager
	Manager *User `json:"manager,omitempty"`

	// Images
	Images *[]Userimage `json:"images,omitempty"`

	// Version - Required when updating a user, this value should be the current version of the user.  The current version can be obtained with a GET on the user before doing a PATCH.
	Version *int `json:"version,omitempty"`

	// Certifications
	Certifications *[]string `json:"certifications,omitempty"`

	// Biography
	Biography *Biography `json:"biography,omitempty"`

	// EmployerInfo
	EmployerInfo *Employerinfo `json:"employerInfo,omitempty"`

	// RoutingStatus - ACD routing status
	RoutingStatus *Routingstatus `json:"routingStatus,omitempty"`

	// Presence - Active presence
	Presence *Userpresence `json:"presence,omitempty"`

	// ConversationSummary - Summary of conversion statistics for conversation types.
	ConversationSummary *Userconversationsummary `json:"conversationSummary,omitempty"`

	// OutOfOffice - Determine if out of office is enabled
	OutOfOffice *Outofoffice `json:"outOfOffice,omitempty"`

	// Geolocation - Current geolocation position
	Geolocation *Geolocation `json:"geolocation,omitempty"`

	// Station - Effective, default, and last station information
	Station *Userstations `json:"station,omitempty"`

	// Authorization - Roles and permissions assigned to the user
	Authorization *Userauthorization `json:"authorization,omitempty"`

	// ProfileSkills - Profile skills possessed by the user
	ProfileSkills *[]string `json:"profileSkills,omitempty"`

	// Locations - The user placement at each site location.
	Locations *[]Location `json:"locations,omitempty"`

	// Groups - The groups the user is a member of
	Groups *[]Group `json:"groups,omitempty"`

	// Team - The team the user is a member of
	Team *Team `json:"team,omitempty"`

	// Skills - Routing (ACD) skills possessed by the user
	Skills *[]Userroutingskill `json:"skills,omitempty"`

	// Languages - Routing (ACD) languages possessed by the user
	Languages *[]Userroutinglanguage `json:"languages,omitempty"`

	// AcdAutoAnswer - acd auto answer
	AcdAutoAnswer *bool `json:"acdAutoAnswer,omitempty"`

	// LanguagePreference - preferred language by the user
	LanguagePreference *string `json:"languagePreference,omitempty"`

	// LastTokenIssued
	LastTokenIssued *Oauthlasttokenissued `json:"lastTokenIssued,omitempty"`

	// TrustUserDetails
	TrustUserDetails *Trustuserdetails `json:"trustUserDetails,omitempty"`
}

Trustuser

func (*Trustuser) String ¶

func (o *Trustuser) String() string

String returns a JSON representation of the model

type Trustuserdetails ¶

type Trustuserdetails struct {
	// DateCreated - Date Trust User was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// CreatedBy - User that added trusted user.
	CreatedBy *Orguser `json:"createdBy,omitempty"`
}

Trustuserdetails

func (*Trustuserdetails) String ¶

func (o *Trustuserdetails) String() string

String returns a JSON representation of the model

type Trustuserentitylisting ¶

type Trustuserentitylisting struct {
	// Entities
	Entities *[]Trustuser `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Trustuserentitylisting

func (*Trustuserentitylisting) String ¶

func (o *Trustuserentitylisting) String() string

String returns a JSON representation of the model

type Ttsengineentity ¶

type Ttsengineentity struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Languages - The set of languages the TTS engine supports
	Languages *[]string `json:"languages,omitempty"`

	// OutputFormats - The set of output formats the TTS engine can produce
	OutputFormats *[]string `json:"outputFormats,omitempty"`

	// Voices - The set of voices the TTS engine supports
	Voices *[]Ttsvoiceentity `json:"voices,omitempty"`

	// IsDefault - The TTS engine is the global default engine
	IsDefault *bool `json:"isDefault,omitempty"`

	// IsSecure - The TTS engine can be used in a secure call flow
	IsSecure *bool `json:"isSecure,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Ttsengineentity

func (*Ttsengineentity) String ¶

func (o *Ttsengineentity) String() string

String returns a JSON representation of the model

type Ttsengineentitylisting ¶

type Ttsengineentitylisting struct {
	// Entities
	Entities *[]Ttsengineentity `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Ttsengineentitylisting

func (*Ttsengineentitylisting) String ¶

func (o *Ttsengineentitylisting) String() string

String returns a JSON representation of the model

type Ttssettings ¶

type Ttssettings struct {
	// DefaultEngine - ID of the global default TTS engine
	DefaultEngine *string `json:"defaultEngine,omitempty"`

	// LanguageOverrides - The list of default overrides for specific languages
	LanguageOverrides *[]Languageoverride `json:"languageOverrides,omitempty"`
}

Ttssettings

func (*Ttssettings) String ¶

func (o *Ttssettings) String() string

String returns a JSON representation of the model

type Ttsvoiceentity ¶

type Ttsvoiceentity struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Gender - The gender of the TTS voice
	Gender *string `json:"gender,omitempty"`

	// Language - The language supported by the TTS voice
	Language *string `json:"language,omitempty"`

	// Engine - Ths TTS engine this voice belongs to
	Engine *Ttsengineentity `json:"engine,omitempty"`

	// IsDefault - The voice is the default voice for its language
	IsDefault *bool `json:"isDefault,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Ttsvoiceentity

func (*Ttsvoiceentity) String ¶

func (o *Ttsvoiceentity) String() string

String returns a JSON representation of the model

type Ttsvoiceentitylisting ¶

type Ttsvoiceentitylisting struct {
	// Entities
	Entities *[]Ttsvoiceentity `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Ttsvoiceentitylisting

func (*Ttsvoiceentitylisting) String ¶

func (o *Ttsvoiceentitylisting) String() string

String returns a JSON representation of the model

type Twitterid ¶

type Twitterid struct {
	// Id - twitter user.id_str
	Id *string `json:"id,omitempty"`

	// Name - twitter user.name
	Name *string `json:"name,omitempty"`

	// ScreenName - twitter user.screen_name
	ScreenName *string `json:"screenName,omitempty"`

	// Verified - whether this data has been verified using the twitter API
	Verified *bool `json:"verified,omitempty"`

	// ProfileUrl - url of user's twitter profile
	ProfileUrl *string `json:"profileUrl,omitempty"`
}

Twitterid - User information for a twitter account

func (*Twitterid) String ¶

func (o *Twitterid) String() string

String returns a JSON representation of the model

type Twitterintegration ¶

type Twitterintegration struct {
	// Id - A unique Integration Id
	Id *string `json:"id,omitempty"`

	// Name - The name of the Twitter Integration
	Name *string `json:"name,omitempty"`

	// AccessTokenKey - The Access Token Key from Twitter messenger
	AccessTokenKey *string `json:"accessTokenKey,omitempty"`

	// ConsumerKey - The Consumer Key from Twitter messenger
	ConsumerKey *string `json:"consumerKey,omitempty"`

	// Username - The Username from Twitter
	Username *string `json:"username,omitempty"`

	// UserId - The UserId from Twitter
	UserId *string `json:"userId,omitempty"`

	// Status - The status of the Twitter Integration
	Status *string `json:"status,omitempty"`

	// Tier - The type of twitter account to be used for the integration
	Tier *string `json:"tier,omitempty"`

	// EnvName - The Twitter environment name, e.g.: env-beta (required for premium tier)
	EnvName *string `json:"envName,omitempty"`

	// Recipient - The recipient associated to the Twitter Integration. This recipient is used to associate a flow to an integration
	Recipient *Domainentityref `json:"recipient,omitempty"`

	// DateCreated - Date this Integration 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"`

	// DateModified - Date this Integration was 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"`

	// CreatedBy - User reference that created this Integration
	CreatedBy *Domainentityref `json:"createdBy,omitempty"`

	// ModifiedBy - User reference that last modified this Integration
	ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"`

	// Version - Version number required for updates.
	Version *int `json:"version,omitempty"`

	// CreateStatus - Status of asynchronous create operation
	CreateStatus *string `json:"createStatus,omitempty"`

	// CreateError - Error information returned, if createStatus is set to Error
	CreateError *Errorbody `json:"createError,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Twitterintegration

func (*Twitterintegration) String ¶

func (o *Twitterintegration) String() string

String returns a JSON representation of the model

type Twitterintegrationentitylisting ¶

type Twitterintegrationentitylisting struct {
	// Entities
	Entities *[]Twitterintegration `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Twitterintegrationentitylisting

func (*Twitterintegrationentitylisting) String ¶

String returns a JSON representation of the model

type Twitterintegrationrequest ¶

type Twitterintegrationrequest struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the Twitter Integration
	Name *string `json:"name,omitempty"`

	// AccessTokenKey - The Access Token Key from Twitter messenger
	AccessTokenKey *string `json:"accessTokenKey,omitempty"`

	// AccessTokenSecret - The Access Token Secret from Twitter messenger
	AccessTokenSecret *string `json:"accessTokenSecret,omitempty"`

	// ConsumerKey - The Consumer Key from Twitter messenger
	ConsumerKey *string `json:"consumerKey,omitempty"`

	// ConsumerSecret - The Consumer Secret from Twitter messenger
	ConsumerSecret *string `json:"consumerSecret,omitempty"`

	// Tier - The type of twitter account to be used for the integration
	Tier *string `json:"tier,omitempty"`

	// EnvName - The Twitter environment name, e.g.: env-beta (required for premium tier)
	EnvName *string `json:"envName,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Twitterintegrationrequest

func (*Twitterintegrationrequest) String ¶

func (o *Twitterintegrationrequest) String() string

String returns a JSON representation of the model

type Unpublishedprogramsentitylisting ¶

type Unpublishedprogramsentitylisting struct {
	// Entities
	Entities *[]Program `json:"entities,omitempty"`

	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`

	// NextUri
	NextUri *string `json:"nextUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Unpublishedprogramsentitylisting

func (*Unpublishedprogramsentitylisting) String ¶

String returns a JSON representation of the model

type Unreadmetric ¶

type Unreadmetric struct {
	// Count - The count of unread alerts for a specific rule type.
	Count *int `json:"count,omitempty"`
}

Unreadmetric

func (*Unreadmetric) String ¶

func (o *Unreadmetric) String() string

String returns a JSON representation of the model

type Unreadstatus ¶

type Unreadstatus struct {
	// Unread - Sets if the alert is read or unread.
	Unread *bool `json:"unread,omitempty"`
}

Unreadstatus

func (*Unreadstatus) String ¶

func (o *Unreadstatus) String() string

String returns a JSON representation of the model

type Updateactioninput ¶

type Updateactioninput struct {
	// Category - Category of action, Can be up to 256 characters long
	Category *string `json:"category,omitempty"`

	// Name - Name of action, Can be up to 256 characters long
	Name *string `json:"name,omitempty"`

	// Config - Configuration to support request and response processing
	Config *Actionconfig `json:"config,omitempty"`

	// Version - Version of this action
	Version *int `json:"version,omitempty"`
}

Updateactioninput

func (*Updateactioninput) String ¶

func (o *Updateactioninput) String() string

String returns a JSON representation of the model

type Updateactivitycoderequest ¶

type Updateactivitycoderequest struct {
	// Name - The name of the activity code
	Name *string `json:"name,omitempty"`

	// Category - The activity code's category. Attempting to change the category of a default activity code will return an error
	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 work time
	CountsAsWorkTime *bool `json:"countsAsWorkTime,omitempty"`

	// AgentTimeOffSelectable - Whether an agent can select this activity code when creating or editing a time off request
	AgentTimeOffSelectable *bool `json:"agentTimeOffSelectable,omitempty"`

	// Metadata - Version metadata for the associated business unit's list of activity codes
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Updateactivitycoderequest - Activity Code

func (*Updateactivitycoderequest) String ¶

func (o *Updateactivitycoderequest) String() string

String returns a JSON representation of the model

type Updatebusinessunitrequest ¶

type Updatebusinessunitrequest struct {
	// Name - The name of the business unit
	Name *string `json:"name,omitempty"`

	// DivisionId - The ID of the division to which the business unit should be moved
	DivisionId *string `json:"divisionId,omitempty"`

	// Settings - Configuration for the business unit
	Settings *Updatebusinessunitsettings `json:"settings,omitempty"`
}

Updatebusinessunitrequest

func (*Updatebusinessunitrequest) String ¶

func (o *Updatebusinessunitrequest) String() string

String returns a JSON representation of the model

type Updatebusinessunitsettings ¶

type Updatebusinessunitsettings 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"`
}

Updatebusinessunitsettings

func (*Updatebusinessunitsettings) String ¶

func (o *Updatebusinessunitsettings) String() string

String returns a JSON representation of the model

type Updatecoachingappointmentrequest ¶

type Updatecoachingappointmentrequest struct {
	// 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. Times will be rounded down to the minute. 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"`

	// ConversationIds - IDs of conversations associated with this coaching appointment.
	ConversationIds *[]string `json:"conversationIds,omitempty"`

	// DocumentIds - IDs of documents associated with this coaching appointment.
	DocumentIds *[]string `json:"documentIds,omitempty"`

	// Status - The status of the coaching appointment.
	Status *string `json:"status,omitempty"`
}

Updatecoachingappointmentrequest - Update coaching appointment request

func (*Updatecoachingappointmentrequest) String ¶

String returns a JSON representation of the model

type Updatedraftinput ¶

type Updatedraftinput struct {
	// Category - Category of action, Can be up to 256 characters long
	Category *string `json:"category,omitempty"`

	// Name - Name of action, Can be up to 256 characters long
	Name *string `json:"name,omitempty"`

	// Config - Configuration to support request and response processing
	Config *Actionconfig `json:"config,omitempty"`

	// Contract - Action contract
	Contract *Actioncontractinput `json:"contract,omitempty"`

	// Secure - Indication of whether or not the action is designed to accept sensitive data
	Secure *bool `json:"secure,omitempty"`

	// Version - Version of current Draft
	Version *int `json:"version,omitempty"`
}

Updatedraftinput - Definition of an Action Draft to be created or updated.

func (*Updatedraftinput) String ¶

func (o *Updatedraftinput) String() string

String returns a JSON representation of the model

type Updatemanagementunitrequest ¶

type Updatemanagementunitrequest struct {
	// Name - The new name of the management unit
	Name *string `json:"name,omitempty"`

	// DivisionId - The new division id for the management unit
	DivisionId *string `json:"divisionId,omitempty"`

	// Settings - Updated settings for the management unit
	Settings *Managementunitsettingsrequest `json:"settings,omitempty"`
}

Updatemanagementunitrequest

func (*Updatemanagementunitrequest) String ¶

func (o *Updatemanagementunitrequest) String() string

String returns a JSON representation of the model

type Updatenotificationresponse ¶

type Updatenotificationresponse struct {
	// MutableGroupId - The mutableGroupId of the notification
	MutableGroupId *string `json:"mutableGroupId,omitempty"`

	// Id - The id of the notification for mapping the potentially new mutableGroupId
	Id *string `json:"id,omitempty"`
}

Updatenotificationresponse

func (*Updatenotificationresponse) String ¶

func (o *Updatenotificationresponse) String() string

String returns a JSON representation of the model

type Updatenotificationsrequest ¶

type Updatenotificationsrequest struct {
	// Entities - The notifications to update
	Entities *[]Wfmusernotification `json:"entities,omitempty"`
}

Updatenotificationsrequest

func (*Updatenotificationsrequest) String ¶

func (o *Updatenotificationsrequest) String() string

String returns a JSON representation of the model

type Updatenotificationsresponse ¶

type Updatenotificationsresponse struct {
	// Entities
	Entities *[]Updatenotificationresponse `json:"entities,omitempty"`
}

Updatenotificationsresponse

func (*Updatenotificationsresponse) String ¶

func (o *Updatenotificationsresponse) String() string

String returns a JSON representation of the model

type Updateplanninggrouprequest ¶

type Updateplanninggrouprequest struct {
	// Name - The name of the planning group
	Name *string `json:"name,omitempty"`

	// RoutePaths - Set of route paths to associate with the planning group
	RoutePaths *Setwrapperroutepathrequest `json:"routePaths,omitempty"`

	// ServiceGoalTemplateId - The ID of the service goal template to associate with this planning group
	ServiceGoalTemplateId *string `json:"serviceGoalTemplateId,omitempty"`

	// Metadata - Version metadata for the planning group
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Updateplanninggrouprequest

func (*Updateplanninggrouprequest) String ¶

func (o *Updateplanninggrouprequest) String() string

String returns a JSON representation of the model

type Updateservicegoaltemplate ¶

type Updateservicegoaltemplate struct {
	// Name - The name of the service goal template.
	Name *string `json:"name,omitempty"`

	// ServiceLevel - Service level targets for this service goal template
	ServiceLevel *Buservicelevel `json:"serviceLevel,omitempty"`

	// AverageSpeedOfAnswer - Average speed of answer targets for this service goal template
	AverageSpeedOfAnswer *Buaveragespeedofanswer `json:"averageSpeedOfAnswer,omitempty"`

	// AbandonRate - Abandon rate targets for this service goal template
	AbandonRate *Buabandonrate `json:"abandonRate,omitempty"`

	// Metadata - Version metadata for the service goal template
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Updateservicegoaltemplate

func (*Updateservicegoaltemplate) String ¶

func (o *Updateservicegoaltemplate) String() string

String returns a JSON representation of the model

type Updateuser ¶

type Updateuser struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Chat
	Chat *Chat `json:"chat,omitempty"`

	// Department
	Department *string `json:"department,omitempty"`

	// Email
	Email *string `json:"email,omitempty"`

	// PrimaryContactInfo - The address(s) used for primary contact. Updates to the corresponding address in the addresses list will be reflected here.
	PrimaryContactInfo *[]Contact `json:"primaryContactInfo,omitempty"`

	// Addresses - Email address, phone number, and/or extension for this user. One entry is allowed per media type
	Addresses *[]Contact `json:"addresses,omitempty"`

	// Title
	Title *string `json:"title,omitempty"`

	// Username
	Username *string `json:"username,omitempty"`

	// Manager
	Manager *string `json:"manager,omitempty"`

	// Images
	Images *[]Userimage `json:"images,omitempty"`

	// Version - This value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH.
	Version *int `json:"version,omitempty"`

	// ProfileSkills - Profile skills possessed by the user
	ProfileSkills *[]string `json:"profileSkills,omitempty"`

	// Locations - The user placement at each site location.
	Locations *[]Location `json:"locations,omitempty"`

	// Groups - The groups the user is a member of
	Groups *[]Group `json:"groups,omitempty"`

	// State - The state of the user. This property can be used to restore a deleted user or transition between active and inactive. If specified, it is the only modifiable field.
	State *string `json:"state,omitempty"`

	// AcdAutoAnswer - The value that denotes if acdAutoAnswer is set on the user
	AcdAutoAnswer *bool `json:"acdAutoAnswer,omitempty"`

	// Certifications
	Certifications *[]string `json:"certifications,omitempty"`

	// Biography
	Biography *Biography `json:"biography,omitempty"`

	// EmployerInfo
	EmployerInfo *Employerinfo `json:"employerInfo,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Updateuser

func (*Updateuser) String ¶

func (o *Updateuser) String() string

String returns a JSON representation of the model

type Updateworkplanrotationagentrequest ¶

type Updateworkplanrotationagentrequest 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"`

	// Delete - If marked true for this agent when updating, then this agent will be removed from this work plan rotation
	Delete *bool `json:"delete,omitempty"`
}

Updateworkplanrotationagentrequest

func (*Updateworkplanrotationagentrequest) String ¶

String returns a JSON representation of the model

type Updateworkplanrotationrequest ¶

type Updateworkplanrotationrequest struct {
	// Name - Name of this work plan rotation
	Name *string `json:"name,omitempty"`

	// Enabled - Whether the work plan rotation is enabled for scheduling
	Enabled *bool `json:"enabled,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 *[]Updateworkplanrotationagentrequest `json:"agents,omitempty"`

	// Pattern - Pattern with list of work plan IDs that rotate on a weekly basis
	Pattern *Workplanpatternrequest `json:"pattern,omitempty"`

	// Metadata - Version metadata for this work plan rotation
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Updateworkplanrotationrequest

func (*Updateworkplanrotationrequest) String ¶

String returns a JSON representation of the model

type UploadsApi ¶

type UploadsApi struct {
	Configuration *Configuration
}

UploadsApi provides functions for API endpoints

func NewUploadsApi ¶

func NewUploadsApi() *UploadsApi

NewUploadsApi creates an API instance using the default configuration

func NewUploadsApiWithConfig ¶

func NewUploadsApiWithConfig(config *Configuration) *UploadsApi

NewUploadsApiWithConfig creates an API instance using the provided configuration

func (UploadsApi) PostUploadsPublicassetsImages ¶

func (a UploadsApi) PostUploadsPublicassetsImages(body Uploadurlrequest) (*Uploadurlresponse, *APIResponse, error)

PostUploadsPublicassetsImages invokes POST /api/v2/uploads/publicassets/images

Creates presigned url for uploading a public asset image

func (UploadsApi) PostUploadsRecordings ¶

func (a UploadsApi) PostUploadsRecordings(body Uploadurlrequest) (*Uploadurlresponse, *APIResponse, error)

PostUploadsRecordings invokes POST /api/v2/uploads/recordings

Creates presigned url for uploading a recording file

func (UploadsApi) PostUploadsWorkforcemanagementHistoricaldataCsv ¶

func (a UploadsApi) PostUploadsWorkforcemanagementHistoricaldataCsv(body Uploadurlrequest) (*Uploadurlresponse, *APIResponse, error)

PostUploadsWorkforcemanagementHistoricaldataCsv invokes POST /api/v2/uploads/workforcemanagement/historicaldata/csv

Creates presigned url for uploading WFM historical data file. Requires data in csv format.

func (UploadsApi) PostUploadsWorkforcemanagementHistoricaldataJson ¶

func (a UploadsApi) PostUploadsWorkforcemanagementHistoricaldataJson(body Uploadurlrequest) (*Uploadurlresponse, *APIResponse, error)

PostUploadsWorkforcemanagementHistoricaldataJson invokes POST /api/v2/uploads/workforcemanagement/historicaldata/json

Creates presigned url for uploading WFM historical data file. Requires data in json format.

type Uploadurlrequest ¶

type Uploadurlrequest struct {
	// FileName - Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|
	FileName *string `json:"fileName,omitempty"`

	// ContentMd5 - Content MD-5 of the file to upload
	ContentMd5 *string `json:"contentMd5,omitempty"`

	// SignedUrlTimeoutSeconds - The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds
	SignedUrlTimeoutSeconds *int `json:"signedUrlTimeoutSeconds,omitempty"`

	// ServerSideEncryption
	ServerSideEncryption *string `json:"serverSideEncryption,omitempty"`
}

Uploadurlrequest

func (*Uploadurlrequest) String ¶

func (o *Uploadurlrequest) String() string

String returns a JSON representation of the model

type Uploadurlresponse ¶

type Uploadurlresponse struct {
	// Url - Presigned URL to PUT the file to
	Url *string `json:"url,omitempty"`

	// UploadKey - Key that identifies the file in the storage including the file name
	UploadKey *string `json:"uploadKey,omitempty"`

	// Headers - Required headers when uploading a file through PUT request to the URL
	Headers *map[string]string `json:"headers,omitempty"`
}

Uploadurlresponse

func (*Uploadurlresponse) String ¶

func (o *Uploadurlresponse) String() string

String returns a JSON representation of the model

type Urlcondition ¶

type Urlcondition struct {
	// Values - The URL condition value.
	Values *[]string `json:"values,omitempty"`

	// Operator - The comparison operator.
	Operator *string `json:"operator,omitempty"`
}

Urlcondition

func (*Urlcondition) String ¶

func (o *Urlcondition) String() string

String returns a JSON representation of the model

type Urlresponse ¶

type Urlresponse struct {
	// Url
	Url *string `json:"url,omitempty"`
}

Urlresponse

func (*Urlresponse) String ¶

func (o *Urlresponse) String() string

String returns a JSON representation of the model

type Usage ¶

type Usage struct {
	// Types
	Types *[]Usageitem `json:"types,omitempty"`
}

Usage

func (*Usage) String ¶

func (o *Usage) String() string

String returns a JSON representation of the model

type UsageApi ¶

type UsageApi struct {
	Configuration *Configuration
}

UsageApi provides functions for API endpoints

func NewUsageApi ¶

func NewUsageApi() *UsageApi

NewUsageApi creates an API instance using the default configuration

func NewUsageApiWithConfig ¶

func NewUsageApiWithConfig(config *Configuration) *UsageApi

NewUsageApiWithConfig creates an API instance using the provided configuration

func (UsageApi) GetUsageQueryExecutionIdResults ¶

func (a UsageApi) GetUsageQueryExecutionIdResults(executionId string) (*Apiusagequeryresult, *APIResponse, error)

GetUsageQueryExecutionIdResults invokes GET /api/v2/usage/query/{executionId}/results

Get the results of a usage query

func (UsageApi) PostUsageQuery ¶

func (a UsageApi) PostUsageQuery(body Apiusagequery) (*Usageexecutionresult, *APIResponse, error)

PostUsageQuery invokes POST /api/v2/usage/query

Query organization API Usage -

After calling this method, you will then need to poll for the query results based on the returned execution Id

type Usageexecutionresult ¶

type Usageexecutionresult struct {
	// ExecutionId - The id of the query execution
	ExecutionId *string `json:"executionId,omitempty"`

	// ResultsUri - URI where the query results can be retrieved
	ResultsUri *string `json:"resultsUri,omitempty"`
}

Usageexecutionresult

func (*Usageexecutionresult) String ¶

func (o *Usageexecutionresult) String() string

String returns a JSON representation of the model

type Usageitem ¶

type Usageitem struct {
	// VarType
	VarType *string `json:"type,omitempty"`

	// TotalDocumentByteCount
	TotalDocumentByteCount *int `json:"totalDocumentByteCount,omitempty"`

	// TotalDocumentCount
	TotalDocumentCount *int `json:"totalDocumentCount,omitempty"`
}

Usageitem

func (*Usageitem) String ¶

func (o *Usageitem) String() string

String returns a JSON representation of the model

type User ¶

type User 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"`

	// Chat
	Chat *Chat `json:"chat,omitempty"`

	// Department
	Department *string `json:"department,omitempty"`

	// Email
	Email *string `json:"email,omitempty"`

	// PrimaryContactInfo - Auto populated from addresses.
	PrimaryContactInfo *[]Contact `json:"primaryContactInfo,omitempty"`

	// Addresses - Email addresses and phone numbers for this user
	Addresses *[]Contact `json:"addresses,omitempty"`

	// State - The current state for this user.
	State *string `json:"state,omitempty"`

	// Title
	Title *string `json:"title,omitempty"`

	// Username
	Username *string `json:"username,omitempty"`

	// Manager
	Manager **User `json:"manager,omitempty"`

	// Images
	Images *[]Userimage `json:"images,omitempty"`

	// Version - Required when updating a user, this value should be the current version of the user.  The current version can be obtained with a GET on the user before doing a PATCH.
	Version *int `json:"version,omitempty"`

	// Certifications
	Certifications *[]string `json:"certifications,omitempty"`

	// Biography
	Biography *Biography `json:"biography,omitempty"`

	// EmployerInfo
	EmployerInfo *Employerinfo `json:"employerInfo,omitempty"`

	// RoutingStatus - ACD routing status
	RoutingStatus *Routingstatus `json:"routingStatus,omitempty"`

	// Presence - Active presence
	Presence *Userpresence `json:"presence,omitempty"`

	// ConversationSummary - Summary of conversion statistics for conversation types.
	ConversationSummary *Userconversationsummary `json:"conversationSummary,omitempty"`

	// OutOfOffice - Determine if out of office is enabled
	OutOfOffice **Outofoffice `json:"outOfOffice,omitempty"`

	// Geolocation - Current geolocation position
	Geolocation *Geolocation `json:"geolocation,omitempty"`

	// Station - Effective, default, and last station information
	Station **Userstations `json:"station,omitempty"`

	// Authorization - Roles and permissions assigned to the user
	Authorization *Userauthorization `json:"authorization,omitempty"`

	// ProfileSkills - Profile skills possessed by the user
	ProfileSkills *[]string `json:"profileSkills,omitempty"`

	// Locations - The user placement at each site location.
	Locations *[]Location `json:"locations,omitempty"`

	// Groups - The groups the user is a member of
	Groups *[]Group `json:"groups,omitempty"`

	// Team - The team the user is a member of
	Team *Team `json:"team,omitempty"`

	// Skills - Routing (ACD) skills possessed by the user
	Skills *[]Userroutingskill `json:"skills,omitempty"`

	// Languages - Routing (ACD) languages possessed by the user
	Languages *[]Userroutinglanguage `json:"languages,omitempty"`

	// AcdAutoAnswer - acd auto answer
	AcdAutoAnswer *bool `json:"acdAutoAnswer,omitempty"`

	// LanguagePreference - preferred language by the user
	LanguagePreference *string `json:"languagePreference,omitempty"`

	// LastTokenIssued
	LastTokenIssued *Oauthlasttokenissued `json:"lastTokenIssued,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

User

func (*User) String ¶

func (o *User) String() string

String returns a JSON representation of the model

type UserRecordingsApi ¶

type UserRecordingsApi struct {
	Configuration *Configuration
}

UserRecordingsApi provides functions for API endpoints

func NewUserRecordingsApi ¶

func NewUserRecordingsApi() *UserRecordingsApi

NewUserRecordingsApi creates an API instance using the default configuration

func NewUserRecordingsApiWithConfig ¶

func NewUserRecordingsApiWithConfig(config *Configuration) *UserRecordingsApi

NewUserRecordingsApiWithConfig creates an API instance using the provided configuration

func (UserRecordingsApi) DeleteUserrecording ¶

func (a UserRecordingsApi) DeleteUserrecording(recordingId string) (*APIResponse, error)

DeleteUserrecording invokes DELETE /api/v2/userrecordings/{recordingId}

Delete a user recording.

func (UserRecordingsApi) GetUserrecording ¶

func (a UserRecordingsApi) GetUserrecording(recordingId string, expand []string) (*Userrecording, *APIResponse, error)

GetUserrecording invokes GET /api/v2/userrecordings/{recordingId}

Get a user recording.

func (UserRecordingsApi) GetUserrecordingMedia ¶

func (a UserRecordingsApi) GetUserrecordingMedia(recordingId string, formatId string) (*Downloadresponse, *APIResponse, error)

GetUserrecordingMedia invokes GET /api/v2/userrecordings/{recordingId}/media

Download a user recording.

func (UserRecordingsApi) GetUserrecordings ¶

func (a UserRecordingsApi) GetUserrecordings(pageSize int, pageNumber int, expand []string) (*Userrecordingentitylisting, *APIResponse, error)

GetUserrecordings invokes GET /api/v2/userrecordings

Get a list of user recordings.

func (UserRecordingsApi) GetUserrecordingsSummary ¶

func (a UserRecordingsApi) GetUserrecordingsSummary() (*Faxsummary, *APIResponse, error)

GetUserrecordingsSummary invokes GET /api/v2/userrecordings/summary

Get user recording summary

func (UserRecordingsApi) PutUserrecording ¶

func (a UserRecordingsApi) PutUserrecording(recordingId string, body Userrecording, expand []string) (*Userrecording, *APIResponse, error)

PutUserrecording invokes PUT /api/v2/userrecordings/{recordingId}

Update a user recording.

type Useractioncategory ¶

type Useractioncategory struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Useractioncategory

func (*Useractioncategory) String ¶

func (o *Useractioncategory) String() string

String returns a JSON representation of the model

type Useractioncategoryentitylisting ¶

type Useractioncategoryentitylisting struct {
	// Entities
	Entities *[]Useractioncategory `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Useractioncategoryentitylisting

func (*Useractioncategoryentitylisting) String ¶

String returns a JSON representation of the model

type Useragentinfo ¶

type Useragentinfo struct {
	// FirmwareVersion - The firmware version of the phone.
	FirmwareVersion *string `json:"firmwareVersion,omitempty"`

	// Manufacturer - The manufacturer of the phone.
	Manufacturer *string `json:"manufacturer,omitempty"`

	// Model - The model of the phone.
	Model *string `json:"model,omitempty"`
}

Useragentinfo

func (*Useragentinfo) String ¶

func (o *Useragentinfo) String() string

String returns a JSON representation of the model

type Useraggregatedatacontainer ¶

type Useraggregatedatacontainer struct {
	// Group - A mapping from dimension to value
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Statisticalresponse `json:"data,omitempty"`
}

Useraggregatedatacontainer

func (*Useraggregatedatacontainer) String ¶

func (o *Useraggregatedatacontainer) String() string

String returns a JSON representation of the model

type Useraggregatequeryclause ¶

type Useraggregatequeryclause 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 *[]Useraggregatequerypredicate `json:"predicates,omitempty"`
}

Useraggregatequeryclause

func (*Useraggregatequeryclause) String ¶

func (o *Useraggregatequeryclause) String() string

String returns a JSON representation of the model

type Useraggregatequeryfilter ¶

type Useraggregatequeryfilter 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 *[]Useraggregatequeryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Useraggregatequerypredicate `json:"predicates,omitempty"`
}

Useraggregatequeryfilter

func (*Useraggregatequeryfilter) String ¶

func (o *Useraggregatequeryfilter) String() string

String returns a JSON representation of the model

type Useraggregatequerypredicate ¶

type Useraggregatequerypredicate 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"`
}

Useraggregatequerypredicate

func (*Useraggregatequerypredicate) String ¶

func (o *Useraggregatequerypredicate) String() string

String returns a JSON representation of the model

type Useraggregatequeryresponse ¶

type Useraggregatequeryresponse struct {
	// SystemToOrganizationMappings - A mapping from system presence to a list of organization presence ids
	SystemToOrganizationMappings *map[string][]string `json:"systemToOrganizationMappings,omitempty"`

	// Results
	Results *[]Useraggregatedatacontainer `json:"results,omitempty"`
}

Useraggregatequeryresponse

func (*Useraggregatequeryresponse) String ¶

func (o *Useraggregatequeryresponse) String() string

String returns a JSON representation of the model

type Useraggregationquery ¶

type Useraggregationquery 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 *Useraggregatequeryfilter `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 *[]Useraggregationview `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"`
}

Useraggregationquery

func (*Useraggregationquery) String ¶

func (o *Useraggregationquery) String() string

String returns a JSON representation of the model

type Useraggregationview ¶

type Useraggregationview 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"`
}

Useraggregationview

func (*Useraggregationview) String ¶

func (o *Useraggregationview) String() string

String returns a JSON representation of the model

type Userapp ¶

type Userapp struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the userApp, used to distinguish this userApp from others of the same type.
	Name *string `json:"name,omitempty"`

	// IntegrationType - Integration Type for the userApp
	IntegrationType *Integrationtype `json:"integrationType,omitempty"`

	// Config
	Config *Userappconfigurationinfo `json:"config,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Userapp - Details for a UserApp

func (*Userapp) String ¶

func (o *Userapp) String() string

String returns a JSON representation of the model

type Userappconfigurationinfo ¶

type Userappconfigurationinfo 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"`
}

Userappconfigurationinfo - Configuration information for the integration

func (*Userappconfigurationinfo) String ¶

func (o *Userappconfigurationinfo) String() string

String returns a JSON representation of the model

type Userappentitylisting ¶

type Userappentitylisting struct {
	// Entities
	Entities *[]Userapp `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Userappentitylisting

func (*Userappentitylisting) String ¶

func (o *Userappentitylisting) String() string

String returns a JSON representation of the model

type Userauthorization ¶

type Userauthorization struct {
	// Roles
	Roles *[]Domainrole `json:"roles,omitempty"`

	// UnusedRoles - A collection of the roles the user is not using
	UnusedRoles *[]Domainrole `json:"unusedRoles,omitempty"`

	// Permissions - A collection of the permissions granted by all assigned roles
	Permissions *[]string `json:"permissions,omitempty"`

	// PermissionPolicies - The policies configured for assigned permissions.
	PermissionPolicies *[]Resourcepermissionpolicy `json:"permissionPolicies,omitempty"`
}

Userauthorization

func (*Userauthorization) String ¶

func (o *Userauthorization) String() string

String returns a JSON representation of the model

type Useravailabletimes ¶

type Useravailabletimes struct {
	// User - User reference
	User *Userreference `json:"user,omitempty"`

	// AvailableTimes - Periods of availability to schedule coaching appointment for an user
	AvailableTimes *[]Availabletime `json:"availableTimes,omitempty"`
}

Useravailabletimes

func (*Useravailabletimes) String ¶

func (o *Useravailabletimes) String() string

String returns a JSON representation of the model

type Userbestpoints ¶

type Userbestpoints struct {
	// User - The requested user for the best points
	User *Userreference `json:"user,omitempty"`

	// BestPoints - List of best point for the requested user
	BestPoints *[]Userbestpointsitem `json:"bestPoints,omitempty"`
}

Userbestpoints

func (*Userbestpoints) String ¶

func (o *Userbestpoints) String() string

String returns a JSON representation of the model

type Userbestpointsitem ¶

type Userbestpointsitem struct {
	// GranularityType - Best points aggregation interval granularity
	GranularityType *string `json:"granularityType,omitempty"`

	// Points - Gamification points
	Points *int `json:"points,omitempty"`

	// DateStartWorkday - Start workday of the best points aggregation interval. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateStartWorkday *time.Time `json:"dateStartWorkday,omitempty"`

	// DateEndWorkday - End workday of the best points aggregation interval. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateEndWorkday *time.Time `json:"dateEndWorkday,omitempty"`

	// Rank - The rank of this user
	Rank *int `json:"rank,omitempty"`
}

Userbestpointsitem

func (*Userbestpointsitem) String ¶

func (o *Userbestpointsitem) String() string

String returns a JSON representation of the model

type Userconversationseventmediasummary ¶

type Userconversationseventmediasummary struct {
	// ContactCenter
	ContactCenter *Userconversationseventmediasummarydetail `json:"contactCenter,omitempty"`

	// Enterprise
	Enterprise *Userconversationseventmediasummarydetail `json:"enterprise,omitempty"`
}

Userconversationseventmediasummary

func (*Userconversationseventmediasummary) String ¶

String returns a JSON representation of the model

type Userconversationseventmediasummarydetail ¶

type Userconversationseventmediasummarydetail struct {
	// Active
	Active *int `json:"active,omitempty"`

	// Acw
	Acw *int `json:"acw,omitempty"`
}

Userconversationseventmediasummarydetail

func (*Userconversationseventmediasummarydetail) String ¶

String returns a JSON representation of the model

type Userconversationseventuserconversationsummary ¶

type Userconversationseventuserconversationsummary struct {
	// UserId
	UserId *string `json:"userId,omitempty"`

	// Call
	Call *Userconversationseventmediasummary `json:"call,omitempty"`

	// Callback
	Callback *Userconversationseventmediasummary `json:"callback,omitempty"`

	// Email
	Email *Userconversationseventmediasummary `json:"email,omitempty"`

	// Message
	Message *Userconversationseventmediasummary `json:"message,omitempty"`

	// Chat
	Chat *Userconversationseventmediasummary `json:"chat,omitempty"`

	// SocialExpression
	SocialExpression *Userconversationseventmediasummary `json:"socialExpression,omitempty"`

	// Video
	Video *Userconversationseventmediasummary `json:"video,omitempty"`
}

Userconversationseventuserconversationsummary

func (*Userconversationseventuserconversationsummary) String ¶

String returns a JSON representation of the model

type Userconversationsummary ¶

type Userconversationsummary struct {
	// UserId
	UserId *string `json:"userId,omitempty"`

	// Call
	Call *Mediasummary `json:"call,omitempty"`

	// Callback
	Callback *Mediasummary `json:"callback,omitempty"`

	// Email
	Email *Mediasummary `json:"email,omitempty"`

	// Message
	Message *Mediasummary `json:"message,omitempty"`

	// Chat
	Chat *Mediasummary `json:"chat,omitempty"`

	// SocialExpression
	SocialExpression *Mediasummary `json:"socialExpression,omitempty"`

	// Video
	Video *Mediasummary `json:"video,omitempty"`
}

Userconversationsummary

func (*Userconversationsummary) String ¶

func (o *Userconversationsummary) String() string

String returns a JSON representation of the model

type Userdetailqueryclause ¶

type Userdetailqueryclause 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 *[]Userdetailquerypredicate `json:"predicates,omitempty"`
}

Userdetailqueryclause

func (*Userdetailqueryclause) String ¶

func (o *Userdetailqueryclause) String() string

String returns a JSON representation of the model

type Userdetailqueryfilter ¶

type Userdetailqueryfilter 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 *[]Userdetailqueryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Userdetailquerypredicate `json:"predicates,omitempty"`
}

Userdetailqueryfilter

func (*Userdetailqueryfilter) String ¶

func (o *Userdetailqueryfilter) String() string

String returns a JSON representation of the model

type Userdetailquerypredicate ¶

type Userdetailquerypredicate 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"`
}

Userdetailquerypredicate

func (*Userdetailquerypredicate) String ¶

func (o *Userdetailquerypredicate) String() string

String returns a JSON representation of the model

type Userdetailsdatalakeavailabilitytopicdataavailabilitychangenotification ¶

type Userdetailsdatalakeavailabilitytopicdataavailabilitychangenotification struct{}

Userdetailsdatalakeavailabilitytopicdataavailabilitychangenotification

func (*Userdetailsdatalakeavailabilitytopicdataavailabilitychangenotification) String ¶

String returns a JSON representation of the model

type Userdetailsquery ¶

type Userdetailsquery 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"`

	// PresenceAggregations - Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters
	PresenceAggregations *[]Analyticsqueryaggregation `json:"presenceAggregations,omitempty"`

	// RoutingStatusAggregations - Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters
	RoutingStatusAggregations *[]Analyticsqueryaggregation `json:"routingStatusAggregations,omitempty"`

	// Paging - Page size and number to control iterating through large result sets. Default page size is 25
	Paging *Pagingspec `json:"paging,omitempty"`
}

Userdetailsquery

func (*Userdetailsquery) String ¶

func (o *Userdetailsquery) String() string

String returns a JSON representation of the model

type Userdevice ¶

type Userdevice struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// DeviceToken - device token sent by mobile clients.
	DeviceToken *string `json:"deviceToken,omitempty"`

	// NotificationId - notification id of the device.
	NotificationId *string `json:"notificationId,omitempty"`

	// Make - make of the device.
	Make *string `json:"make,omitempty"`

	// Model - Device model
	Model *string `json:"model,omitempty"`

	// AcceptNotifications - if the device accepts notifications
	AcceptNotifications *bool `json:"acceptNotifications,omitempty"`

	// VarType - type of the device; ios or android
	VarType *string `json:"type,omitempty"`

	// SessionHash
	SessionHash *string `json:"sessionHash,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Userdevice

func (*Userdevice) String ¶

func (o *Userdevice) String() string

String returns a JSON representation of the model

type Userentitylisting ¶

type Userentitylisting struct {
	// Entities
	Entities *[]User `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Userentitylisting

func (*Userentitylisting) String ¶

func (o *Userentitylisting) String() string

String returns a JSON representation of the model

type Userexpands ¶

type Userexpands struct {
	// RoutingStatus - ACD routing status
	RoutingStatus *Routingstatus `json:"routingStatus,omitempty"`

	// Presence - Active presence
	Presence *Userpresence `json:"presence,omitempty"`

	// ConversationSummary - Summary of conversion statistics for conversation types.
	ConversationSummary *Userconversationsummary `json:"conversationSummary,omitempty"`

	// OutOfOffice - Determine if out of office is enabled
	OutOfOffice *Outofoffice `json:"outOfOffice,omitempty"`

	// Geolocation - Current geolocation position
	Geolocation *Geolocation `json:"geolocation,omitempty"`

	// Station - Effective, default, and last station information
	Station *Userstations `json:"station,omitempty"`

	// Authorization - Roles and permissions assigned to the user
	Authorization *Userauthorization `json:"authorization,omitempty"`
}

Userexpands

func (*Userexpands) String ¶

func (o *Userexpands) String() string

String returns a JSON representation of the model

type Usergreetingeventgreeting ¶

type Usergreetingeventgreeting struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// OwnerType
	OwnerType *string `json:"ownerType,omitempty"`

	// Owner
	Owner *Usergreetingeventgreetingowner `json:"owner,omitempty"`

	// GreetingAudioFile
	GreetingAudioFile *Usergreetingeventgreetingaudiofile `json:"greetingAudioFile,omitempty"`

	// AudioTTS
	AudioTTS *string `json:"audioTTS,omitempty"`
}

Usergreetingeventgreeting

func (*Usergreetingeventgreeting) String ¶

func (o *Usergreetingeventgreeting) String() string

String returns a JSON representation of the model

type Usergreetingeventgreetingaudiofile ¶

type Usergreetingeventgreetingaudiofile struct {
	// DurationMilliseconds
	DurationMilliseconds *int `json:"durationMilliseconds,omitempty"`

	// SizeBytes
	SizeBytes *int `json:"sizeBytes,omitempty"`
}

Usergreetingeventgreetingaudiofile

func (*Usergreetingeventgreetingaudiofile) String ¶

String returns a JSON representation of the model

type Usergreetingeventgreetingowner ¶

type Usergreetingeventgreetingowner struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Usergreetingeventgreetingowner

func (*Usergreetingeventgreetingowner) String ¶

String returns a JSON representation of the model

type Userimage ¶

type Userimage struct {
	// Resolution - Height and/or width of image. ex: 640x480 or x128
	Resolution *string `json:"resolution,omitempty"`

	// ImageUri
	ImageUri *string `json:"imageUri,omitempty"`
}

Userimage

func (*Userimage) String ¶

func (o *Userimage) String() string

String returns a JSON representation of the model

type Userlanguageentitylisting ¶

type Userlanguageentitylisting struct {
	// Entities
	Entities *[]Userroutinglanguage `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Userlanguageentitylisting

func (*Userlanguageentitylisting) String ¶

func (o *Userlanguageentitylisting) String() string

String returns a JSON representation of the model

type Userlicenses ¶

type Userlicenses struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Licenses
	Licenses *[]string `json:"licenses,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Userlicenses

func (*Userlicenses) String ¶

func (o *Userlicenses) String() string

String returns a JSON representation of the model

type Userlicensesentitylisting ¶

type Userlicensesentitylisting struct {
	// Entities
	Entities *[]Userlicenses `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"`
}

Userlicensesentitylisting

func (*Userlicensesentitylisting) String ¶

func (o *Userlicensesentitylisting) String() string

String returns a JSON representation of the model

type Userlistschedulerequestbody ¶

type Userlistschedulerequestbody struct {
	// UserIds - The user ids for which to fetch schedules
	UserIds *[]string `json:"userIds,omitempty"`

	// StartDate - Beginning of the range of schedules to fetch, in ISO-8601 format
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - End of the range of schedules to fetch, in ISO-8601 format
	EndDate *time.Time `json:"endDate,omitempty"`

	// LoadFullWeeks - Whether to load the full week's schedule (for the requested users) of any week overlapping the start/end date query parameters, defaults to false
	LoadFullWeeks *bool `json:"loadFullWeeks,omitempty"`
}

Userlistschedulerequestbody - Request body for fetching the schedule for a group of users over a given time range

func (*Userlistschedulerequestbody) String ¶

func (o *Userlistschedulerequestbody) String() string

String returns a JSON representation of the model

type Userme ¶

type Userme 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"`

	// Chat
	Chat *Chat `json:"chat,omitempty"`

	// Department
	Department *string `json:"department,omitempty"`

	// Email
	Email *string `json:"email,omitempty"`

	// PrimaryContactInfo - Auto populated from addresses.
	PrimaryContactInfo *[]Contact `json:"primaryContactInfo,omitempty"`

	// Addresses - Email addresses and phone numbers for this user
	Addresses *[]Contact `json:"addresses,omitempty"`

	// State - The current state for this user.
	State *string `json:"state,omitempty"`

	// Title
	Title *string `json:"title,omitempty"`

	// Username
	Username *string `json:"username,omitempty"`

	// Manager
	Manager *User `json:"manager,omitempty"`

	// Images
	Images *[]Userimage `json:"images,omitempty"`

	// Version - Required when updating a user, this value should be the current version of the user.  The current version can be obtained with a GET on the user before doing a PATCH.
	Version *int `json:"version,omitempty"`

	// Certifications
	Certifications *[]string `json:"certifications,omitempty"`

	// Biography
	Biography *Biography `json:"biography,omitempty"`

	// EmployerInfo
	EmployerInfo *Employerinfo `json:"employerInfo,omitempty"`

	// RoutingStatus - ACD routing status
	RoutingStatus *Routingstatus `json:"routingStatus,omitempty"`

	// Presence - Active presence
	Presence *Userpresence `json:"presence,omitempty"`

	// ConversationSummary - Summary of conversion statistics for conversation types.
	ConversationSummary *Userconversationsummary `json:"conversationSummary,omitempty"`

	// OutOfOffice - Determine if out of office is enabled
	OutOfOffice *Outofoffice `json:"outOfOffice,omitempty"`

	// Geolocation - Current geolocation position
	Geolocation *Geolocation `json:"geolocation,omitempty"`

	// Station - Effective, default, and last station information
	Station *Userstations `json:"station,omitempty"`

	// Authorization - Roles and permissions assigned to the user
	Authorization *Userauthorization `json:"authorization,omitempty"`

	// ProfileSkills - Profile skills possessed by the user
	ProfileSkills *[]string `json:"profileSkills,omitempty"`

	// Locations - The user placement at each site location.
	Locations *[]Location `json:"locations,omitempty"`

	// Groups - The groups the user is a member of
	Groups *[]Group `json:"groups,omitempty"`

	// Team - The team the user is a member of
	Team *Team `json:"team,omitempty"`

	// Skills - Routing (ACD) skills possessed by the user
	Skills *[]Userroutingskill `json:"skills,omitempty"`

	// Languages - Routing (ACD) languages possessed by the user
	Languages *[]Userroutinglanguage `json:"languages,omitempty"`

	// AcdAutoAnswer - acd auto answer
	AcdAutoAnswer *bool `json:"acdAutoAnswer,omitempty"`

	// LanguagePreference - preferred language by the user
	LanguagePreference *string `json:"languagePreference,omitempty"`

	// LastTokenIssued
	LastTokenIssued *Oauthlasttokenissued `json:"lastTokenIssued,omitempty"`

	// Date - The PureCloud system date time.
	Date *Serverdate `json:"date,omitempty"`

	// GeolocationSettings - Geolocation settings for user's organization.
	GeolocationSettings *Geolocationsettings `json:"geolocationSettings,omitempty"`

	// Organization - Organization details for this user.
	Organization *Organization `json:"organization,omitempty"`

	// PresenceDefinitions - The first 100 presence definitions for user's organization.
	PresenceDefinitions *[]Organizationpresence `json:"presenceDefinitions,omitempty"`

	// LocationDefinitions - The first 100 site locations for user's organization
	LocationDefinitions *[]Locationdefinition `json:"locationDefinitions,omitempty"`

	// OrgAuthorization - The first 100 organization roles, with applicable permission policies, for user's organization.
	OrgAuthorization *[]Domainorganizationrole `json:"orgAuthorization,omitempty"`

	// Favorites - The first 50 favorited users.
	Favorites *[]User `json:"favorites,omitempty"`

	// Superiors - The first 50 superiors of this user.
	Superiors *[]User `json:"superiors,omitempty"`

	// DirectReports - The first 50 direct reports to this user.
	DirectReports *[]User `json:"directReports,omitempty"`

	// Adjacents - The first 50 superiors, direct reports, and siblings of this user. Mutually exclusive with superiors and direct reports expands.
	Adjacents *Adjacents `json:"adjacents,omitempty"`

	// RoutingSkills - The first 50 routing skills for user's organizations
	RoutingSkills *[]Routingskill `json:"routingSkills,omitempty"`

	// FieldConfigs - The field config for all entities types of user's organization
	FieldConfigs *Fieldconfigs `json:"fieldConfigs,omitempty"`

	// Token - Information about the current token
	Token *Tokeninfo `json:"token,omitempty"`

	// Trustors - Organizations having this user as a trustee
	Trustors *[]Trustor `json:"trustors,omitempty"`

	// OrgProducts - Products enabled in this organization
	OrgProducts *[]Domainorganizationproduct `json:"orgProducts,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Userme

func (*Userme) String ¶

func (o *Userme) String() string

String returns a JSON representation of the model

type Userobservationdatacontainer ¶

type Userobservationdatacontainer struct {
	// Group - A mapping from dimension to value
	Group *map[string]string `json:"group,omitempty"`

	// Data
	Data *[]Observationmetricdata `json:"data,omitempty"`
}

Userobservationdatacontainer

func (*Userobservationdatacontainer) String ¶

String returns a JSON representation of the model

type Userobservationquery ¶

type Userobservationquery struct {
	// Filter - Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters
	Filter *Userobservationqueryfilter `json:"filter,omitempty"`

	// Metrics - Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
	Metrics *[]string `json:"metrics,omitempty"`

	// DetailMetrics - Metrics for which to include additional detailed observations
	DetailMetrics *[]string `json:"detailMetrics,omitempty"`
}

Userobservationquery

func (*Userobservationquery) String ¶

func (o *Userobservationquery) String() string

String returns a JSON representation of the model

type Userobservationqueryclause ¶

type Userobservationqueryclause 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 *[]Userobservationquerypredicate `json:"predicates,omitempty"`
}

Userobservationqueryclause

func (*Userobservationqueryclause) String ¶

func (o *Userobservationqueryclause) String() string

String returns a JSON representation of the model

type Userobservationqueryfilter ¶

type Userobservationqueryfilter 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 *[]Userobservationqueryclause `json:"clauses,omitempty"`

	// Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value).
	Predicates *[]Userobservationquerypredicate `json:"predicates,omitempty"`
}

Userobservationqueryfilter

func (*Userobservationqueryfilter) String ¶

func (o *Userobservationqueryfilter) String() string

String returns a JSON representation of the model

type Userobservationquerypredicate ¶

type Userobservationquerypredicate 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"`
}

Userobservationquerypredicate

func (*Userobservationquerypredicate) String ¶

String returns a JSON representation of the model

type Userobservationqueryresponse ¶

type Userobservationqueryresponse struct {
	// Results
	Results *[]Userobservationdatacontainer `json:"results,omitempty"`
}

Userobservationqueryresponse

func (*Userobservationqueryresponse) String ¶

String returns a JSON representation of the model

type Userparam ¶

type Userparam struct {
	// Key
	Key *string `json:"key,omitempty"`

	// Value
	Value *string `json:"value,omitempty"`
}

Userparam

func (*Userparam) String ¶

func (o *Userparam) String() string

String returns a JSON representation of the model

type Userpresence ¶

type Userpresence struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Source - Represents the source where the Presence was set. Some examples are: PURECLOUD, LYNC, OUTLOOK, etc.
	Source *string `json:"source,omitempty"`

	// Primary - A boolean used to tell whether or not to set this presence source as the primary on a PATCH
	Primary *bool `json:"primary,omitempty"`

	// PresenceDefinition
	PresenceDefinition *Presencedefinition `json:"presenceDefinition,omitempty"`

	// Message
	Message *string `json:"message,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"`
}

Userpresence

func (*Userpresence) String ¶

func (o *Userpresence) String() string

String returns a JSON representation of the model

type Userprofile ¶

type Userprofile struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// State - The state of the user resource
	State *string `json:"state,omitempty"`

	// DateModified - Datetime of the last modification. 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 - The version of the group resource
	Version *int `json:"version,omitempty"`

	// Expands - User information expansions
	Expands *Userexpands `json:"expands,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Userprofile

func (*Userprofile) String ¶

func (o *Userprofile) String() string

String returns a JSON representation of the model

type Userprofileentitylisting ¶

type Userprofileentitylisting struct {
	// Entities
	Entities *[]Userprofile `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Userprofileentitylisting

func (*Userprofileentitylisting) String ¶

func (o *Userprofileentitylisting) String() string

String returns a JSON representation of the model

type Userqueue ¶

type Userqueue 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"`

	// Description - The queue description.
	Description *string `json:"description,omitempty"`

	// DateCreated - The date the queue 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"`

	// DateModified - The date of the last modification to the queue. 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 ID of the user that last modified the queue.
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy - The ID of the user that created the queue.
	CreatedBy *string `json:"createdBy,omitempty"`

	// MemberCount - The total number of members (joined or unjoined) in the queue.
	MemberCount *int `json:"memberCount,omitempty"`

	// JoinedMemberCount - The number of joined members in the queue.
	JoinedMemberCount *int `json:"joinedMemberCount,omitempty"`

	// MediaSettings - The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM
	MediaSettings *map[string]Mediasetting `json:"mediaSettings,omitempty"`

	// RoutingRules - The routing rules for the queue, used for routing to known or preferred agents.
	RoutingRules *[]Routingrule `json:"routingRules,omitempty"`

	// Bullseye - The bulls-eye settings for the queue.
	Bullseye *Bullseye `json:"bullseye,omitempty"`

	// AcwSettings - The ACW settings for the queue.
	AcwSettings *Acwsettings `json:"acwSettings,omitempty"`

	// SkillEvaluationMethod - The skill evaluation method to use when routing conversations.
	SkillEvaluationMethod *string `json:"skillEvaluationMethod,omitempty"`

	// QueueFlow - The in-queue flow to use for conversations waiting in queue.
	QueueFlow *Domainentityref `json:"queueFlow,omitempty"`

	// WhisperPrompt - The prompt used for whisper on the queue, if configured.
	WhisperPrompt *Domainentityref `json:"whisperPrompt,omitempty"`

	// EnableTranscription - Indicates whether voice transcription is enabled for this queue.
	EnableTranscription *bool `json:"enableTranscription,omitempty"`

	// EnableManualAssignment - Indicates whether manual assignment is enabled for this queue.
	EnableManualAssignment *bool `json:"enableManualAssignment,omitempty"`

	// CallingPartyName - The name to use for caller identification for outbound calls from this queue.
	CallingPartyName *string `json:"callingPartyName,omitempty"`

	// CallingPartyNumber - The phone number to use for caller identification for outbound calls from this queue.
	CallingPartyNumber *string `json:"callingPartyNumber,omitempty"`

	// DefaultScripts - The default script Ids for the communication types.
	DefaultScripts *map[string]Script `json:"defaultScripts,omitempty"`

	// OutboundMessagingAddresses - The messaging addresses for the queue.
	OutboundMessagingAddresses *Queuemessagingaddresses `json:"outboundMessagingAddresses,omitempty"`

	// OutboundEmailAddress
	OutboundEmailAddress *Queueemailaddress `json:"outboundEmailAddress,omitempty"`

	// Joined
	Joined *bool `json:"joined,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Userqueue

func (*Userqueue) String ¶

func (o *Userqueue) String() string

String returns a JSON representation of the model

type Userqueueentitylisting ¶

type Userqueueentitylisting struct {
	// Entities
	Entities *[]Userqueue `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Userqueueentitylisting

func (*Userqueueentitylisting) String ¶

func (o *Userqueueentitylisting) String() string

String returns a JSON representation of the model

type Userrecording ¶

type Userrecording struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,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"`

	// 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"`

	// ContentUri
	ContentUri *string `json:"contentUri,omitempty"`

	// Workspace
	Workspace *Domainentityref `json:"workspace,omitempty"`

	// CreatedBy
	CreatedBy *Domainentityref `json:"createdBy,omitempty"`

	// Conversation
	Conversation *Conversation `json:"conversation,omitempty"`

	// ContentLength
	ContentLength *int `json:"contentLength,omitempty"`

	// DurationMilliseconds
	DurationMilliseconds *int `json:"durationMilliseconds,omitempty"`

	// Thumbnails
	Thumbnails *[]Documentthumbnail `json:"thumbnails,omitempty"`

	// Read
	Read *bool `json:"read,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Userrecording

func (*Userrecording) String ¶

func (o *Userrecording) String() string

String returns a JSON representation of the model

type Userrecordingentitylisting ¶

type Userrecordingentitylisting struct {
	// Entities
	Entities *[]Userrecording `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Userrecordingentitylisting

func (*Userrecordingentitylisting) String ¶

func (o *Userrecordingentitylisting) String() string

String returns a JSON representation of the model

type Userreference ¶

type Userreference 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"`
}

Userreference

func (*Userreference) String ¶

func (o *Userreference) String() string

String returns a JSON representation of the model

type Userroutinglanguage ¶

type Userroutinglanguage struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Proficiency - A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings.
	Proficiency *float64 `json:"proficiency,omitempty"`

	// State - Activate or deactivate this routing language.
	State *string `json:"state,omitempty"`

	// LanguageUri - URI to the organization language used by this user language.
	LanguageUri *string `json:"languageUri,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Userroutinglanguage - Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.

func (*Userroutinglanguage) String ¶

func (o *Userroutinglanguage) String() string

String returns a JSON representation of the model

type Userroutinglanguagepost ¶

type Userroutinglanguagepost struct {
	// Id - The id of the existing routing language to add to the user
	Id *string `json:"id,omitempty"`

	// Proficiency - Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular language. It is used when a queue is set to \"Best available language\" mode to allow acd interactions to target agents with higher proficiency ratings.
	Proficiency *float64 `json:"proficiency,omitempty"`

	// LanguageUri - URI to the organization language used by this user language.
	LanguageUri *string `json:"languageUri,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Userroutinglanguagepost - Represents an organization language assigned to a user. When assigning to a user specify the organization langauge id as the id.

func (*Userroutinglanguagepost) String ¶

func (o *Userroutinglanguagepost) String() string

String returns a JSON representation of the model

type Userroutingskill ¶

type Userroutingskill struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Proficiency - A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings.
	Proficiency *float64 `json:"proficiency,omitempty"`

	// State - Activate or deactivate this routing skill.
	State *string `json:"state,omitempty"`

	// SkillUri - URI to the organization skill used by this user skill.
	SkillUri *string `json:"skillUri,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Userroutingskill - Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.

func (*Userroutingskill) String ¶

func (o *Userroutingskill) String() string

String returns a JSON representation of the model

type Userroutingskillpost ¶

type Userroutingskillpost struct {
	// Id - The id of the existing routing skill to add to the user
	Id *string `json:"id,omitempty"`

	// Proficiency - Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular skill. It is used when a queue is set to \"Best available skills\" mode to allow acd interactions to target agents with higher proficiency ratings.
	Proficiency *float64 `json:"proficiency,omitempty"`

	// SkillUri - URI to the organization skill used by this user skill.
	SkillUri *string `json:"skillUri,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Userroutingskillpost - Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.

func (*Userroutingskillpost) String ¶

func (o *Userroutingskillpost) String() string

String returns a JSON representation of the model

type Userroutingstatuserrorinfo ¶

type Userroutingstatuserrorinfo struct {
	// ErrorCode
	ErrorCode *string `json:"errorCode,omitempty"`

	// Status
	Status *int `json:"status,omitempty"`

	// CorrelationId
	CorrelationId *string `json:"correlationId,omitempty"`

	// UserMessage
	UserMessage *string `json:"userMessage,omitempty"`

	// UserParamsMessage
	UserParamsMessage *string `json:"userParamsMessage,omitempty"`

	// UserParams
	UserParams *[]Userroutingstatususerparam `json:"userParams,omitempty"`
}

Userroutingstatuserrorinfo

func (*Userroutingstatuserrorinfo) String ¶

func (o *Userroutingstatuserrorinfo) String() string

String returns a JSON representation of the model

type Userroutingstatusroutingstatus ¶

type Userroutingstatusroutingstatus struct {
	// Status
	Status *string `json:"status,omitempty"`

	// StartTime
	StartTime *time.Time `json:"startTime,omitempty"`
}

Userroutingstatusroutingstatus

func (*Userroutingstatusroutingstatus) String ¶

String returns a JSON representation of the model

type Userroutingstatususerparam ¶

type Userroutingstatususerparam struct {
	// Key
	Key *string `json:"key,omitempty"`

	// Value
	Value *string `json:"value,omitempty"`

	// AdditionalProperties
	AdditionalProperties *interface{} `json:"additionalProperties,omitempty"`
}

Userroutingstatususerparam

func (*Userroutingstatususerparam) String ¶

func (o *Userroutingstatususerparam) String() string

String returns a JSON representation of the model

type Userroutingstatususerroutingstatus ¶

type Userroutingstatususerroutingstatus struct {
	// RoutingStatus
	RoutingStatus *Userroutingstatusroutingstatus `json:"routingStatus,omitempty"`

	// ErrorInfo
	ErrorInfo *Userroutingstatuserrorinfo `json:"errorInfo,omitempty"`
}

Userroutingstatususerroutingstatus

func (*Userroutingstatususerroutingstatus) String ¶

String returns a JSON representation of the model

type UsersApi ¶

type UsersApi struct {
	Configuration *Configuration
}

UsersApi provides functions for API endpoints

func NewUsersApi ¶

func NewUsersApi() *UsersApi

NewUsersApi creates an API instance using the default configuration

func NewUsersApiWithConfig ¶

func NewUsersApiWithConfig(config *Configuration) *UsersApi

NewUsersApiWithConfig creates an API instance using the provided configuration

func (UsersApi) DeleteAnalyticsUsersDetailsJob ¶

func (a UsersApi) DeleteAnalyticsUsersDetailsJob(jobId string) (*APIResponse, error)

DeleteAnalyticsUsersDetailsJob invokes DELETE /api/v2/analytics/users/details/jobs/{jobId}

Delete/cancel an async request

func (UsersApi) DeleteAuthorizationSubjectDivisionRole ¶

func (a UsersApi) 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 (UsersApi) DeleteRoutingUserUtilization ¶

func (a UsersApi) DeleteRoutingUserUtilization(userId string) (*APIResponse, error)

DeleteRoutingUserUtilization invokes DELETE /api/v2/routing/users/{userId}/utilization

Delete the user&#39;s max utilization settings and revert to the organization-wide default.

func (UsersApi) DeleteUser ¶

func (a UsersApi) DeleteUser(userId string) (*Empty, *APIResponse, error)

DeleteUser invokes DELETE /api/v2/users/{userId}

Delete user

func (UsersApi) DeleteUserRoutinglanguage ¶

func (a UsersApi) DeleteUserRoutinglanguage(userId string, languageId string) (*APIResponse, error)

DeleteUserRoutinglanguage invokes DELETE /api/v2/users/{userId}/routinglanguages/{languageId}

Remove routing language from user

func (UsersApi) DeleteUserRoutingskill ¶

func (a UsersApi) DeleteUserRoutingskill(userId string, skillId string) (*APIResponse, error)

DeleteUserRoutingskill invokes DELETE /api/v2/users/{userId}/routingskills/{skillId}

Remove routing skill from user

func (UsersApi) DeleteUserStationAssociatedstation ¶

func (a UsersApi) DeleteUserStationAssociatedstation(userId string) (*APIResponse, error)

DeleteUserStationAssociatedstation invokes DELETE /api/v2/users/{userId}/station/associatedstation

Clear associated station

func (UsersApi) DeleteUserStationDefaultstation ¶

func (a UsersApi) DeleteUserStationDefaultstation(userId string) (*APIResponse, error)

DeleteUserStationDefaultstation invokes DELETE /api/v2/users/{userId}/station/defaultstation

Clear default station

func (UsersApi) GetAnalyticsUsersDetailsJob ¶

func (a UsersApi) 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 (UsersApi) GetAnalyticsUsersDetailsJobResults ¶

func (a UsersApi) 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 (UsersApi) GetAnalyticsUsersDetailsJobsAvailability ¶

func (a UsersApi) GetAnalyticsUsersDetailsJobsAvailability() (*Dataavailabilityresponse, *APIResponse, error)

GetAnalyticsUsersDetailsJobsAvailability invokes GET /api/v2/analytics/users/details/jobs/availability

Lookup the datalake availability date and time

func (UsersApi) GetAuthorizationDivisionspermittedMe ¶

func (a UsersApi) 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 (UsersApi) GetAuthorizationDivisionspermittedPagedMe ¶

func (a UsersApi) 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 (UsersApi) GetAuthorizationDivisionspermittedPagedSubjectId ¶

func (a UsersApi) 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 (UsersApi) GetAuthorizationSubject ¶

func (a UsersApi) 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 (UsersApi) GetAuthorizationSubjectsMe ¶

func (a UsersApi) 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 (UsersApi) GetFieldconfig ¶

func (a UsersApi) GetFieldconfig(varType string) (*Fieldconfig, *APIResponse, error)

GetFieldconfig invokes GET /api/v2/fieldconfig

Fetch field config for an entity type

func (UsersApi) GetProfilesUsers ¶

func (a UsersApi) GetProfilesUsers(pageSize int, pageNumber int, id []string, jid []string, sortOrder string, expand []string, integrationPresenceSource string) (*Userprofileentitylisting, *APIResponse, error)

GetProfilesUsers invokes GET /api/v2/profiles/users

Get a user profile listing ¶

This api is deprecated. User /api/v2/users

func (UsersApi) GetRoutingUserUtilization ¶

func (a UsersApi) GetRoutingUserUtilization(userId string) (*Agentmaxutilization, *APIResponse, error)

GetRoutingUserUtilization invokes GET /api/v2/routing/users/{userId}/utilization

Get the user&#39;s max utilization settings. If not configured, the organization-wide default is returned.

func (UsersApi) GetUser ¶

func (a UsersApi) GetUser(userId string, expand []string, integrationPresenceSource string, state string) (*User, *APIResponse, error)

GetUser invokes GET /api/v2/users/{userId}

Get user.

func (UsersApi) GetUserAdjacents ¶

func (a UsersApi) GetUserAdjacents(userId string, expand []string) (*Adjacents, *APIResponse, error)

GetUserAdjacents invokes GET /api/v2/users/{userId}/adjacents

Get adjacents

func (UsersApi) GetUserCallforwarding ¶

func (a UsersApi) GetUserCallforwarding(userId string) (*Callforwarding, *APIResponse, error)

GetUserCallforwarding invokes GET /api/v2/users/{userId}/callforwarding

Get a user&#39;s CallForwarding

func (UsersApi) GetUserDirectreports ¶

func (a UsersApi) GetUserDirectreports(userId string, expand []string) ([]User, *APIResponse, error)

GetUserDirectreports invokes GET /api/v2/users/{userId}/directreports

Get direct reports

func (UsersApi) GetUserFavorites ¶

func (a UsersApi) GetUserFavorites(userId string, pageSize int, pageNumber int, sortOrder string, expand []string) (*Userentitylisting, *APIResponse, error)

GetUserFavorites invokes GET /api/v2/users/{userId}/favorites

Deprecated; will be revived with new contract

func (UsersApi) GetUserGeolocation ¶

func (a UsersApi) GetUserGeolocation(userId string, clientId string) (*Geolocation, *APIResponse, error)

GetUserGeolocation invokes GET /api/v2/users/{userId}/geolocations/{clientId}

Get a user&#39;s Geolocation

func (UsersApi) GetUserOutofoffice ¶

func (a UsersApi) GetUserOutofoffice(userId string) (*Outofoffice, *APIResponse, error)

GetUserOutofoffice invokes GET /api/v2/users/{userId}/outofoffice

Get a OutOfOffice

func (UsersApi) GetUserProfile ¶

func (a UsersApi) GetUserProfile(userId string, expand []string, integrationPresenceSource string) (*Userprofile, *APIResponse, error)

GetUserProfile invokes GET /api/v2/users/{userId}/profile

Get user profile ¶

This api has been deprecated. Use api/v2/users instead

func (UsersApi) GetUserProfileskills ¶

func (a UsersApi) GetUserProfileskills(userId string) ([]string, *APIResponse, error)

GetUserProfileskills invokes GET /api/v2/users/{userId}/profileskills

List profile skills for a user

func (UsersApi) GetUserQueues ¶

func (a UsersApi) GetUserQueues(userId string, pageSize int, pageNumber int, joined bool, divisionId []string) (*Userqueueentitylisting, *APIResponse, error)

GetUserQueues invokes GET /api/v2/users/{userId}/queues

Get queues for user

func (UsersApi) GetUserRoles ¶

func (a UsersApi) 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 (UsersApi) GetUserRoutinglanguages ¶

func (a UsersApi) GetUserRoutinglanguages(userId string, pageSize int, pageNumber int, sortOrder string) (*Userlanguageentitylisting, *APIResponse, error)

GetUserRoutinglanguages invokes GET /api/v2/users/{userId}/routinglanguages

List routing language for user

func (UsersApi) GetUserRoutingskills ¶

func (a UsersApi) GetUserRoutingskills(userId string, pageSize int, pageNumber int, sortOrder string) (*Userskillentitylisting, *APIResponse, error)

GetUserRoutingskills invokes GET /api/v2/users/{userId}/routingskills

List routing skills for user

func (UsersApi) GetUserRoutingstatus ¶

func (a UsersApi) GetUserRoutingstatus(userId string) (*Routingstatus, *APIResponse, error)

GetUserRoutingstatus invokes GET /api/v2/users/{userId}/routingstatus

Fetch the routing status of a user

func (UsersApi) GetUserStation ¶

func (a UsersApi) GetUserStation(userId string) (*Userstations, *APIResponse, error)

GetUserStation invokes GET /api/v2/users/{userId}/station

Get station information for user

func (UsersApi) GetUserSuperiors ¶

func (a UsersApi) GetUserSuperiors(userId string, expand []string) ([]User, *APIResponse, error)

GetUserSuperiors invokes GET /api/v2/users/{userId}/superiors

Get superiors

func (UsersApi) GetUserTrustors ¶

func (a UsersApi) GetUserTrustors(userId string, pageSize int, pageNumber int) (*Trustorentitylisting, *APIResponse, error)

GetUserTrustors invokes GET /api/v2/users/{userId}/trustors

List the organizations that have authorized/trusted the user.

func (UsersApi) GetUsers ¶

func (a UsersApi) GetUsers(pageSize int, pageNumber int, id []string, jabberId []string, sortOrder string, expand []string, integrationPresenceSource string, state string) (*Userentitylisting, *APIResponse, error)

GetUsers invokes GET /api/v2/users

Get the list of available users.

Example ¶
// Use the default config instance and retrieve settings from env vars
config := GetDefaultConfiguration()
config.LoggingConfiguration.LogLevel = LNone
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()

// Invoke API
_, response, err := usersAPI.GetUsers(100, 1, make([]string, 0), make([]string, 0), "", make([]string, 0), "", "")
if err != nil {
	fmt.Printf("Error calling GetUsers: %v\n", err)
} else {
	fmt.Printf("Successfully retrieved user data with status code %v\n", response.StatusCode)
}
Output:

Successfully retrieved user data with status code 200

func (UsersApi) GetUsersDevelopmentActivities ¶

func (a UsersApi) GetUsersDevelopmentActivities(userId []string, moduleId string, interval string, completionInterval string, overdue string, pageSize int, pageNumber int, sortOrder string, types []string, statuses []string, relationship []string) (*Developmentactivitylisting, *APIResponse, error)

GetUsersDevelopmentActivities invokes GET /api/v2/users/development/activities

Get list of Development Activities ¶

Either moduleId or userId is required. Results are filtered based on the applicable permissions.

func (UsersApi) GetUsersDevelopmentActivitiesMe ¶

func (a UsersApi) GetUsersDevelopmentActivitiesMe(moduleId string, interval string, completionInterval string, overdue string, pageSize int, pageNumber int, sortOrder string, types []string, statuses []string, relationship []string) (*Developmentactivitylisting, *APIResponse, error)

GetUsersDevelopmentActivitiesMe invokes GET /api/v2/users/development/activities/me

Get list of Development Activities for current user ¶

Results are filtered based on the applicable permissions.

func (UsersApi) GetUsersDevelopmentActivity ¶

func (a UsersApi) GetUsersDevelopmentActivity(activityId string, varType string) (*Developmentactivity, *APIResponse, error)

GetUsersDevelopmentActivity invokes GET /api/v2/users/development/activities/{activityId}

Get a Development Activity ¶

Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.

func (UsersApi) GetUsersMe ¶

func (a UsersApi) GetUsersMe(expand []string, integrationPresenceSource string) (*Userme, *APIResponse, error)

GetUsersMe invokes GET /api/v2/users/me

Get current user details.

This request is not valid when using the Client Credentials OAuth grant.

func (UsersApi) GetUsersSearch ¶

func (a UsersApi) GetUsersSearch(q64 string, expand []string, integrationPresenceSource string) (*Userssearchresponse, *APIResponse, error)

GetUsersSearch invokes GET /api/v2/users/search

Search users using the q64 value returned from a previous search

func (UsersApi) PatchUser ¶

func (a UsersApi) PatchUser(userId string, body Updateuser) (*User, *APIResponse, error)

PatchUser invokes PATCH /api/v2/users/{userId}

Update user

func (UsersApi) PatchUserCallforwarding ¶

func (a UsersApi) PatchUserCallforwarding(userId string, body Callforwarding) (*Callforwarding, *APIResponse, error)

PatchUserCallforwarding invokes PATCH /api/v2/users/{userId}/callforwarding

Patch a user&#39;s CallForwarding

func (UsersApi) PatchUserGeolocation ¶

func (a UsersApi) PatchUserGeolocation(userId string, clientId string, body Geolocation) (*Geolocation, *APIResponse, error)

PatchUserGeolocation invokes PATCH /api/v2/users/{userId}/geolocations/{clientId}

Patch a user&#39;s Geolocation

The geolocation object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the client as the user&#39;s primary geolocation source. Option 2: Provide the &#39;latitude&#39; and &#39;longitude&#39; values. This will enqueue an asynchronous update of the &#39;city&#39;, &#39;region&#39;, and &#39;country&#39;, generating a notification. A subsequent GET operation will include the new values for &#39;city&#39;, &#39;region&#39; and &#39;country&#39;. Option 3: Provide the &#39;city&#39;, &#39;region&#39;, &#39;country&#39; values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.

func (UsersApi) PatchUserQueue ¶

func (a UsersApi) PatchUserQueue(queueId string, userId string, body Userqueue) (*Userqueue, *APIResponse, error)

PatchUserQueue invokes PATCH /api/v2/users/{userId}/queues/{queueId}

Join or unjoin a queue for a user

func (UsersApi) PatchUserQueues ¶

func (a UsersApi) PatchUserQueues(userId string, body []Userqueue, divisionId []string) (*Userqueueentitylisting, *APIResponse, error)

PatchUserQueues invokes PATCH /api/v2/users/{userId}/queues

Join or unjoin a set of queues for a user

func (UsersApi) PatchUserRoutinglanguage ¶

func (a UsersApi) PatchUserRoutinglanguage(userId string, languageId string, body Userroutinglanguage) (*Userroutinglanguage, *APIResponse, error)

PatchUserRoutinglanguage invokes PATCH /api/v2/users/{userId}/routinglanguages/{languageId}

Update routing language proficiency or state.

func (UsersApi) PatchUserRoutinglanguagesBulk ¶

func (a UsersApi) PatchUserRoutinglanguagesBulk(userId string, body []Userroutinglanguagepost) (*Userlanguageentitylisting, *APIResponse, error)

PatchUserRoutinglanguagesBulk invokes PATCH /api/v2/users/{userId}/routinglanguages/bulk

Add bulk routing language to user. Max limit 50 languages

func (UsersApi) PatchUserRoutingskillsBulk ¶

func (a UsersApi) PatchUserRoutingskillsBulk(userId string, body []Userroutingskillpost) (*Userskillentitylisting, *APIResponse, error)

PatchUserRoutingskillsBulk invokes PATCH /api/v2/users/{userId}/routingskills/bulk

Bulk add routing skills to user

func (UsersApi) PatchUsersBulk ¶

func (a UsersApi) PatchUsersBulk(body []Patchuser) (*Userentitylisting, *APIResponse, error)

PatchUsersBulk invokes PATCH /api/v2/users/bulk

Update bulk acd autoanswer on users

func (UsersApi) PostAnalyticsUsersAggregatesQuery ¶

func (a UsersApi) PostAnalyticsUsersAggregatesQuery(body Useraggregationquery) (*Useraggregatequeryresponse, *APIResponse, error)

PostAnalyticsUsersAggregatesQuery invokes POST /api/v2/analytics/users/aggregates/query

Query for user aggregates

func (UsersApi) PostAnalyticsUsersDetailsJobs ¶

func (a UsersApi) PostAnalyticsUsersDetailsJobs(body Asyncuserdetailsquery) (*Asyncqueryresponse, *APIResponse, error)

PostAnalyticsUsersDetailsJobs invokes POST /api/v2/analytics/users/details/jobs

Query for user details asynchronously

func (UsersApi) PostAnalyticsUsersDetailsQuery ¶

func (a UsersApi) PostAnalyticsUsersDetailsQuery(body Userdetailsquery) (*Analyticsuserdetailsqueryresponse, *APIResponse, error)

PostAnalyticsUsersDetailsQuery invokes POST /api/v2/analytics/users/details/query

Query for user details

func (UsersApi) PostAnalyticsUsersObservationsQuery ¶

func (a UsersApi) PostAnalyticsUsersObservationsQuery(body Userobservationquery) (*Userobservationqueryresponse, *APIResponse, error)

PostAnalyticsUsersObservationsQuery invokes POST /api/v2/analytics/users/observations/query

Query for user observations

func (UsersApi) PostAuthorizationSubjectBulkadd ¶

func (a UsersApi) 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 (UsersApi) PostAuthorizationSubjectBulkremove ¶

func (a UsersApi) PostAuthorizationSubjectBulkremove(subjectId string, body Roledivisiongrants) (*APIResponse, error)

PostAuthorizationSubjectBulkremove invokes POST /api/v2/authorization/subjects/{subjectId}/bulkremove

Bulk-remove grants from a subject.

func (UsersApi) PostAuthorizationSubjectBulkreplace ¶

func (a UsersApi) PostAuthorizationSubjectBulkreplace(subjectId string, body Roledivisiongrants, subjectType string) (*APIResponse, error)

PostAuthorizationSubjectBulkreplace invokes POST /api/v2/authorization/subjects/{subjectId}/bulkreplace

Replace subject&#39;s roles and divisions with the exact list supplied in the request.

This operation will not remove grants that are inherited from group membership. It will only set the grants directly applied to the subject.

func (UsersApi) PostAuthorizationSubjectDivisionRole ¶

func (a UsersApi) 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 (UsersApi) PostUserInvite ¶

func (a UsersApi) PostUserInvite(userId string, force bool) (*APIResponse, error)

PostUserInvite invokes POST /api/v2/users/{userId}/invite

Send an activation email to the user

func (UsersApi) PostUserPassword ¶

func (a UsersApi) PostUserPassword(userId string, body Changepasswordrequest) (*APIResponse, error)

PostUserPassword invokes POST /api/v2/users/{userId}/password

Change a users password

func (UsersApi) PostUserRoutinglanguages ¶

func (a UsersApi) PostUserRoutinglanguages(userId string, body Userroutinglanguagepost) (*Userroutinglanguage, *APIResponse, error)

PostUserRoutinglanguages invokes POST /api/v2/users/{userId}/routinglanguages

Add routing language to user

func (UsersApi) PostUserRoutingskills ¶

func (a UsersApi) PostUserRoutingskills(userId string, body Userroutingskillpost) (*Userroutingskill, *APIResponse, error)

PostUserRoutingskills invokes POST /api/v2/users/{userId}/routingskills

Add routing skill to user

func (UsersApi) PostUsers ¶

func (a UsersApi) PostUsers(body Createuser) (*User, *APIResponse, error)

PostUsers invokes POST /api/v2/users

Create user

func (UsersApi) PostUsersDevelopmentActivitiesAggregatesQuery ¶

func (a UsersApi) PostUsersDevelopmentActivitiesAggregatesQuery(body Developmentactivityaggregateparam) (*Developmentactivityaggregateresponse, *APIResponse, error)

PostUsersDevelopmentActivitiesAggregatesQuery invokes POST /api/v2/users/development/activities/aggregates/query

Retrieve aggregated development activity data ¶

Results are filtered based on the applicable permissions.

func (UsersApi) PostUsersMePassword ¶

func (a UsersApi) PostUsersMePassword(body Changemypasswordrequest) (*APIResponse, error)

PostUsersMePassword invokes POST /api/v2/users/me/password

Change your password

func (UsersApi) PostUsersSearch ¶

func (a UsersApi) PostUsersSearch(body Usersearchrequest) (*Userssearchresponse, *APIResponse, error)

PostUsersSearch invokes POST /api/v2/users/search

Search users

func (UsersApi) PutRoutingUserUtilization ¶

func (a UsersApi) PutRoutingUserUtilization(userId string, body Utilization) (*Agentmaxutilization, *APIResponse, error)

PutRoutingUserUtilization invokes PUT /api/v2/routing/users/{userId}/utilization

Update the user&#39;s max utilization settings. Include only those media types requiring custom configuration.

func (UsersApi) PutUserCallforwarding ¶

func (a UsersApi) PutUserCallforwarding(userId string, body Callforwarding) (*Callforwarding, *APIResponse, error)

PutUserCallforwarding invokes PUT /api/v2/users/{userId}/callforwarding

Update a user&#39;s CallForwarding

func (UsersApi) PutUserOutofoffice ¶

func (a UsersApi) PutUserOutofoffice(userId string, body Outofoffice) (*Outofoffice, *APIResponse, error)

PutUserOutofoffice invokes PUT /api/v2/users/{userId}/outofoffice

Update an OutOfOffice

func (UsersApi) PutUserProfileskills ¶

func (a UsersApi) PutUserProfileskills(userId string, body []string) ([]string, *APIResponse, error)

PutUserProfileskills invokes PUT /api/v2/users/{userId}/profileskills

Update profile skills for a user

func (UsersApi) PutUserRoles ¶

func (a UsersApi) PutUserRoles(userId string, body []string) (*Userauthorization, *APIResponse, error)

PutUserRoles invokes PUT /api/v2/users/{userId}/roles

Sets the user&#39;s roles

func (UsersApi) PutUserRoutingskill ¶

func (a UsersApi) PutUserRoutingskill(userId string, skillId string, body Userroutingskill) (*Userroutingskill, *APIResponse, error)

PutUserRoutingskill invokes PUT /api/v2/users/{userId}/routingskills/{skillId}

Update routing skill proficiency or state.

func (UsersApi) PutUserRoutingskillsBulk ¶

func (a UsersApi) PutUserRoutingskillsBulk(userId string, body []Userroutingskillpost) (*Userskillentitylisting, *APIResponse, error)

PutUserRoutingskillsBulk invokes PUT /api/v2/users/{userId}/routingskills/bulk

Replace all routing skills assigned to a user

func (UsersApi) PutUserRoutingstatus ¶

func (a UsersApi) PutUserRoutingstatus(userId string, body Routingstatus) (*Routingstatus, *APIResponse, error)

PutUserRoutingstatus invokes PUT /api/v2/users/{userId}/routingstatus

Update the routing status of a user

func (UsersApi) PutUserStationAssociatedstationStationId ¶

func (a UsersApi) PutUserStationAssociatedstationStationId(userId string, stationId string) (*APIResponse, error)

PutUserStationAssociatedstationStationId invokes PUT /api/v2/users/{userId}/station/associatedstation/{stationId}

Set associated station

func (UsersApi) PutUserStationDefaultstationStationId ¶

func (a UsersApi) PutUserStationDefaultstationStationId(userId string, stationId string) (*APIResponse, error)

PutUserStationDefaultstationStationId invokes PUT /api/v2/users/{userId}/station/defaultstation/{stationId}

Set default station

type Userschedule ¶

type Userschedule struct {
	// Shifts - The shifts that belong to this schedule
	Shifts *[]Userscheduleshift `json:"shifts,omitempty"`

	// FullDayTimeOffMarkers - Markers to indicate a full day time off request, relative to the management unit time zone
	FullDayTimeOffMarkers *[]Userschedulefulldaytimeoffmarker `json:"fullDayTimeOffMarkers,omitempty"`

	// Delete - If marked true for updating an existing user schedule, it will be deleted
	Delete *bool `json:"delete,omitempty"`

	// Metadata - Version metadata for this schedule
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// WorkPlanId - ID of the work plan associated with the user during schedule creation
	WorkPlanId *string `json:"workPlanId,omitempty"`
}

Userschedule - A schedule for a single user over a given time range

func (*Userschedule) String ¶

func (o *Userschedule) String() string

String returns a JSON representation of the model

type Userscheduleactivity ¶

type Userscheduleactivity struct {
	// ActivityCodeId - The id for the activity code.  Look up a map of activity codes with the activities route
	ActivityCodeId *string `json:"activityCodeId,omitempty"`

	// StartDate - Start time in UTC for this activity, in ISO-8601 format
	StartDate *time.Time `json:"startDate,omitempty"`

	// LengthInMinutes - Length in minutes for this activity
	LengthInMinutes *int `json:"lengthInMinutes,omitempty"`

	// Description - Description for this activity
	Description *string `json:"description,omitempty"`

	// CountsAsPaidTime - Whether this activity is paid
	CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"`

	// IsDstFallback - Whether this activity spans a DST fallback
	IsDstFallback *bool `json:"isDstFallback,omitempty"`

	// TimeOffRequestId - Time off request id of this activity
	TimeOffRequestId *string `json:"timeOffRequestId,omitempty"`
}

Userscheduleactivity - Represents a single activity in a user's shift

func (*Userscheduleactivity) String ¶

func (o *Userscheduleactivity) String() string

String returns a JSON representation of the model

type Userscheduleadherence ¶

type Userscheduleadherence struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// User - The user for whom this status applies
	User *Userreference `json:"user,omitempty"`

	// ManagementUnit - The management unit to which this user belongs
	ManagementUnit *Managementunit `json:"managementUnit,omitempty"`

	// Team - The team to which this user belongs
	Team *Team `json:"team,omitempty"`

	// ScheduledActivityCategory - Activity for which the user is scheduled
	ScheduledActivityCategory *string `json:"scheduledActivityCategory,omitempty"`

	// SystemPresence - Actual underlying system presence value
	SystemPresence *string `json:"systemPresence,omitempty"`

	// OrganizationSecondaryPresenceId - Organization Secondary Presence Id.
	OrganizationSecondaryPresenceId *string `json:"organizationSecondaryPresenceId,omitempty"`

	// RoutingStatus - Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue
	RoutingStatus *string `json:"routingStatus,omitempty"`

	// ActualActivityCategory - Activity in which the user is actually engaged
	ActualActivityCategory *string `json:"actualActivityCategory,omitempty"`

	// IsOutOfOffice - Whether the user is marked OutOfOffice
	IsOutOfOffice *bool `json:"isOutOfOffice,omitempty"`

	// AdherenceState - The user's current adherence state
	AdherenceState *string `json:"adherenceState,omitempty"`

	// Impact - The impact of the user's current adherenceState
	Impact *string `json:"impact,omitempty"`

	// TimeOfAdherenceChange - Time when the user entered the current adherenceState in ISO-8601 format
	TimeOfAdherenceChange *time.Time `json:"timeOfAdherenceChange,omitempty"`

	// PresenceUpdateTime - Time when presence was last updated.  Used to calculate time in current status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	PresenceUpdateTime *time.Time `json:"presenceUpdateTime,omitempty"`

	// ActiveQueues - The list of queues to which this user is joined
	ActiveQueues *[]Queuereference `json:"activeQueues,omitempty"`

	// ActiveQueuesModifiedTime - Time when the list of active queues for this user was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ActiveQueuesModifiedTime *time.Time `json:"activeQueuesModifiedTime,omitempty"`

	// RemovedFromManagementUnit - For notification purposes. Used to indicate that a user was removed from the management unit
	RemovedFromManagementUnit *bool `json:"removedFromManagementUnit,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Userscheduleadherence

func (*Userscheduleadherence) String ¶

func (o *Userscheduleadherence) String() string

String returns a JSON representation of the model

type Userscheduleadherencelisting ¶

type Userscheduleadherencelisting struct {
	// Entities
	Entities *[]Userscheduleadherence `json:"entities,omitempty"`

	// DownloadUrl - The downloadUrl if the response is too large to send directly via http response
	DownloadUrl *string `json:"downloadUrl,omitempty"`
}

Userscheduleadherencelisting

func (*Userscheduleadherencelisting) String ¶

String returns a JSON representation of the model

type Userschedulecontainer ¶

type Userschedulecontainer struct {
	// ManagementUnitTimeZone - The reference time zone used for the management unit
	ManagementUnitTimeZone *string `json:"managementUnitTimeZone,omitempty"`

	// PublishedSchedules - References to all published week schedules overlapping the start/end date query parameters
	PublishedSchedules *[]Weekschedulereference `json:"publishedSchedules,omitempty"`

	// UserSchedules - Map of user id to user schedule
	UserSchedules *map[string]Userschedule `json:"userSchedules,omitempty"`
}

Userschedulecontainer - Container object to hold a map of user schedules

func (*Userschedulecontainer) String ¶

func (o *Userschedulecontainer) String() string

String returns a JSON representation of the model

type Userschedulefulldaytimeoffmarker ¶

type Userschedulefulldaytimeoffmarker struct {
	// ManagementUnitDate - The date associated with the time off request that this marker corresponds to.  Date only, in ISO-8601 format.
	ManagementUnitDate *string `json:"managementUnitDate,omitempty"`

	// ActivityCodeId - The id for the activity code.  Look up a map of activity codes with the activities route
	ActivityCodeId *string `json:"activityCodeId,omitempty"`

	// IsPaid - Whether this is paid time off
	IsPaid *bool `json:"isPaid,omitempty"`

	// LengthInMinutes - The length in minutes of this time off marker
	LengthInMinutes *int `json:"lengthInMinutes,omitempty"`

	// Description - The description associated with the time off request that this marker corresponds to
	Description *string `json:"description,omitempty"`

	// Delete - If marked true for updating an existing full day time off marker, it will be deleted
	Delete *bool `json:"delete,omitempty"`
}

Userschedulefulldaytimeoffmarker - Marker to indicate an approved full day time off request

func (*Userschedulefulldaytimeoffmarker) String ¶

String returns a JSON representation of the model

type Userscheduleshift ¶

type Userscheduleshift struct {
	// WeekSchedule - The schedule to which this shift belongs
	WeekSchedule *Weekschedulereference `json:"weekSchedule,omitempty"`

	// Id - ID of the schedule shift. This is only for the case of updating and deleting an existing shift
	Id *string `json:"id,omitempty"`

	// StartDate - Start time in UTC for 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"`

	// LengthInMinutes - Length of this shift in minutes
	LengthInMinutes *int `json:"lengthInMinutes,omitempty"`

	// Activities - List of activities in this shift
	Activities *[]Userscheduleactivity `json:"activities,omitempty"`

	// Delete - If marked true for updating this schedule shift, it will be deleted
	Delete *bool `json:"delete,omitempty"`

	// ManuallyEdited - Whether the shift was set as manually edited
	ManuallyEdited *bool `json:"manuallyEdited,omitempty"`
}

Userscheduleshift - Single shift in a user's schedule

func (*Userscheduleshift) String ¶

func (o *Userscheduleshift) String() string

String returns a JSON representation of the model

type Usersearchcriteria ¶

type Usersearchcriteria struct {
	// EndValue - The end value of the range. This field is used for range search types.
	EndValue *string `json:"endValue,omitempty"`

	// Values - A list of values for the search to match against
	Values *[]string `json:"values,omitempty"`

	// StartValue - The start value of the range. This field is used for range search types.
	StartValue *string `json:"startValue,omitempty"`

	// Fields - Field names to search against
	Fields *[]string `json:"fields,omitempty"`

	// Value - A value for the search to match against
	Value *string `json:"value,omitempty"`

	// Operator - How to apply this search criteria against other criteria
	Operator *string `json:"operator,omitempty"`

	// Group - Groups multiple conditions
	Group *[]Usersearchcriteria `json:"group,omitempty"`

	// DateFormat - Set date format for criteria values when using date range search type.  Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX.
	DateFormat *string `json:"dateFormat,omitempty"`

	// VarType - Search Type
	VarType *string `json:"type,omitempty"`
}

Usersearchcriteria

func (*Usersearchcriteria) String ¶

func (o *Usersearchcriteria) String() string

String returns a JSON representation of the model

type Usersearchrequest ¶

type Usersearchrequest struct {
	// SortOrder - The sort order for results
	SortOrder *string `json:"sortOrder,omitempty"`

	// SortBy - The field in the resource that you want to sort the results by
	SortBy *string `json:"sortBy,omitempty"`

	// PageSize - The number of results per page
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The page of resources you want to retrieve
	PageNumber *int `json:"pageNumber,omitempty"`

	// Sort - Multi-value sort order, list of multiple sort values
	Sort *[]Searchsort `json:"sort,omitempty"`

	// Expand - Provides more details about a specified resource
	Expand *[]string `json:"expand,omitempty"`

	// Query
	Query *[]Usersearchcriteria `json:"query,omitempty"`

	// IntegrationPresenceSource - Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 10.
	IntegrationPresenceSource *string `json:"integrationPresenceSource,omitempty"`

	// EnforcePermissions - This property only applies to api/v2/user/search; when set to true add additional search criteria to filter users by: directory:user:view
	EnforcePermissions *bool `json:"enforcePermissions,omitempty"`
}

Usersearchrequest

func (*Usersearchrequest) String ¶

func (o *Usersearchrequest) String() string

String returns a JSON representation of the model

type Userskillentitylisting ¶

type Userskillentitylisting struct {
	// Entities
	Entities *[]Userroutingskill `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Userskillentitylisting

func (*Userskillentitylisting) String ¶

func (o *Userskillentitylisting) String() string

String returns a JSON representation of the model

type Userssearchresponse ¶

type Userssearchresponse struct {
	// Total - The total number of results found
	Total *int `json:"total,omitempty"`

	// PageCount - The total number of pages
	PageCount *int `json:"pageCount,omitempty"`

	// PageSize - The current page size
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The current page number
	PageNumber *int `json:"pageNumber,omitempty"`

	// PreviousPage - Q64 value for the previous page of results
	PreviousPage *string `json:"previousPage,omitempty"`

	// CurrentPage - Q64 value for the current page of results
	CurrentPage *string `json:"currentPage,omitempty"`

	// NextPage - Q64 value for the next page of results
	NextPage *string `json:"nextPage,omitempty"`

	// Types - Resource types the search was performed against
	Types *[]string `json:"types,omitempty"`

	// Results - Search results
	Results *[]User `json:"results,omitempty"`
}

Userssearchresponse

func (*Userssearchresponse) String ¶

func (o *Userssearchresponse) String() string

String returns a JSON representation of the model

type Userstation ¶

type Userstation struct {
	// Id - A globally unique identifier for this station
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// AssociatedUser
	AssociatedUser *User `json:"associatedUser,omitempty"`

	// AssociatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	AssociatedDate *time.Time `json:"associatedDate,omitempty"`

	// DefaultUser
	DefaultUser *User `json:"defaultUser,omitempty"`

	// ProviderInfo - Provider-specific info for this station, e.g. { \"edgeGroupId\": \"ffe7b15c-a9cc-4f4c-88f5-781327819a49\" }
	ProviderInfo *map[string]string `json:"providerInfo,omitempty"`
}

Userstation

func (*Userstation) String ¶

func (o *Userstation) String() string

String returns a JSON representation of the model

type Userstationchangetopicuser ¶

type Userstationchangetopicuser struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Userstationchangetopicuser

func (*Userstationchangetopicuser) String ¶

func (o *Userstationchangetopicuser) String() string

String returns a JSON representation of the model

type Userstationchangetopicuserstation ¶

type Userstationchangetopicuserstation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// AssociatedUser
	AssociatedUser *Userstationchangetopicuser `json:"associatedUser,omitempty"`
}

Userstationchangetopicuserstation

func (*Userstationchangetopicuserstation) String ¶

String returns a JSON representation of the model

type Userstationchangetopicuserstations ¶

type Userstationchangetopicuserstations struct {
	// AssociatedStation
	AssociatedStation *Userstationchangetopicuserstation `json:"associatedStation,omitempty"`
}

Userstationchangetopicuserstations

func (*Userstationchangetopicuserstations) String ¶

String returns a JSON representation of the model

type Userstations ¶

type Userstations struct {
	// AssociatedStation - Current associated station for this user.
	AssociatedStation *Userstation `json:"associatedStation,omitempty"`

	// EffectiveStation - The station where the user can be reached based on their default and associated station.
	EffectiveStation *Userstation `json:"effectiveStation,omitempty"`

	// DefaultStation - Default station to be used if not associated with a station.
	DefaultStation *Userstation `json:"defaultStation,omitempty"`

	// LastAssociatedStation - Last associated station for this user.
	LastAssociatedStation *Userstation `json:"lastAssociatedStation,omitempty"`
}

Userstations

func (*Userstations) String ¶

func (o *Userstations) String() string

String returns a JSON representation of the model

type Usertokenstopictokennotification ¶

type Usertokenstopictokennotification struct {
	// User
	User *Usertokenstopicurireference `json:"user,omitempty"`

	// IpAddress
	IpAddress *string `json:"ipAddress,omitempty"`

	// DateCreated
	DateCreated *string `json:"dateCreated,omitempty"`

	// TokenExpirationDate
	TokenExpirationDate *string `json:"tokenExpirationDate,omitempty"`

	// SessionId
	SessionId *string `json:"sessionId,omitempty"`

	// ClientId
	ClientId *string `json:"clientId,omitempty"`

	// TokenHash
	TokenHash *string `json:"tokenHash,omitempty"`
}

Usertokenstopictokennotification

func (*Usertokenstopictokennotification) String ¶

String returns a JSON representation of the model

type Usertokenstopicurireference ¶

type Usertokenstopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Usertokenstopicurireference

func (*Usertokenstopicurireference) String ¶

func (o *Usertokenstopicurireference) String() string

String returns a JSON representation of the model

type UtilitiesApi ¶

type UtilitiesApi struct {
	Configuration *Configuration
}

UtilitiesApi provides functions for API endpoints

func NewUtilitiesApi ¶

func NewUtilitiesApi() *UtilitiesApi

NewUtilitiesApi creates an API instance using the default configuration

func NewUtilitiesApiWithConfig ¶

func NewUtilitiesApiWithConfig(config *Configuration) *UtilitiesApi

NewUtilitiesApiWithConfig creates an API instance using the provided configuration

func (UtilitiesApi) GetDate ¶

func (a UtilitiesApi) GetDate() (*Serverdate, *APIResponse, error)

GetDate invokes GET /api/v2/date

Get the current system date/time

func (UtilitiesApi) GetIpranges ¶

func (a UtilitiesApi) GetIpranges() (*Ipaddressrangelisting, *APIResponse, error)

GetIpranges invokes GET /api/v2/ipranges

Get public ip address ranges for PureCloud

func (UtilitiesApi) GetTimezones ¶

func (a UtilitiesApi) GetTimezones(pageSize int, pageNumber int) (*Timezoneentitylisting, *APIResponse, error)

GetTimezones invokes GET /api/v2/timezones

Get time zones list

func (UtilitiesApi) PostCertificateDetails ¶

func (a UtilitiesApi) PostCertificateDetails(body Certificate) (*Parsedcertificate, *APIResponse, error)

PostCertificateDetails invokes POST /api/v2/certificate/details

Returns the information about an X509 PEM encoded certificate or certificate chain.

type Utilization ¶

type Utilization struct {
	// Utilization - Map of media type to utilization settings.  Valid media types include call, callback, chat, email, and message.
	Utilization *map[string]Mediautilization `json:"utilization,omitempty"`
}

Utilization

func (*Utilization) String ¶

func (o *Utilization) String() string

String returns a JSON representation of the model

type Validateaddressrequest ¶

type Validateaddressrequest struct {
	// Address - Address schema
	Address *Streetaddress `json:"address,omitempty"`
}

Validateaddressrequest

func (*Validateaddressrequest) String ¶

func (o *Validateaddressrequest) String() string

String returns a JSON representation of the model

type Validateaddressresponse ¶

type Validateaddressresponse struct {
	// Valid - Was the passed in address valid
	Valid *bool `json:"valid,omitempty"`

	// Response - Subscriber schema
	Response *Subscriberresponse `json:"response,omitempty"`
}

Validateaddressresponse

func (*Validateaddressresponse) String ¶

func (o *Validateaddressresponse) String() string

String returns a JSON representation of the model

type Validateworkplanmessages ¶

type Validateworkplanmessages struct {
	// ViolationMessages - Messages for work plan violating some rules such as no shifts in a work plan
	ViolationMessages *[]Workplanconfigurationviolationmessage `json:"violationMessages,omitempty"`

	// ConstraintConflictMessage - This field is not null when there is a set of work plan constraints that conflict thus agent schedules cannot be generated
	ConstraintConflictMessage *Constraintconflictmessage `json:"constraintConflictMessage,omitempty"`
}

Validateworkplanmessages

func (*Validateworkplanmessages) String ¶

func (o *Validateworkplanmessages) String() string

String returns a JSON representation of the model

type Validateworkplanresponse ¶

type Validateworkplanresponse struct {
	// WorkPlan - The work plan reference associated with this response
	WorkPlan *Workplanreference `json:"workPlan,omitempty"`

	// Valid - Whether the work plan is valid or not
	Valid *bool `json:"valid,omitempty"`

	// Messages - Validation messages for this work plan
	Messages *Validateworkplanmessages `json:"messages,omitempty"`
}

Validateworkplanresponse

func (*Validateworkplanresponse) String ¶

func (o *Validateworkplanresponse) String() string

String returns a JSON representation of the model

type Validationlimits ¶

type Validationlimits struct {
	// MinLength
	MinLength *Minlength `json:"minLength,omitempty"`

	// MaxLength
	MaxLength *Maxlength `json:"maxLength,omitempty"`

	// MinItems
	MinItems *Minlength `json:"minItems,omitempty"`

	// MaxItems
	MaxItems *Maxlength `json:"maxItems,omitempty"`

	// Minimum
	Minimum *Minlength `json:"minimum,omitempty"`

	// Maximum
	Maximum *Maxlength `json:"maximum,omitempty"`
}

Validationlimits

func (*Validationlimits) String ¶

func (o *Validationlimits) String() string

String returns a JSON representation of the model

type Validationservicerequest ¶

type Validationservicerequest struct {
	// DateImportEnded - The last day of the data you are importing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DateImportEnded *time.Time `json:"dateImportEnded,omitempty"`

	// FileUrl - Path to the file in the storage including the file name
	FileUrl *string `json:"fileUrl,omitempty"`
}

Validationservicerequest

func (*Validationservicerequest) String ¶

func (o *Validationservicerequest) String() string

String returns a JSON representation of the model

type Valuewrapperdate ¶

type Valuewrapperdate struct {
	// Value - The value for the associated field. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Value *time.Time `json:"value,omitempty"`
}

Valuewrapperdate - An object to provide context to nullable fields in PATCH requests

func (*Valuewrapperdate) String ¶

func (o *Valuewrapperdate) String() string

String returns a JSON representation of the model

type Valuewrapperplanningperiodsettings ¶

type Valuewrapperplanningperiodsettings struct {
	// Value - The value for the associated field
	Value *Planningperiodsettings `json:"value,omitempty"`
}

Valuewrapperplanningperiodsettings - An object to provide context to nullable fields in PATCH requests

func (*Valuewrapperplanningperiodsettings) String ¶

String returns a JSON representation of the model

type Valuewrapperstring ¶

type Valuewrapperstring struct {
	// Value - The value for the associated field
	Value *string `json:"value,omitempty"`
}

Valuewrapperstring - An object to provide context to nullable fields in PATCH requests

func (*Valuewrapperstring) String ¶

func (o *Valuewrapperstring) String() string

String returns a JSON representation of the model

type Vendorconnectionrequest ¶

type Vendorconnectionrequest struct {
	// Publisher - Publisher of the integration or connector who registered the new connection. Typically, inin.
	Publisher *string `json:"publisher,omitempty"`

	// VarType - Integration or connector type that registered the new connection. Example, wfm-rta-integration
	VarType *string `json:"type,omitempty"`

	// Name - Name of the integration or connector instance that registered the new connection. Example, my-wfm
	Name *string `json:"name,omitempty"`
}

Vendorconnectionrequest

func (*Vendorconnectionrequest) String ¶

func (o *Vendorconnectionrequest) String() string

String returns a JSON representation of the model

type Verificationresult ¶

type Verificationresult struct {
	// Status - The verification status.
	Status *string `json:"status,omitempty"`

	// Records - The list of DNS records that pertain that need to exist for verification.
	Records *[]Record `json:"records,omitempty"`
}

Verificationresult

func (*Verificationresult) String ¶

func (o *Verificationresult) String() string

String returns a JSON representation of the model

type Video ¶

type Video 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"`

	// Context - The room id context (xmpp jid) for the conference session.
	Context *string `json:"context,omitempty"`

	// AudioMuted - Indicates whether this participant has muted their outgoing audio.
	AudioMuted *bool `json:"audioMuted,omitempty"`

	// VideoMuted - Indicates whether this participant has muted/paused their outgoing video.
	VideoMuted *bool `json:"videoMuted,omitempty"`

	// SharingScreen - Indicates whether this participant is sharing their screen to the session.
	SharingScreen *bool `json:"sharingScreen,omitempty"`

	// PeerCount - The number of peer participants from the perspective of the participant in the conference.
	PeerCount *int `json:"peerCount,omitempty"`

	// DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
	DisconnectType *string `json:"disconnectType,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 video.
	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"`

	// Msids - List of media stream ids
	Msids *[]string `json:"msids,omitempty"`

	// Self - Address and name data for a call endpoint.
	Self *Address `json:"self,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"`
}

Video

func (*Video) String ¶

func (o *Video) String() string

String returns a JSON representation of the model

type Viewfilter ¶

type Viewfilter struct {
	// MediaTypes - The media types are used to filter the view
	MediaTypes *[]string `json:"mediaTypes,omitempty"`

	// QueueIds - The queue ids are used to filter the view
	QueueIds *[]string `json:"queueIds,omitempty"`

	// SkillIds - The skill ids are used to filter the view
	SkillIds *[]string `json:"skillIds,omitempty"`

	// SkillGroups - The skill groups used to filter the view
	SkillGroups *[]string `json:"skillGroups,omitempty"`

	// LanguageIds - The language ids are used to filter the view
	LanguageIds *[]string `json:"languageIds,omitempty"`

	// LanguageGroups - The language groups used to filter the view
	LanguageGroups *[]string `json:"languageGroups,omitempty"`

	// Directions - The directions are used to filter the view
	Directions *[]string `json:"directions,omitempty"`

	// OriginatingDirections - The list of orginating directions used to filter the view
	OriginatingDirections *[]string `json:"originatingDirections,omitempty"`

	// WrapUpCodes - The wrap up codes are used to filter the view
	WrapUpCodes *[]string `json:"wrapUpCodes,omitempty"`

	// DnisList - The dnis list is used to filter the view
	DnisList *[]string `json:"dnisList,omitempty"`

	// SessionDnisList - The list of session dnis used to filter the view
	SessionDnisList *[]string `json:"sessionDnisList,omitempty"`

	// FilterQueuesByUserIds - The user ids are used to fetch associated queues for the view
	FilterQueuesByUserIds *[]string `json:"filterQueuesByUserIds,omitempty"`

	// FilterUsersByQueueIds - The queue ids are used to fetch associated users for the view
	FilterUsersByQueueIds *[]string `json:"filterUsersByQueueIds,omitempty"`

	// UserIds - The user ids are used to filter the view
	UserIds *[]string `json:"userIds,omitempty"`

	// AddressTos - The address To values are used to filter the view
	AddressTos *[]string `json:"addressTos,omitempty"`

	// AddressFroms - The address from values are used to filter the view
	AddressFroms *[]string `json:"addressFroms,omitempty"`

	// OutboundCampaignIds - The outbound campaign ids are used to filter the view
	OutboundCampaignIds *[]string `json:"outboundCampaignIds,omitempty"`

	// OutboundContactListIds - The outbound contact list ids are used to filter the view
	OutboundContactListIds *[]string `json:"outboundContactListIds,omitempty"`

	// ContactIds - The contact ids are used to filter the view
	ContactIds *[]string `json:"contactIds,omitempty"`

	// ExternalContactIds - The external contact ids are used to filter the view
	ExternalContactIds *[]string `json:"externalContactIds,omitempty"`

	// ExternalOrgIds - The external org ids are used to filter the view
	ExternalOrgIds *[]string `json:"externalOrgIds,omitempty"`

	// AniList - The ani list ids are used to filter the view
	AniList *[]string `json:"aniList,omitempty"`

	// DurationsMilliseconds - The durations in milliseconds used to filter the view
	DurationsMilliseconds *[]Numericrange `json:"durationsMilliseconds,omitempty"`

	// AcdDurationsMilliseconds - The acd durations in milliseconds used to filter the view
	AcdDurationsMilliseconds *[]Numericrange `json:"acdDurationsMilliseconds,omitempty"`

	// TalkDurationsMilliseconds - The talk durations in milliseconds used to filter the view
	TalkDurationsMilliseconds *[]Numericrange `json:"talkDurationsMilliseconds,omitempty"`

	// AcwDurationsMilliseconds - The acw durations in milliseconds used to filter the view
	AcwDurationsMilliseconds *[]Numericrange `json:"acwDurationsMilliseconds,omitempty"`

	// HandleDurationsMilliseconds - The handle durations in milliseconds used to filter the view
	HandleDurationsMilliseconds *[]Numericrange `json:"handleDurationsMilliseconds,omitempty"`

	// HoldDurationsMilliseconds - The hold durations in milliseconds used to filter the view
	HoldDurationsMilliseconds *[]Numericrange `json:"holdDurationsMilliseconds,omitempty"`

	// AbandonDurationsMilliseconds - The abandon durations in milliseconds used to filter the view
	AbandonDurationsMilliseconds *[]Numericrange `json:"abandonDurationsMilliseconds,omitempty"`

	// EvaluationScore - The evaluationScore is used to filter the view
	EvaluationScore *Numericrange `json:"evaluationScore,omitempty"`

	// EvaluationCriticalScore - The evaluationCriticalScore is used to filter the view
	EvaluationCriticalScore *Numericrange `json:"evaluationCriticalScore,omitempty"`

	// EvaluationFormIds - The evaluation form ids are used to filter the view
	EvaluationFormIds *[]string `json:"evaluationFormIds,omitempty"`

	// EvaluatedAgentIds - The evaluated agent ids are used to filter the view
	EvaluatedAgentIds *[]string `json:"evaluatedAgentIds,omitempty"`

	// EvaluatorIds - The evaluator ids are used to filter the view
	EvaluatorIds *[]string `json:"evaluatorIds,omitempty"`

	// Transferred - Indicates filtering for transfers
	Transferred *bool `json:"transferred,omitempty"`

	// Abandoned - Indicates filtering for abandons
	Abandoned *bool `json:"abandoned,omitempty"`

	// Answered - Indicates filtering for answered interactions
	Answered *bool `json:"answered,omitempty"`

	// MessageTypes - The message media types used to filter the view
	MessageTypes *[]string `json:"messageTypes,omitempty"`

	// DivisionIds - The divison Ids used to filter the view
	DivisionIds *[]string `json:"divisionIds,omitempty"`

	// SurveyFormIds - The survey form ids used to filter the view
	SurveyFormIds *[]string `json:"surveyFormIds,omitempty"`

	// SurveyTotalScore - The survey total score used to filter the view
	SurveyTotalScore *Numericrange `json:"surveyTotalScore,omitempty"`

	// SurveyNpsScore - The survey NPS score used to filter the view
	SurveyNpsScore *Numericrange `json:"surveyNpsScore,omitempty"`

	// Mos - The desired range for mos values
	Mos *Numericrange `json:"mos,omitempty"`

	// SurveyQuestionGroupScore - The survey question group score used to filter the view
	SurveyQuestionGroupScore *Numericrange `json:"surveyQuestionGroupScore,omitempty"`

	// SurveyPromoterScore - The survey promoter score used to filter the view
	SurveyPromoterScore *Numericrange `json:"surveyPromoterScore,omitempty"`

	// SurveyFormContextIds - The list of survey form context ids used to filter the view
	SurveyFormContextIds *[]string `json:"surveyFormContextIds,omitempty"`

	// ConversationIds - The list of conversation ids used to filter the view
	ConversationIds *[]string `json:"conversationIds,omitempty"`

	// SipCallIds - The list of SIP call ids used to filter the view
	SipCallIds *[]string `json:"sipCallIds,omitempty"`

	// IsEnded - Indicates filtering for ended
	IsEnded *bool `json:"isEnded,omitempty"`

	// IsSurveyed - Indicates filtering for survey
	IsSurveyed *bool `json:"isSurveyed,omitempty"`

	// SurveyScores - The list of survey score ranges used to filter the view
	SurveyScores *[]Numericrange `json:"surveyScores,omitempty"`

	// PromoterScores - The list of promoter score ranges used to filter the view
	PromoterScores *[]Numericrange `json:"promoterScores,omitempty"`

	// IsCampaign - Indicates filtering for campaign
	IsCampaign *bool `json:"isCampaign,omitempty"`

	// SurveyStatuses - The list of survey statuses used to filter the view
	SurveyStatuses *[]string `json:"surveyStatuses,omitempty"`

	// ConversationProperties - A grouping of conversation level filters
	ConversationProperties *Conversationproperties `json:"conversationProperties,omitempty"`

	// IsBlindTransferred - Indicates filtering for blind transferred
	IsBlindTransferred *bool `json:"isBlindTransferred,omitempty"`

	// IsConsulted - Indicates filtering for consulted
	IsConsulted *bool `json:"isConsulted,omitempty"`

	// IsConsultTransferred - Indicates filtering for consult transferred
	IsConsultTransferred *bool `json:"isConsultTransferred,omitempty"`

	// RemoteParticipants - The list of remote participants used to filter the view
	RemoteParticipants *[]string `json:"remoteParticipants,omitempty"`

	// FlowIds - The list of flow Ids
	FlowIds *[]string `json:"flowIds,omitempty"`

	// FlowOutcomeIds - A list of outcome ids of the flow
	FlowOutcomeIds *[]string `json:"flowOutcomeIds,omitempty"`

	// FlowOutcomeValues - A list of outcome values of the flow
	FlowOutcomeValues *[]string `json:"flowOutcomeValues,omitempty"`

	// FlowDestinationTypes - The list of destination types of the flow
	FlowDestinationTypes *[]string `json:"flowDestinationTypes,omitempty"`

	// FlowDisconnectReasons - The list of reasons for the flow to disconnect
	FlowDisconnectReasons *[]string `json:"flowDisconnectReasons,omitempty"`

	// FlowTypes - A list of types of the flow
	FlowTypes *[]string `json:"flowTypes,omitempty"`

	// FlowEntryTypes - A list of types of the flow entry
	FlowEntryTypes *[]string `json:"flowEntryTypes,omitempty"`

	// FlowEntryReasons - A list of reasons of flow entry
	FlowEntryReasons *[]string `json:"flowEntryReasons,omitempty"`

	// FlowVersions - A list of versions of a flow
	FlowVersions *[]string `json:"flowVersions,omitempty"`

	// GroupIds - A list of directory group ids
	GroupIds *[]string `json:"groupIds,omitempty"`

	// HasJourneyCustomerId - Indicates filtering for journey customer id
	HasJourneyCustomerId *bool `json:"hasJourneyCustomerId,omitempty"`

	// HasJourneyActionMapId - Indicates filtering for Journey action map id
	HasJourneyActionMapId *bool `json:"hasJourneyActionMapId,omitempty"`

	// HasJourneyVisitId - Indicates filtering for Journey visit id
	HasJourneyVisitId *bool `json:"hasJourneyVisitId,omitempty"`

	// HasMedia - Indicates filtering for presence of MMS media
	HasMedia *bool `json:"hasMedia,omitempty"`

	// RoleIds - The role Ids used to filter the view
	RoleIds *[]string `json:"roleIds,omitempty"`

	// ReportsTos - The report to user IDs used to filter the view
	ReportsTos *[]string `json:"reportsTos,omitempty"`

	// LocationIds - The location Ids used to filter the view
	LocationIds *[]string `json:"locationIds,omitempty"`

	// FlowOutTypes - A list of flow out types
	FlowOutTypes *[]string `json:"flowOutTypes,omitempty"`

	// ProviderList - A list of providers
	ProviderList *[]string `json:"providerList,omitempty"`

	// CallbackNumberList - A list of callback numbers or substrings of numbers (ex: [\"317\", \"13172222222\"])
	CallbackNumberList *[]string `json:"callbackNumberList,omitempty"`

	// CallbackInterval - An interval of time to filter for scheduled callbacks. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
	CallbackInterval *string `json:"callbackInterval,omitempty"`

	// UsedRoutingTypes - A list of routing types used
	UsedRoutingTypes *[]string `json:"usedRoutingTypes,omitempty"`

	// RequestedRoutingTypes - A list of routing types requested
	RequestedRoutingTypes *[]string `json:"requestedRoutingTypes,omitempty"`

	// HasAgentAssistId - Indicates filtering for agent assist id
	HasAgentAssistId *bool `json:"hasAgentAssistId,omitempty"`

	// Transcripts - A list of transcript contents requested
	Transcripts *[]Transcripts `json:"transcripts,omitempty"`

	// TranscriptLanguages - A list of transcript languages requested
	TranscriptLanguages *[]string `json:"transcriptLanguages,omitempty"`

	// ParticipantPurposes - A list of participant purpose requested
	ParticipantPurposes *[]string `json:"participantPurposes,omitempty"`

	// ShowFirstQueue - Indicates filtering for first queue data
	ShowFirstQueue *bool `json:"showFirstQueue,omitempty"`

	// TeamIds - The team ids used to filter the view data
	TeamIds *[]string `json:"teamIds,omitempty"`

	// FilterUsersByTeamIds - The team ids are used to fetch associated users for the view
	FilterUsersByTeamIds *[]string `json:"filterUsersByTeamIds,omitempty"`

	// JourneyActionMapIds - The journey action map ids are used to fetch action maps for the associated view
	JourneyActionMapIds *[]string `json:"journeyActionMapIds,omitempty"`

	// JourneyOutcomeIds - The journey outcome ids are used to fetch outcomes for the associated view
	JourneyOutcomeIds *[]string `json:"journeyOutcomeIds,omitempty"`

	// JourneySegmentIds - The journey segment ids are used to fetch segments for the associated view
	JourneySegmentIds *[]string `json:"journeySegmentIds,omitempty"`

	// JourneyActionMapTypes - The journey action map types are used to filter action map data for the associated view
	JourneyActionMapTypes *[]string `json:"journeyActionMapTypes,omitempty"`

	// DevelopmentRoleList - The list of development roles used to filter agent development view
	DevelopmentRoleList *[]string `json:"developmentRoleList,omitempty"`

	// DevelopmentTypeList - The list of development types used to filter agent development view
	DevelopmentTypeList *[]string `json:"developmentTypeList,omitempty"`

	// DevelopmentStatusList - The list of development status used to filter agent development view
	DevelopmentStatusList *[]string `json:"developmentStatusList,omitempty"`

	// DevelopmentModuleIds - The list of development moduleIds used to filter agent development view
	DevelopmentModuleIds *[]string `json:"developmentModuleIds,omitempty"`

	// DevelopmentActivityOverdue - Indicates filtering for development activities
	DevelopmentActivityOverdue *bool `json:"developmentActivityOverdue,omitempty"`

	// CustomerSentimentScore - The customer sentiment score used to filter the view
	CustomerSentimentScore *Numericrange `json:"customerSentimentScore,omitempty"`

	// CustomerSentimentTrend - The customer sentiment trend used to filter the view
	CustomerSentimentTrend *Numericrange `json:"customerSentimentTrend,omitempty"`

	// FlowTransferTargets - The list of transfer targets used to filter flow data
	FlowTransferTargets *[]string `json:"flowTransferTargets,omitempty"`

	// DevelopmentName - Filter for development name
	DevelopmentName *string `json:"developmentName,omitempty"`

	// TopicIds - Represents the topics detected in the transcript
	TopicIds *[]string `json:"topicIds,omitempty"`

	// ExternalTags - The list of external Tags used to filter conversation data
	ExternalTags *[]string `json:"externalTags,omitempty"`

	// IsNotResponding - Indicates filtering for not responding users
	IsNotResponding *bool `json:"isNotResponding,omitempty"`

	// IsAuthenticated - Indicates filtering for the authenticated chat
	IsAuthenticated *bool `json:"isAuthenticated,omitempty"`
}

Viewfilter

func (*Viewfilter) String ¶

func (o *Viewfilter) String() string

String returns a JSON representation of the model

type Visibilitycondition ¶

type Visibilitycondition struct {
	// CombiningOperation
	CombiningOperation *string `json:"combiningOperation,omitempty"`

	// Predicates - A list of strings, each representing the location in the form of the Answer Option to depend on. In the format of \"/form/questionGroup/{questionGroupIndex}/question/{questionIndex}/answer/{answerIndex}\" or, to assume the current question group, \"../question/{questionIndex}/answer/{answerIndex}\". Note: Indexes are zero-based
	Predicates *[]interface{} `json:"predicates,omitempty"`
}

Visibilitycondition

func (*Visibilitycondition) String ¶

func (o *Visibilitycondition) String() string

String returns a JSON representation of the model

type Vmpairinginfo ¶

type Vmpairinginfo struct {
	// MetaData - This is to be used to complete the setup process of a locally deployed virtual edge device.
	MetaData *Metadata `json:"meta-data,omitempty"`

	// EdgeId
	EdgeId *string `json:"edge-id,omitempty"`

	// AuthToken
	AuthToken *string `json:"auth-token,omitempty"`

	// OrgId
	OrgId *string `json:"org-id,omitempty"`
}

Vmpairinginfo

func (*Vmpairinginfo) String ¶

func (o *Vmpairinginfo) String() string

String returns a JSON representation of the model

type Voicemail ¶

type Voicemail struct {
	// Id - The voicemail id
	Id *string `json:"id,omitempty"`

	// UploadStatus - current state of the voicemail upload
	UploadStatus *string `json:"uploadStatus,omitempty"`
}

Voicemail

func (*Voicemail) String ¶

func (o *Voicemail) String() string

String returns a JSON representation of the model

type VoicemailApi ¶

type VoicemailApi struct {
	Configuration *Configuration
}

VoicemailApi provides functions for API endpoints

func NewVoicemailApi ¶

func NewVoicemailApi() *VoicemailApi

NewVoicemailApi creates an API instance using the default configuration

func NewVoicemailApiWithConfig ¶

func NewVoicemailApiWithConfig(config *Configuration) *VoicemailApi

NewVoicemailApiWithConfig creates an API instance using the provided configuration

func (VoicemailApi) DeleteVoicemailMessage ¶

func (a VoicemailApi) DeleteVoicemailMessage(messageId string) (*APIResponse, error)

DeleteVoicemailMessage invokes DELETE /api/v2/voicemail/messages/{messageId}

Delete a voicemail message.

A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission.

func (VoicemailApi) DeleteVoicemailMessages ¶

func (a VoicemailApi) DeleteVoicemailMessages() (*APIResponse, error)

DeleteVoicemailMessages invokes DELETE /api/v2/voicemail/messages

Delete all voicemail messages

func (VoicemailApi) GetVoicemailGroupMailbox ¶

func (a VoicemailApi) GetVoicemailGroupMailbox(groupId string) (*Voicemailmailboxinfo, *APIResponse, error)

GetVoicemailGroupMailbox invokes GET /api/v2/voicemail/groups/{groupId}/mailbox

Get the group&#39;s mailbox information

func (VoicemailApi) GetVoicemailGroupMessages ¶

func (a VoicemailApi) GetVoicemailGroupMessages(groupId string, pageSize int, pageNumber int) (*Voicemailmessageentitylisting, *APIResponse, error)

GetVoicemailGroupMessages invokes GET /api/v2/voicemail/groups/{groupId}/messages

List voicemail messages

func (VoicemailApi) GetVoicemailGroupPolicy ¶

func (a VoicemailApi) GetVoicemailGroupPolicy(groupId string) (*Voicemailgrouppolicy, *APIResponse, error)

GetVoicemailGroupPolicy invokes GET /api/v2/voicemail/groups/{groupId}/policy

Get a group&#39;s voicemail policy

func (VoicemailApi) GetVoicemailMailbox ¶

func (a VoicemailApi) GetVoicemailMailbox() (*Voicemailmailboxinfo, *APIResponse, error)

GetVoicemailMailbox invokes GET /api/v2/voicemail/mailbox

Get the current user&#39;s mailbox information

func (VoicemailApi) GetVoicemailMeMailbox ¶

func (a VoicemailApi) GetVoicemailMeMailbox() (*Voicemailmailboxinfo, *APIResponse, error)

GetVoicemailMeMailbox invokes GET /api/v2/voicemail/me/mailbox

Get the current user&#39;s mailbox information

func (VoicemailApi) GetVoicemailMeMessages ¶

func (a VoicemailApi) GetVoicemailMeMessages(pageSize int, pageNumber int) (*Voicemailmessageentitylisting, *APIResponse, error)

GetVoicemailMeMessages invokes GET /api/v2/voicemail/me/messages

List voicemail messages

func (VoicemailApi) GetVoicemailMePolicy ¶

func (a VoicemailApi) GetVoicemailMePolicy() (*Voicemailuserpolicy, *APIResponse, error)

GetVoicemailMePolicy invokes GET /api/v2/voicemail/me/policy

Get the current user&#39;s voicemail policy

func (VoicemailApi) GetVoicemailMessage ¶

func (a VoicemailApi) GetVoicemailMessage(messageId string, expand []string) (*Voicemailmessage, *APIResponse, error)

GetVoicemailMessage invokes GET /api/v2/voicemail/messages/{messageId}

Get a voicemail message

func (VoicemailApi) GetVoicemailMessageMedia ¶

func (a VoicemailApi) GetVoicemailMessageMedia(messageId string, formatId string) (*Voicemailmediainfo, *APIResponse, error)

GetVoicemailMessageMedia invokes GET /api/v2/voicemail/messages/{messageId}/media

Get media playback URI for this voicemail message

func (VoicemailApi) GetVoicemailMessages ¶

func (a VoicemailApi) GetVoicemailMessages(ids string, expand []string) (*Voicemailmessageentitylisting, *APIResponse, error)

GetVoicemailMessages invokes GET /api/v2/voicemail/messages

List voicemail messages

func (VoicemailApi) GetVoicemailPolicy ¶

func (a VoicemailApi) GetVoicemailPolicy() (*Voicemailorganizationpolicy, *APIResponse, error)

GetVoicemailPolicy invokes GET /api/v2/voicemail/policy

Get a policy

func (VoicemailApi) GetVoicemailQueueMessages ¶

func (a VoicemailApi) GetVoicemailQueueMessages(queueId string, pageSize int, pageNumber int) (*Voicemailmessageentitylisting, *APIResponse, error)

GetVoicemailQueueMessages invokes GET /api/v2/voicemail/queues/{queueId}/messages

List voicemail messages

func (VoicemailApi) GetVoicemailSearch ¶

func (a VoicemailApi) GetVoicemailSearch(q64 string, expand []string) (*Voicemailssearchresponse, *APIResponse, error)

GetVoicemailSearch invokes GET /api/v2/voicemail/search

Search voicemails using the q64 value returned from a previous search

func (VoicemailApi) GetVoicemailUserpolicy ¶

func (a VoicemailApi) GetVoicemailUserpolicy(userId string) (*Voicemailuserpolicy, *APIResponse, error)

GetVoicemailUserpolicy invokes GET /api/v2/voicemail/userpolicies/{userId}

Get a user&#39;s voicemail policy

func (VoicemailApi) PatchVoicemailGroupPolicy ¶

func (a VoicemailApi) PatchVoicemailGroupPolicy(groupId string, body Voicemailgrouppolicy) (*Voicemailgrouppolicy, *APIResponse, error)

PatchVoicemailGroupPolicy invokes PATCH /api/v2/voicemail/groups/{groupId}/policy

Update a group&#39;s voicemail policy

func (VoicemailApi) PatchVoicemailMePolicy ¶

func (a VoicemailApi) PatchVoicemailMePolicy(body Voicemailuserpolicy) (*Voicemailuserpolicy, *APIResponse, error)

PatchVoicemailMePolicy invokes PATCH /api/v2/voicemail/me/policy

Update the current user&#39;s voicemail policy

func (VoicemailApi) PatchVoicemailMessage ¶

func (a VoicemailApi) PatchVoicemailMessage(messageId string, body Voicemailmessage) (*Voicemailmessage, *APIResponse, error)

PatchVoicemailMessage invokes PATCH /api/v2/voicemail/messages/{messageId}

Update a voicemail message ¶

A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.

func (VoicemailApi) PatchVoicemailUserpolicy ¶

func (a VoicemailApi) PatchVoicemailUserpolicy(userId string, body Voicemailuserpolicy) (*Voicemailuserpolicy, *APIResponse, error)

PatchVoicemailUserpolicy invokes PATCH /api/v2/voicemail/userpolicies/{userId}

Update a user&#39;s voicemail policy

func (VoicemailApi) PostVoicemailMessages ¶

func (a VoicemailApi) PostVoicemailMessages(body Copyvoicemailmessage) (*Voicemailmessage, *APIResponse, error)

PostVoicemailMessages invokes POST /api/v2/voicemail/messages

Copy a voicemail message to a user or group

func (VoicemailApi) PostVoicemailSearch ¶

PostVoicemailSearch invokes POST /api/v2/voicemail/search

Search voicemails

func (VoicemailApi) PutVoicemailMessage ¶

func (a VoicemailApi) PutVoicemailMessage(messageId string, body Voicemailmessage) (*Voicemailmessage, *APIResponse, error)

PutVoicemailMessage invokes PUT /api/v2/voicemail/messages/{messageId}

Update a voicemail message ¶

A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.

func (VoicemailApi) PutVoicemailPolicy ¶

PutVoicemailPolicy invokes PUT /api/v2/voicemail/policy

Update a policy

type Voicemailcopyrecord ¶

type Voicemailcopyrecord struct {
	// User - The user that the voicemail message was copied to/from
	User *User `json:"user,omitempty"`

	// Group - The group that the voicemail message was copied to/from
	Group *Group `json:"group,omitempty"`

	// Date - The date when the voicemail was copied. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Date *time.Time `json:"date,omitempty"`
}

Voicemailcopyrecord

func (*Voicemailcopyrecord) String ¶

func (o *Voicemailcopyrecord) String() string

String returns a JSON representation of the model

type Voicemailgrouppolicy ¶

type Voicemailgrouppolicy struct {
	// Name
	Name *string `json:"name,omitempty"`

	// Group - The group associated with the policy
	Group *Group `json:"group,omitempty"`

	// Enabled - Whether voicemail is enabled for the group
	Enabled *bool `json:"enabled,omitempty"`

	// SendEmailNotifications - Whether email notifications are sent to group members when a new voicemail is received
	SendEmailNotifications *bool `json:"sendEmailNotifications,omitempty"`

	// DisableEmailPii - Removes any PII from group emails. This is overridden by the analogous organization configuration value. This is always true if HIPAA is enabled or unknown for an organization.
	DisableEmailPii *bool `json:"disableEmailPii,omitempty"`

	// RotateCallsSecs - How many seconds to ring before rotating to the next member in the group
	RotateCallsSecs *int `json:"rotateCallsSecs,omitempty"`

	// StopRingingAfterRotations - How many rotations to go through
	StopRingingAfterRotations *int `json:"stopRingingAfterRotations,omitempty"`

	// OverflowGroupId -  A fallback group to contact when all of the members in this group did not answer the call.
	OverflowGroupId *string `json:"overflowGroupId,omitempty"`

	// GroupAlertType - Specifies if the members in this group should be contacted randomly, in a specific order, or by round-robin.
	GroupAlertType *string `json:"groupAlertType,omitempty"`
}

Voicemailgrouppolicy

func (*Voicemailgrouppolicy) String ¶

func (o *Voicemailgrouppolicy) String() string

String returns a JSON representation of the model

type Voicemailmailboxinfo ¶

type Voicemailmailboxinfo struct {
	// UsageSizeBytes - The total number of bytes for all voicemail message audio recordings
	UsageSizeBytes *int `json:"usageSizeBytes,omitempty"`

	// TotalCount - The total number of voicemail messages
	TotalCount *int `json:"totalCount,omitempty"`

	// UnreadCount - The total number of voicemail messages marked as unread
	UnreadCount *int `json:"unreadCount,omitempty"`

	// DeletedCount - The total number of voicemail messages marked as deleted
	DeletedCount *int `json:"deletedCount,omitempty"`

	// CreatedDate - The date of the oldest voicemail message. 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 of the most recent voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	ModifiedDate *time.Time `json:"modifiedDate,omitempty"`
}

Voicemailmailboxinfo

func (*Voicemailmailboxinfo) String ¶

func (o *Voicemailmailboxinfo) String() string

String returns a JSON representation of the model

type Voicemailmediainfo ¶

type Voicemailmediainfo struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// MediaFileUri
	MediaFileUri *string `json:"mediaFileUri,omitempty"`

	// MediaImageUri
	MediaImageUri *string `json:"mediaImageUri,omitempty"`

	// WaveformData
	WaveformData *[]float32 `json:"waveformData,omitempty"`
}

Voicemailmediainfo

func (*Voicemailmediainfo) String ¶

func (o *Voicemailmediainfo) String() string

String returns a JSON representation of the model

type Voicemailmessage ¶

type Voicemailmessage struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Conversation - The conversation that the voicemail message is associated with
	Conversation *Conversation `json:"conversation,omitempty"`

	// Read - Whether the voicemail message is marked as read
	Read *bool `json:"read,omitempty"`

	// AudioRecordingDurationSeconds - The voicemail message's audio recording duration in seconds
	AudioRecordingDurationSeconds *int `json:"audioRecordingDurationSeconds,omitempty"`

	// AudioRecordingSizeBytes - The voicemail message's audio recording size in bytes
	AudioRecordingSizeBytes *int `json:"audioRecordingSizeBytes,omitempty"`

	// CreatedDate - The date the voicemail message 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 voicemail message 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"`

	// DeletedDate - The date the voicemail message deleted property was set to true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	DeletedDate *time.Time `json:"deletedDate,omitempty"`

	// CallerAddress - The caller address
	CallerAddress *string `json:"callerAddress,omitempty"`

	// CallerName - Optionally the name of the caller that left the voicemail message if the caller was a known user
	CallerName *string `json:"callerName,omitempty"`

	// CallerUser - Optionally the user that left the voicemail message if the caller was a known user
	CallerUser *User `json:"callerUser,omitempty"`

	// Deleted - Whether the voicemail message has been marked as deleted
	Deleted *bool `json:"deleted,omitempty"`

	// Note - An optional note
	Note *string `json:"note,omitempty"`

	// User - The user that the voicemail message belongs to or null which means the voicemail message belongs to a group or queue
	User *User `json:"user,omitempty"`

	// Group - The group that the voicemail message belongs to or null which means the voicemail message belongs to a user or queue
	Group *Group `json:"group,omitempty"`

	// Queue - The queue that the voicemail message belongs to or null which means the voicemail message belongs to a user or group
	Queue *Queue `json:"queue,omitempty"`

	// CopiedFrom - Represents where this voicemail message was copied from
	CopiedFrom *Voicemailcopyrecord `json:"copiedFrom,omitempty"`

	// CopiedTo - Represents where this voicemail has been copied to
	CopiedTo *[]Voicemailcopyrecord `json:"copiedTo,omitempty"`

	// DeleteRetentionPolicy - The retention policy for this voicemail when deleted is set to true
	DeleteRetentionPolicy *Voicemailretentionpolicy `json:"deleteRetentionPolicy,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Voicemailmessage

func (*Voicemailmessage) String ¶

func (o *Voicemailmessage) String() string

String returns a JSON representation of the model

type Voicemailmessageentitylisting ¶

type Voicemailmessageentitylisting struct {
	// Entities
	Entities *[]Voicemailmessage `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Voicemailmessageentitylisting

func (*Voicemailmessageentitylisting) String ¶

String returns a JSON representation of the model

type Voicemailmessagestopicowner ¶

type Voicemailmessagestopicowner struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Voicemailmessagestopicowner

func (*Voicemailmessagestopicowner) String ¶

func (o *Voicemailmessagestopicowner) String() string

String returns a JSON representation of the model

type Voicemailmessagestopicvoicemailcopyrecord ¶

type Voicemailmessagestopicvoicemailcopyrecord struct {
	// User
	User *Voicemailmessagestopicowner `json:"user,omitempty"`

	// Group
	Group *Voicemailmessagestopicowner `json:"group,omitempty"`
}

Voicemailmessagestopicvoicemailcopyrecord

func (*Voicemailmessagestopicvoicemailcopyrecord) String ¶

String returns a JSON representation of the model

type Voicemailmessagestopicvoicemailmessage ¶

type Voicemailmessagestopicvoicemailmessage struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Read
	Read *bool `json:"read,omitempty"`

	// AudioRecordingDurationSeconds
	AudioRecordingDurationSeconds *int `json:"audioRecordingDurationSeconds,omitempty"`

	// AudioRecordingSizeBytes
	AudioRecordingSizeBytes *int `json:"audioRecordingSizeBytes,omitempty"`

	// CreatedDate
	CreatedDate *time.Time `json:"createdDate,omitempty"`

	// ModifiedDate
	ModifiedDate *time.Time `json:"modifiedDate,omitempty"`

	// CallerAddress
	CallerAddress *string `json:"callerAddress,omitempty"`

	// CallerName
	CallerName *string `json:"callerName,omitempty"`

	// Action
	Action *string `json:"action,omitempty"`

	// Note
	Note *string `json:"note,omitempty"`

	// Deleted
	Deleted *bool `json:"deleted,omitempty"`

	// ModifiedByUserId
	ModifiedByUserId *string `json:"modifiedByUserId,omitempty"`

	// CopiedTo
	CopiedTo *[]Voicemailmessagestopicvoicemailcopyrecord `json:"copiedTo,omitempty"`

	// CopiedFrom
	CopiedFrom *Voicemailmessagestopicvoicemailcopyrecord `json:"copiedFrom,omitempty"`
}

Voicemailmessagestopicvoicemailmessage

func (*Voicemailmessagestopicvoicemailmessage) String ¶

String returns a JSON representation of the model

type Voicemailorganizationpolicy ¶

type Voicemailorganizationpolicy struct {
	// Enabled - Whether voicemail is enable for this organization
	Enabled *bool `json:"enabled,omitempty"`

	// AlertTimeoutSeconds - The organization's default number of seconds to ring a user's phone before a call is transfered to voicemail
	AlertTimeoutSeconds *int `json:"alertTimeoutSeconds,omitempty"`

	// PinConfiguration - The configuration for user PINs to access their voicemail from a phone
	PinConfiguration *Pinconfiguration `json:"pinConfiguration,omitempty"`

	// VoicemailExtension - The extension for voicemail retrieval.  The default value is *86.
	VoicemailExtension *string `json:"voicemailExtension,omitempty"`

	// PinRequired - If this is true, a PIN is required when accessing a user's voicemail from a phone.
	PinRequired *bool `json:"pinRequired,omitempty"`

	// SendEmailNotifications - Whether email notifications are sent for new voicemails in the organization. If false, new voicemail email notifications are not be sent for the organization overriding any user or group setting.
	SendEmailNotifications *bool `json:"sendEmailNotifications,omitempty"`

	// DisableEmailPii - Removes any PII from emails. This overrides any analogous group configuration value. This is always true if HIPAA is enabled or unknown for an organization.
	DisableEmailPii *bool `json:"disableEmailPii,omitempty"`

	// ModifiedDate - The date the policy 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"`
}

Voicemailorganizationpolicy

func (*Voicemailorganizationpolicy) String ¶

func (o *Voicemailorganizationpolicy) String() string

String returns a JSON representation of the model

type Voicemailretentionpolicy ¶

type Voicemailretentionpolicy struct {
	// VoicemailRetentionPolicyType - The retention policy type
	VoicemailRetentionPolicyType *string `json:"voicemailRetentionPolicyType,omitempty"`

	// NumberOfDays - If retentionPolicyType == RETAIN_WITH_TTL, then this value represents the number of days for the TTL
	NumberOfDays *int `json:"numberOfDays,omitempty"`
}

Voicemailretentionpolicy - Governs how the voicemail is retained

func (*Voicemailretentionpolicy) String ¶

func (o *Voicemailretentionpolicy) String() string

String returns a JSON representation of the model

type Voicemailsearchcriteria ¶

type Voicemailsearchcriteria struct {
	// EndValue - The end value of the range. This field is used for range search types.
	EndValue *string `json:"endValue,omitempty"`

	// Values - A list of values for the search to match against
	Values *[]string `json:"values,omitempty"`

	// StartValue - The start value of the range. This field is used for range search types.
	StartValue *string `json:"startValue,omitempty"`

	// Fields - Field names to search against
	Fields *[]string `json:"fields,omitempty"`

	// Value - A value for the search to match against
	Value *string `json:"value,omitempty"`

	// Operator - How to apply this search criteria against other criteria
	Operator *string `json:"operator,omitempty"`

	// Group - Groups multiple conditions
	Group *[]Voicemailsearchcriteria `json:"group,omitempty"`

	// DateFormat - Set date format for criteria values when using date range search type.  Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX.
	DateFormat *string `json:"dateFormat,omitempty"`

	// VarType - Search Type
	VarType *string `json:"type,omitempty"`
}

Voicemailsearchcriteria

func (*Voicemailsearchcriteria) String ¶

func (o *Voicemailsearchcriteria) String() string

String returns a JSON representation of the model

type Voicemailsearchrequest ¶

type Voicemailsearchrequest struct {
	// SortOrder - The sort order for results
	SortOrder *string `json:"sortOrder,omitempty"`

	// SortBy - The field in the resource that you want to sort the results by
	SortBy *string `json:"sortBy,omitempty"`

	// PageSize - The number of results per page
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The page of resources you want to retrieve
	PageNumber *int `json:"pageNumber,omitempty"`

	// Sort - Multi-value sort order, list of multiple sort values
	Sort *[]Searchsort `json:"sort,omitempty"`

	// Expand - Provides more details about a specified resource
	Expand *[]string `json:"expand,omitempty"`

	// Query
	Query *[]Voicemailsearchcriteria `json:"query,omitempty"`
}

Voicemailsearchrequest

func (*Voicemailsearchrequest) String ¶

func (o *Voicemailsearchrequest) String() string

String returns a JSON representation of the model

type Voicemailssearchresponse ¶

type Voicemailssearchresponse struct {
	// Total - The total number of results found
	Total *int `json:"total,omitempty"`

	// PageCount - The total number of pages
	PageCount *int `json:"pageCount,omitempty"`

	// PageSize - The current page size
	PageSize *int `json:"pageSize,omitempty"`

	// PageNumber - The current page number
	PageNumber *int `json:"pageNumber,omitempty"`

	// PreviousPage - Q64 value for the previous page of results
	PreviousPage *string `json:"previousPage,omitempty"`

	// CurrentPage - Q64 value for the current page of results
	CurrentPage *string `json:"currentPage,omitempty"`

	// NextPage - Q64 value for the next page of results
	NextPage *string `json:"nextPage,omitempty"`

	// Types - Resource types the search was performed against
	Types *[]string `json:"types,omitempty"`

	// Results - Search results
	Results *[]Voicemailmessage `json:"results,omitempty"`
}

Voicemailssearchresponse

func (*Voicemailssearchresponse) String ¶

func (o *Voicemailssearchresponse) String() string

String returns a JSON representation of the model

type Voicemailuserpolicy ¶

type Voicemailuserpolicy struct {
	// Enabled - Whether the user has voicemail enabled
	Enabled *bool `json:"enabled,omitempty"`

	// AlertTimeoutSeconds - The number of seconds to ring the user's phone before a call is transfered to voicemail
	AlertTimeoutSeconds *int `json:"alertTimeoutSeconds,omitempty"`

	// Pin - The user's PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security
	Pin *string `json:"pin,omitempty"`

	// ModifiedDate - The date the policy 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"`

	// SendEmailNotifications - Whether email notifications are sent to the user when a new voicemail is received
	SendEmailNotifications *bool `json:"sendEmailNotifications,omitempty"`
}

Voicemailuserpolicy

func (*Voicemailuserpolicy) String ¶

func (o *Voicemailuserpolicy) String() string

String returns a JSON representation of the model

type Void ¶

type Void struct{}

Void

func (*Void) String ¶

func (o *Void) String() string

String returns a JSON representation of the model

type WebChatApi ¶

type WebChatApi struct {
	Configuration *Configuration
}

WebChatApi provides functions for API endpoints

func NewWebChatApi ¶

func NewWebChatApi() *WebChatApi

NewWebChatApi creates an API instance using the default configuration

func NewWebChatApiWithConfig ¶

func NewWebChatApiWithConfig(config *Configuration) *WebChatApi

NewWebChatApiWithConfig creates an API instance using the provided configuration

func (WebChatApi) DeleteWebchatDeployment ¶

func (a WebChatApi) DeleteWebchatDeployment(deploymentId string) (*APIResponse, error)

DeleteWebchatDeployment invokes DELETE /api/v2/webchat/deployments/{deploymentId}

Delete a WebChat deployment

func (WebChatApi) DeleteWebchatGuestConversationMember ¶

func (a WebChatApi) DeleteWebchatGuestConversationMember(conversationId string, memberId string) (*APIResponse, error)

DeleteWebchatGuestConversationMember invokes DELETE /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}

Remove a member from a chat conversation

func (WebChatApi) DeleteWebchatSettings ¶

func (a WebChatApi) DeleteWebchatSettings() (*APIResponse, error)

DeleteWebchatSettings invokes DELETE /api/v2/webchat/settings

Remove WebChat deployment settings

func (WebChatApi) GetWebchatDeployment ¶

func (a WebChatApi) GetWebchatDeployment(deploymentId string) (*Webchatdeployment, *APIResponse, error)

GetWebchatDeployment invokes GET /api/v2/webchat/deployments/{deploymentId}

Get a WebChat deployment

func (WebChatApi) GetWebchatDeployments ¶

func (a WebChatApi) GetWebchatDeployments() (*Webchatdeploymententitylisting, *APIResponse, error)

GetWebchatDeployments invokes GET /api/v2/webchat/deployments

List WebChat deployments

func (WebChatApi) GetWebchatGuestConversationMediarequest ¶

func (a WebChatApi) GetWebchatGuestConversationMediarequest(conversationId string, mediaRequestId string) (*Webchatguestmediarequest, *APIResponse, error)

GetWebchatGuestConversationMediarequest invokes GET /api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}

Get a media request in the conversation

func (WebChatApi) GetWebchatGuestConversationMediarequests ¶

func (a WebChatApi) GetWebchatGuestConversationMediarequests(conversationId string) (*Webchatguestmediarequestentitylist, *APIResponse, error)

GetWebchatGuestConversationMediarequests invokes GET /api/v2/webchat/guest/conversations/{conversationId}/mediarequests

Get all media requests to the guest in the conversation

func (WebChatApi) GetWebchatGuestConversationMember ¶

func (a WebChatApi) GetWebchatGuestConversationMember(conversationId string, memberId string) (*Webchatmemberinfo, *APIResponse, error)

GetWebchatGuestConversationMember invokes GET /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}

Get a web chat conversation member

func (WebChatApi) GetWebchatGuestConversationMembers ¶

func (a WebChatApi) GetWebchatGuestConversationMembers(conversationId string, pageSize int, pageNumber int, excludeDisconnectedMembers bool) (*Webchatmemberinfoentitylist, *APIResponse, error)

GetWebchatGuestConversationMembers invokes GET /api/v2/webchat/guest/conversations/{conversationId}/members

Get the members of a chat conversation.

func (WebChatApi) GetWebchatGuestConversationMessage ¶

func (a WebChatApi) GetWebchatGuestConversationMessage(conversationId string, messageId string) (*Webchatmessage, *APIResponse, error)

GetWebchatGuestConversationMessage invokes GET /api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId}

Get a web chat conversation message

func (WebChatApi) GetWebchatGuestConversationMessages ¶

func (a WebChatApi) GetWebchatGuestConversationMessages(conversationId string, after string, before string, sortOrder string, maxResults int) (*Webchatmessageentitylist, *APIResponse, error)

GetWebchatGuestConversationMessages invokes GET /api/v2/webchat/guest/conversations/{conversationId}/messages

Get the messages of a chat conversation.

func (WebChatApi) GetWebchatSettings ¶

func (a WebChatApi) GetWebchatSettings() (*Webchatsettings, *APIResponse, error)

GetWebchatSettings invokes GET /api/v2/webchat/settings

Get WebChat deployment settings

func (WebChatApi) PatchWebchatGuestConversationMediarequest ¶

func (a WebChatApi) PatchWebchatGuestConversationMediarequest(conversationId string, mediaRequestId string, body Webchatguestmediarequest) (*Webchatguestmediarequest, *APIResponse, error)

PatchWebchatGuestConversationMediarequest invokes PATCH /api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}

Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED

func (WebChatApi) PostWebchatDeployments ¶

func (a WebChatApi) PostWebchatDeployments(body Webchatdeployment) (*Webchatdeployment, *APIResponse, error)

PostWebchatDeployments invokes POST /api/v2/webchat/deployments

Create WebChat deployment

func (WebChatApi) PostWebchatGuestConversationMemberMessages ¶

func (a WebChatApi) PostWebchatGuestConversationMemberMessages(conversationId string, memberId string, body Createwebchatmessagerequest) (*Webchatmessage, *APIResponse, error)

PostWebchatGuestConversationMemberMessages invokes POST /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages

Send a message in a chat conversation.

func (WebChatApi) PostWebchatGuestConversationMemberTyping ¶

func (a WebChatApi) PostWebchatGuestConversationMemberTyping(conversationId string, memberId string) (*Webchattyping, *APIResponse, error)

PostWebchatGuestConversationMemberTyping invokes POST /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing

Send a typing-indicator in a chat conversation.

func (WebChatApi) PostWebchatGuestConversations ¶

PostWebchatGuestConversations invokes POST /api/v2/webchat/guest/conversations

Create an ACD chat conversation from an external customer.

This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the &#39;memberAuthToken&#39; field should include his JWT as generated by the &#39;POST /api/v2/signeddata&#39; resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the &#39;eventStreamUri&#39; field of the response; the conversation is not routed until the event stream is attached.

func (WebChatApi) PutWebchatDeployment ¶

func (a WebChatApi) PutWebchatDeployment(deploymentId string, body Webchatdeployment) (*Webchatdeployment, *APIResponse, error)

PutWebchatDeployment invokes PUT /api/v2/webchat/deployments/{deploymentId}

Update a WebChat deployment

func (WebChatApi) PutWebchatSettings ¶

func (a WebChatApi) PutWebchatSettings(body Webchatsettings) (*Webchatsettings, *APIResponse, error)

PutWebchatSettings invokes PUT /api/v2/webchat/settings

Update WebChat deployment settings

type Webchatconfig ¶

type Webchatconfig struct {
	// WebChatSkin - css class to be applied to the web chat widget.
	WebChatSkin *string `json:"webChatSkin,omitempty"`
}

Webchatconfig

func (*Webchatconfig) String ¶

func (o *Webchatconfig) String() string

String returns a JSON representation of the model

type Webchatconversation ¶

type Webchatconversation struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Member - Chat Member
	Member *Webchatmemberinfo `json:"member,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Webchatconversation

func (*Webchatconversation) String ¶

func (o *Webchatconversation) String() string

String returns a JSON representation of the model

type Webchatdeployment ¶

type Webchatdeployment 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"`

	// AuthenticationRequired
	AuthenticationRequired *bool `json:"authenticationRequired,omitempty"`

	// AuthenticationUrl - URL for third party service authenticating web chat clients. See https://github.com/MyPureCloud/authenticated-web-chat-server-examples
	AuthenticationUrl *string `json:"authenticationUrl,omitempty"`

	// Disabled
	Disabled *bool `json:"disabled,omitempty"`

	// WebChatConfig
	WebChatConfig *Webchatconfig `json:"webChatConfig,omitempty"`

	// AllowedDomains
	AllowedDomains *[]string `json:"allowedDomains,omitempty"`

	// Flow - The URI of the Inbound Chat Flow to run when new chats are initiated under this Deployment.
	Flow *Domainentityref `json:"flow,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Webchatdeployment

func (*Webchatdeployment) String ¶

func (o *Webchatdeployment) String() string

String returns a JSON representation of the model

type Webchatdeploymententitylisting ¶

type Webchatdeploymententitylisting struct {
	// Total
	Total *int `json:"total,omitempty"`

	// Entities
	Entities *[]Webchatdeployment `json:"entities,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`
}

Webchatdeploymententitylisting

func (*Webchatdeploymententitylisting) String ¶

String returns a JSON representation of the model

type Webchatguestmediarequest ¶

type Webchatguestmediarequest struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Types - The types of media being requested.
	Types *[]string `json:"types,omitempty"`

	// State - The state of the media request, one of PENDING|ACCEPTED|DECLINED|TIMEDOUT|CANCELLED|ERRORED.
	State *string `json:"state,omitempty"`

	// CommunicationId - The ID of the new media communication, if applicable.
	CommunicationId *string `json:"communicationId,omitempty"`

	// SecurityKey - The security information related to a media request.
	SecurityKey *string `json:"securityKey,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Webchatguestmediarequest - Object representing the guest model of a media request of a chat conversation.

func (*Webchatguestmediarequest) String ¶

func (o *Webchatguestmediarequest) String() string

String returns a JSON representation of the model

type Webchatguestmediarequestentitylist ¶

type Webchatguestmediarequestentitylist struct {
	// Entities
	Entities *[]Webchatguestmediarequest `json:"entities,omitempty"`
}

Webchatguestmediarequestentitylist

func (*Webchatguestmediarequestentitylist) String ¶

String returns a JSON representation of the model

type Webchatmemberinfo ¶

type Webchatmemberinfo struct {
	// Id - The communicationId of this member.
	Id *string `json:"id,omitempty"`

	// DisplayName - The display name of the member.
	DisplayName *string `json:"displayName,omitempty"`

	// FirstName - The first name of the member.
	FirstName *string `json:"firstName,omitempty"`

	// LastName - The last name of the member.
	LastName *string `json:"lastName,omitempty"`

	// Email - The email address of the member.
	Email *string `json:"email,omitempty"`

	// PhoneNumber - The phone number of the member.
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// AvatarImageUrl - The url to the avatar image of the member.
	AvatarImageUrl *string `json:"avatarImageUrl,omitempty"`

	// Role - The role of the member, one of [agent, customer, acd, workflow]
	Role *string `json:"role,omitempty"`

	// JoinDate - The time the member joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	JoinDate *time.Time `json:"joinDate,omitempty"`

	// LeaveDate - The time the member left the conversation, or null if the member is still active in the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	LeaveDate *time.Time `json:"leaveDate,omitempty"`

	// AuthenticatedGuest - If true, the guest member is an authenticated guest.
	AuthenticatedGuest *bool `json:"authenticatedGuest,omitempty"`

	// CustomFields - Any custom fields of information pertaining to this member.
	CustomFields *map[string]string `json:"customFields,omitempty"`

	// State - The connection state of this member.
	State *string `json:"state,omitempty"`
}

Webchatmemberinfo

func (*Webchatmemberinfo) String ¶

func (o *Webchatmemberinfo) String() string

String returns a JSON representation of the model

type Webchatmemberinfoentitylist ¶

type Webchatmemberinfoentitylist struct {
	// Entities
	Entities *[]Webchatmemberinfo `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Webchatmemberinfoentitylist

func (*Webchatmemberinfoentitylist) String ¶

func (o *Webchatmemberinfoentitylist) String() string

String returns a JSON representation of the model

type Webchatmessage ¶

type Webchatmessage struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Conversation - The identifier of the conversation
	Conversation *Webchatconversation `json:"conversation,omitempty"`

	// Sender - The member who sent the message
	Sender *Webchatmemberinfo `json:"sender,omitempty"`

	// Body - The message body.
	Body *string `json:"body,omitempty"`

	// BodyType - The purpose of the message within the conversation, such as a standard text entry versus a greeting.
	BodyType *string `json:"bodyType,omitempty"`

	// Timestamp - The timestamp of the message, in ISO-8601 format
	Timestamp *time.Time `json:"timestamp,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Webchatmessage

func (*Webchatmessage) String ¶

func (o *Webchatmessage) String() string

String returns a JSON representation of the model

type Webchatmessageentitylist ¶

type Webchatmessageentitylist struct {
	// PageSize
	PageSize *int `json:"pageSize,omitempty"`

	// Entities
	Entities *[]Webchatmessage `json:"entities,omitempty"`

	// PreviousPage
	PreviousPage *string `json:"previousPage,omitempty"`

	// Next
	Next *string `json:"next,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`
}

Webchatmessageentitylist

func (*Webchatmessageentitylist) String ¶

func (o *Webchatmessageentitylist) String() string

String returns a JSON representation of the model

type Webchatroutingtarget ¶

type Webchatroutingtarget struct {
	// TargetType - The target type of the routing target, such as 'QUEUE'.
	TargetType *string `json:"targetType,omitempty"`

	// TargetAddress - The target of the route, in the format appropriate given the 'targetType'.
	TargetAddress *string `json:"targetAddress,omitempty"`

	// Skills - The list of skill names to use for routing.
	Skills *[]string `json:"skills,omitempty"`

	// Language - The language name to use for routing.
	Language *string `json:"language,omitempty"`

	// Priority - The priority to assign to the conversation for routing.
	Priority *int `json:"priority,omitempty"`
}

Webchatroutingtarget

func (*Webchatroutingtarget) String ¶

func (o *Webchatroutingtarget) String() string

String returns a JSON representation of the model

type Webchatsettings ¶

type Webchatsettings struct {
	// RequireDeployment
	RequireDeployment *bool `json:"requireDeployment,omitempty"`
}

Webchatsettings

func (*Webchatsettings) String ¶

func (o *Webchatsettings) String() string

String returns a JSON representation of the model

type Webchattyping ¶

type Webchattyping struct {
	// Id - The event identifier of this typing indicator event (useful to guard against event re-delivery
	Id *string `json:"id,omitempty"`

	// Conversation - The identifier of the conversation
	Conversation *Webchatconversation `json:"conversation,omitempty"`

	// Sender - The member who sent the message
	Sender *Webchatmemberinfo `json:"sender,omitempty"`

	// Timestamp - The timestamp of the message, in ISO-8601 format
	Timestamp *time.Time `json:"timestamp,omitempty"`
}

Webchattyping

func (*Webchattyping) String ¶

func (o *Webchattyping) String() string

String returns a JSON representation of the model

type Webdeploymentsconfigtopicwebmessagingconfigchangeeventbody ¶

type Webdeploymentsconfigtopicwebmessagingconfigchangeeventbody struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *string `json:"version,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`
}

Webdeploymentsconfigtopicwebmessagingconfigchangeeventbody

func (*Webdeploymentsconfigtopicwebmessagingconfigchangeeventbody) String ¶

String returns a JSON representation of the model

type Webdeploymentsdeploymenttopicwebmessagingconfigchangeeventbody ¶

type Webdeploymentsdeploymenttopicwebmessagingconfigchangeeventbody struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Version
	Version *string `json:"version,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`
}

Webdeploymentsdeploymenttopicwebmessagingconfigchangeeventbody

func (*Webdeploymentsdeploymenttopicwebmessagingconfigchangeeventbody) String ¶

String returns a JSON representation of the model

type Webdeploymentsdeploymenttopicwebmessagingdeploymentchangeeventbody ¶

type Webdeploymentsdeploymenttopicwebmessagingdeploymentchangeeventbody struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Configuration
	Configuration *Webdeploymentsdeploymenttopicwebmessagingconfigchangeeventbody `json:"configuration,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`
}

Webdeploymentsdeploymenttopicwebmessagingdeploymentchangeeventbody

func (*Webdeploymentsdeploymenttopicwebmessagingdeploymentchangeeventbody) String ¶

String returns a JSON representation of the model

type Webmessagingofferfields ¶

type Webmessagingofferfields struct {
	// OfferText - Text value to be used when inviting a visitor to engage with a web messaging offer.
	OfferText *string `json:"offerText,omitempty"`
}

Webmessagingofferfields

func (*Webmessagingofferfields) String ¶

func (o *Webmessagingofferfields) String() string

String returns a JSON representation of the model

type Weekschedule ¶

type Weekschedule 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"`

	// WeekDate - First day of this week schedule in yyyy-MM-dd format
	WeekDate *string `json:"weekDate,omitempty"`

	// Description - Description of the week schedule
	Description *string `json:"description,omitempty"`

	// Published - Whether the week schedule is published
	Published *bool `json:"published,omitempty"`

	// GenerationResults - Summary of the results from the schedule run
	GenerationResults *Weekschedulegenerationresult `json:"generationResults,omitempty"`

	// ShortTermForecast - Short term forecast associated with this schedule
	ShortTermForecast *Shorttermforecastreference `json:"shortTermForecast,omitempty"`

	// Metadata - Version metadata for this work plan
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// UserSchedules - User schedules in the week
	UserSchedules *map[string]Userschedule `json:"userSchedules,omitempty"`

	// HeadcountForecast - Headcount information for the week schedule
	HeadcountForecast *Headcountforecast `json:"headcountForecast,omitempty"`

	// AgentSchedulesVersion - Version of agent schedules in the week schedule
	AgentSchedulesVersion *int `json:"agentSchedulesVersion,omitempty"`
}

Weekschedule - Week schedule information

func (*Weekschedule) String ¶

func (o *Weekschedule) String() string

String returns a JSON representation of the model

type Weekschedulegenerationresult ¶

type Weekschedulegenerationresult struct {
	// Failed - Whether the schedule generation failed
	Failed *bool `json:"failed,omitempty"`

	// RunId - ID of the schedule run
	RunId *string `json:"runId,omitempty"`

	// AgentWarnings - Warning messages from the schedule run. This will be available only when requesting information for a single week schedule
	AgentWarnings *[]Schedulegenerationwarning `json:"agentWarnings,omitempty"`

	// AgentWarningCount - Count of warning messages from the schedule run. This will be available only when requesting multiple week schedules
	AgentWarningCount *int `json:"agentWarningCount,omitempty"`
}

Weekschedulegenerationresult

func (*Weekschedulegenerationresult) String ¶

String returns a JSON representation of the model

type Weekschedulelistitemresponse ¶

type Weekschedulelistitemresponse 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"`

	// WeekDate - First day of this week schedule in yyyy-MM-dd format
	WeekDate *string `json:"weekDate,omitempty"`

	// Description - Description of the week schedule
	Description *string `json:"description,omitempty"`

	// Published - Whether the week schedule is published
	Published *bool `json:"published,omitempty"`

	// GenerationResults - Summary of the results from the schedule run
	GenerationResults *Weekschedulegenerationresult `json:"generationResults,omitempty"`

	// ShortTermForecast - Short term forecast associated with this schedule
	ShortTermForecast *Shorttermforecastreference `json:"shortTermForecast,omitempty"`

	// Metadata - Version metadata for this work plan
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`
}

Weekschedulelistitemresponse

func (*Weekschedulelistitemresponse) String ¶

String returns a JSON representation of the model

type Weekschedulelistresponse ¶

type Weekschedulelistresponse struct {
	// Entities
	Entities *[]Weekschedulelistitemresponse `json:"entities,omitempty"`
}

Weekschedulelistresponse - Week schedule list

func (*Weekschedulelistresponse) String ¶

func (o *Weekschedulelistresponse) String() string

String returns a JSON representation of the model

type Weekschedulereference ¶

type Weekschedulereference 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"`

	// WeekDate - First day of this week schedule in yyyy-MM-dd format
	WeekDate *string `json:"weekDate,omitempty"`
}

Weekschedulereference

func (*Weekschedulereference) String ¶

func (o *Weekschedulereference) String() string

String returns a JSON representation of the model

type Weekscheduleresponse ¶

type Weekscheduleresponse struct {
	// Result - The result of the request. The value will be null 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"`
}

Weekscheduleresponse - Response for query for week schedule for a given week in management unit

func (*Weekscheduleresponse) String ¶

func (o *Weekscheduleresponse) String() string

String returns a JSON representation of the model

type Weekshifttradelistresponse ¶

type Weekshifttradelistresponse struct {
	// Entities
	Entities *[]Weekshifttraderesponse `json:"entities,omitempty"`
}

Weekshifttradelistresponse

func (*Weekshifttradelistresponse) String ¶

func (o *Weekshifttradelistresponse) String() string

String returns a JSON representation of the model

type Weekshifttradematchessummaryresponse ¶

type Weekshifttradematchessummaryresponse struct {
	// WeekDate - The schedule week date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	WeekDate *time.Time `json:"weekDate,omitempty"`

	// Count - The number of trades in the Matched state for the given week
	Count *int `json:"count,omitempty"`
}

Weekshifttradematchessummaryresponse

func (*Weekshifttradematchessummaryresponse) String ¶

String returns a JSON representation of the model

type Weekshifttraderesponse ¶

type Weekshifttraderesponse struct {
	// Trade - The shift trade details
	Trade *Shifttraderesponse `json:"trade,omitempty"`

	// MatchReview - A preview of what the schedule would look like if the shift trade is approved plus any violations
	MatchReview *Shifttradematchreviewresponse `json:"matchReview,omitempty"`
}

Weekshifttraderesponse

func (*Weekshifttraderesponse) String ¶

func (o *Weekshifttraderesponse) String() string

String returns a JSON representation of the model

type Wemcoachingappointmenttopiccoachingappointmentconversation ¶

type Wemcoachingappointmenttopiccoachingappointmentconversation struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Action
	Action *string `json:"action,omitempty"`
}

Wemcoachingappointmenttopiccoachingappointmentconversation

func (*Wemcoachingappointmenttopiccoachingappointmentconversation) String ¶

String returns a JSON representation of the model

type Wemcoachingappointmenttopiccoachingappointmentdocument ¶

type Wemcoachingappointmenttopiccoachingappointmentdocument struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Action
	Action *string `json:"action,omitempty"`
}

Wemcoachingappointmenttopiccoachingappointmentdocument

func (*Wemcoachingappointmenttopiccoachingappointmentdocument) String ¶

String returns a JSON representation of the model

type Wemcoachingappointmenttopiccoachingappointmentexternallink struct {
	// ExternalLink
	ExternalLink *string `json:"externalLink,omitempty"`

	// Action
	Action *string `json:"action,omitempty"`
}

Wemcoachingappointmenttopiccoachingappointmentexternallink

func (*Wemcoachingappointmenttopiccoachingappointmentexternallink) String ¶

String returns a JSON representation of the model

type Wemcoachingappointmenttopiccoachingappointmentnotification ¶

type Wemcoachingappointmenttopiccoachingappointmentnotification struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// DateStart
	DateStart *time.Time `json:"dateStart,omitempty"`

	// LengthInMinutes
	LengthInMinutes *int `json:"lengthInMinutes,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`

	// Facilitator
	Facilitator *Wemcoachingappointmenttopicuserreference `json:"facilitator,omitempty"`

	// Attendees
	Attendees *[]Wemcoachingappointmenttopicuserreference `json:"attendees,omitempty"`

	// CreatedBy
	CreatedBy *Wemcoachingappointmenttopicuserreference `json:"createdBy,omitempty"`

	// DateCreated
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// ModifiedBy
	ModifiedBy *Wemcoachingappointmenttopicuserreference `json:"modifiedBy,omitempty"`

	// DateModified
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Conversations
	Conversations *[]Wemcoachingappointmenttopiccoachingappointmentconversation `json:"conversations,omitempty"`

	// Documents
	Documents *[]Wemcoachingappointmenttopiccoachingappointmentdocument `json:"documents,omitempty"`

	// ChangeType
	ChangeType *string `json:"changeType,omitempty"`

	// DateCompleted
	DateCompleted *time.Time `json:"dateCompleted,omitempty"`

	// ExternalLinks
	ExternalLinks *[]Wemcoachingappointmenttopiccoachingappointmentexternallink `json:"externalLinks,omitempty"`
}

Wemcoachingappointmenttopiccoachingappointmentnotification

func (*Wemcoachingappointmenttopiccoachingappointmentnotification) String ¶

String returns a JSON representation of the model

type Wemcoachingappointmenttopicuserreference ¶

type Wemcoachingappointmenttopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wemcoachingappointmenttopicuserreference

func (*Wemcoachingappointmenttopicuserreference) String ¶

String returns a JSON representation of the model

type Wemlearningassignmentruleruntopiclearningassignmentrulerunnotification ¶

type Wemlearningassignmentruleruntopiclearningassignmentrulerunnotification struct {
	// Entities
	Entities *[]Wemlearningassignmentruleruntopicwemlearningassignmentscreated `json:"entities,omitempty"`

	// Total
	Total *int `json:"total,omitempty"`
}

Wemlearningassignmentruleruntopiclearningassignmentrulerunnotification

func (*Wemlearningassignmentruleruntopiclearningassignmentrulerunnotification) String ¶

String returns a JSON representation of the model

type Wemlearningassignmentruleruntopiclearningmodulereference ¶

type Wemlearningassignmentruleruntopiclearningmodulereference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Wemlearningassignmentruleruntopiclearningmodulereference

func (*Wemlearningassignmentruleruntopiclearningmodulereference) String ¶

String returns a JSON representation of the model

type Wemlearningassignmentruleruntopicwemlearningassignmentscreated ¶

type Wemlearningassignmentruleruntopicwemlearningassignmentscreated struct {
	// Module
	Module *Wemlearningassignmentruleruntopiclearningmodulereference `json:"module,omitempty"`
}

Wemlearningassignmentruleruntopicwemlearningassignmentscreated

func (*Wemlearningassignmentruleruntopicwemlearningassignmentscreated) String ¶

String returns a JSON representation of the model

type Wemlearningassignmenttopiclearningassignmentnotification ¶

type Wemlearningassignmenttopiclearningassignmentnotification struct {
	// Id
	Id *string `json:"id,omitempty"`

	// User
	User *Wemlearningassignmenttopicuserreference `json:"user,omitempty"`

	// Module
	Module *Wemlearningassignmenttopiclearningmodulereference `json:"module,omitempty"`

	// Version
	Version *int `json:"version,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// DateRecommendedForCompletion
	DateRecommendedForCompletion *time.Time `json:"dateRecommendedForCompletion,omitempty"`

	// CreatedBy
	CreatedBy *Wemlearningassignmenttopicuserreference `json:"createdBy,omitempty"`

	// DateCreated
	DateCreated *time.Time `json:"dateCreated,omitempty"`

	// ModifiedBy
	ModifiedBy *Wemlearningassignmenttopicuserreference `json:"modifiedBy,omitempty"`

	// DateModified
	DateModified *time.Time `json:"dateModified,omitempty"`

	// IsOverdue
	IsOverdue *bool `json:"isOverdue,omitempty"`
}

Wemlearningassignmenttopiclearningassignmentnotification

func (*Wemlearningassignmenttopiclearningassignmentnotification) String ¶

String returns a JSON representation of the model

type Wemlearningassignmenttopiclearningmodulereference ¶

type Wemlearningassignmenttopiclearningmodulereference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Wemlearningassignmenttopiclearningmodulereference

func (*Wemlearningassignmenttopiclearningmodulereference) String ¶

String returns a JSON representation of the model

type Wemlearningassignmenttopicuserreference ¶

type Wemlearningassignmenttopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wemlearningassignmenttopicuserreference

func (*Wemlearningassignmenttopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmagent ¶

type Wfmagent struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// User - The user associated with this data
	User *Userreference `json:"user,omitempty"`

	// WorkPlan - The work plan associated with this agent, if applicable
	WorkPlan *Workplanreference `json:"workPlan,omitempty"`

	// WorkPlanRotation - The work plan rotation associated with this agent, if applicable
	WorkPlanRotation *Workplanrotationreference `json:"workPlanRotation,omitempty"`

	// AcceptDirectShiftTrades - Whether the agent accepts direct shift trade requests
	AcceptDirectShiftTrades *bool `json:"acceptDirectShiftTrades,omitempty"`

	// Queues - List of queues to which this agent is capable of handling
	Queues *[]Queuereference `json:"queues,omitempty"`

	// Languages - The list of languages this agent is capable of handling
	Languages *[]Languagereference `json:"languages,omitempty"`

	// Skills - The list of skills this agent is capable of handling
	Skills *[]Routingskillreference `json:"skills,omitempty"`

	// Schedulable - Whether the agent has the permission to be included in schedule generation
	Schedulable *bool `json:"schedulable,omitempty"`

	// Metadata - Metadata for this agent
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Wfmagent - Workforce management agent data

func (*Wfmagent) String ¶

func (o *Wfmagent) String() string

String returns a JSON representation of the model

type Wfmagentscheduleupdatetopicuserreference ¶

type Wfmagentscheduleupdatetopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmagentscheduleupdatetopicuserreference

func (*Wfmagentscheduleupdatetopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmagentscheduleupdatetopicwfmagentscheduleupdate ¶

type Wfmagentscheduleupdatetopicwfmagentscheduleupdate struct {
	// UpdateType
	UpdateType *string `json:"updateType,omitempty"`

	// ShiftStartDates
	ShiftStartDates *[]time.Time `json:"shiftStartDates,omitempty"`
}

Wfmagentscheduleupdatetopicwfmagentscheduleupdate

func (*Wfmagentscheduleupdatetopicwfmagentscheduleupdate) String ¶

String returns a JSON representation of the model

type Wfmagentscheduleupdatetopicwfmagentscheduleupdatenotification ¶

type Wfmagentscheduleupdatetopicwfmagentscheduleupdatenotification struct {
	// User
	User *Wfmagentscheduleupdatetopicuserreference `json:"user,omitempty"`

	// StartDate
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate
	EndDate *time.Time `json:"endDate,omitempty"`

	// Shifts
	Shifts *[]Wfmagentscheduleupdatetopicwfmscheduleshift `json:"shifts,omitempty"`

	// FullDayTimeOffMarkers
	FullDayTimeOffMarkers *[]Wfmagentscheduleupdatetopicwfmfulldaytimeoffmarker `json:"fullDayTimeOffMarkers,omitempty"`

	// Updates
	Updates *[]Wfmagentscheduleupdatetopicwfmagentscheduleupdate `json:"updates,omitempty"`
}

Wfmagentscheduleupdatetopicwfmagentscheduleupdatenotification

func (*Wfmagentscheduleupdatetopicwfmagentscheduleupdatenotification) String ¶

String returns a JSON representation of the model

type Wfmagentscheduleupdatetopicwfmfulldaytimeoffmarker ¶

type Wfmagentscheduleupdatetopicwfmfulldaytimeoffmarker struct {
	// TimeOffRequestId
	TimeOffRequestId *string `json:"timeOffRequestId,omitempty"`

	// ManagementUnitDate
	ManagementUnitDate *string `json:"managementUnitDate,omitempty"`

	// ActivityCodeId
	ActivityCodeId *string `json:"activityCodeId,omitempty"`

	// IsPaid
	IsPaid *bool `json:"isPaid,omitempty"`

	// LengthInMinutes
	LengthInMinutes *int `json:"lengthInMinutes,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Paid
	Paid *bool `json:"paid,omitempty"`
}

Wfmagentscheduleupdatetopicwfmfulldaytimeoffmarker

func (*Wfmagentscheduleupdatetopicwfmfulldaytimeoffmarker) String ¶

String returns a JSON representation of the model

type Wfmagentscheduleupdatetopicwfmscheduleactivity ¶

type Wfmagentscheduleupdatetopicwfmscheduleactivity struct {
	// ActivityCodeId
	ActivityCodeId *string `json:"activityCodeId,omitempty"`

	// StartDate
	StartDate *time.Time `json:"startDate,omitempty"`

	// CountsAsPaidTime
	CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"`

	// LengthInMinutes
	LengthInMinutes *int `json:"lengthInMinutes,omitempty"`

	// TimeOffRequestId
	TimeOffRequestId *string `json:"timeOffRequestId,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`
}

Wfmagentscheduleupdatetopicwfmscheduleactivity

func (*Wfmagentscheduleupdatetopicwfmscheduleactivity) String ¶

String returns a JSON representation of the model

type Wfmagentscheduleupdatetopicwfmscheduleshift ¶

type Wfmagentscheduleupdatetopicwfmscheduleshift struct {
	// WeekDate
	WeekDate *string `json:"weekDate,omitempty"`

	// WeekScheduleId
	WeekScheduleId *string `json:"weekScheduleId,omitempty"`

	// Id
	Id *string `json:"id,omitempty"`

	// StartDate
	StartDate *time.Time `json:"startDate,omitempty"`

	// LengthInMinutes
	LengthInMinutes *int `json:"lengthInMinutes,omitempty"`

	// Activities
	Activities *[]Wfmagentscheduleupdatetopicwfmscheduleactivity `json:"activities,omitempty"`
}

Wfmagentscheduleupdatetopicwfmscheduleshift

func (*Wfmagentscheduleupdatetopicwfmscheduleshift) String ¶

String returns a JSON representation of the model

type Wfmbuintradaydataupdatetopicbuintradaydatagroup ¶

type Wfmbuintradaydataupdatetopicbuintradaydatagroup struct {
	// MediaType
	MediaType *string `json:"mediaType,omitempty"`

	// ForecastDataSummary
	ForecastDataSummary *Wfmbuintradaydataupdatetopicbuintradayforecastdata `json:"forecastDataSummary,omitempty"`

	// ForecastDataPerInterval
	ForecastDataPerInterval *[]Wfmbuintradaydataupdatetopicbuintradayforecastdata `json:"forecastDataPerInterval,omitempty"`

	// ScheduleDataSummary
	ScheduleDataSummary *Wfmbuintradaydataupdatetopicbuintradayscheduledata `json:"scheduleDataSummary,omitempty"`

	// ScheduleDataPerInterval
	ScheduleDataPerInterval *[]Wfmbuintradaydataupdatetopicbuintradayscheduledata `json:"scheduleDataPerInterval,omitempty"`

	// PerformancePredictionDataSummary
	PerformancePredictionDataSummary *Wfmbuintradaydataupdatetopicintradayperformancepredictiondata `json:"performancePredictionDataSummary,omitempty"`

	// PerformancePredictionDataPerInterval
	PerformancePredictionDataPerInterval *[]Wfmbuintradaydataupdatetopicintradayperformancepredictiondata `json:"performancePredictionDataPerInterval,omitempty"`
}

Wfmbuintradaydataupdatetopicbuintradaydatagroup

func (*Wfmbuintradaydataupdatetopicbuintradaydatagroup) String ¶

String returns a JSON representation of the model

type Wfmbuintradaydataupdatetopicbuintradayforecastdata ¶

type Wfmbuintradaydataupdatetopicbuintradayforecastdata struct {
	// Offered
	Offered *float32 `json:"offered,omitempty"`

	// AverageHandleTimeSeconds
	AverageHandleTimeSeconds *float32 `json:"averageHandleTimeSeconds,omitempty"`
}

Wfmbuintradaydataupdatetopicbuintradayforecastdata

func (*Wfmbuintradaydataupdatetopicbuintradayforecastdata) String ¶

String returns a JSON representation of the model

type Wfmbuintradaydataupdatetopicbuintradaynotification ¶

type Wfmbuintradaydataupdatetopicbuintradaynotification struct {
	// OperationId
	OperationId *string `json:"operationId,omitempty"`

	// Result
	Result *Wfmbuintradaydataupdatetopicbuintradayresult `json:"result,omitempty"`
}

Wfmbuintradaydataupdatetopicbuintradaynotification

func (*Wfmbuintradaydataupdatetopicbuintradaynotification) String ¶

String returns a JSON representation of the model

type Wfmbuintradaydataupdatetopicbuintradayresult ¶

type Wfmbuintradaydataupdatetopicbuintradayresult struct {
	// StartDate
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate
	EndDate *time.Time `json:"endDate,omitempty"`

	// IntervalLengthMinutes
	IntervalLengthMinutes *int `json:"intervalLengthMinutes,omitempty"`

	// IntradayDataGroupings
	IntradayDataGroupings *[]Wfmbuintradaydataupdatetopicbuintradaydatagroup `json:"intradayDataGroupings,omitempty"`

	// Categories
	Categories *[]string `json:"categories,omitempty"`

	// NoDataReason
	NoDataReason *string `json:"noDataReason,omitempty"`

	// Schedule
	Schedule *Wfmbuintradaydataupdatetopicbuschedulereference `json:"schedule,omitempty"`

	// ShortTermForecast
	ShortTermForecast *Wfmbuintradaydataupdatetopicbushorttermforecastreference `json:"shortTermForecast,omitempty"`
}

Wfmbuintradaydataupdatetopicbuintradayresult

func (*Wfmbuintradaydataupdatetopicbuintradayresult) String ¶

String returns a JSON representation of the model

type Wfmbuintradaydataupdatetopicbuintradayscheduledata ¶

type Wfmbuintradaydataupdatetopicbuintradayscheduledata struct {
	// OnQueueTimeSeconds
	OnQueueTimeSeconds *int `json:"onQueueTimeSeconds,omitempty"`
}

Wfmbuintradaydataupdatetopicbuintradayscheduledata

func (*Wfmbuintradaydataupdatetopicbuintradayscheduledata) String ¶

String returns a JSON representation of the model

type Wfmbuintradaydataupdatetopicbuschedulereference ¶

type Wfmbuintradaydataupdatetopicbuschedulereference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmbuintradaydataupdatetopicbuschedulereference

func (*Wfmbuintradaydataupdatetopicbuschedulereference) String ¶

String returns a JSON representation of the model

type Wfmbuintradaydataupdatetopicbushorttermforecastreference ¶

type Wfmbuintradaydataupdatetopicbushorttermforecastreference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// WeekDate
	WeekDate *string `json:"weekDate,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`
}

Wfmbuintradaydataupdatetopicbushorttermforecastreference

func (*Wfmbuintradaydataupdatetopicbushorttermforecastreference) String ¶

String returns a JSON representation of the model

type Wfmbuintradaydataupdatetopicintradayperformancepredictiondata ¶

type Wfmbuintradaydataupdatetopicintradayperformancepredictiondata struct {
	// ServiceLevelPercent
	ServiceLevelPercent *float32 `json:"serviceLevelPercent,omitempty"`

	// AverageSpeedOfAnswerSeconds
	AverageSpeedOfAnswerSeconds *float32 `json:"averageSpeedOfAnswerSeconds,omitempty"`

	// OccupancyPercent
	OccupancyPercent *float32 `json:"occupancyPercent,omitempty"`
}

Wfmbuintradaydataupdatetopicintradayperformancepredictiondata

func (*Wfmbuintradaydataupdatetopicintradayperformancepredictiondata) String ¶

String returns a JSON representation of the model

type Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdatenotification ¶

type Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdatenotification struct {
	// Status
	Status *string `json:"status,omitempty"`

	// OperationId
	OperationId *string `json:"operationId,omitempty"`

	// Result
	Result *Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresultlisting `json:"result,omitempty"`
}

Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdatenotification

func (*Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdatenotification) String ¶

String returns a JSON representation of the model

type Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresult ¶

type Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresult struct {
	// Id
	Id *string `json:"id,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// ReviewedBy
	ReviewedBy *Wfmbulkshifttradestateupdatenotificationtopicuserreference `json:"reviewedBy,omitempty"`

	// ReviewedDate
	ReviewedDate *time.Time `json:"reviewedDate,omitempty"`

	// FailureReason
	FailureReason *string `json:"failureReason,omitempty"`

	// Metadata
	Metadata *Wfmbulkshifttradestateupdatenotificationtopicwfmversionedentitymetadata `json:"metadata,omitempty"`
}

Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresult

func (*Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresult) String ¶

String returns a JSON representation of the model

type Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresultlisting ¶

type Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresultlisting struct {
	// Entities
	Entities *[]Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresult `json:"entities,omitempty"`
}

Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresultlisting

func (*Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresultlisting) String ¶

String returns a JSON representation of the model

type Wfmbulkshifttradestateupdatenotificationtopicuserreference ¶

type Wfmbulkshifttradestateupdatenotificationtopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmbulkshifttradestateupdatenotificationtopicuserreference

func (*Wfmbulkshifttradestateupdatenotificationtopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmbulkshifttradestateupdatenotificationtopicwfmversionedentitymetadata ¶

type Wfmbulkshifttradestateupdatenotificationtopicwfmversionedentitymetadata struct {
	// Version
	Version *int `json:"version,omitempty"`

	// ModifiedBy
	ModifiedBy *Wfmbulkshifttradestateupdatenotificationtopicuserreference `json:"modifiedBy,omitempty"`

	// DateModified
	DateModified *time.Time `json:"dateModified,omitempty"`
}

Wfmbulkshifttradestateupdatenotificationtopicwfmversionedentitymetadata

func (*Wfmbulkshifttradestateupdatenotificationtopicwfmversionedentitymetadata) String ¶

String returns a JSON representation of the model

type Wfmbuschedulequeryresulttopicbuschedulesearchresultnotification ¶

type Wfmbuschedulequeryresulttopicbuschedulesearchresultnotification struct {
	// OperationId
	OperationId *string `json:"operationId,omitempty"`

	// BusinessUnitId
	BusinessUnitId *string `json:"businessUnitId,omitempty"`

	// DownloadUrl
	DownloadUrl *string `json:"downloadUrl,omitempty"`
}

Wfmbuschedulequeryresulttopicbuschedulesearchresultnotification

func (*Wfmbuschedulequeryresulttopicbuschedulesearchresultnotification) String ¶

String returns a JSON representation of the model

type Wfmbuscheduleruntopicbuschedulereference ¶

type Wfmbuscheduleruntopicbuschedulereference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmbuscheduleruntopicbuschedulereference

func (*Wfmbuscheduleruntopicbuschedulereference) String ¶

String returns a JSON representation of the model

type Wfmbuscheduleruntopicbuschedulerun ¶

type Wfmbuscheduleruntopicbuschedulerun struct {
	// Id
	Id *string `json:"id,omitempty"`

	// PercentComplete
	PercentComplete *float32 `json:"percentComplete,omitempty"`

	// IntradayRescheduling
	IntradayRescheduling *bool `json:"intradayRescheduling,omitempty"`

	// State
	State *string `json:"state,omitempty"`

	// WeekCount
	WeekCount *int `json:"weekCount,omitempty"`

	// Schedule
	Schedule *Wfmbuscheduleruntopicbuschedulereference `json:"schedule,omitempty"`

	// SchedulingCanceledBy
	SchedulingCanceledBy *Wfmbuscheduleruntopicuserreference `json:"schedulingCanceledBy,omitempty"`

	// SchedulingCompletedTime
	SchedulingCompletedTime *string `json:"schedulingCompletedTime,omitempty"`

	// MessageCount
	MessageCount *int `json:"messageCount,omitempty"`
}

Wfmbuscheduleruntopicbuschedulerun

func (*Wfmbuscheduleruntopicbuschedulerun) String ¶

String returns a JSON representation of the model

type Wfmbuscheduleruntopicbuschedulingrunprogressnotification ¶

type Wfmbuscheduleruntopicbuschedulingrunprogressnotification struct {
	// Status
	Status *string `json:"status,omitempty"`

	// OperationId
	OperationId *string `json:"operationId,omitempty"`

	// Result
	Result *Wfmbuscheduleruntopicbuschedulerun `json:"result,omitempty"`
}

Wfmbuscheduleruntopicbuschedulingrunprogressnotification

func (*Wfmbuscheduleruntopicbuschedulingrunprogressnotification) String ¶

String returns a JSON representation of the model

type Wfmbuscheduleruntopicuserreference ¶

type Wfmbuscheduleruntopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmbuscheduleruntopicuserreference

func (*Wfmbuscheduleruntopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmbuschedulesearchresulttopicbuschedulesearchresultnotification ¶

type Wfmbuschedulesearchresulttopicbuschedulesearchresultnotification struct {
	// OperationId
	OperationId *string `json:"operationId,omitempty"`

	// BusinessUnitId
	BusinessUnitId *string `json:"businessUnitId,omitempty"`

	// DownloadUrl
	DownloadUrl *string `json:"downloadUrl,omitempty"`
}

Wfmbuschedulesearchresulttopicbuschedulesearchresultnotification

func (*Wfmbuschedulesearchresulttopicbuschedulesearchresultnotification) String ¶

String returns a JSON representation of the model

type Wfmbuscheduletopicbumanagementunitschedulesummary ¶

type Wfmbuscheduletopicbumanagementunitschedulesummary struct {
	// ManagementUnit
	ManagementUnit *Wfmbuscheduletopicmanagementunit `json:"managementUnit,omitempty"`

	// StartDate
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate
	EndDate *time.Time `json:"endDate,omitempty"`

	// Agents
	Agents *[]Wfmbuscheduletopicuserreference `json:"agents,omitempty"`

	// AgentCount
	AgentCount *int `json:"agentCount,omitempty"`
}

Wfmbuscheduletopicbumanagementunitschedulesummary

func (*Wfmbuscheduletopicbumanagementunitschedulesummary) String ¶

String returns a JSON representation of the model

type Wfmbuscheduletopicbuschedulegenerationresultsummary ¶

type Wfmbuscheduletopicbuschedulegenerationresultsummary struct {
	// Failed
	Failed *bool `json:"failed,omitempty"`

	// RunId
	RunId *string `json:"runId,omitempty"`

	// MessageCount
	MessageCount *int `json:"messageCount,omitempty"`
}

Wfmbuscheduletopicbuschedulegenerationresultsummary

func (*Wfmbuscheduletopicbuschedulegenerationresultsummary) String ¶

String returns a JSON representation of the model

type Wfmbuscheduletopicbuschedulemetadata ¶

type Wfmbuscheduletopicbuschedulemetadata struct {
	// Id
	Id *string `json:"id,omitempty"`

	// WeekCount
	WeekCount *int `json:"weekCount,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Published
	Published *bool `json:"published,omitempty"`

	// ShortTermForecast
	ShortTermForecast *Wfmbuscheduletopicbushorttermforecastreference `json:"shortTermForecast,omitempty"`

	// ManagementUnits
	ManagementUnits *[]Wfmbuscheduletopicbumanagementunitschedulesummary `json:"managementUnits,omitempty"`

	// GenerationResults
	GenerationResults *Wfmbuscheduletopicbuschedulegenerationresultsummary `json:"generationResults,omitempty"`

	// Metadata
	Metadata *Wfmbuscheduletopicwfmversionedentitymetadata `json:"metadata,omitempty"`
}

Wfmbuscheduletopicbuschedulemetadata

func (*Wfmbuscheduletopicbuschedulemetadata) String ¶

String returns a JSON representation of the model

type Wfmbuscheduletopicbuschedulenotification ¶

type Wfmbuscheduletopicbuschedulenotification struct {
	// Status
	Status *string `json:"status,omitempty"`

	// OperationId
	OperationId *string `json:"operationId,omitempty"`

	// EventType
	EventType *string `json:"eventType,omitempty"`

	// Result
	Result *Wfmbuscheduletopicbuschedulemetadata `json:"result,omitempty"`
}

Wfmbuscheduletopicbuschedulenotification

func (*Wfmbuscheduletopicbuschedulenotification) String ¶

String returns a JSON representation of the model

type Wfmbuscheduletopicbushorttermforecastreference ¶

type Wfmbuscheduletopicbushorttermforecastreference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// WeekDate
	WeekDate *string `json:"weekDate,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`
}

Wfmbuscheduletopicbushorttermforecastreference

func (*Wfmbuscheduletopicbushorttermforecastreference) String ¶

String returns a JSON representation of the model

type Wfmbuscheduletopicmanagementunit ¶

type Wfmbuscheduletopicmanagementunit struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmbuscheduletopicmanagementunit

func (*Wfmbuscheduletopicmanagementunit) String ¶

String returns a JSON representation of the model

type Wfmbuscheduletopicuserreference ¶

type Wfmbuscheduletopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmbuscheduletopicuserreference

func (*Wfmbuscheduletopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmbuscheduletopicwfmversionedentitymetadata ¶

type Wfmbuscheduletopicwfmversionedentitymetadata struct {
	// Version
	Version *int `json:"version,omitempty"`

	// ModifiedBy
	ModifiedBy *Wfmbuscheduletopicuserreference `json:"modifiedBy,omitempty"`

	// DateModified
	DateModified *time.Time `json:"dateModified,omitempty"`
}

Wfmbuscheduletopicwfmversionedentitymetadata

func (*Wfmbuscheduletopicwfmversionedentitymetadata) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastcopycompletetopicbuforecastmodification ¶

type Wfmbushorttermforecastcopycompletetopicbuforecastmodification struct {
	// VarType
	VarType *string `json:"type,omitempty"`

	// StartIntervalIndex
	StartIntervalIndex *int `json:"startIntervalIndex,omitempty"`

	// EndIntervalIndex
	EndIntervalIndex *int `json:"endIntervalIndex,omitempty"`

	// Metric
	Metric *string `json:"metric,omitempty"`

	// LegacyMetric
	LegacyMetric *string `json:"legacyMetric,omitempty"`

	// Value
	Value *float32 `json:"value,omitempty"`

	// Values
	Values *[]Wfmbushorttermforecastcopycompletetopicmodificationintervaloffsetvalue `json:"values,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// Granularity
	Granularity *string `json:"granularity,omitempty"`

	// DisplayGranularity
	DisplayGranularity *string `json:"displayGranularity,omitempty"`

	// PlanningGroupIds
	PlanningGroupIds *[]string `json:"planningGroupIds,omitempty"`
}

Wfmbushorttermforecastcopycompletetopicbuforecastmodification

func (*Wfmbushorttermforecastcopycompletetopicbuforecastmodification) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastcopycompletetopicbushorttermforecast ¶

type Wfmbushorttermforecastcopycompletetopicbushorttermforecast struct {
	// Id
	Id *string `json:"id,omitempty"`

	// WeekDate
	WeekDate *string `json:"weekDate,omitempty"`

	// CreationMethod
	CreationMethod *string `json:"creationMethod,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Legacy
	Legacy *bool `json:"legacy,omitempty"`

	// ReferenceStartDate
	ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"`

	// SourceDays
	SourceDays *[]Wfmbushorttermforecastcopycompletetopicforecastsourcedaypointer `json:"sourceDays,omitempty"`

	// Modifications
	Modifications *[]Wfmbushorttermforecastcopycompletetopicbuforecastmodification `json:"modifications,omitempty"`

	// TimeZone
	TimeZone *string `json:"timeZone,omitempty"`

	// PlanningGroupsVersion
	PlanningGroupsVersion *int `json:"planningGroupsVersion,omitempty"`

	// WeekCount
	WeekCount *int `json:"weekCount,omitempty"`

	// Metadata
	Metadata *Wfmbushorttermforecastcopycompletetopicwfmversionedentitymetadata `json:"metadata,omitempty"`

	// CanUseForScheduling
	CanUseForScheduling *bool `json:"canUseForScheduling,omitempty"`
}

Wfmbushorttermforecastcopycompletetopicbushorttermforecast

func (*Wfmbushorttermforecastcopycompletetopicbushorttermforecast) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastcopycompletetopicbushorttermforecastnotification ¶

type Wfmbushorttermforecastcopycompletetopicbushorttermforecastnotification struct {
	// Status
	Status *string `json:"status,omitempty"`

	// Result
	Result *Wfmbushorttermforecastcopycompletetopicbushorttermforecast `json:"result,omitempty"`

	// OperationId
	OperationId *string `json:"operationId,omitempty"`
}

Wfmbushorttermforecastcopycompletetopicbushorttermforecastnotification

func (*Wfmbushorttermforecastcopycompletetopicbushorttermforecastnotification) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastcopycompletetopicforecastsourcedaypointer ¶

type Wfmbushorttermforecastcopycompletetopicforecastsourcedaypointer struct {
	// DayOfWeek
	DayOfWeek *string `json:"dayOfWeek,omitempty"`

	// Weight
	Weight *int `json:"weight,omitempty"`

	// Date
	Date *string `json:"date,omitempty"`

	// FileName
	FileName *string `json:"fileName,omitempty"`

	// DataKey
	DataKey *string `json:"dataKey,omitempty"`
}

Wfmbushorttermforecastcopycompletetopicforecastsourcedaypointer

func (*Wfmbushorttermforecastcopycompletetopicforecastsourcedaypointer) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastcopycompletetopicmodificationintervaloffsetvalue ¶

type Wfmbushorttermforecastcopycompletetopicmodificationintervaloffsetvalue struct {
	// IntervalIndex
	IntervalIndex *int `json:"intervalIndex,omitempty"`

	// Value
	Value *float32 `json:"value,omitempty"`
}

Wfmbushorttermforecastcopycompletetopicmodificationintervaloffsetvalue

func (*Wfmbushorttermforecastcopycompletetopicmodificationintervaloffsetvalue) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastcopycompletetopicuserreference ¶

type Wfmbushorttermforecastcopycompletetopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmbushorttermforecastcopycompletetopicuserreference

func (*Wfmbushorttermforecastcopycompletetopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastcopycompletetopicwfmversionedentitymetadata ¶

type Wfmbushorttermforecastcopycompletetopicwfmversionedentitymetadata struct {
	// Version
	Version *int `json:"version,omitempty"`

	// ModifiedBy
	ModifiedBy *Wfmbushorttermforecastcopycompletetopicuserreference `json:"modifiedBy,omitempty"`

	// DateModified
	DateModified *time.Time `json:"dateModified,omitempty"`
}

Wfmbushorttermforecastcopycompletetopicwfmversionedentitymetadata

func (*Wfmbushorttermforecastcopycompletetopicwfmversionedentitymetadata) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastgenerateprogresstopicbuforecastmodification ¶

type Wfmbushorttermforecastgenerateprogresstopicbuforecastmodification struct {
	// VarType
	VarType *string `json:"type,omitempty"`

	// StartIntervalIndex
	StartIntervalIndex *int `json:"startIntervalIndex,omitempty"`

	// EndIntervalIndex
	EndIntervalIndex *int `json:"endIntervalIndex,omitempty"`

	// Metric
	Metric *string `json:"metric,omitempty"`

	// LegacyMetric
	LegacyMetric *string `json:"legacyMetric,omitempty"`

	// Value
	Value *float32 `json:"value,omitempty"`

	// Values
	Values *[]Wfmbushorttermforecastgenerateprogresstopicmodificationintervaloffsetvalue `json:"values,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// Granularity
	Granularity *string `json:"granularity,omitempty"`

	// DisplayGranularity
	DisplayGranularity *string `json:"displayGranularity,omitempty"`

	// PlanningGroupIds
	PlanningGroupIds *[]string `json:"planningGroupIds,omitempty"`
}

Wfmbushorttermforecastgenerateprogresstopicbuforecastmodification

func (*Wfmbushorttermforecastgenerateprogresstopicbuforecastmodification) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastgenerateprogresstopicbushorttermforecast ¶

type Wfmbushorttermforecastgenerateprogresstopicbushorttermforecast struct {
	// Id
	Id *string `json:"id,omitempty"`

	// WeekDate
	WeekDate *string `json:"weekDate,omitempty"`

	// CreationMethod
	CreationMethod *string `json:"creationMethod,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Legacy
	Legacy *bool `json:"legacy,omitempty"`

	// ReferenceStartDate
	ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"`

	// SourceDays
	SourceDays *[]Wfmbushorttermforecastgenerateprogresstopicforecastsourcedaypointer `json:"sourceDays,omitempty"`

	// Modifications
	Modifications *[]Wfmbushorttermforecastgenerateprogresstopicbuforecastmodification `json:"modifications,omitempty"`

	// TimeZone
	TimeZone *string `json:"timeZone,omitempty"`

	// PlanningGroupsVersion
	PlanningGroupsVersion *int `json:"planningGroupsVersion,omitempty"`

	// WeekCount
	WeekCount *int `json:"weekCount,omitempty"`

	// Metadata
	Metadata *Wfmbushorttermforecastgenerateprogresstopicwfmversionedentitymetadata `json:"metadata,omitempty"`

	// CanUseForScheduling
	CanUseForScheduling *bool `json:"canUseForScheduling,omitempty"`
}

Wfmbushorttermforecastgenerateprogresstopicbushorttermforecast

func (*Wfmbushorttermforecastgenerateprogresstopicbushorttermforecast) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastgenerateprogresstopicforecastsourcedaypointer ¶

type Wfmbushorttermforecastgenerateprogresstopicforecastsourcedaypointer struct {
	// DayOfWeek
	DayOfWeek *string `json:"dayOfWeek,omitempty"`

	// Weight
	Weight *int `json:"weight,omitempty"`

	// Date
	Date *string `json:"date,omitempty"`

	// FileName
	FileName *string `json:"fileName,omitempty"`

	// DataKey
	DataKey *string `json:"dataKey,omitempty"`
}

Wfmbushorttermforecastgenerateprogresstopicforecastsourcedaypointer

func (*Wfmbushorttermforecastgenerateprogresstopicforecastsourcedaypointer) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastgenerateprogresstopicgeneratebushorttermforecastprogressnotification ¶

type Wfmbushorttermforecastgenerateprogresstopicgeneratebushorttermforecastprogressnotification struct {
	// Status
	Status *string `json:"status,omitempty"`

	// Result
	Result *Wfmbushorttermforecastgenerateprogresstopicbushorttermforecast `json:"result,omitempty"`

	// OperationId
	OperationId *string `json:"operationId,omitempty"`

	// Progress
	Progress *int `json:"progress,omitempty"`
}

Wfmbushorttermforecastgenerateprogresstopicgeneratebushorttermforecastprogressnotification

func (*Wfmbushorttermforecastgenerateprogresstopicgeneratebushorttermforecastprogressnotification) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastgenerateprogresstopicmodificationintervaloffsetvalue ¶

type Wfmbushorttermforecastgenerateprogresstopicmodificationintervaloffsetvalue struct {
	// IntervalIndex
	IntervalIndex *int `json:"intervalIndex,omitempty"`

	// Value
	Value *float32 `json:"value,omitempty"`
}

Wfmbushorttermforecastgenerateprogresstopicmodificationintervaloffsetvalue

func (*Wfmbushorttermforecastgenerateprogresstopicmodificationintervaloffsetvalue) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastgenerateprogresstopicuserreference ¶

type Wfmbushorttermforecastgenerateprogresstopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmbushorttermforecastgenerateprogresstopicuserreference

func (*Wfmbushorttermforecastgenerateprogresstopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastgenerateprogresstopicwfmversionedentitymetadata ¶

type Wfmbushorttermforecastgenerateprogresstopicwfmversionedentitymetadata struct {
	// Version
	Version *int `json:"version,omitempty"`

	// ModifiedBy
	ModifiedBy *Wfmbushorttermforecastgenerateprogresstopicuserreference `json:"modifiedBy,omitempty"`

	// DateModified
	DateModified *time.Time `json:"dateModified,omitempty"`
}

Wfmbushorttermforecastgenerateprogresstopicwfmversionedentitymetadata

func (*Wfmbushorttermforecastgenerateprogresstopicwfmversionedentitymetadata) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastimportcompletetopicbuforecastmodification ¶

type Wfmbushorttermforecastimportcompletetopicbuforecastmodification struct {
	// VarType
	VarType *string `json:"type,omitempty"`

	// StartIntervalIndex
	StartIntervalIndex *int `json:"startIntervalIndex,omitempty"`

	// EndIntervalIndex
	EndIntervalIndex *int `json:"endIntervalIndex,omitempty"`

	// Metric
	Metric *string `json:"metric,omitempty"`

	// LegacyMetric
	LegacyMetric *string `json:"legacyMetric,omitempty"`

	// Value
	Value *float32 `json:"value,omitempty"`

	// Values
	Values *[]Wfmbushorttermforecastimportcompletetopicmodificationintervaloffsetvalue `json:"values,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// Granularity
	Granularity *string `json:"granularity,omitempty"`

	// DisplayGranularity
	DisplayGranularity *string `json:"displayGranularity,omitempty"`

	// PlanningGroupIds
	PlanningGroupIds *[]string `json:"planningGroupIds,omitempty"`
}

Wfmbushorttermforecastimportcompletetopicbuforecastmodification

func (*Wfmbushorttermforecastimportcompletetopicbuforecastmodification) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastimportcompletetopicbushorttermforecast ¶

type Wfmbushorttermforecastimportcompletetopicbushorttermforecast struct {
	// Id
	Id *string `json:"id,omitempty"`

	// WeekDate
	WeekDate *string `json:"weekDate,omitempty"`

	// CreationMethod
	CreationMethod *string `json:"creationMethod,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Legacy
	Legacy *bool `json:"legacy,omitempty"`

	// ReferenceStartDate
	ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"`

	// SourceDays
	SourceDays *[]Wfmbushorttermforecastimportcompletetopicforecastsourcedaypointer `json:"sourceDays,omitempty"`

	// Modifications
	Modifications *[]Wfmbushorttermforecastimportcompletetopicbuforecastmodification `json:"modifications,omitempty"`

	// TimeZone
	TimeZone *string `json:"timeZone,omitempty"`

	// PlanningGroupsVersion
	PlanningGroupsVersion *int `json:"planningGroupsVersion,omitempty"`

	// WeekCount
	WeekCount *int `json:"weekCount,omitempty"`

	// Metadata
	Metadata *Wfmbushorttermforecastimportcompletetopicwfmversionedentitymetadata `json:"metadata,omitempty"`

	// CanUseForScheduling
	CanUseForScheduling *bool `json:"canUseForScheduling,omitempty"`
}

Wfmbushorttermforecastimportcompletetopicbushorttermforecast

func (*Wfmbushorttermforecastimportcompletetopicbushorttermforecast) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastimportcompletetopicbushorttermforecastnotification ¶

type Wfmbushorttermforecastimportcompletetopicbushorttermforecastnotification struct {
	// Status
	Status *string `json:"status,omitempty"`

	// Result
	Result *Wfmbushorttermforecastimportcompletetopicbushorttermforecast `json:"result,omitempty"`

	// OperationId
	OperationId *string `json:"operationId,omitempty"`
}

Wfmbushorttermforecastimportcompletetopicbushorttermforecastnotification

func (*Wfmbushorttermforecastimportcompletetopicbushorttermforecastnotification) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastimportcompletetopicforecastsourcedaypointer ¶

type Wfmbushorttermforecastimportcompletetopicforecastsourcedaypointer struct {
	// DayOfWeek
	DayOfWeek *string `json:"dayOfWeek,omitempty"`

	// Weight
	Weight *int `json:"weight,omitempty"`

	// Date
	Date *string `json:"date,omitempty"`

	// FileName
	FileName *string `json:"fileName,omitempty"`

	// DataKey
	DataKey *string `json:"dataKey,omitempty"`
}

Wfmbushorttermforecastimportcompletetopicforecastsourcedaypointer

func (*Wfmbushorttermforecastimportcompletetopicforecastsourcedaypointer) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastimportcompletetopicmodificationintervaloffsetvalue ¶

type Wfmbushorttermforecastimportcompletetopicmodificationintervaloffsetvalue struct {
	// IntervalIndex
	IntervalIndex *int `json:"intervalIndex,omitempty"`

	// Value
	Value *float32 `json:"value,omitempty"`
}

Wfmbushorttermforecastimportcompletetopicmodificationintervaloffsetvalue

func (*Wfmbushorttermforecastimportcompletetopicmodificationintervaloffsetvalue) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastimportcompletetopicuserreference ¶

type Wfmbushorttermforecastimportcompletetopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmbushorttermforecastimportcompletetopicuserreference

func (*Wfmbushorttermforecastimportcompletetopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastimportcompletetopicwfmversionedentitymetadata ¶

type Wfmbushorttermforecastimportcompletetopicwfmversionedentitymetadata struct {
	// Version
	Version *int `json:"version,omitempty"`

	// ModifiedBy
	ModifiedBy *Wfmbushorttermforecastimportcompletetopicuserreference `json:"modifiedBy,omitempty"`

	// DateModified
	DateModified *time.Time `json:"dateModified,omitempty"`
}

Wfmbushorttermforecastimportcompletetopicwfmversionedentitymetadata

func (*Wfmbushorttermforecastimportcompletetopicwfmversionedentitymetadata) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastupdatecompletetopicbuforecastmodification ¶

type Wfmbushorttermforecastupdatecompletetopicbuforecastmodification struct {
	// VarType
	VarType *string `json:"type,omitempty"`

	// StartIntervalIndex
	StartIntervalIndex *int `json:"startIntervalIndex,omitempty"`

	// EndIntervalIndex
	EndIntervalIndex *int `json:"endIntervalIndex,omitempty"`

	// Metric
	Metric *string `json:"metric,omitempty"`

	// LegacyMetric
	LegacyMetric *string `json:"legacyMetric,omitempty"`

	// Value
	Value *float32 `json:"value,omitempty"`

	// Values
	Values *[]Wfmbushorttermforecastupdatecompletetopicmodificationintervaloffsetvalue `json:"values,omitempty"`

	// Enabled
	Enabled *bool `json:"enabled,omitempty"`

	// Granularity
	Granularity *string `json:"granularity,omitempty"`

	// DisplayGranularity
	DisplayGranularity *string `json:"displayGranularity,omitempty"`

	// PlanningGroupIds
	PlanningGroupIds *[]string `json:"planningGroupIds,omitempty"`
}

Wfmbushorttermforecastupdatecompletetopicbuforecastmodification

func (*Wfmbushorttermforecastupdatecompletetopicbuforecastmodification) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastupdatecompletetopicbushorttermforecast ¶

type Wfmbushorttermforecastupdatecompletetopicbushorttermforecast struct {
	// Id
	Id *string `json:"id,omitempty"`

	// WeekDate
	WeekDate *string `json:"weekDate,omitempty"`

	// CreationMethod
	CreationMethod *string `json:"creationMethod,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// Legacy
	Legacy *bool `json:"legacy,omitempty"`

	// ReferenceStartDate
	ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"`

	// SourceDays
	SourceDays *[]Wfmbushorttermforecastupdatecompletetopicforecastsourcedaypointer `json:"sourceDays,omitempty"`

	// Modifications
	Modifications *[]Wfmbushorttermforecastupdatecompletetopicbuforecastmodification `json:"modifications,omitempty"`

	// TimeZone
	TimeZone *string `json:"timeZone,omitempty"`

	// PlanningGroupsVersion
	PlanningGroupsVersion *int `json:"planningGroupsVersion,omitempty"`

	// WeekCount
	WeekCount *int `json:"weekCount,omitempty"`

	// Metadata
	Metadata *Wfmbushorttermforecastupdatecompletetopicwfmversionedentitymetadata `json:"metadata,omitempty"`

	// CanUseForScheduling
	CanUseForScheduling *bool `json:"canUseForScheduling,omitempty"`
}

Wfmbushorttermforecastupdatecompletetopicbushorttermforecast

func (*Wfmbushorttermforecastupdatecompletetopicbushorttermforecast) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastupdatecompletetopicbushorttermforecastnotification ¶

type Wfmbushorttermforecastupdatecompletetopicbushorttermforecastnotification struct {
	// Status
	Status *string `json:"status,omitempty"`

	// Result
	Result *Wfmbushorttermforecastupdatecompletetopicbushorttermforecast `json:"result,omitempty"`

	// OperationId
	OperationId *string `json:"operationId,omitempty"`
}

Wfmbushorttermforecastupdatecompletetopicbushorttermforecastnotification

func (*Wfmbushorttermforecastupdatecompletetopicbushorttermforecastnotification) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastupdatecompletetopicforecastsourcedaypointer ¶

type Wfmbushorttermforecastupdatecompletetopicforecastsourcedaypointer struct {
	// DayOfWeek
	DayOfWeek *string `json:"dayOfWeek,omitempty"`

	// Weight
	Weight *int `json:"weight,omitempty"`

	// Date
	Date *string `json:"date,omitempty"`

	// FileName
	FileName *string `json:"fileName,omitempty"`

	// DataKey
	DataKey *string `json:"dataKey,omitempty"`
}

Wfmbushorttermforecastupdatecompletetopicforecastsourcedaypointer

func (*Wfmbushorttermforecastupdatecompletetopicforecastsourcedaypointer) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastupdatecompletetopicmodificationintervaloffsetvalue ¶

type Wfmbushorttermforecastupdatecompletetopicmodificationintervaloffsetvalue struct {
	// IntervalIndex
	IntervalIndex *int `json:"intervalIndex,omitempty"`

	// Value
	Value *float32 `json:"value,omitempty"`
}

Wfmbushorttermforecastupdatecompletetopicmodificationintervaloffsetvalue

func (*Wfmbushorttermforecastupdatecompletetopicmodificationintervaloffsetvalue) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastupdatecompletetopicuserreference ¶

type Wfmbushorttermforecastupdatecompletetopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmbushorttermforecastupdatecompletetopicuserreference

func (*Wfmbushorttermforecastupdatecompletetopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmbushorttermforecastupdatecompletetopicwfmversionedentitymetadata ¶

type Wfmbushorttermforecastupdatecompletetopicwfmversionedentitymetadata struct {
	// Version
	Version *int `json:"version,omitempty"`

	// ModifiedBy
	ModifiedBy *Wfmbushorttermforecastupdatecompletetopicuserreference `json:"modifiedBy,omitempty"`

	// DateModified
	DateModified *time.Time `json:"dateModified,omitempty"`
}

Wfmbushorttermforecastupdatecompletetopicwfmversionedentitymetadata

func (*Wfmbushorttermforecastupdatecompletetopicwfmversionedentitymetadata) String ¶

String returns a JSON representation of the model

type Wfmbusinessunitreference ¶

type Wfmbusinessunitreference struct {
	// Id - The ID of the business unit
	Id *string `json:"id,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Wfmbusinessunitreference

func (*Wfmbusinessunitreference) String ¶

func (o *Wfmbusinessunitreference) String() string

String returns a JSON representation of the model

type Wfmforecastmodificationintervaloffsetvalue ¶

type Wfmforecastmodificationintervaloffsetvalue struct {
	// IntervalIndex - The number of 15 minute intervals past referenceStartDate to which to apply this modification
	IntervalIndex *int `json:"intervalIndex,omitempty"`

	// Value - The value to set for the given interval
	Value *float64 `json:"value,omitempty"`
}

Wfmforecastmodificationintervaloffsetvalue - Override the value of a single interval in a forecast

func (*Wfmforecastmodificationintervaloffsetvalue) String ¶

String returns a JSON representation of the model

type Wfmhistoricaladherencecalculationscompletetopicwfmhistoricaladherencecalculationscompletenotice ¶

type Wfmhistoricaladherencecalculationscompletetopicwfmhistoricaladherencecalculationscompletenotice struct {
	// Id
	Id *string `json:"id,omitempty"`

	// DownloadUrl
	DownloadUrl *string `json:"downloadUrl,omitempty"`

	// DownloadUrls
	DownloadUrls *[]string `json:"downloadUrls,omitempty"`

	// QueryState
	QueryState *string `json:"queryState,omitempty"`
}

Wfmhistoricaladherencecalculationscompletetopicwfmhistoricaladherencecalculationscompletenotice

func (*Wfmhistoricaladherencecalculationscompletetopicwfmhistoricaladherencecalculationscompletenotice) String ¶

String returns a JSON representation of the model

type Wfmhistoricaladherencequery ¶

type Wfmhistoricaladherencequery struct {
	// StartDate - Beginning of the date range to query in ISO-8601 format
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time
	EndDate *time.Time `json:"endDate,omitempty"`

	// TimeZone - The time zone to use for returned results in olson format. If it is not set, the business unit time zone will be used to compute adherence
	TimeZone *string `json:"timeZone,omitempty"`

	// UserIds - The userIds to report on. If null or not set, adherence will be computed for all the users in management unit or requested teamIds
	UserIds *[]string `json:"userIds,omitempty"`

	// IncludeExceptions - Whether user exceptions should be returned as part of the results
	IncludeExceptions *bool `json:"includeExceptions,omitempty"`
}

Wfmhistoricaladherencequery

func (*Wfmhistoricaladherencequery) String ¶

func (o *Wfmhistoricaladherencequery) String() string

String returns a JSON representation of the model

type Wfmhistoricaladherencequeryforusers ¶

type Wfmhistoricaladherencequeryforusers struct {
	// StartDate - Beginning of the date range to query in ISO-8601 format
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate - End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time
	EndDate *time.Time `json:"endDate,omitempty"`

	// TimeZone - The time zone to use for returned results in olson format. If it is not set, the business unit time zone will be used to compute adherence
	TimeZone *string `json:"timeZone,omitempty"`

	// UserIds - The userIds to report on
	UserIds *[]string `json:"userIds,omitempty"`

	// IncludeExceptions - Whether user exceptions should be returned as part of the results
	IncludeExceptions *bool `json:"includeExceptions,omitempty"`
}

Wfmhistoricaladherencequeryforusers

func (*Wfmhistoricaladherencequeryforusers) String ¶

String returns a JSON representation of the model

type Wfmhistoricaladherenceresponse ¶

type Wfmhistoricaladherenceresponse struct {
	// Id - The query ID to listen for
	Id *string `json:"id,omitempty"`

	// DownloadUrl - Deprecated. Use downloadUrls instead.
	DownloadUrl *string `json:"downloadUrl,omitempty"`

	// DownloadResult - Result will always come via downloadUrls; however the schema is included for documentation
	DownloadResult *Wfmhistoricaladherenceresultwrapper `json:"downloadResult,omitempty"`

	// DownloadUrls - The uri list to GET the results of the Historical Adherence query. For notification purposes only
	DownloadUrls *[]string `json:"downloadUrls,omitempty"`

	// QueryState - The state of the adherence query
	QueryState *string `json:"queryState,omitempty"`
}

Wfmhistoricaladherenceresponse - Response for Historical Adherence Query, intended to tell the client what to listen for on a notification topic

func (*Wfmhistoricaladherenceresponse) String ¶

String returns a JSON representation of the model

type Wfmhistoricaladherenceresultwrapper ¶

type Wfmhistoricaladherenceresultwrapper struct {
	// EntityId - The operation ID of the historical adherence query
	EntityId *string `json:"entityId,omitempty"`

	// Data - The list of historical adherence query results
	Data *[]Historicaladherencequeryresult `json:"data,omitempty"`

	// LookupIdToSecondaryPresenceId - Map of secondary presence lookup ID to corresponding secondary presence ID
	LookupIdToSecondaryPresenceId *map[string]string `json:"lookupIdToSecondaryPresenceId,omitempty"`
}

Wfmhistoricaladherenceresultwrapper

func (*Wfmhistoricaladherenceresultwrapper) String ¶

String returns a JSON representation of the model

type Wfmhistoricaldatauploadpurgerequeststatustopichistoricaldatauploadpurgerequestupdate ¶

type Wfmhistoricaldatauploadpurgerequeststatustopichistoricaldatauploadpurgerequestupdate struct {
	// Status
	Status *string `json:"status,omitempty"`
}

Wfmhistoricaldatauploadpurgerequeststatustopichistoricaldatauploadpurgerequestupdate

func (*Wfmhistoricaldatauploadpurgerequeststatustopichistoricaldatauploadpurgerequestupdate) String ¶

String returns a JSON representation of the model

type Wfmhistoricaldatauploadrequeststatustopichistoricaldatauploadrequestupdate ¶

type Wfmhistoricaldatauploadrequeststatustopichistoricaldatauploadrequestupdate struct {
	// RequestId
	RequestId *string `json:"requestId,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`

	// VarError
	VarError *string `json:"error,omitempty"`

	// Active
	Active *bool `json:"active,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`
}

Wfmhistoricaldatauploadrequeststatustopichistoricaldatauploadrequestupdate

func (*Wfmhistoricaldatauploadrequeststatustopichistoricaldatauploadrequestupdate) String ¶

String returns a JSON representation of the model

type Wfmintradaydataupdatetopicintradaydatagroup ¶

type Wfmintradaydataupdatetopicintradaydatagroup struct {
	// MediaType
	MediaType *string `json:"mediaType,omitempty"`

	// ForecastDataPerInterval
	ForecastDataPerInterval *[]Wfmintradaydataupdatetopicintradayforecastdata `json:"forecastDataPerInterval,omitempty"`

	// ScheduleDataPerInterval
	ScheduleDataPerInterval *[]Wfmintradaydataupdatetopicintradayscheduledata `json:"scheduleDataPerInterval,omitempty"`

	// HistoricalAgentDataPerInterval
	HistoricalAgentDataPerInterval *[]Wfmintradaydataupdatetopicintradayhistoricalagentdata `json:"historicalAgentDataPerInterval,omitempty"`

	// HistoricalQueueDataPerInterval
	HistoricalQueueDataPerInterval *[]Wfmintradaydataupdatetopicintradayhistoricalqueuedata `json:"historicalQueueDataPerInterval,omitempty"`

	// PerformancePredictionAgentDataPerInterval
	PerformancePredictionAgentDataPerInterval *[]Wfmintradaydataupdatetopicintradayperformancepredictionagentdata `json:"performancePredictionAgentDataPerInterval,omitempty"`

	// PerformancePredictionQueueDataPerInterval
	PerformancePredictionQueueDataPerInterval *[]Wfmintradaydataupdatetopicintradayperformancepredictionqueuedata `json:"performancePredictionQueueDataPerInterval,omitempty"`
}

Wfmintradaydataupdatetopicintradaydatagroup

func (*Wfmintradaydataupdatetopicintradaydatagroup) String ¶

String returns a JSON representation of the model

type Wfmintradaydataupdatetopicintradaydataupdate ¶

type Wfmintradaydataupdatetopicintradaydataupdate struct {
	// StartDate
	StartDate *time.Time `json:"startDate,omitempty"`

	// EndDate
	EndDate *time.Time `json:"endDate,omitempty"`

	// IntervalLengthMinutes
	IntervalLengthMinutes *int `json:"intervalLengthMinutes,omitempty"`

	// NumberOfIntervals
	NumberOfIntervals *int `json:"numberOfIntervals,omitempty"`

	// Metrics
	Metrics *[]Wfmintradaydataupdatetopicintradaymetric `json:"metrics,omitempty"`

	// QueueIds
	QueueIds *[]string `json:"queueIds,omitempty"`

	// IntradayDataGroupings
	IntradayDataGroupings *[]Wfmintradaydataupdatetopicintradaydatagroup `json:"intradayDataGroupings,omitempty"`
}

Wfmintradaydataupdatetopicintradaydataupdate

func (*Wfmintradaydataupdatetopicintradaydataupdate) String ¶

String returns a JSON representation of the model

type Wfmintradaydataupdatetopicintradayforecastdata ¶

type Wfmintradaydataupdatetopicintradayforecastdata struct {
	// Offered
	Offered *float32 `json:"offered,omitempty"`

	// AverageTalkTimeSeconds
	AverageTalkTimeSeconds *float32 `json:"averageTalkTimeSeconds,omitempty"`

	// AverageAfterCallWorkSeconds
	AverageAfterCallWorkSeconds *float32 `json:"averageAfterCallWorkSeconds,omitempty"`
}

Wfmintradaydataupdatetopicintradayforecastdata

func (*Wfmintradaydataupdatetopicintradayforecastdata) String ¶

String returns a JSON representation of the model

type Wfmintradaydataupdatetopicintradayhistoricalagentdata ¶

type Wfmintradaydataupdatetopicintradayhistoricalagentdata struct {
	// OnQueueTimeSeconds
	OnQueueTimeSeconds *float32 `json:"onQueueTimeSeconds,omitempty"`

	// InteractingTimeSeconds
	InteractingTimeSeconds *float32 `json:"interactingTimeSeconds,omitempty"`
}

Wfmintradaydataupdatetopicintradayhistoricalagentdata

func (*Wfmintradaydataupdatetopicintradayhistoricalagentdata) String ¶

String returns a JSON representation of the model

type Wfmintradaydataupdatetopicintradayhistoricalqueuedata ¶

type Wfmintradaydataupdatetopicintradayhistoricalqueuedata struct {
	// Offered
	Offered *int `json:"offered,omitempty"`

	// Completed
	Completed *int `json:"completed,omitempty"`

	// Answered
	Answered *int `json:"answered,omitempty"`

	// Abandoned
	Abandoned *int `json:"abandoned,omitempty"`

	// AverageTalkTimeSeconds
	AverageTalkTimeSeconds *float32 `json:"averageTalkTimeSeconds,omitempty"`

	// AverageAfterCallWorkSeconds
	AverageAfterCallWorkSeconds *float32 `json:"averageAfterCallWorkSeconds,omitempty"`

	// ServiceLevelPercent
	ServiceLevelPercent *float32 `json:"serviceLevelPercent,omitempty"`

	// AverageSpeedOfAnswerSeconds
	AverageSpeedOfAnswerSeconds *float32 `json:"averageSpeedOfAnswerSeconds,omitempty"`
}

Wfmintradaydataupdatetopicintradayhistoricalqueuedata

func (*Wfmintradaydataupdatetopicintradayhistoricalqueuedata) String ¶

String returns a JSON representation of the model

type Wfmintradaydataupdatetopicintradaymetric ¶

type Wfmintradaydataupdatetopicintradaymetric struct {
	// Category
	Category *string `json:"category,omitempty"`

	// Version
	Version *string `json:"version,omitempty"`
}

Wfmintradaydataupdatetopicintradaymetric

func (*Wfmintradaydataupdatetopicintradaymetric) String ¶

String returns a JSON representation of the model

type Wfmintradaydataupdatetopicintradayperformancepredictionagentdata ¶

type Wfmintradaydataupdatetopicintradayperformancepredictionagentdata struct {
	// InteractingTimeSeconds
	InteractingTimeSeconds *float32 `json:"interactingTimeSeconds,omitempty"`
}

Wfmintradaydataupdatetopicintradayperformancepredictionagentdata

func (*Wfmintradaydataupdatetopicintradayperformancepredictionagentdata) String ¶

String returns a JSON representation of the model

type Wfmintradaydataupdatetopicintradayperformancepredictionqueuedata ¶

type Wfmintradaydataupdatetopicintradayperformancepredictionqueuedata struct {
	// ServiceLevelPercent
	ServiceLevelPercent *float32 `json:"serviceLevelPercent,omitempty"`

	// AverageSpeedOfAnswerSeconds
	AverageSpeedOfAnswerSeconds *float32 `json:"averageSpeedOfAnswerSeconds,omitempty"`

	// NumberOfInteractions
	NumberOfInteractions *float32 `json:"numberOfInteractions,omitempty"`
}

Wfmintradaydataupdatetopicintradayperformancepredictionqueuedata

func (*Wfmintradaydataupdatetopicintradayperformancepredictionqueuedata) String ¶

String returns a JSON representation of the model

type Wfmintradaydataupdatetopicintradayscheduledata ¶

type Wfmintradaydataupdatetopicintradayscheduledata struct {
	// OnQueueTimeSeconds
	OnQueueTimeSeconds *int `json:"onQueueTimeSeconds,omitempty"`

	// ScheduledTimeSeconds
	ScheduledTimeSeconds *int `json:"scheduledTimeSeconds,omitempty"`
}

Wfmintradaydataupdatetopicintradayscheduledata

func (*Wfmintradaydataupdatetopicintradayscheduledata) String ¶

String returns a JSON representation of the model

type Wfmintradayplanninggrouplisting ¶

type Wfmintradayplanninggrouplisting struct {
	// Entities
	Entities *[]Forecastplanninggroupresponse `json:"entities,omitempty"`

	// NoDataReason - The reason there was no data for the request
	NoDataReason *string `json:"noDataReason,omitempty"`
}

Wfmintradayplanninggrouplisting - A list of IntradayPlanningGroup objects

func (*Wfmintradayplanninggrouplisting) String ¶

String returns a JSON representation of the model

type Wfmmoveagentscompletetopicmanagementunit ¶

type Wfmmoveagentscompletetopicmanagementunit struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmmoveagentscompletetopicmanagementunit

func (*Wfmmoveagentscompletetopicmanagementunit) String ¶

String returns a JSON representation of the model

type Wfmmoveagentscompletetopicuserreference ¶

type Wfmmoveagentscompletetopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmmoveagentscompletetopicuserreference

func (*Wfmmoveagentscompletetopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmmoveagentscompletetopicwfmmoveagentdata ¶

type Wfmmoveagentscompletetopicwfmmoveagentdata struct {
	// User
	User *Wfmmoveagentscompletetopicuserreference `json:"user,omitempty"`

	// Result
	Result *string `json:"result,omitempty"`
}

Wfmmoveagentscompletetopicwfmmoveagentdata

func (*Wfmmoveagentscompletetopicwfmmoveagentdata) String ¶

String returns a JSON representation of the model

type Wfmmoveagentscompletetopicwfmmoveagentscomplete ¶

type Wfmmoveagentscompletetopicwfmmoveagentscomplete struct {
	// RequestingUser
	RequestingUser *Wfmmoveagentscompletetopicuserreference `json:"requestingUser,omitempty"`

	// DestinationManagementUnit
	DestinationManagementUnit *Wfmmoveagentscompletetopicmanagementunit `json:"destinationManagementUnit,omitempty"`

	// Results
	Results *[]Wfmmoveagentscompletetopicwfmmoveagentdata `json:"results,omitempty"`
}

Wfmmoveagentscompletetopicwfmmoveagentscomplete

func (*Wfmmoveagentscompletetopicwfmmoveagentscomplete) String ¶

String returns a JSON representation of the model

type Wfmmovemanagementunittopicbusinessunit ¶

type Wfmmovemanagementunittopicbusinessunit struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmmovemanagementunittopicbusinessunit

func (*Wfmmovemanagementunittopicbusinessunit) String ¶

String returns a JSON representation of the model

type Wfmmovemanagementunittopicmovemanagementunitnotification ¶

type Wfmmovemanagementunittopicmovemanagementunitnotification struct {
	// BusinessUnit
	BusinessUnit *Wfmmovemanagementunittopicbusinessunit `json:"businessUnit,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`
}

Wfmmovemanagementunittopicmovemanagementunitnotification

func (*Wfmmovemanagementunittopicmovemanagementunitnotification) String ¶

String returns a JSON representation of the model

type Wfmschedulereference ¶

type Wfmschedulereference struct {
	// Id - The ID of the WFM schedule
	Id *string `json:"id,omitempty"`

	// BusinessUnit - A reference to a Workforce Management Business Unit
	BusinessUnit *Wfmbusinessunitreference `json:"businessUnit,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"`
}

Wfmschedulereference

func (*Wfmschedulereference) String ¶

func (o *Wfmschedulereference) String() string

String returns a JSON representation of the model

type Wfmscheduletopicwfmschedulenotification ¶

type Wfmscheduletopicwfmschedulenotification struct {
	// Status
	Status *string `json:"status,omitempty"`

	// OperationId
	OperationId *string `json:"operationId,omitempty"`

	// DownloadUrl
	DownloadUrl *string `json:"downloadUrl,omitempty"`

	// PercentComplete
	PercentComplete *int `json:"percentComplete,omitempty"`

	// EventType
	EventType *string `json:"eventType,omitempty"`
}

Wfmscheduletopicwfmschedulenotification

func (*Wfmscheduletopicwfmschedulenotification) String ¶

String returns a JSON representation of the model

type Wfmtimeoffrequestupdatetopictimeoffrequestupdate ¶

type Wfmtimeoffrequestupdatetopictimeoffrequestupdate struct {
	// Id
	Id *string `json:"id,omitempty"`

	// User
	User *Wfmtimeoffrequestupdatetopicuserreference `json:"user,omitempty"`

	// IsFullDayRequest
	IsFullDayRequest *bool `json:"isFullDayRequest,omitempty"`

	// MarkedAsRead
	MarkedAsRead *bool `json:"markedAsRead,omitempty"`

	// ActivityCodeId
	ActivityCodeId *string `json:"activityCodeId,omitempty"`

	// Paid
	Paid *bool `json:"paid,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`

	// Substatus
	Substatus *string `json:"substatus,omitempty"`

	// PartialDayStartDateTimes
	PartialDayStartDateTimes *[]string `json:"partialDayStartDateTimes,omitempty"`

	// FullDayManagementUnitDates
	FullDayManagementUnitDates *[]string `json:"fullDayManagementUnitDates,omitempty"`

	// DailyDurationMinutes
	DailyDurationMinutes *int `json:"dailyDurationMinutes,omitempty"`

	// Notes
	Notes *string `json:"notes,omitempty"`

	// ReviewedDate
	ReviewedDate *string `json:"reviewedDate,omitempty"`

	// ReviewedBy
	ReviewedBy *string `json:"reviewedBy,omitempty"`

	// SubmittedDate
	SubmittedDate *string `json:"submittedDate,omitempty"`

	// SubmittedBy
	SubmittedBy *string `json:"submittedBy,omitempty"`

	// ModifiedDate
	ModifiedDate *string `json:"modifiedDate,omitempty"`

	// ModifiedBy
	ModifiedBy *string `json:"modifiedBy,omitempty"`
}

Wfmtimeoffrequestupdatetopictimeoffrequestupdate

func (*Wfmtimeoffrequestupdatetopictimeoffrequestupdate) String ¶

String returns a JSON representation of the model

type Wfmtimeoffrequestupdatetopicuserreference ¶

type Wfmtimeoffrequestupdatetopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmtimeoffrequestupdatetopicuserreference

func (*Wfmtimeoffrequestupdatetopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmupdateagentdetailstopicwfmupdateagentdetailscomplete ¶

type Wfmupdateagentdetailstopicwfmupdateagentdetailscomplete struct {
	// Status
	Status *string `json:"status,omitempty"`
}

Wfmupdateagentdetailstopicwfmupdateagentdetailscomplete

func (*Wfmupdateagentdetailstopicwfmupdateagentdetailscomplete) String ¶

String returns a JSON representation of the model

type Wfmuserentitylisting ¶

type Wfmuserentitylisting struct {
	// Entities
	Entities *[]User `json:"entities,omitempty"`
}

Wfmuserentitylisting

func (*Wfmuserentitylisting) String ¶

func (o *Wfmuserentitylisting) String() string

String returns a JSON representation of the model

type Wfmusernotification ¶

type Wfmusernotification struct {
	// Id - The immutable globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// MutableGroupId - The group ID of the notification (mutable, may change  on update)
	MutableGroupId *string `json:"mutableGroupId,omitempty"`

	// Timestamp - The timestamp for this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	Timestamp *time.Time `json:"timestamp,omitempty"`

	// VarType - The type of this notification
	VarType *string `json:"type,omitempty"`

	// ShiftTrade - A shift trade notification.  Only set if type == ShiftTrade
	ShiftTrade *Shifttradenotification `json:"shiftTrade,omitempty"`

	// TimeOffRequest - A time off request notification.  Only set if type == TimeOffRequest
	TimeOffRequest *Timeoffrequestnotification `json:"timeOffRequest,omitempty"`

	// MarkedAsRead - Whether this notification has been marked \"read\"
	MarkedAsRead *bool `json:"markedAsRead,omitempty"`

	// AgentNotification - Whether this notification is for an agent
	AgentNotification *bool `json:"agentNotification,omitempty"`

	// OtherNotificationIdsInGroup - Other notification IDs in group.  This field is only populated in real-time notifications
	OtherNotificationIdsInGroup *[]string `json:"otherNotificationIdsInGroup,omitempty"`
}

Wfmusernotification

func (*Wfmusernotification) String ¶

func (o *Wfmusernotification) String() string

String returns a JSON representation of the model

type Wfmusernotificationtopicshifttradenotification ¶

type Wfmusernotificationtopicshifttradenotification struct {
	// WeekDate
	WeekDate *string `json:"weekDate,omitempty"`

	// TradeId
	TradeId *string `json:"tradeId,omitempty"`

	// OneSided
	OneSided *bool `json:"oneSided,omitempty"`

	// NewState
	NewState *string `json:"newState,omitempty"`

	// InitiatingUser
	InitiatingUser *Wfmusernotificationtopicuserreference `json:"initiatingUser,omitempty"`

	// InitiatingShiftDate
	InitiatingShiftDate *time.Time `json:"initiatingShiftDate,omitempty"`

	// ReceivingUser
	ReceivingUser *Wfmusernotificationtopicuserreference `json:"receivingUser,omitempty"`

	// ReceivingShiftDate
	ReceivingShiftDate *time.Time `json:"receivingShiftDate,omitempty"`
}

Wfmusernotificationtopicshifttradenotification

func (*Wfmusernotificationtopicshifttradenotification) String ¶

String returns a JSON representation of the model

type Wfmusernotificationtopictimeoffrequestnotification ¶

type Wfmusernotificationtopictimeoffrequestnotification struct {
	// TimeOffRequestId
	TimeOffRequestId *string `json:"timeOffRequestId,omitempty"`

	// User
	User *Wfmusernotificationtopicuserreference `json:"user,omitempty"`

	// IsFullDayRequest
	IsFullDayRequest *bool `json:"isFullDayRequest,omitempty"`

	// Status
	Status *string `json:"status,omitempty"`

	// PartialDayStartDateTimes
	PartialDayStartDateTimes *[]time.Time `json:"partialDayStartDateTimes,omitempty"`

	// FullDayManagementUnitDates
	FullDayManagementUnitDates *[]string `json:"fullDayManagementUnitDates,omitempty"`
}

Wfmusernotificationtopictimeoffrequestnotification

func (*Wfmusernotificationtopictimeoffrequestnotification) String ¶

String returns a JSON representation of the model

type Wfmusernotificationtopicuserreference ¶

type Wfmusernotificationtopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmusernotificationtopicuserreference

func (*Wfmusernotificationtopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmusernotificationtopicwfmusernotification ¶

type Wfmusernotificationtopicwfmusernotification struct {
	// Id
	Id *string `json:"id,omitempty"`

	// MutableGroupId
	MutableGroupId *string `json:"mutableGroupId,omitempty"`

	// Timestamp
	Timestamp *time.Time `json:"timestamp,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// ShiftTrade
	ShiftTrade *Wfmusernotificationtopicshifttradenotification `json:"shiftTrade,omitempty"`

	// TimeOffRequest
	TimeOffRequest *Wfmusernotificationtopictimeoffrequestnotification `json:"timeOffRequest,omitempty"`

	// AgentNotification
	AgentNotification *bool `json:"agentNotification,omitempty"`

	// OtherNotificationIdsInGroup
	OtherNotificationIdsInGroup *[]string `json:"otherNotificationIdsInGroup,omitempty"`

	// MarkedAsRead
	MarkedAsRead *bool `json:"markedAsRead,omitempty"`
}

Wfmusernotificationtopicwfmusernotification

func (*Wfmusernotificationtopicwfmusernotification) String ¶

String returns a JSON representation of the model

type Wfmuserscheduleadherenceupdatedmutopicqueuereference ¶

type Wfmuserscheduleadherenceupdatedmutopicqueuereference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmuserscheduleadherenceupdatedmutopicqueuereference

func (*Wfmuserscheduleadherenceupdatedmutopicqueuereference) String ¶

String returns a JSON representation of the model

type Wfmuserscheduleadherenceupdatedmutopicurireference ¶

type Wfmuserscheduleadherenceupdatedmutopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Wfmuserscheduleadherenceupdatedmutopicurireference

func (*Wfmuserscheduleadherenceupdatedmutopicurireference) String ¶

String returns a JSON representation of the model

type Wfmuserscheduleadherenceupdatedmutopicuserreference ¶

type Wfmuserscheduleadherenceupdatedmutopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmuserscheduleadherenceupdatedmutopicuserreference

func (*Wfmuserscheduleadherenceupdatedmutopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmuserscheduleadherenceupdatedmutopicuserscheduleadherenceupdate ¶

type Wfmuserscheduleadherenceupdatedmutopicuserscheduleadherenceupdate struct {
	// User
	User *Wfmuserscheduleadherenceupdatedmutopicuserreference `json:"user,omitempty"`

	// ManagementUnitId
	ManagementUnitId *string `json:"managementUnitId,omitempty"`

	// Team
	Team *Wfmuserscheduleadherenceupdatedmutopicurireference `json:"team,omitempty"`

	// ScheduledActivityCategory
	ScheduledActivityCategory *string `json:"scheduledActivityCategory,omitempty"`

	// SystemPresence
	SystemPresence *string `json:"systemPresence,omitempty"`

	// OrganizationSecondaryPresenceId
	OrganizationSecondaryPresenceId *string `json:"organizationSecondaryPresenceId,omitempty"`

	// RoutingStatus
	RoutingStatus *string `json:"routingStatus,omitempty"`

	// ActualActivityCategory
	ActualActivityCategory *string `json:"actualActivityCategory,omitempty"`

	// IsOutOfOffice
	IsOutOfOffice *bool `json:"isOutOfOffice,omitempty"`

	// AdherenceState
	AdherenceState *string `json:"adherenceState,omitempty"`

	// Impact
	Impact *string `json:"impact,omitempty"`

	// AdherenceChangeTime
	AdherenceChangeTime *time.Time `json:"adherenceChangeTime,omitempty"`

	// PresenceUpdateTime
	PresenceUpdateTime *time.Time `json:"presenceUpdateTime,omitempty"`

	// ActiveQueues
	ActiveQueues *[]Wfmuserscheduleadherenceupdatedmutopicqueuereference `json:"activeQueues,omitempty"`

	// ActiveQueuesModifiedTime
	ActiveQueuesModifiedTime *time.Time `json:"activeQueuesModifiedTime,omitempty"`

	// RemovedFromManagementUnit
	RemovedFromManagementUnit *bool `json:"removedFromManagementUnit,omitempty"`
}

Wfmuserscheduleadherenceupdatedmutopicuserscheduleadherenceupdate

func (*Wfmuserscheduleadherenceupdatedmutopicuserscheduleadherenceupdate) String ¶

String returns a JSON representation of the model

type Wfmuserscheduleadherenceupdatedteamtopicqueuereference ¶

type Wfmuserscheduleadherenceupdatedteamtopicqueuereference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmuserscheduleadherenceupdatedteamtopicqueuereference

func (*Wfmuserscheduleadherenceupdatedteamtopicqueuereference) String ¶

String returns a JSON representation of the model

type Wfmuserscheduleadherenceupdatedteamtopicurireference ¶

type Wfmuserscheduleadherenceupdatedteamtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Wfmuserscheduleadherenceupdatedteamtopicurireference

func (*Wfmuserscheduleadherenceupdatedteamtopicurireference) String ¶

String returns a JSON representation of the model

type Wfmuserscheduleadherenceupdatedteamtopicuserreference ¶

type Wfmuserscheduleadherenceupdatedteamtopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmuserscheduleadherenceupdatedteamtopicuserreference

func (*Wfmuserscheduleadherenceupdatedteamtopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmuserscheduleadherenceupdatedteamtopicuserscheduleadherenceupdate ¶

type Wfmuserscheduleadherenceupdatedteamtopicuserscheduleadherenceupdate struct {
	// User
	User *Wfmuserscheduleadherenceupdatedteamtopicuserreference `json:"user,omitempty"`

	// ManagementUnitId
	ManagementUnitId *string `json:"managementUnitId,omitempty"`

	// Team
	Team *Wfmuserscheduleadherenceupdatedteamtopicurireference `json:"team,omitempty"`

	// ScheduledActivityCategory
	ScheduledActivityCategory *string `json:"scheduledActivityCategory,omitempty"`

	// SystemPresence
	SystemPresence *string `json:"systemPresence,omitempty"`

	// OrganizationSecondaryPresenceId
	OrganizationSecondaryPresenceId *string `json:"organizationSecondaryPresenceId,omitempty"`

	// RoutingStatus
	RoutingStatus *string `json:"routingStatus,omitempty"`

	// ActualActivityCategory
	ActualActivityCategory *string `json:"actualActivityCategory,omitempty"`

	// IsOutOfOffice
	IsOutOfOffice *bool `json:"isOutOfOffice,omitempty"`

	// AdherenceState
	AdherenceState *string `json:"adherenceState,omitempty"`

	// Impact
	Impact *string `json:"impact,omitempty"`

	// AdherenceChangeTime
	AdherenceChangeTime *time.Time `json:"adherenceChangeTime,omitempty"`

	// PresenceUpdateTime
	PresenceUpdateTime *time.Time `json:"presenceUpdateTime,omitempty"`

	// ActiveQueues
	ActiveQueues *[]Wfmuserscheduleadherenceupdatedteamtopicqueuereference `json:"activeQueues,omitempty"`

	// ActiveQueuesModifiedTime
	ActiveQueuesModifiedTime *time.Time `json:"activeQueuesModifiedTime,omitempty"`

	// RemovedFromManagementUnit
	RemovedFromManagementUnit *bool `json:"removedFromManagementUnit,omitempty"`
}

Wfmuserscheduleadherenceupdatedteamtopicuserscheduleadherenceupdate

func (*Wfmuserscheduleadherenceupdatedteamtopicuserscheduleadherenceupdate) String ¶

String returns a JSON representation of the model

type Wfmuserscheduleadherenceupdatedtopicqueuereference ¶

type Wfmuserscheduleadherenceupdatedtopicqueuereference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmuserscheduleadherenceupdatedtopicqueuereference

func (*Wfmuserscheduleadherenceupdatedtopicqueuereference) String ¶

String returns a JSON representation of the model

type Wfmuserscheduleadherenceupdatedtopicurireference ¶

type Wfmuserscheduleadherenceupdatedtopicurireference struct {
	// Id
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`
}

Wfmuserscheduleadherenceupdatedtopicurireference

func (*Wfmuserscheduleadherenceupdatedtopicurireference) String ¶

String returns a JSON representation of the model

type Wfmuserscheduleadherenceupdatedtopicuserreference ¶

type Wfmuserscheduleadherenceupdatedtopicuserreference struct {
	// Id
	Id *string `json:"id,omitempty"`
}

Wfmuserscheduleadherenceupdatedtopicuserreference

func (*Wfmuserscheduleadherenceupdatedtopicuserreference) String ¶

String returns a JSON representation of the model

type Wfmuserscheduleadherenceupdatedtopicuserscheduleadherenceupdate ¶

type Wfmuserscheduleadherenceupdatedtopicuserscheduleadherenceupdate struct {
	// User
	User *Wfmuserscheduleadherenceupdatedtopicuserreference `json:"user,omitempty"`

	// ManagementUnitId
	ManagementUnitId *string `json:"managementUnitId,omitempty"`

	// Team
	Team *Wfmuserscheduleadherenceupdatedtopicurireference `json:"team,omitempty"`

	// ScheduledActivityCategory
	ScheduledActivityCategory *string `json:"scheduledActivityCategory,omitempty"`

	// SystemPresence
	SystemPresence *string `json:"systemPresence,omitempty"`

	// OrganizationSecondaryPresenceId
	OrganizationSecondaryPresenceId *string `json:"organizationSecondaryPresenceId,omitempty"`

	// RoutingStatus
	RoutingStatus *string `json:"routingStatus,omitempty"`

	// ActualActivityCategory
	ActualActivityCategory *string `json:"actualActivityCategory,omitempty"`

	// IsOutOfOffice
	IsOutOfOffice *bool `json:"isOutOfOffice,omitempty"`

	// AdherenceState
	AdherenceState *string `json:"adherenceState,omitempty"`

	// Impact
	Impact *string `json:"impact,omitempty"`

	// AdherenceChangeTime
	AdherenceChangeTime *time.Time `json:"adherenceChangeTime,omitempty"`

	// PresenceUpdateTime
	PresenceUpdateTime *time.Time `json:"presenceUpdateTime,omitempty"`

	// ActiveQueues
	ActiveQueues *[]Wfmuserscheduleadherenceupdatedtopicqueuereference `json:"activeQueues,omitempty"`

	// ActiveQueuesModifiedTime
	ActiveQueuesModifiedTime *time.Time `json:"activeQueuesModifiedTime,omitempty"`

	// RemovedFromManagementUnit
	RemovedFromManagementUnit *bool `json:"removedFromManagementUnit,omitempty"`
}

Wfmuserscheduleadherenceupdatedtopicuserscheduleadherenceupdate

func (*Wfmuserscheduleadherenceupdatedtopicuserscheduleadherenceupdate) String ¶

String returns a JSON representation of the model

type Wfmversionedentitymetadata ¶

type Wfmversionedentitymetadata struct {
	// Version - The version of the associated entity.  Used to prevent conflicts on concurrent edits
	Version *int `json:"version,omitempty"`

	// ModifiedBy - The user who last modified the associated entity
	ModifiedBy *Userreference `json:"modifiedBy,omitempty"`

	// DateModified - The date the associated entity 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"`
}

Wfmversionedentitymetadata - Metadata to associate with a given entity

func (*Wfmversionedentitymetadata) String ¶

func (o *Wfmversionedentitymetadata) String() string

String returns a JSON representation of the model

type Whatsappdefinition ¶

type Whatsappdefinition struct {
	// Name - The messaging template name.
	Name *string `json:"name,omitempty"`

	// Namespace - The messaging template namespace.
	Namespace *string `json:"namespace,omitempty"`

	// Language - The messaging template language configured for this template. This is a WhatsApp specific value. For example, 'en_US'
	Language *string `json:"language,omitempty"`
}

Whatsappdefinition - A WhatsApp messaging template definition as defined in the WhatsApp Business Manager

func (*Whatsappdefinition) String ¶

func (o *Whatsappdefinition) String() string

String returns a JSON representation of the model

type Whatsappid ¶

type Whatsappid struct {
	// PhoneNumber - The phone number associated with this WhatsApp account
	PhoneNumber *Phonenumber `json:"phoneNumber,omitempty"`

	// DisplayName - The displayName of this person's account in WhatsApp
	DisplayName *string `json:"displayName,omitempty"`
}

Whatsappid - User information for a WhatsApp account

func (*Whatsappid) String ¶

func (o *Whatsappid) String() string

String returns a JSON representation of the model

type Whatsappintegration ¶

type Whatsappintegration struct {
	// Id - A unique Integration Id.
	Id *string `json:"id,omitempty"`

	// Name - The name of the WhatsApp integration.
	Name *string `json:"name,omitempty"`

	// PhoneNumber - The phone number associated to the whatsApp integration.
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// Status - The status of the WhatsApp Integration
	Status *string `json:"status,omitempty"`

	// Recipient - The recipient associated to the WhatsApp Integration. This recipient is used to associate a flow to an integration
	Recipient *Domainentityref `json:"recipient,omitempty"`

	// DateCreated - Date this Integration 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"`

	// DateModified - Date this Integration 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"`

	// CreatedBy - User reference that created this Integration
	CreatedBy *Domainentityref `json:"createdBy,omitempty"`

	// ModifiedBy - User reference that last modified this Integration
	ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"`

	// Version - Version number required for updates.
	Version *int `json:"version,omitempty"`

	// ActivationStatusCode - The status code of WhatsApp Integration activation process
	ActivationStatusCode *string `json:"activationStatusCode,omitempty"`

	// ActivationErrorInfo - The error information of WhatsApp Integration activation process
	ActivationErrorInfo *Errorbody `json:"activationErrorInfo,omitempty"`

	// CreateStatus - Status of asynchronous create operation
	CreateStatus *string `json:"createStatus,omitempty"`

	// CreateError - Error information returned, if createStatus is set to Error
	CreateError *Errorbody `json:"createError,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Whatsappintegration

func (*Whatsappintegration) String ¶

func (o *Whatsappintegration) String() string

String returns a JSON representation of the model

type Whatsappintegrationentitylisting ¶

type Whatsappintegrationentitylisting struct {
	// Entities
	Entities *[]Whatsappintegration `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Whatsappintegrationentitylisting

func (*Whatsappintegrationentitylisting) String ¶

String returns a JSON representation of the model

type Whatsappintegrationrequest ¶

type Whatsappintegrationrequest struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The name of the WhatsApp Integration
	Name *string `json:"name,omitempty"`

	// PhoneNumber - The phone number associated to the whatsApp integration
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// WabaCertificate - The waba(WhatsApp Business Manager) certificate associated to the WhatsApp integration phone number
	WabaCertificate *string `json:"wabaCertificate,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Whatsappintegrationrequest

func (*Whatsappintegrationrequest) String ¶

func (o *Whatsappintegrationrequest) String() string

String returns a JSON representation of the model

type Whatsappintegrationupdaterequest ¶

type Whatsappintegrationupdaterequest struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - WhatsApp Integration name
	Name *string `json:"name,omitempty"`

	// Action - The action used to activate and then confirm a WhatsApp Integration.
	Action *string `json:"action,omitempty"`

	// AuthenticationMethod - The authentication method used to confirm a WhatsApp Integration activation. If action is set to Activate, then authenticationMethod is a required field.
	AuthenticationMethod *string `json:"authenticationMethod,omitempty"`

	// ConfirmationCode - The confirmation code sent by Whatsapp to you during the activation step. If action is set to Confirm, then confirmationCode is a required field.
	ConfirmationCode *string `json:"confirmationCode,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Whatsappintegrationupdaterequest

func (*Whatsappintegrationupdaterequest) String ¶

String returns a JSON representation of the model

type Widgetclientconfig ¶

type Widgetclientconfig struct {
	// V1
	V1 *Widgetclientconfigv1 `json:"v1,omitempty"`

	// V2
	V2 *Widgetclientconfigv2 `json:"v2,omitempty"`

	// V1Http
	V1Http *Widgetclientconfigv1http `json:"v1-http,omitempty"`

	// ThirdParty
	ThirdParty *Widgetclientconfigthirdparty `json:"third-party,omitempty"`
}

Widgetclientconfig

func (*Widgetclientconfig) String ¶

func (o *Widgetclientconfig) String() string

String returns a JSON representation of the model

type Widgetclientconfigthirdparty ¶

type Widgetclientconfigthirdparty struct{}

Widgetclientconfigthirdparty

func (*Widgetclientconfigthirdparty) String ¶

String returns a JSON representation of the model

type Widgetclientconfigv1 ¶

type Widgetclientconfigv1 struct {
	// WebChatSkin
	WebChatSkin *string `json:"webChatSkin,omitempty"`

	// AuthenticationUrl
	AuthenticationUrl *string `json:"authenticationUrl,omitempty"`
}

Widgetclientconfigv1

func (*Widgetclientconfigv1) String ¶

func (o *Widgetclientconfigv1) String() string

String returns a JSON representation of the model

type Widgetclientconfigv1http ¶

type Widgetclientconfigv1http struct {
	// WebChatSkin
	WebChatSkin *string `json:"webChatSkin,omitempty"`

	// AuthenticationUrl
	AuthenticationUrl *string `json:"authenticationUrl,omitempty"`
}

Widgetclientconfigv1http

func (*Widgetclientconfigv1http) String ¶

func (o *Widgetclientconfigv1http) String() string

String returns a JSON representation of the model

type Widgetclientconfigv2 ¶

type Widgetclientconfigv2 struct{}

Widgetclientconfigv2

func (*Widgetclientconfigv2) String ¶

func (o *Widgetclientconfigv2) String() string

String returns a JSON representation of the model

type Widgetdeployment ¶

type Widgetdeployment struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Description - A human-readable description of this Deployment.
	Description *string `json:"description,omitempty"`

	// AuthenticationRequired - When true, the customer members starting a chat must be authenticated by supplying their JWT to the create operation.
	AuthenticationRequired *bool `json:"authenticationRequired,omitempty"`

	// Disabled - When true, all create chat operations using this Deployment will be rejected.
	Disabled *bool `json:"disabled,omitempty"`

	// Flow - The URI of the Inbound Chat Flow to run when new chats are initiated under this Deployment.
	Flow *Domainentityref `json:"flow,omitempty"`

	// AllowedDomains - The list of domains that are approved to use this Deployment; the list will be added to CORS headers for ease of web use.
	AllowedDomains *[]string `json:"allowedDomains,omitempty"`

	// ClientType - The type of display widget for which this Deployment is configured, which controls the administrator settings shown.
	ClientType *string `json:"clientType,omitempty"`

	// ClientConfig - The client configuration options that should be made available to the clients of this Deployment.
	ClientConfig *Widgetclientconfig `json:"clientConfig,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Widgetdeployment

func (*Widgetdeployment) String ¶

func (o *Widgetdeployment) String() string

String returns a JSON representation of the model

type Widgetdeploymententitylisting ¶

type Widgetdeploymententitylisting struct {
	// Total
	Total *int `json:"total,omitempty"`

	// Entities
	Entities *[]Widgetdeployment `json:"entities,omitempty"`

	// SelfUri
	SelfUri *string `json:"selfUri,omitempty"`
}

Widgetdeploymententitylisting

func (*Widgetdeploymententitylisting) String ¶

String returns a JSON representation of the model

type WidgetsApi ¶

type WidgetsApi struct {
	Configuration *Configuration
}

WidgetsApi provides functions for API endpoints

func NewWidgetsApi ¶

func NewWidgetsApi() *WidgetsApi

NewWidgetsApi creates an API instance using the default configuration

func NewWidgetsApiWithConfig ¶

func NewWidgetsApiWithConfig(config *Configuration) *WidgetsApi

NewWidgetsApiWithConfig creates an API instance using the provided configuration

func (WidgetsApi) DeleteWidgetsDeployment ¶

func (a WidgetsApi) DeleteWidgetsDeployment(deploymentId string) (*APIResponse, error)

DeleteWidgetsDeployment invokes DELETE /api/v2/widgets/deployments/{deploymentId}

Delete a Widget deployment

func (WidgetsApi) GetWidgetsDeployment ¶

func (a WidgetsApi) GetWidgetsDeployment(deploymentId string) (*Widgetdeployment, *APIResponse, error)

GetWidgetsDeployment invokes GET /api/v2/widgets/deployments/{deploymentId}

Get a Widget deployment

func (WidgetsApi) GetWidgetsDeployments ¶

func (a WidgetsApi) GetWidgetsDeployments() (*Widgetdeploymententitylisting, *APIResponse, error)

GetWidgetsDeployments invokes GET /api/v2/widgets/deployments

List Widget deployments

func (WidgetsApi) PostWidgetsDeployments ¶

func (a WidgetsApi) PostWidgetsDeployments(body Widgetdeployment) (*Widgetdeployment, *APIResponse, error)

PostWidgetsDeployments invokes POST /api/v2/widgets/deployments

Create Widget deployment

func (WidgetsApi) PutWidgetsDeployment ¶

func (a WidgetsApi) PutWidgetsDeployment(deploymentId string, body Widgetdeployment) (*Widgetdeployment, *APIResponse, error)

PutWidgetsDeployment invokes PUT /api/v2/widgets/deployments/{deploymentId}

Update a Widget deployment

type Workdaymetric ¶

type Workdaymetric struct {
	// Metric - Gamification metric
	Metric *Metric `json:"metric,omitempty"`

	// Objective - Current objective for this metric
	Objective *Objective `json:"objective,omitempty"`

	// Points - Gamification points earned for this metric
	Points *int `json:"points,omitempty"`

	// Value - Value of this metric
	Value *float64 `json:"value,omitempty"`

	// PunctualityEvents - List of schedule activity events for punctuality metrics
	PunctualityEvents *[]Punctualityevent `json:"punctualityEvents,omitempty"`
}

Workdaymetric

func (*Workdaymetric) String ¶

func (o *Workdaymetric) String() string

String returns a JSON representation of the model

type Workdaymetriclisting ¶

type Workdaymetriclisting struct {
	// Entities
	Entities *[]Workdaymetric `json:"entities,omitempty"`
}

Workdaymetriclisting

func (*Workdaymetriclisting) String ¶

func (o *Workdaymetriclisting) String() string

String returns a JSON representation of the model

type Workdaypointstrend ¶

type Workdaypointstrend struct {
	// DateStartWorkday - The start workday for the query range for the gamification points trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateStartWorkday *time.Time `json:"dateStartWorkday,omitempty"`

	// DateEndWorkday - The end workday for the query range for the gamification points trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateEndWorkday *time.Time `json:"dateEndWorkday,omitempty"`

	// User - The targeted user for the query
	User *Userreference `json:"user,omitempty"`

	// DayOfWeek - Aggregated for same day comparison
	DayOfWeek *string `json:"dayOfWeek,omitempty"`

	// AveragePoints - The total average points
	AveragePoints *float64 `json:"averagePoints,omitempty"`

	// Trend - Daily points trends
	Trend *[]Workdaypointstrenditem `json:"trend,omitempty"`
}

Workdaypointstrend

func (*Workdaypointstrend) String ¶

func (o *Workdaypointstrend) String() string

String returns a JSON representation of the model

type Workdaypointstrenditem ¶

type Workdaypointstrenditem struct {
	// DateWorkday - workday date for the points trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateWorkday *time.Time `json:"dateWorkday,omitempty"`

	// Points - workday points for the date
	Points *float64 `json:"points,omitempty"`
}

Workdaypointstrenditem

func (*Workdaypointstrenditem) String ¶

func (o *Workdaypointstrenditem) String() string

String returns a JSON representation of the model

type Workdayvaluesmetricitem ¶

type Workdayvaluesmetricitem struct {
	// MetricDefinition - Gamification metric for the average and the trend
	MetricDefinition *Metricdefinition `json:"metricDefinition,omitempty"`

	// Average - The average value of the metric
	Average *float64 `json:"average,omitempty"`

	// UnitType - The unit type of the metric value
	UnitType *string `json:"unitType,omitempty"`

	// Trend - The metric value trend
	Trend *[]Workdayvaluestrenditem `json:"trend,omitempty"`
}

Workdayvaluesmetricitem

func (*Workdayvaluesmetricitem) String ¶

func (o *Workdayvaluesmetricitem) String() string

String returns a JSON representation of the model

type Workdayvaluestrend ¶

type Workdayvaluestrend struct {
	// DateStartWorkday - The start workday for the query range for the metric value trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateStartWorkday *time.Time `json:"dateStartWorkday,omitempty"`

	// DateEndWorkday - The end workday for the query range for the metric value trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateEndWorkday *time.Time `json:"dateEndWorkday,omitempty"`

	// Division - The targeted division for the query
	Division *Division `json:"division,omitempty"`

	// User - The targeted user for the query
	User *Userreference `json:"user,omitempty"`

	// Timezone - The time zone used for aggregating metric values
	Timezone *string `json:"timezone,omitempty"`

	// Results - The metric value trends
	Results *[]Workdayvaluesmetricitem `json:"results,omitempty"`
}

Workdayvaluestrend

func (*Workdayvaluestrend) String ¶

func (o *Workdayvaluestrend) String() string

String returns a JSON representation of the model

type Workdayvaluestrenditem ¶

type Workdayvaluestrenditem struct {
	// DateWorkday - The workday for the metric value. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
	DateWorkday *time.Time `json:"dateWorkday,omitempty"`

	// Value - The metric value
	Value *float64 `json:"value,omitempty"`
}

Workdayvaluestrenditem

func (*Workdayvaluestrenditem) String ¶

func (o *Workdayvaluestrenditem) String() string

String returns a JSON representation of the model

type WorkforceManagementApi ¶

type WorkforceManagementApi struct {
	Configuration *Configuration
}

WorkforceManagementApi provides functions for API endpoints

func NewWorkforceManagementApi ¶

func NewWorkforceManagementApi() *WorkforceManagementApi

NewWorkforceManagementApi creates an API instance using the default configuration

func NewWorkforceManagementApiWithConfig ¶

func NewWorkforceManagementApiWithConfig(config *Configuration) *WorkforceManagementApi

NewWorkforceManagementApiWithConfig creates an API instance using the provided configuration

func (WorkforceManagementApi) DeleteWorkforcemanagementBusinessunit ¶

func (a WorkforceManagementApi) DeleteWorkforcemanagementBusinessunit(businessUnitId string) (*APIResponse, error)

DeleteWorkforcemanagementBusinessunit invokes DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}

Delete business unit ¶

A business unit cannot be deleted if it contains one or more management units

func (WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitActivitycode ¶

func (a WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitActivitycode(businessUnitId string, activityCodeId string) (*APIResponse, error)

DeleteWorkforcemanagementBusinessunitActivitycode invokes DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}

Deletes an activity code

func (WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitPlanninggroup ¶

func (a WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitPlanninggroup(businessUnitId string, planningGroupId string) (*APIResponse, error)

DeleteWorkforcemanagementBusinessunitPlanninggroup invokes DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}

Deletes the planning group

func (WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitSchedulingRun ¶

func (a WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitSchedulingRun(businessUnitId string, runId string) (*APIResponse, error)

DeleteWorkforcemanagementBusinessunitSchedulingRun invokes DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}

Cancel a scheduling run

func (WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitServicegoaltemplate ¶

func (a WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId string, serviceGoalTemplateId string) (*APIResponse, error)

DeleteWorkforcemanagementBusinessunitServicegoaltemplate invokes DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}

Delete a service goal template

func (WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitWeekSchedule ¶

func (a WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitWeekSchedule(businessUnitId string, weekId time.Time, scheduleId string) (*Buasyncscheduleresponse, *APIResponse, error)

DeleteWorkforcemanagementBusinessunitWeekSchedule invokes DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}

Delete a schedule

func (WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitWeekShorttermforecast ¶

func (a WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId string, weekDateId time.Time, forecastId string) (*APIResponse, error)

DeleteWorkforcemanagementBusinessunitWeekShorttermforecast invokes DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}

Delete a short term forecast ¶

Must not be tied to any schedules

func (WorkforceManagementApi) DeleteWorkforcemanagementManagementunit ¶

func (a WorkforceManagementApi) DeleteWorkforcemanagementManagementunit(managementUnitId string) (*APIResponse, error)

DeleteWorkforcemanagementManagementunit invokes DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}

Delete management unit

func (WorkforceManagementApi) DeleteWorkforcemanagementManagementunitWorkplan ¶

func (a WorkforceManagementApi) DeleteWorkforcemanagementManagementunitWorkplan(managementUnitId string, workPlanId string) (*APIResponse, error)

DeleteWorkforcemanagementManagementunitWorkplan invokes DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}

Delete a work plan

func (WorkforceManagementApi) DeleteWorkforcemanagementManagementunitWorkplanrotation ¶

func (a WorkforceManagementApi) DeleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId string, workPlanRotationId string) (*APIResponse, error)

DeleteWorkforcemanagementManagementunitWorkplanrotation invokes DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}

Delete a work plan rotation

func (WorkforceManagementApi) GetWorkforcemanagementAdherence ¶

func (a WorkforceManagementApi) GetWorkforcemanagementAdherence(userId []string) ([]Userscheduleadherence, *APIResponse, error)

GetWorkforcemanagementAdherence invokes GET /api/v2/workforcemanagement/adherence

Get a list of UserScheduleAdherence records for the requested users

func (WorkforceManagementApi) GetWorkforcemanagementAdhocmodelingjob ¶

func (a WorkforceManagementApi) GetWorkforcemanagementAdhocmodelingjob(jobId string) (*Modelingstatusresponse, *APIResponse, error)

GetWorkforcemanagementAdhocmodelingjob invokes GET /api/v2/workforcemanagement/adhocmodelingjobs/{jobId}

Get status of the modeling job

func (WorkforceManagementApi) GetWorkforcemanagementAgentManagementunit ¶

func (a WorkforceManagementApi) GetWorkforcemanagementAgentManagementunit(agentId string) (*Agentmanagementunitreference, *APIResponse, error)

GetWorkforcemanagementAgentManagementunit invokes GET /api/v2/workforcemanagement/agents/{agentId}/managementunit

Get the management unit to which the agent belongs

func (WorkforceManagementApi) GetWorkforcemanagementAgentsMeManagementunit ¶

func (a WorkforceManagementApi) GetWorkforcemanagementAgentsMeManagementunit() (*Agentmanagementunitreference, *APIResponse, error)

GetWorkforcemanagementAgentsMeManagementunit invokes GET /api/v2/workforcemanagement/agents/me/managementunit

Get the management unit to which the currently logged in agent belongs

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunit ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunit(businessUnitId string, expand []string) (*Businessunit, *APIResponse, error)

GetWorkforcemanagementBusinessunit invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}

Get business unit ¶

Expanding \&quot;settings\&quot; will retrieve all settings. All other expands will retrieve only the requested settings field(s).

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitActivitycode ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitActivitycode(businessUnitId string, activityCodeId string) (*Businessunitactivitycode, *APIResponse, error)

GetWorkforcemanagementBusinessunitActivitycode invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}

Get an activity code

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitActivitycodes ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitActivitycodes(businessUnitId string) (*Businessunitactivitycodelisting, *APIResponse, error)

GetWorkforcemanagementBusinessunitActivitycodes invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes

Get activity codes

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitIntradayPlanninggroups ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId string, date time.Time) (*Wfmintradayplanninggrouplisting, *APIResponse, error)

GetWorkforcemanagementBusinessunitIntradayPlanninggroups invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups

Get intraday planning groups for the given date

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitManagementunits ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitManagementunits(businessUnitId string, feature string, divisionId string) (*Managementunitlisting, *APIResponse, error)

GetWorkforcemanagementBusinessunitManagementunits invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits

Get all authorized management units in the business unit

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitPlanninggroup ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitPlanninggroup(businessUnitId string, planningGroupId string) (*Planninggroup, *APIResponse, error)

GetWorkforcemanagementBusinessunitPlanninggroup invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}

Get a planning group

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitPlanninggroups ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitPlanninggroups(businessUnitId string) (*Planninggrouplist, *APIResponse, error)

GetWorkforcemanagementBusinessunitPlanninggroups invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups

Gets list of planning groups

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitSchedulingRun ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitSchedulingRun(businessUnitId string, runId string) (*Buschedulerun, *APIResponse, error)

GetWorkforcemanagementBusinessunitSchedulingRun invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}

Get a scheduling run

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitSchedulingRunResult ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitSchedulingRunResult(businessUnitId string, runId string, managementUnitIds []string, expand []string) (*Burescheduleresult, *APIResponse, error)

GetWorkforcemanagementBusinessunitSchedulingRunResult invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result

Get the result of a rescheduling operation

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitSchedulingRuns ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitSchedulingRuns(businessUnitId string) (*Buschedulerunlisting, *APIResponse, error)

GetWorkforcemanagementBusinessunitSchedulingRuns invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs

Get the list of scheduling runs

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitServicegoaltemplate ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId string, serviceGoalTemplateId string) (*Servicegoaltemplate, *APIResponse, error)

GetWorkforcemanagementBusinessunitServicegoaltemplate invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}

Get a service goal template

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitServicegoaltemplates ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId string) (*Servicegoaltemplatelist, *APIResponse, error)

GetWorkforcemanagementBusinessunitServicegoaltemplates invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates

Gets list of service goal templates

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekSchedule ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekSchedule(businessUnitId string, weekId time.Time, scheduleId string, expand string) (*Buschedulemetadata, *APIResponse, error)

GetWorkforcemanagementBusinessunitWeekSchedule invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}

Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekScheduleGenerationresults ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekScheduleGenerationresults(businessUnitId string, weekId time.Time, scheduleId string) (*Schedulegenerationresult, *APIResponse, error)

GetWorkforcemanagementBusinessunitWeekScheduleGenerationresults invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults

Get the generation results for a generated schedule

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast(businessUnitId string, weekId time.Time, scheduleId string, forceDownload bool) (*Buheadcountforecastresponse, *APIResponse, error)

GetWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast

Get the headcount forecast by planning group for the schedule

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekScheduleHistoryAgent ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekScheduleHistoryAgent(businessUnitId string, weekId time.Time, scheduleId string, agentId string) (*Buagentschedulehistoryresponse, *APIResponse, error)

GetWorkforcemanagementBusinessunitWeekScheduleHistoryAgent invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}

Loads agent&#39;s schedule history.

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekSchedules ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekSchedules(businessUnitId string, weekId string, includeOnlyPublished bool, expand string) (*Buschedulelisting, *APIResponse, error)

GetWorkforcemanagementBusinessunitWeekSchedules invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules

Get the list of week schedules for the specified week ¶

Use \&quot;recent\&quot; for the `weekId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any schedule which spans the specified week

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecast ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId string, weekDateId time.Time, forecastId string, expand []string) (*Bushorttermforecast, *APIResponse, error)

GetWorkforcemanagementBusinessunitWeekShorttermforecast invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}

Get a short term forecast

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecastData ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecastData(businessUnitId string, weekDateId time.Time, forecastId string, weekNumber int, forceDownloadService bool) (*Buforecastresultresponse, *APIResponse, error)

GetWorkforcemanagementBusinessunitWeekShorttermforecastData invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data

Get the result of a short term forecast calculation ¶

Includes modifications unless you pass the doNotApplyModifications query parameter

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults(businessUnitId string, weekDateId time.Time, forecastId string) (*Buforecastgenerationresult, *APIResponse, error)

GetWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults

Gets the forecast generation results

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata(businessUnitId string, weekDateId time.Time, forecastId string, forceDownloadService bool) (*Longtermforecastresultresponse, *APIResponse, error)

GetWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/longtermforecastdata

Get the result of a long term forecast calculation ¶

Includes modifications unless you pass the doNotApplyModifications query parameter

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups(businessUnitId string, weekDateId time.Time, forecastId string) (*Forecastplanninggroupsresponse, *APIResponse, error)

GetWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups

Gets the forecast planning group snapshot

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecasts ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId string, weekDateId string) (*Bushorttermforecastlisting, *APIResponse, error)

GetWorkforcemanagementBusinessunitWeekShorttermforecasts invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts

Get short term forecasts ¶

Use \&quot;recent\&quot; for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunits ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunits(feature string, divisionId string) (*Businessunitlisting, *APIResponse, error)

GetWorkforcemanagementBusinessunits invokes GET /api/v2/workforcemanagement/businessunits

Get business units

func (WorkforceManagementApi) GetWorkforcemanagementBusinessunitsDivisionviews ¶

func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitsDivisionviews(divisionId []string) (*Businessunitlisting, *APIResponse, error)

GetWorkforcemanagementBusinessunitsDivisionviews invokes GET /api/v2/workforcemanagement/businessunits/divisionviews

Get business units across divisions

func (WorkforceManagementApi) GetWorkforcemanagementHistoricaldataDeletejob ¶

func (a WorkforceManagementApi) GetWorkforcemanagementHistoricaldataDeletejob() (*Historicalimportdeletejobresponse, *APIResponse, error)

GetWorkforcemanagementHistoricaldataDeletejob invokes GET /api/v2/workforcemanagement/historicaldata/deletejob

Retrieves delete job status for historical data imports of the organization

func (WorkforceManagementApi) GetWorkforcemanagementHistoricaldataImportstatus ¶

func (a WorkforceManagementApi) GetWorkforcemanagementHistoricaldataImportstatus() (*Historicalimportstatuslisting, *APIResponse, error)

GetWorkforcemanagementHistoricaldataImportstatus invokes GET /api/v2/workforcemanagement/historicaldata/importstatus

Retrieves status of the historical data imports of the organization

func (WorkforceManagementApi) GetWorkforcemanagementManagementunit ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunit(managementUnitId string, expand []string) (*Managementunit, *APIResponse, error)

GetWorkforcemanagementManagementunit invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}

Get management unit ¶

settings.shortTermForecasting is deprecated and now lives on the business unit

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitActivitycodes ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitActivitycodes(managementUnitId string) (*Activitycodecontainer, *APIResponse, error)

GetWorkforcemanagementManagementunitActivitycodes invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/activitycodes

Get activity codes

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitAdherence ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitAdherence(managementUnitId string, forceDownloadService bool) (*Userscheduleadherencelisting, *APIResponse, error)

GetWorkforcemanagementManagementunitAdherence invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence

Get a list of user schedule adherence records for the requested management unit

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitAgent ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitAgent(managementUnitId string, agentId string, excludeCapabilities bool) (*Wfmagent, *APIResponse, error)

GetWorkforcemanagementManagementunitAgent invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}

Get data for agent in the management unit

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitAgentShifttrades ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitAgentShifttrades(managementUnitId string, agentId string) (*Shifttradelistresponse, *APIResponse, error)

GetWorkforcemanagementManagementunitAgentShifttrades invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades

Gets all the shift trades for a given agent

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitShifttradesMatched ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitShifttradesMatched(managementUnitId string) (*Shifttradematchessummaryresponse, *APIResponse, error)

GetWorkforcemanagementManagementunitShifttradesMatched invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched

Gets a summary of all shift trades in the matched state

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitShifttradesUsers ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitShifttradesUsers(managementUnitId string) (*Wfmuserentitylisting, *APIResponse, error)

GetWorkforcemanagementManagementunitShifttradesUsers invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users

Gets list of users available for whom you can send direct shift trade requests

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitUserTimeoffrequest ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId string, userId string, timeOffRequestId string) (*Timeoffrequestresponse, *APIResponse, error)

GetWorkforcemanagementManagementunitUserTimeoffrequest invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}

Get a time off request

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitUserTimeoffrequests ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId string, userId string, recentlyReviewed bool) (*Timeoffrequestlist, *APIResponse, error)

GetWorkforcemanagementManagementunitUserTimeoffrequests invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests

Get a list of time off requests for a given user

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitUsers ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitUsers(managementUnitId string) (*Wfmuserentitylisting, *APIResponse, error)

GetWorkforcemanagementManagementunitUsers invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users

Get users in the management unit

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitWeekSchedule ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitWeekSchedule(managementUnitId string, weekId string, scheduleId string, expand string, forceDownloadService bool) (*Weekscheduleresponse, *APIResponse, error)

GetWorkforcemanagementManagementunitWeekSchedule invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}

Deprecated. Use the equivalent business unit resource instead. Get a week schedule

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitWeekSchedules ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitWeekSchedules(managementUnitId string, weekId string, includeOnlyPublished bool, earliestWeekDate string, latestWeekDate string) (*Weekschedulelistresponse, *APIResponse, error)

GetWorkforcemanagementManagementunitWeekSchedules invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules

Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitWeekShifttrades ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitWeekShifttrades(managementUnitId string, weekDateId time.Time, evaluateMatches bool) (*Weekshifttradelistresponse, *APIResponse, error)

GetWorkforcemanagementManagementunitWeekShifttrades invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades

Gets all the shift trades for a given week

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitWorkplan ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitWorkplan(managementUnitId string, workPlanId string) (*Workplan, *APIResponse, error)

GetWorkforcemanagementManagementunitWorkplan invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}

Get a work plan

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitWorkplanrotation ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitWorkplanrotation(managementUnitId string, workPlanRotationId string) (*Workplanrotationresponse, *APIResponse, error)

GetWorkforcemanagementManagementunitWorkplanrotation invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}

Get a work plan rotation

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitWorkplanrotations ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitWorkplanrotations(managementUnitId string, expand []string) (*Workplanrotationlistresponse, *APIResponse, error)

GetWorkforcemanagementManagementunitWorkplanrotations invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations

Get work plan rotations

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitWorkplans ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitWorkplans(managementUnitId string, expand []string) (*Workplanlistresponse, *APIResponse, error)

GetWorkforcemanagementManagementunitWorkplans invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans

Get work plans ¶

\&quot;expand=details\&quot; is deprecated

func (WorkforceManagementApi) GetWorkforcemanagementManagementunits ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunits(pageSize int, pageNumber int, expand string, feature string, divisionId string) (*Managementunitlisting, *APIResponse, error)

GetWorkforcemanagementManagementunits invokes GET /api/v2/workforcemanagement/managementunits

Get management units

func (WorkforceManagementApi) GetWorkforcemanagementManagementunitsDivisionviews ¶

func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitsDivisionviews(divisionId []string) (*Managementunitlisting, *APIResponse, error)

GetWorkforcemanagementManagementunitsDivisionviews invokes GET /api/v2/workforcemanagement/managementunits/divisionviews

Get management units across divisions

func (WorkforceManagementApi) GetWorkforcemanagementNotifications ¶

func (a WorkforceManagementApi) GetWorkforcemanagementNotifications() (*Notificationsresponse, *APIResponse, error)

GetWorkforcemanagementNotifications invokes GET /api/v2/workforcemanagement/notifications

Get a list of notifications for the current user

func (WorkforceManagementApi) GetWorkforcemanagementSchedulingjob ¶

func (a WorkforceManagementApi) GetWorkforcemanagementSchedulingjob(jobId string) (*Schedulingstatusresponse, *APIResponse, error)

GetWorkforcemanagementSchedulingjob invokes GET /api/v2/workforcemanagement/schedulingjobs/{jobId}

Get status of the scheduling job

func (WorkforceManagementApi) GetWorkforcemanagementShifttrades ¶

func (a WorkforceManagementApi) GetWorkforcemanagementShifttrades() (*Shifttradelistresponse, *APIResponse, error)

GetWorkforcemanagementShifttrades invokes GET /api/v2/workforcemanagement/shifttrades

Gets all of my shift trades

func (WorkforceManagementApi) GetWorkforcemanagementTimeoffrequest ¶

func (a WorkforceManagementApi) GetWorkforcemanagementTimeoffrequest(timeOffRequestId string) (*Timeoffrequestresponse, *APIResponse, error)

GetWorkforcemanagementTimeoffrequest invokes GET /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}

Get a time off request for the current user

func (WorkforceManagementApi) GetWorkforcemanagementTimeoffrequests ¶

func (a WorkforceManagementApi) GetWorkforcemanagementTimeoffrequests(recentlyReviewed bool) (*Timeoffrequestlist, *APIResponse, error)

GetWorkforcemanagementTimeoffrequests invokes GET /api/v2/workforcemanagement/timeoffrequests

Get a list of time off requests for the current user

func (WorkforceManagementApi) PatchWorkforcemanagementBusinessunit ¶

func (a WorkforceManagementApi) PatchWorkforcemanagementBusinessunit(businessUnitId string, body Updatebusinessunitrequest) (*Businessunit, *APIResponse, error)

PatchWorkforcemanagementBusinessunit invokes PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}

Update business unit

func (WorkforceManagementApi) PatchWorkforcemanagementBusinessunitActivitycode ¶

func (a WorkforceManagementApi) PatchWorkforcemanagementBusinessunitActivitycode(businessUnitId string, activityCodeId string, body Updateactivitycoderequest) (*Businessunitactivitycode, *APIResponse, error)

PatchWorkforcemanagementBusinessunitActivitycode invokes PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}

Update an activity code

func (WorkforceManagementApi) PatchWorkforcemanagementBusinessunitPlanninggroup ¶

func (a WorkforceManagementApi) PatchWorkforcemanagementBusinessunitPlanninggroup(businessUnitId string, planningGroupId string, body Updateplanninggrouprequest) (*Planninggroup, *APIResponse, error)

PatchWorkforcemanagementBusinessunitPlanninggroup invokes PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}

Updates the planning group

func (WorkforceManagementApi) PatchWorkforcemanagementBusinessunitSchedulingRun ¶

func (a WorkforceManagementApi) PatchWorkforcemanagementBusinessunitSchedulingRun(businessUnitId string, runId string, body Patchbuschedulerunrequest) (*APIResponse, error)

PatchWorkforcemanagementBusinessunitSchedulingRun invokes PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}

Mark a schedule run as applied

func (WorkforceManagementApi) PatchWorkforcemanagementBusinessunitServicegoaltemplate ¶

func (a WorkforceManagementApi) PatchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId string, serviceGoalTemplateId string, body Updateservicegoaltemplate) (*Servicegoaltemplate, *APIResponse, error)

PatchWorkforcemanagementBusinessunitServicegoaltemplate invokes PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}

Updates a service goal template

func (WorkforceManagementApi) PatchWorkforcemanagementManagementunit ¶

func (a WorkforceManagementApi) PatchWorkforcemanagementManagementunit(managementUnitId string, body Updatemanagementunitrequest) (*Managementunit, *APIResponse, error)

PatchWorkforcemanagementManagementunit invokes PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}

Update the requested management unit

func (WorkforceManagementApi) PatchWorkforcemanagementManagementunitUserTimeoffrequest ¶

func (a WorkforceManagementApi) PatchWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId string, userId string, timeOffRequestId string, body Admintimeoffrequestpatch) (*Timeoffrequestresponse, *APIResponse, error)

PatchWorkforcemanagementManagementunitUserTimeoffrequest invokes PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}

Update a time off request

func (WorkforceManagementApi) PatchWorkforcemanagementManagementunitWeekShifttrade ¶

func (a WorkforceManagementApi) PatchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId string, weekDateId time.Time, body Patchshifttraderequest, tradeId string) (*Shifttraderesponse, *APIResponse, error)

PatchWorkforcemanagementManagementunitWeekShifttrade invokes PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}

Updates a shift trade. This route can only be called by the initiating agent

func (WorkforceManagementApi) PatchWorkforcemanagementManagementunitWorkplan ¶

func (a WorkforceManagementApi) PatchWorkforcemanagementManagementunitWorkplan(managementUnitId string, workPlanId string, body Workplan, validationMode string) (*Workplan, *APIResponse, error)

PatchWorkforcemanagementManagementunitWorkplan invokes PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}

Update a work plan

func (WorkforceManagementApi) PatchWorkforcemanagementManagementunitWorkplanrotation ¶

func (a WorkforceManagementApi) PatchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId string, workPlanRotationId string, body Updateworkplanrotationrequest) (*Workplanrotationresponse, *APIResponse, error)

PatchWorkforcemanagementManagementunitWorkplanrotation invokes PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}

Update a work plan rotation

func (WorkforceManagementApi) PatchWorkforcemanagementTimeoffrequest ¶

func (a WorkforceManagementApi) PatchWorkforcemanagementTimeoffrequest(timeOffRequestId string, body Agenttimeoffrequestpatch) (*Timeoffrequestresponse, *APIResponse, error)

PatchWorkforcemanagementTimeoffrequest invokes PATCH /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}

Update a time off request for the current user

func (WorkforceManagementApi) PostWorkforcemanagementAdherenceHistorical ¶

func (a WorkforceManagementApi) PostWorkforcemanagementAdherenceHistorical(body Wfmhistoricaladherencequeryforusers) (*Wfmhistoricaladherenceresponse, *APIResponse, error)

PostWorkforcemanagementAdherenceHistorical invokes POST /api/v2/workforcemanagement/adherence/historical

Request a historical adherence report for users across management units

func (WorkforceManagementApi) PostWorkforcemanagementAgentschedulesMine ¶

PostWorkforcemanagementAgentschedulesMine invokes POST /api/v2/workforcemanagement/agentschedules/mine

Get published schedule for the current user

func (WorkforceManagementApi) PostWorkforcemanagementBusinessunitActivitycodes ¶

func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitActivitycodes(businessUnitId string, body Createactivitycoderequest) (*Businessunitactivitycode, *APIResponse, error)

PostWorkforcemanagementBusinessunitActivitycodes invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes

Create a new activity code

func (WorkforceManagementApi) PostWorkforcemanagementBusinessunitAgentschedulesSearch ¶

func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitAgentschedulesSearch(businessUnitId string, body Busearchagentschedulesrequest, forceAsync bool, forceDownloadService bool) (*Buasyncagentschedulessearchresponse, *APIResponse, error)

PostWorkforcemanagementBusinessunitAgentschedulesSearch invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search

Search published schedules

func (WorkforceManagementApi) PostWorkforcemanagementBusinessunitIntraday ¶

func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitIntraday(businessUnitId string, forceAsync bool, body Intradayplanninggrouprequest) (*Asyncintradayresponse, *APIResponse, error)

PostWorkforcemanagementBusinessunitIntraday invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday

Get intraday data for the given date for the requested planningGroupIds

func (WorkforceManagementApi) PostWorkforcemanagementBusinessunitPlanninggroups ¶

func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitPlanninggroups(businessUnitId string, body Createplanninggrouprequest) (*Planninggroup, *APIResponse, error)

PostWorkforcemanagementBusinessunitPlanninggroups invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups

Adds a new planning group

func (WorkforceManagementApi) PostWorkforcemanagementBusinessunitServicegoaltemplates ¶

func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId string, body Createservicegoaltemplate) (*Servicegoaltemplate, *APIResponse, error)

PostWorkforcemanagementBusinessunitServicegoaltemplates invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates

Adds a new service goal template

func (WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery ¶

func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery(businessUnitId string, weekId time.Time, scheduleId string, body Buqueryagentschedulesrequest, forceAsync bool, forceDownloadService bool) (*Buasyncagentschedulesqueryresponse, *APIResponse, error)

PostWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query

Loads agent schedule data from the schedule. Used in combination with the metadata route

func (WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekScheduleCopy ¶

func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekScheduleCopy(businessUnitId string, weekId time.Time, scheduleId string, body Bucopyschedulerequest) (*Buasyncscheduleresponse, *APIResponse, error)

PostWorkforcemanagementBusinessunitWeekScheduleCopy invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy

Copy a schedule

func (WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekScheduleReschedule ¶

func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekScheduleReschedule(businessUnitId string, weekId time.Time, scheduleId string, body Bureschedulerequest) (*Buasyncschedulerunresponse, *APIResponse, error)

PostWorkforcemanagementBusinessunitWeekScheduleReschedule invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule

Start a rescheduling run

func (WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekSchedules ¶

func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekSchedules(businessUnitId string, weekId time.Time, body Bucreateblankschedulerequest) (*Buschedulemetadata, *APIResponse, error)

PostWorkforcemanagementBusinessunitWeekSchedules invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules

Create a blank schedule

func (WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekSchedulesGenerate ¶

func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekSchedulesGenerate(businessUnitId string, weekId time.Time, body Bugenerateschedulerequest) (*Buasyncschedulerunresponse, *APIResponse, error)

PostWorkforcemanagementBusinessunitWeekSchedulesGenerate invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate

Generate a schedule

func (WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekShorttermforecastCopy ¶

func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekShorttermforecastCopy(businessUnitId string, weekDateId time.Time, forecastId string, body Copybuforecastrequest, forceAsync bool) (*Asyncforecastoperationresult, *APIResponse, error)

PostWorkforcemanagementBusinessunitWeekShorttermforecastCopy invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy

Copy a short term forecast

func (WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate ¶

func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate(businessUnitId string, weekDateId time.Time, body Generatebuforecastrequest, forceAsync bool) (*Asyncforecastoperationresult, *APIResponse, error)

PostWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate

Generate a short term forecast

func (WorkforceManagementApi) PostWorkforcemanagementBusinessunits ¶

func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunits(body Createbusinessunitrequest) (*Businessunit, *APIResponse, error)

PostWorkforcemanagementBusinessunits invokes POST /api/v2/workforcemanagement/businessunits

Add a new business unit ¶

It may take a minute or two for a new business unit to be available for api operations

func (WorkforceManagementApi) PostWorkforcemanagementHistoricaldataDeletejob ¶

func (a WorkforceManagementApi) PostWorkforcemanagementHistoricaldataDeletejob() (*Historicalimportdeletejobresponse, *APIResponse, error)

PostWorkforcemanagementHistoricaldataDeletejob invokes POST /api/v2/workforcemanagement/historicaldata/deletejob

Delete the entries of the historical data imports in the organization

func (WorkforceManagementApi) PostWorkforcemanagementHistoricaldataValidate ¶

func (a WorkforceManagementApi) PostWorkforcemanagementHistoricaldataValidate(body Validationservicerequest) (*APIResponse, error)

PostWorkforcemanagementHistoricaldataValidate invokes POST /api/v2/workforcemanagement/historicaldata/validate

Trigger validation process for historical import

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitAgentschedulesSearch ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitAgentschedulesSearch(managementUnitId string, body Busearchagentschedulesrequest, forceAsync bool, forceDownloadService bool) (*Buasyncagentschedulessearchresponse, *APIResponse, error)

PostWorkforcemanagementManagementunitAgentschedulesSearch invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search

Query published schedules for given given time range for set of users

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitHistoricaladherencequery ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitHistoricaladherencequery(managementUnitId string, body Wfmhistoricaladherencequery) (*Wfmhistoricaladherenceresponse, *APIResponse, error)

PostWorkforcemanagementManagementunitHistoricaladherencequery invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery

Request a historical adherence report ¶

The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitMove ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitMove(managementUnitId string, body Movemanagementunitrequest) (*Movemanagementunitresponse, *APIResponse, error)

PostWorkforcemanagementManagementunitMove invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/move

Move the requested management unit to a new business unit ¶

Returns status 200 if the management unit is already in the requested business unit

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitSchedulesSearch ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitSchedulesSearch(managementUnitId string, body Userlistschedulerequestbody) (*Userschedulecontainer, *APIResponse, error)

PostWorkforcemanagementManagementunitSchedulesSearch invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search

Query published schedules for given given time range for set of users

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitTimeoffrequests ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitTimeoffrequests(managementUnitId string, body Createadmintimeoffrequest) (*Timeoffrequestlist, *APIResponse, error)

PostWorkforcemanagementManagementunitTimeoffrequests invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests

Create a new time off request

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitTimeoffrequestsQuery ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId string, body Timeoffrequestquerybody) (*Timeoffrequestlisting, *APIResponse, error)

PostWorkforcemanagementManagementunitTimeoffrequestsQuery invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query

Fetches time off requests matching the conditions specified in the request body ¶

Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitWeekShifttradeMatch ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId string, weekDateId time.Time, body Matchshifttraderequest, tradeId string) (*Matchshifttraderesponse, *APIResponse, error)

PostWorkforcemanagementManagementunitWeekShifttradeMatch invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match

Matches a shift trade. This route can only be called by the receiving agent

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitWeekShifttrades ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWeekShifttrades(managementUnitId string, weekDateId time.Time, body Addshifttraderequest) (*Shifttraderesponse, *APIResponse, error)

PostWorkforcemanagementManagementunitWeekShifttrades invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades

Adds a shift trade

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitWeekShifttradesSearch ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId string, weekDateId time.Time, body Searchshifttradesrequest) (*Searchshifttradesresponse, *APIResponse, error)

PostWorkforcemanagementManagementunitWeekShifttradesSearch invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search

Searches for potential shift trade matches for the current agent

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitWeekShifttradesStateBulk ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId string, weekDateId time.Time, body Bulkshifttradestateupdaterequest, forceAsync bool) (*Bulkupdateshifttradestateresponse, *APIResponse, error)

PostWorkforcemanagementManagementunitWeekShifttradesStateBulk invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk

Updates the state of a batch of shift trades ¶

Admin functionality is not supported with \&quot;mine\&quot;.

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplanCopy ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplanCopy(managementUnitId string, workPlanId string, body Copyworkplan) (*Workplan, *APIResponse, error)

PostWorkforcemanagementManagementunitWorkplanCopy invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy

Create a copy of work plan

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplanValidate ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplanValidate(managementUnitId string, workPlanId string, body Workplanvalidationrequest, expand []string) (*Validateworkplanresponse, *APIResponse, error)

PostWorkforcemanagementManagementunitWorkplanValidate invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate

Validate Work Plan

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplanrotationCopy ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId string, workPlanRotationId string, body Copyworkplanrotationrequest) (*Workplanrotationresponse, *APIResponse, error)

PostWorkforcemanagementManagementunitWorkplanrotationCopy invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy

Create a copy of work plan rotation

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplanrotations ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplanrotations(managementUnitId string, body Addworkplanrotationrequest) (*Workplanrotationresponse, *APIResponse, error)

PostWorkforcemanagementManagementunitWorkplanrotations invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations

Create a new work plan rotation

func (WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplans ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplans(managementUnitId string, body Createworkplan, validationMode string) (*Workplan, *APIResponse, error)

PostWorkforcemanagementManagementunitWorkplans invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans

Create a new work plan

func (WorkforceManagementApi) PostWorkforcemanagementManagementunits ¶

func (a WorkforceManagementApi) PostWorkforcemanagementManagementunits(body Createmanagementunitapirequest) (*Managementunit, *APIResponse, error)

PostWorkforcemanagementManagementunits invokes POST /api/v2/workforcemanagement/managementunits

Add a management unit ¶

It may take a minute or two for a new management unit to be available for api operations

func (WorkforceManagementApi) PostWorkforcemanagementNotificationsUpdate ¶

func (a WorkforceManagementApi) PostWorkforcemanagementNotificationsUpdate(body Updatenotificationsrequest) (*Updatenotificationsresponse, *APIResponse, error)

PostWorkforcemanagementNotificationsUpdate invokes POST /api/v2/workforcemanagement/notifications/update

Mark a list of notifications as read or unread

func (WorkforceManagementApi) PostWorkforcemanagementSchedules ¶

func (a WorkforceManagementApi) PostWorkforcemanagementSchedules(body Currentuserschedulerequestbody) (*Userschedulecontainer, *APIResponse, error)

PostWorkforcemanagementSchedules invokes POST /api/v2/workforcemanagement/schedules

Get published schedule for the current user

func (WorkforceManagementApi) PostWorkforcemanagementTimeoffrequests ¶

func (a WorkforceManagementApi) PostWorkforcemanagementTimeoffrequests(body Createagenttimeoffrequest) (*Timeoffrequestresponse, *APIResponse, error)

PostWorkforcemanagementTimeoffrequests invokes POST /api/v2/workforcemanagement/timeoffrequests

Create a time off request for the current user

type Workplan ¶

type Workplan struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Enabled - Whether the work plan is enabled for scheduling
	Enabled *bool `json:"enabled,omitempty"`

	// Valid - Whether the work plan is valid or not
	Valid *bool `json:"valid,omitempty"`

	// ConstrainWeeklyPaidTime - Whether the weekly paid time constraint is enabled for this work plan
	ConstrainWeeklyPaidTime *bool `json:"constrainWeeklyPaidTime,omitempty"`

	// FlexibleWeeklyPaidTime - Whether the weekly paid time constraint is flexible for this work plan
	FlexibleWeeklyPaidTime *bool `json:"flexibleWeeklyPaidTime,omitempty"`

	// WeeklyExactPaidMinutes - Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false
	WeeklyExactPaidMinutes *int `json:"weeklyExactPaidMinutes,omitempty"`

	// WeeklyMinimumPaidMinutes - Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true
	WeeklyMinimumPaidMinutes *int `json:"weeklyMinimumPaidMinutes,omitempty"`

	// WeeklyMaximumPaidMinutes - Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true
	WeeklyMaximumPaidMinutes *int `json:"weeklyMaximumPaidMinutes,omitempty"`

	// ConstrainPaidTimeGranularity - Whether paid time granularity is constrained for this work plan
	ConstrainPaidTimeGranularity *bool `json:"constrainPaidTimeGranularity,omitempty"`

	// PaidTimeGranularityMinutes - Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true
	PaidTimeGranularityMinutes *int `json:"paidTimeGranularityMinutes,omitempty"`

	// ConstrainMinimumTimeBetweenShifts - Whether the minimum time between shifts constraint is enabled for this work plan
	ConstrainMinimumTimeBetweenShifts *bool `json:"constrainMinimumTimeBetweenShifts,omitempty"`

	// MinimumTimeBetweenShiftsMinutes - Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true
	MinimumTimeBetweenShiftsMinutes *int `json:"minimumTimeBetweenShiftsMinutes,omitempty"`

	// MaximumDays - Maximum number days in a week allowed to be scheduled for this work plan
	MaximumDays *int `json:"maximumDays,omitempty"`

	// MinimumConsecutiveNonWorkingMinutesPerWeek - Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off
	MinimumConsecutiveNonWorkingMinutesPerWeek *int `json:"minimumConsecutiveNonWorkingMinutesPerWeek,omitempty"`

	// ConstrainMaximumConsecutiveWorkingWeekends - Whether to constrain the maximum consecutive working weekends
	ConstrainMaximumConsecutiveWorkingWeekends *bool `json:"constrainMaximumConsecutiveWorkingWeekends,omitempty"`

	// MaximumConsecutiveWorkingWeekends - The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work
	MaximumConsecutiveWorkingWeekends *int `json:"maximumConsecutiveWorkingWeekends,omitempty"`

	// MinimumWorkingDaysPerWeek - The minimum number of days that agents assigned to a work plan must work per week
	MinimumWorkingDaysPerWeek *int `json:"minimumWorkingDaysPerWeek,omitempty"`

	// ConstrainMaximumConsecutiveWorkingDays - Whether to constrain the maximum consecutive working days
	ConstrainMaximumConsecutiveWorkingDays *bool `json:"constrainMaximumConsecutiveWorkingDays,omitempty"`

	// MaximumConsecutiveWorkingDays - The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true
	MaximumConsecutiveWorkingDays *int `json:"maximumConsecutiveWorkingDays,omitempty"`

	// MinimumShiftStartDistanceMinutes - The time period in minutes for the duration between the start times of two consecutive working days
	MinimumShiftStartDistanceMinutes *int `json:"minimumShiftStartDistanceMinutes,omitempty"`

	// MinimumDaysOffPerPlanningPeriod - Minimum days off in the planning period
	MinimumDaysOffPerPlanningPeriod *int `json:"minimumDaysOffPerPlanningPeriod,omitempty"`

	// MaximumDaysOffPerPlanningPeriod - Maximum days off in the planning period
	MaximumDaysOffPerPlanningPeriod *int `json:"maximumDaysOffPerPlanningPeriod,omitempty"`

	// MinimumPaidMinutesPerPlanningPeriod - Minimum paid minutes in the planning period
	MinimumPaidMinutesPerPlanningPeriod *int `json:"minimumPaidMinutesPerPlanningPeriod,omitempty"`

	// MaximumPaidMinutesPerPlanningPeriod - Maximum paid minutes in the planning period
	MaximumPaidMinutesPerPlanningPeriod *int `json:"maximumPaidMinutesPerPlanningPeriod,omitempty"`

	// OptionalDays - Optional days to schedule for this work plan
	OptionalDays *Setwrapperdayofweek `json:"optionalDays,omitempty"`

	// ShiftStartVarianceType - This constraint ensures that an agent starts each workday within a user-defined time threshold
	ShiftStartVarianceType *string `json:"shiftStartVarianceType,omitempty"`

	// ShiftStartVariances - Variance in minutes among start times of shifts in this work plan
	ShiftStartVariances *Listwrappershiftstartvariance `json:"shiftStartVariances,omitempty"`

	// Shifts - Shifts in this work plan
	Shifts *[]Workplanshift `json:"shifts,omitempty"`

	// Agents - Agents in this work plan
	Agents *[]Deletableuserreference `json:"agents,omitempty"`

	// Metadata - Version metadata for this work plan
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Workplan - Work plan information

func (*Workplan) String ¶

func (o *Workplan) String() string

String returns a JSON representation of the model

type Workplanactivity ¶

type Workplanactivity struct {
	// ActivityCodeId - ID of the activity code associated with this activity
	ActivityCodeId *string `json:"activityCodeId,omitempty"`

	// Description - Description of the activity
	Description *string `json:"description,omitempty"`

	// LengthMinutes - Length of the activity in minutes
	LengthMinutes *int `json:"lengthMinutes,omitempty"`

	// StartTimeIsRelativeToShiftStart - Whether the start time of the activity is relative to the start time of the shift it belongs to
	StartTimeIsRelativeToShiftStart *bool `json:"startTimeIsRelativeToShiftStart,omitempty"`

	// FlexibleStartTime - Whether the start time of the activity is flexible
	FlexibleStartTime *bool `json:"flexibleStartTime,omitempty"`

	// EarliestStartTimeMinutes - Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true
	EarliestStartTimeMinutes *int `json:"earliestStartTimeMinutes,omitempty"`

	// LatestStartTimeMinutes - Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true
	LatestStartTimeMinutes *int `json:"latestStartTimeMinutes,omitempty"`

	// ExactStartTimeMinutes - Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false
	ExactStartTimeMinutes *int `json:"exactStartTimeMinutes,omitempty"`

	// StartTimeIncrementMinutes - Increment in offset minutes that would contribute to different possible start times for the activity
	StartTimeIncrementMinutes *int `json:"startTimeIncrementMinutes,omitempty"`

	// CountsAsPaidTime - Whether the activity is paid
	CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"`

	// CountsAsContiguousWorkTime - Whether the activity duration is counted towards contiguous work time
	CountsAsContiguousWorkTime *bool `json:"countsAsContiguousWorkTime,omitempty"`

	// MinimumLengthFromShiftStartMinutes - The minimum duration between shift start and shift item (e.g., break or meal) start in minutes
	MinimumLengthFromShiftStartMinutes *int `json:"minimumLengthFromShiftStartMinutes,omitempty"`

	// MinimumLengthFromShiftEndMinutes - The minimum duration between shift item (e.g., break or meal) end and shift end in minutes
	MinimumLengthFromShiftEndMinutes *int `json:"minimumLengthFromShiftEndMinutes,omitempty"`

	// Id - ID of the activity. This is required only for the case of updating an existing activity
	Id *string `json:"id,omitempty"`

	// Delete - If marked true for updating an existing activity, the activity will be permanently deleted
	Delete *bool `json:"delete,omitempty"`

	// ValidationId - ID of the activity in the context of work plan validation
	ValidationId *string `json:"validationId,omitempty"`
}

Workplanactivity - Activity configured for shift in work plan

func (*Workplanactivity) String ¶

func (o *Workplanactivity) String() string

String returns a JSON representation of the model

type Workplanconfigurationviolationmessage ¶

type Workplanconfigurationviolationmessage struct {
	// VarType - Type of configuration violation message for this work plan
	VarType *string `json:"type,omitempty"`

	// Arguments - Arguments of the message that provide information about the misconfigured value or the threshold that is exceeded by the misconfigured value
	Arguments *[]Workplanvalidationmessageargument `json:"arguments,omitempty"`

	// Severity - Severity of the message. A message with Error severity indicates the scheduler won't be able to produce schedules and thus the work plan is invalid.
	Severity *string `json:"severity,omitempty"`
}

Workplanconfigurationviolationmessage

func (*Workplanconfigurationviolationmessage) String ¶

String returns a JSON representation of the model

type Workplanconstraintconflictmessage ¶

type Workplanconstraintconflictmessage struct {
	// VarType - Type of constraint conflict that can be resolved by clients in order to generate agent schedules
	VarType *string `json:"type,omitempty"`

	// Arguments - The arguments to the type of the message that can help clients resolve validation issues
	Arguments *[]Workplanvalidationmessageargument `json:"arguments,omitempty"`
}

Workplanconstraintconflictmessage

func (*Workplanconstraintconflictmessage) String ¶

String returns a JSON representation of the model

type Workplanconstraintmessage ¶

type Workplanconstraintmessage struct {
	// VarType - Type of the work plan constraint in this message
	VarType *string `json:"type,omitempty"`

	// Arguments - Arguments of the message that provide information about the constraint that is being conflicted with, such as the value of the constraint
	Arguments *[]Workplanvalidationmessageargument `json:"arguments,omitempty"`
}

Workplanconstraintmessage

func (*Workplanconstraintmessage) String ¶

func (o *Workplanconstraintmessage) String() string

String returns a JSON representation of the model

type Workplanlistitemresponse ¶

type Workplanlistitemresponse struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Enabled - Whether the work plan is enabled for scheduling
	Enabled *bool `json:"enabled,omitempty"`

	// Valid - Whether the work plan is valid or not
	Valid *bool `json:"valid,omitempty"`

	// ConstrainWeeklyPaidTime - Whether the weekly paid time constraint is enabled for this work plan
	ConstrainWeeklyPaidTime *bool `json:"constrainWeeklyPaidTime,omitempty"`

	// FlexibleWeeklyPaidTime - Whether the weekly paid time constraint is flexible for this work plan
	FlexibleWeeklyPaidTime *bool `json:"flexibleWeeklyPaidTime,omitempty"`

	// WeeklyExactPaidMinutes - Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false
	WeeklyExactPaidMinutes *int `json:"weeklyExactPaidMinutes,omitempty"`

	// WeeklyMinimumPaidMinutes - Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true
	WeeklyMinimumPaidMinutes *int `json:"weeklyMinimumPaidMinutes,omitempty"`

	// WeeklyMaximumPaidMinutes - Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true
	WeeklyMaximumPaidMinutes *int `json:"weeklyMaximumPaidMinutes,omitempty"`

	// ConstrainPaidTimeGranularity - Whether paid time granularity is constrained for this work plan
	ConstrainPaidTimeGranularity *bool `json:"constrainPaidTimeGranularity,omitempty"`

	// PaidTimeGranularityMinutes - Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true
	PaidTimeGranularityMinutes *int `json:"paidTimeGranularityMinutes,omitempty"`

	// ConstrainMinimumTimeBetweenShifts - Whether the minimum time between shifts constraint is enabled for this work plan
	ConstrainMinimumTimeBetweenShifts *bool `json:"constrainMinimumTimeBetweenShifts,omitempty"`

	// MinimumTimeBetweenShiftsMinutes - Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true
	MinimumTimeBetweenShiftsMinutes *int `json:"minimumTimeBetweenShiftsMinutes,omitempty"`

	// MaximumDays - Maximum number days in a week allowed to be scheduled for this work plan
	MaximumDays *int `json:"maximumDays,omitempty"`

	// MinimumConsecutiveNonWorkingMinutesPerWeek - Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off
	MinimumConsecutiveNonWorkingMinutesPerWeek *int `json:"minimumConsecutiveNonWorkingMinutesPerWeek,omitempty"`

	// ConstrainMaximumConsecutiveWorkingWeekends - Whether to constrain the maximum consecutive working weekends
	ConstrainMaximumConsecutiveWorkingWeekends *bool `json:"constrainMaximumConsecutiveWorkingWeekends,omitempty"`

	// MaximumConsecutiveWorkingWeekends - The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work
	MaximumConsecutiveWorkingWeekends *int `json:"maximumConsecutiveWorkingWeekends,omitempty"`

	// MinimumWorkingDaysPerWeek - The minimum number of days that agents assigned to a work plan must work per week
	MinimumWorkingDaysPerWeek *int `json:"minimumWorkingDaysPerWeek,omitempty"`

	// ConstrainMaximumConsecutiveWorkingDays - Whether to constrain the maximum consecutive working days
	ConstrainMaximumConsecutiveWorkingDays *bool `json:"constrainMaximumConsecutiveWorkingDays,omitempty"`

	// MaximumConsecutiveWorkingDays - The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true
	MaximumConsecutiveWorkingDays *int `json:"maximumConsecutiveWorkingDays,omitempty"`

	// MinimumShiftStartDistanceMinutes - The time period in minutes for the duration between the start times of two consecutive working days
	MinimumShiftStartDistanceMinutes *int `json:"minimumShiftStartDistanceMinutes,omitempty"`

	// MinimumDaysOffPerPlanningPeriod - Minimum days off in the planning period
	MinimumDaysOffPerPlanningPeriod *int `json:"minimumDaysOffPerPlanningPeriod,omitempty"`

	// MaximumDaysOffPerPlanningPeriod - Maximum days off in the planning period
	MaximumDaysOffPerPlanningPeriod *int `json:"maximumDaysOffPerPlanningPeriod,omitempty"`

	// MinimumPaidMinutesPerPlanningPeriod - Minimum paid minutes in the planning period
	MinimumPaidMinutesPerPlanningPeriod *int `json:"minimumPaidMinutesPerPlanningPeriod,omitempty"`

	// MaximumPaidMinutesPerPlanningPeriod - Maximum paid minutes in the planning period
	MaximumPaidMinutesPerPlanningPeriod *int `json:"maximumPaidMinutesPerPlanningPeriod,omitempty"`

	// OptionalDays - Optional days to schedule for this work plan. Populate with expand=details
	OptionalDays *Setwrapperdayofweek `json:"optionalDays,omitempty"`

	// ShiftStartVarianceType - This constraint ensures that an agent starts each workday within a user-defined time threshold
	ShiftStartVarianceType *string `json:"shiftStartVarianceType,omitempty"`

	// ShiftStartVariances - Variance in minutes among start times of shifts in this work plan. Populate with expand=details
	ShiftStartVariances *Listwrappershiftstartvariance `json:"shiftStartVariances,omitempty"`

	// Shifts - Shifts in this work plan. Populate with expand=details (defaults to empty list)
	Shifts *[]Workplanshift `json:"shifts,omitempty"`

	// Agents - Agents in this work plan. Populate with expand=details (defaults to empty list)
	Agents *[]Deletableuserreference `json:"agents,omitempty"`

	// Metadata - Version metadata for this work plan
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// AgentCount - Number of agents in this work plan.  Populate with expand=agentCount
	AgentCount *int `json:"agentCount,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Workplanlistitemresponse - Work plan information

func (*Workplanlistitemresponse) String ¶

func (o *Workplanlistitemresponse) String() string

String returns a JSON representation of the model

type Workplanlistresponse ¶

type Workplanlistresponse struct {
	// Entities
	Entities *[]Workplanlistitemresponse `json:"entities,omitempty"`
}

Workplanlistresponse

func (*Workplanlistresponse) String ¶

func (o *Workplanlistresponse) String() string

String returns a JSON representation of the model

type Workplanpatternrequest ¶

type Workplanpatternrequest struct {
	// WorkPlanIds - List of work plan IDs in order of rotation on a weekly basis. Values in the list cannot be null or empty
	WorkPlanIds *[]string `json:"workPlanIds,omitempty"`
}

Workplanpatternrequest

func (*Workplanpatternrequest) String ¶

func (o *Workplanpatternrequest) String() string

String returns a JSON representation of the model

type Workplanpatternresponse ¶

type Workplanpatternresponse struct {
	// WorkPlans - List of work plans in order of rotation on a weekly basis
	WorkPlans *[]Workplanreference `json:"workPlans,omitempty"`
}

Workplanpatternresponse

func (*Workplanpatternresponse) String ¶

func (o *Workplanpatternresponse) String() string

String returns a JSON representation of the model

type Workplanreference ¶

type Workplanreference struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// ManagementUnit - The management unit to which this work plan belongs.  Nullable in some routes
	ManagementUnit *Managementunitreference `json:"managementUnit,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Workplanreference - Work plan information

func (*Workplanreference) String ¶

func (o *Workplanreference) String() string

String returns a JSON representation of the model

type Workplanrotationagentresponse ¶

type Workplanrotationagentresponse struct {
	// User - The user associated with this work plan rotation
	User *Userreference `json:"user,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"`
}

Workplanrotationagentresponse

func (*Workplanrotationagentresponse) String ¶

String returns a JSON representation of the model

type Workplanrotationlistresponse ¶

type Workplanrotationlistresponse struct {
	// Entities
	Entities *[]Workplanrotationresponse `json:"entities,omitempty"`
}

Workplanrotationlistresponse

func (*Workplanrotationlistresponse) String ¶

String returns a JSON representation of the model

type Workplanrotationreference ¶

type Workplanrotationreference 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"`
}

Workplanrotationreference

func (*Workplanrotationreference) String ¶

func (o *Workplanrotationreference) String() string

String returns a JSON representation of the model

type Workplanrotationresponse ¶

type Workplanrotationresponse struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Enabled - Whether the work plan rotation is enabled for scheduling
	Enabled *bool `json:"enabled,omitempty"`

	// DateRange - The date range to which this work plan rotation applies
	DateRange *Daterangewithoptionalend `json:"dateRange,omitempty"`

	// Pattern - Pattern with ordered list of work plans that rotate on a weekly basis
	Pattern *Workplanpatternresponse `json:"pattern,omitempty"`

	// AgentCount - Number of agents in this work plan rotation
	AgentCount *int `json:"agentCount,omitempty"`

	// Agents - Agents in this work plan rotation. Populate with expand=agents for GET WorkPlanRotationsList (defaults to empty list)
	Agents *[]Workplanrotationagentresponse `json:"agents,omitempty"`

	// Metadata - Version metadata for this work plan rotation
	Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Workplanrotationresponse

func (*Workplanrotationresponse) String ¶

func (o *Workplanrotationresponse) String() string

String returns a JSON representation of the model

type Workplanshift ¶

type Workplanshift struct {
	// Name - Name of the shift
	Name *string `json:"name,omitempty"`

	// Days - Days of the week applicable for this shift
	Days *Setwrapperdayofweek `json:"days,omitempty"`

	// FlexibleStartTime - Whether the start time of the shift is flexible
	FlexibleStartTime *bool `json:"flexibleStartTime,omitempty"`

	// ExactStartTimeMinutesFromMidnight - Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false
	ExactStartTimeMinutesFromMidnight *int `json:"exactStartTimeMinutesFromMidnight,omitempty"`

	// EarliestStartTimeMinutesFromMidnight - Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true
	EarliestStartTimeMinutesFromMidnight *int `json:"earliestStartTimeMinutesFromMidnight,omitempty"`

	// LatestStartTimeMinutesFromMidnight - Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true
	LatestStartTimeMinutesFromMidnight *int `json:"latestStartTimeMinutesFromMidnight,omitempty"`

	// ConstrainStopTime - Whether the latest stop time constraint for the shift is enabled.  Deprecated, use constrainLatestStopTime instead
	ConstrainStopTime *bool `json:"constrainStopTime,omitempty"`

	// ConstrainLatestStopTime - Whether the latest stop time constraint for the shift is enabled
	ConstrainLatestStopTime *bool `json:"constrainLatestStopTime,omitempty"`

	// LatestStopTimeMinutesFromMidnight - Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true
	LatestStopTimeMinutesFromMidnight *int `json:"latestStopTimeMinutesFromMidnight,omitempty"`

	// ConstrainEarliestStopTime - Whether the earliest stop time constraint for the shift is enabled
	ConstrainEarliestStopTime *bool `json:"constrainEarliestStopTime,omitempty"`

	// EarliestStopTimeMinutesFromMidnight - This is the earliest time a shift can end
	EarliestStopTimeMinutesFromMidnight *int `json:"earliestStopTimeMinutesFromMidnight,omitempty"`

	// StartIncrementMinutes - Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true
	StartIncrementMinutes *int `json:"startIncrementMinutes,omitempty"`

	// FlexiblePaidTime - Whether the paid time setting for the shift is flexible
	FlexiblePaidTime *bool `json:"flexiblePaidTime,omitempty"`

	// ExactPaidTimeMinutes - Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false
	ExactPaidTimeMinutes *int `json:"exactPaidTimeMinutes,omitempty"`

	// MinimumPaidTimeMinutes - Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true
	MinimumPaidTimeMinutes *int `json:"minimumPaidTimeMinutes,omitempty"`

	// MaximumPaidTimeMinutes - Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true
	MaximumPaidTimeMinutes *int `json:"maximumPaidTimeMinutes,omitempty"`

	// ConstrainContiguousWorkTime - Whether the contiguous time constraint for the shift is enabled
	ConstrainContiguousWorkTime *bool `json:"constrainContiguousWorkTime,omitempty"`

	// MinimumContiguousWorkTimeMinutes - Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true
	MinimumContiguousWorkTimeMinutes *int `json:"minimumContiguousWorkTimeMinutes,omitempty"`

	// MaximumContiguousWorkTimeMinutes - Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true
	MaximumContiguousWorkTimeMinutes *int `json:"maximumContiguousWorkTimeMinutes,omitempty"`

	// Activities - Activities configured for this shift
	Activities *[]Workplanactivity `json:"activities,omitempty"`

	// Id - ID of the shift. This is required only for the case of updating an existing shift
	Id *string `json:"id,omitempty"`

	// Delete - If marked true for updating an existing shift, the shift will be permanently deleted
	Delete *bool `json:"delete,omitempty"`

	// ValidationId - ID of shift in the context of work plan validation
	ValidationId *string `json:"validationId,omitempty"`
}

Workplanshift - Shift in a work plan

func (*Workplanshift) String ¶

func (o *Workplanshift) String() string

String returns a JSON representation of the model

type Workplanvalidationmessageargument ¶

type Workplanvalidationmessageargument struct {
	// VarType - The type of the argument associated with violation messages
	VarType *string `json:"type,omitempty"`

	// Value - The value of the argument
	Value *string `json:"value,omitempty"`
}

Workplanvalidationmessageargument

func (*Workplanvalidationmessageargument) String ¶

String returns a JSON representation of the model

type Workplanvalidationrequest ¶

type Workplanvalidationrequest struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Enabled - Whether the work plan is enabled for scheduling
	Enabled *bool `json:"enabled,omitempty"`

	// Valid - Whether the work plan is valid or not
	Valid *bool `json:"valid,omitempty"`

	// ConstrainWeeklyPaidTime - Whether the weekly paid time constraint is enabled for this work plan
	ConstrainWeeklyPaidTime *bool `json:"constrainWeeklyPaidTime,omitempty"`

	// FlexibleWeeklyPaidTime - Whether the weekly paid time constraint is flexible for this work plan
	FlexibleWeeklyPaidTime *bool `json:"flexibleWeeklyPaidTime,omitempty"`

	// WeeklyExactPaidMinutes - Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false
	WeeklyExactPaidMinutes *int `json:"weeklyExactPaidMinutes,omitempty"`

	// WeeklyMinimumPaidMinutes - Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true
	WeeklyMinimumPaidMinutes *int `json:"weeklyMinimumPaidMinutes,omitempty"`

	// WeeklyMaximumPaidMinutes - Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true
	WeeklyMaximumPaidMinutes *int `json:"weeklyMaximumPaidMinutes,omitempty"`

	// ConstrainPaidTimeGranularity - Whether paid time granularity is constrained for this work plan
	ConstrainPaidTimeGranularity *bool `json:"constrainPaidTimeGranularity,omitempty"`

	// PaidTimeGranularityMinutes - Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true
	PaidTimeGranularityMinutes *int `json:"paidTimeGranularityMinutes,omitempty"`

	// ConstrainMinimumTimeBetweenShifts - Whether the minimum time between shifts constraint is enabled for this work plan
	ConstrainMinimumTimeBetweenShifts *bool `json:"constrainMinimumTimeBetweenShifts,omitempty"`

	// MinimumTimeBetweenShiftsMinutes - Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true
	MinimumTimeBetweenShiftsMinutes *int `json:"minimumTimeBetweenShiftsMinutes,omitempty"`

	// MaximumDays - Maximum number days in a week allowed to be scheduled for this work plan
	MaximumDays *int `json:"maximumDays,omitempty"`

	// MinimumConsecutiveNonWorkingMinutesPerWeek - Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off
	MinimumConsecutiveNonWorkingMinutesPerWeek *int `json:"minimumConsecutiveNonWorkingMinutesPerWeek,omitempty"`

	// ConstrainMaximumConsecutiveWorkingWeekends - Whether to constrain the maximum consecutive working weekends
	ConstrainMaximumConsecutiveWorkingWeekends *bool `json:"constrainMaximumConsecutiveWorkingWeekends,omitempty"`

	// MaximumConsecutiveWorkingWeekends - The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work
	MaximumConsecutiveWorkingWeekends *int `json:"maximumConsecutiveWorkingWeekends,omitempty"`

	// MinimumWorkingDaysPerWeek - The minimum number of days that agents assigned to a work plan must work per week
	MinimumWorkingDaysPerWeek *int `json:"minimumWorkingDaysPerWeek,omitempty"`

	// ConstrainMaximumConsecutiveWorkingDays - Whether to constrain the maximum consecutive working days
	ConstrainMaximumConsecutiveWorkingDays *bool `json:"constrainMaximumConsecutiveWorkingDays,omitempty"`

	// MaximumConsecutiveWorkingDays - The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true
	MaximumConsecutiveWorkingDays *int `json:"maximumConsecutiveWorkingDays,omitempty"`

	// MinimumShiftStartDistanceMinutes - The time period in minutes for the duration between the start times of two consecutive working days
	MinimumShiftStartDistanceMinutes *int `json:"minimumShiftStartDistanceMinutes,omitempty"`

	// MinimumDaysOffPerPlanningPeriod - Minimum days off in the planning period
	MinimumDaysOffPerPlanningPeriod *int `json:"minimumDaysOffPerPlanningPeriod,omitempty"`

	// MaximumDaysOffPerPlanningPeriod - Maximum days off in the planning period
	MaximumDaysOffPerPlanningPeriod *int `json:"maximumDaysOffPerPlanningPeriod,omitempty"`

	// MinimumPaidMinutesPerPlanningPeriod - Minimum paid minutes in the planning period
	MinimumPaidMinutesPerPlanningPeriod *int `json:"minimumPaidMinutesPerPlanningPeriod,omitempty"`

	// MaximumPaidMinutesPerPlanningPeriod - Maximum paid minutes in the planning period
	MaximumPaidMinutesPerPlanningPeriod *int `json:"maximumPaidMinutesPerPlanningPeriod,omitempty"`

	// OptionalDays - Optional days to schedule for this work plan
	OptionalDays *Setwrapperdayofweek `json:"optionalDays,omitempty"`

	// ShiftStartVarianceType - This constraint ensures that an agent starts each workday within a user-defined time threshold
	ShiftStartVarianceType *string `json:"shiftStartVarianceType,omitempty"`

	// ShiftStartVariances - Variance in minutes among start times of shifts in this work plan
	ShiftStartVariances *Listwrappershiftstartvariance `json:"shiftStartVariances,omitempty"`

	// Shifts - Shifts in this work plan
	Shifts *[]Workplanshift `json:"shifts,omitempty"`

	// Agents - Agents in this work plan
	Agents *[]Deletableuserreference `json:"agents,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Workplanvalidationrequest - Work plan information

func (*Workplanvalidationrequest) String ¶

func (o *Workplanvalidationrequest) String() string

String returns a JSON representation of the model

type Workspace ¶

type Workspace struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The current name of the workspace.
	Name *string `json:"name,omitempty"`

	// VarType
	VarType *string `json:"type,omitempty"`

	// IsCurrentUserWorkspace
	IsCurrentUserWorkspace *bool `json:"isCurrentUserWorkspace,omitempty"`

	// User
	User *Domainentityref `json:"user,omitempty"`

	// Bucket
	Bucket *string `json:"bucket,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"`

	// 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"`

	// Summary
	Summary *Workspacesummary `json:"summary,omitempty"`

	// Acl
	Acl *[]string `json:"acl,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Workspace

func (*Workspace) String ¶

func (o *Workspace) String() string

String returns a JSON representation of the model

type Workspacecreate ¶

type Workspacecreate struct {
	// Name - The workspace name
	Name *string `json:"name,omitempty"`

	// Bucket
	Bucket *string `json:"bucket,omitempty"`

	// Description
	Description *string `json:"description,omitempty"`
}

Workspacecreate

func (*Workspacecreate) String ¶

func (o *Workspacecreate) String() string

String returns a JSON representation of the model

type Workspaceentitylisting ¶

type Workspaceentitylisting struct {
	// Entities
	Entities *[]Workspace `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Workspaceentitylisting

func (*Workspaceentitylisting) String ¶

func (o *Workspaceentitylisting) String() string

String returns a JSON representation of the model

type Workspacemember ¶

type Workspacemember struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// Workspace
	Workspace *Domainentityref `json:"workspace,omitempty"`

	// MemberType - The workspace member type.
	MemberType *string `json:"memberType,omitempty"`

	// Member
	Member *Domainentityref `json:"member,omitempty"`

	// User
	User *User `json:"user,omitempty"`

	// Group
	Group *Group `json:"group,omitempty"`

	// SecurityProfile
	SecurityProfile *Securityprofile `json:"securityProfile,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Workspacemember

func (*Workspacemember) String ¶

func (o *Workspacemember) String() string

String returns a JSON representation of the model

type Workspacememberentitylisting ¶

type Workspacememberentitylisting struct {
	// Entities
	Entities *[]Workspacemember `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Workspacememberentitylisting

func (*Workspacememberentitylisting) String ¶

String returns a JSON representation of the model

type Workspacesummary ¶

type Workspacesummary struct {
	// TotalDocumentCount
	TotalDocumentCount *int `json:"totalDocumentCount,omitempty"`

	// TotalDocumentByteCount
	TotalDocumentByteCount *int `json:"totalDocumentByteCount,omitempty"`
}

Workspacesummary

func (*Workspacesummary) String ¶

func (o *Workspacesummary) String() string

String returns a JSON representation of the model

type Wrapup ¶

type Wrapup struct {
	// Code - The user configured wrap up code id.
	Code *string `json:"code,omitempty"`

	// Name - The user configured wrap up code name.
	Name *string `json:"name,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 length of time in seconds that the agent spent doing after call work.
	DurationSeconds *int `json:"durationSeconds,omitempty"`

	// EndTime - The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
	EndTime *time.Time `json:"endTime,omitempty"`

	// Provisional - Indicates if this is a pending save and should not require a code to be specified.  This allows someone to save some temporary wrapup that will be used later.
	Provisional *bool `json:"provisional,omitempty"`
}

Wrapup

func (*Wrapup) String ¶

func (o *Wrapup) String() string

String returns a JSON representation of the model

type Wrapupcode ¶

type Wrapupcode struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name - The wrap-up code name.
	Name *string `json:"name,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"`

	// 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"`

	// ModifiedBy
	ModifiedBy *string `json:"modifiedBy,omitempty"`

	// CreatedBy
	CreatedBy *string `json:"createdBy,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Wrapupcode

func (*Wrapupcode) String ¶

func (o *Wrapupcode) String() string

String returns a JSON representation of the model

type Wrapupcodeentitylisting ¶

type Wrapupcodeentitylisting struct {
	// Entities
	Entities *[]Wrapupcode `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"`

	// PreviousUri
	PreviousUri *string `json:"previousUri,omitempty"`

	// LastUri
	LastUri *string `json:"lastUri,omitempty"`

	// PageCount
	PageCount *int `json:"pageCount,omitempty"`
}

Wrapupcodeentitylisting

func (*Wrapupcodeentitylisting) String ¶

func (o *Wrapupcodeentitylisting) String() string

String returns a JSON representation of the model

type Wrapupcodemapping ¶

type Wrapupcodemapping 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"`

	// DefaultSet - The default set of wrap-up flags. These will be used if there is no entry for a given wrap-up code in the mapping.
	DefaultSet *[]string `json:"defaultSet,omitempty"`

	// Mapping - A map from wrap-up code identifiers to a set of wrap-up flags.
	Mapping *map[string][]string `json:"mapping,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Wrapupcodemapping

func (*Wrapupcodemapping) String ¶

func (o *Wrapupcodemapping) String() string

String returns a JSON representation of the model

type Wrapupcodereference ¶

type Wrapupcodereference struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`
}

Wrapupcodereference

func (*Wrapupcodereference) String ¶

func (o *Wrapupcodereference) String() string

String returns a JSON representation of the model

type Writabledialercontact ¶

type Writabledialercontact struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// ContactListId - The identifier of the contact list containing this contact.
	ContactListId *string `json:"contactListId,omitempty"`

	// Data - An ordered map of the contact's columns and corresponding values.
	Data *map[string]interface{} `json:"data,omitempty"`

	// Callable - Indicates whether or not the contact can be called.
	Callable *bool `json:"callable,omitempty"`

	// PhoneNumberStatus - A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not.
	PhoneNumberStatus *map[string]Phonenumberstatus `json:"phoneNumberStatus,omitempty"`
}

Writabledialercontact

func (*Writabledialercontact) String ¶

func (o *Writabledialercontact) String() string

String returns a JSON representation of the model

type Writabledivision ¶

type Writabledivision struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`

	// Name
	Name *string `json:"name,omitempty"`

	// SelfUri - The URI for this object
	SelfUri *string `json:"selfUri,omitempty"`
}

Writabledivision

func (*Writabledivision) String ¶

func (o *Writabledivision) String() string

String returns a JSON representation of the model

type Writableentity ¶

type Writableentity struct {
	// Id - The globally unique identifier for the object.
	Id *string `json:"id,omitempty"`
}

Writableentity

func (*Writableentity) String ¶

func (o *Writableentity) String() string

String returns a JSON representation of the model

Source Files ¶

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL