openapi

package
v1.21.1 Latest Latest
Warning

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

Go to latest
Published: Jun 6, 2024 License: MIT Imports: 6 Imported by: 1

README

Go API client for openapi

This is the public Twilio REST API.

Overview

This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/twilio-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: com.twilio.oai.TwilioGoGenerator For more information, please visit https://support.twilio.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

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

import "./openapi"

Documentation for API Endpoints

All URIs are relative to https://flex-api.twilio.com

Class Method HTTP request Description
AccountProvisionStatusApi FetchProvisioningStatus Get /v1/account/provision/status
ChannelsApi CreateChannel Post /v1/Channels
ChannelsApi DeleteChannel Delete /v1/Channels/{Sid}
ChannelsApi FetchChannel Get /v1/Channels/{Sid}
ChannelsApi ListChannel Get /v1/Channels
ConfigurationApi FetchConfiguration Get /v1/Configuration
ConfigurationApi UpdateConfiguration Post /v1/Configuration
FlexFlowsApi CreateFlexFlow Post /v1/FlexFlows
FlexFlowsApi DeleteFlexFlow Delete /v1/FlexFlows/{Sid}
FlexFlowsApi FetchFlexFlow Get /v1/FlexFlows/{Sid}
FlexFlowsApi ListFlexFlow Get /v1/FlexFlows
FlexFlowsApi UpdateFlexFlow Post /v1/FlexFlows/{Sid}
InsightsConversationsApi ListInsightsConversations Get /v1/Insights/Conversations
InsightsQualityManagementAssessmentsApi CreateInsightsAssessments Post /v1/Insights/QualityManagement/Assessments
InsightsQualityManagementAssessmentsApi ListInsightsAssessments Get /v1/Insights/QualityManagement/Assessments
InsightsQualityManagementAssessmentsApi UpdateInsightsAssessments Post /v1/Insights/QualityManagement/Assessments/{AssessmentSid}
InsightsQualityManagementAssessmentsCommentsApi CreateInsightsAssessmentsComment Post /v1/Insights/QualityManagement/Assessments/Comments
InsightsQualityManagementAssessmentsCommentsApi ListInsightsAssessmentsComment Get /v1/Insights/QualityManagement/Assessments/Comments
InsightsQualityManagementCategoriesApi CreateInsightsQuestionnairesCategory Post /v1/Insights/QualityManagement/Categories
InsightsQualityManagementCategoriesApi DeleteInsightsQuestionnairesCategory Delete /v1/Insights/QualityManagement/Categories/{CategorySid}
InsightsQualityManagementCategoriesApi ListInsightsQuestionnairesCategory Get /v1/Insights/QualityManagement/Categories
InsightsQualityManagementCategoriesApi UpdateInsightsQuestionnairesCategory Post /v1/Insights/QualityManagement/Categories/{CategorySid}
InsightsQualityManagementQuestionnairesApi CreateInsightsQuestionnaires Post /v1/Insights/QualityManagement/Questionnaires
InsightsQualityManagementQuestionnairesApi DeleteInsightsQuestionnaires Delete /v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid}
InsightsQualityManagementQuestionnairesApi FetchInsightsQuestionnaires Get /v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid}
InsightsQualityManagementQuestionnairesApi ListInsightsQuestionnaires Get /v1/Insights/QualityManagement/Questionnaires
InsightsQualityManagementQuestionnairesApi UpdateInsightsQuestionnaires Post /v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid}
InsightsQualityManagementQuestionsApi CreateInsightsQuestionnairesQuestion Post /v1/Insights/QualityManagement/Questions
InsightsQualityManagementQuestionsApi DeleteInsightsQuestionnairesQuestion Delete /v1/Insights/QualityManagement/Questions/{QuestionSid}
InsightsQualityManagementQuestionsApi ListInsightsQuestionnairesQuestion Get /v1/Insights/QualityManagement/Questions
InsightsQualityManagementQuestionsApi UpdateInsightsQuestionnairesQuestion Post /v1/Insights/QualityManagement/Questions/{QuestionSid}
InsightsQualityManagementSettingsAnswerSetsApi FetchInsightsSettingsAnswersets Get /v1/Insights/QualityManagement/Settings/AnswerSets
InsightsQualityManagementSettingsCommentTagsApi FetchInsightsSettingsComment Get /v1/Insights/QualityManagement/Settings/CommentTags
InsightsSegmentsApi ListInsightsSegments Get /v1/Insights/Segments
InsightsSessionApi CreateInsightsSession Post /v1/Insights/Session
InsightsUserRolesApi FetchInsightsUserRoles Get /v1/Insights/UserRoles
InteractionsApi CreateInteraction Post /v1/Interactions
InteractionsApi FetchInteraction Get /v1/Interactions/{Sid}
InteractionsChannelsApi FetchInteractionChannel Get /v1/Interactions/{InteractionSid}/Channels/{Sid}
InteractionsChannelsApi ListInteractionChannel Get /v1/Interactions/{InteractionSid}/Channels
InteractionsChannelsApi UpdateInteractionChannel Post /v1/Interactions/{InteractionSid}/Channels/{Sid}
InteractionsChannelsInvitesApi CreateInteractionChannelInvite Post /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites
InteractionsChannelsInvitesApi ListInteractionChannelInvite Get /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites
InteractionsChannelsParticipantsApi CreateInteractionChannelParticipant Post /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants
InteractionsChannelsParticipantsApi ListInteractionChannelParticipant Get /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants
InteractionsChannelsParticipantsApi UpdateInteractionChannelParticipant Post /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}
PluginServiceConfigurationsApi CreatePluginConfiguration Post /v1/PluginService/Configurations
PluginServiceConfigurationsApi FetchPluginConfiguration Get /v1/PluginService/Configurations/{Sid}
PluginServiceConfigurationsApi ListPluginConfiguration Get /v1/PluginService/Configurations
PluginServiceConfigurationsArchiveApi UpdatePluginConfigurationArchive Post /v1/PluginService/Configurations/{Sid}/Archive
PluginServiceConfigurationsPluginsApi FetchConfiguredPlugin Get /v1/PluginService/Configurations/{ConfigurationSid}/Plugins/{PluginSid}
PluginServiceConfigurationsPluginsApi ListConfiguredPlugin Get /v1/PluginService/Configurations/{ConfigurationSid}/Plugins
PluginServicePluginsApi CreatePlugin Post /v1/PluginService/Plugins
PluginServicePluginsApi FetchPlugin Get /v1/PluginService/Plugins/{Sid}
PluginServicePluginsApi ListPlugin Get /v1/PluginService/Plugins
PluginServicePluginsApi UpdatePlugin Post /v1/PluginService/Plugins/{Sid}
PluginServicePluginsArchiveApi UpdatePluginArchive Post /v1/PluginService/Plugins/{Sid}/Archive
PluginServicePluginsVersionsApi CreatePluginVersion Post /v1/PluginService/Plugins/{PluginSid}/Versions
PluginServicePluginsVersionsApi FetchPluginVersion Get /v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}
PluginServicePluginsVersionsApi ListPluginVersion Get /v1/PluginService/Plugins/{PluginSid}/Versions
PluginServicePluginsVersionsArchiveApi UpdatePluginVersionArchive Post /v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}/Archive
PluginServiceReleasesApi CreatePluginRelease Post /v1/PluginService/Releases
PluginServiceReleasesApi FetchPluginRelease Get /v1/PluginService/Releases/{Sid}
PluginServiceReleasesApi ListPluginRelease Get /v1/PluginService/Releases
WebChannelsApi CreateWebChannel Post /v1/WebChannels
WebChannelsApi DeleteWebChannel Delete /v1/WebChannels/{Sid}
WebChannelsApi FetchWebChannel Get /v1/WebChannels/{Sid}
WebChannelsApi ListWebChannel Get /v1/WebChannels
WebChannelsApi UpdateWebChannel Post /v1/WebChannels/{Sid}

Documentation For Models

Documentation For Authorization

accountSid_authToken

  • Type: HTTP basic authentication

Example

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiService added in v0.11.0

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

func NewApiService added in v0.11.0

func NewApiService(requestHandler *twilio.RequestHandler) *ApiService

func NewApiServiceWithClient added in v0.11.0

func NewApiServiceWithClient(client twilio.BaseClient) *ApiService

func (*ApiService) CreateChannel added in v0.11.0

func (c *ApiService) CreateChannel(params *CreateChannelParams) (*FlexV1Channel, error)

func (*ApiService) CreateFlexFlow added in v0.11.0

func (c *ApiService) CreateFlexFlow(params *CreateFlexFlowParams) (*FlexV1FlexFlow, error)

func (*ApiService) CreateInsightsAssessments added in v1.3.2

func (c *ApiService) CreateInsightsAssessments(params *CreateInsightsAssessmentsParams) (*FlexV1InsightsAssessments, error)

Add assessments against conversation to dynamo db. Used in assessments screen by user. Users can select the questionnaire and pick up answers for each and every question.

func (*ApiService) CreateInsightsAssessmentsComment added in v1.3.3

func (c *ApiService) CreateInsightsAssessmentsComment(params *CreateInsightsAssessmentsCommentParams) (*FlexV1InsightsAssessmentsComment, error)

To create a comment assessment for a conversation

func (*ApiService) CreateInsightsQuestionnaires added in v1.3.3

func (c *ApiService) CreateInsightsQuestionnaires(params *CreateInsightsQuestionnairesParams) (*FlexV1InsightsQuestionnaires, error)

To create a Questionnaire

func (*ApiService) CreateInsightsQuestionnairesCategory added in v1.3.2

func (c *ApiService) CreateInsightsQuestionnairesCategory(params *CreateInsightsQuestionnairesCategoryParams) (*FlexV1InsightsQuestionnairesCategory, error)

To create a category for Questions

func (*ApiService) CreateInsightsQuestionnairesQuestion added in v1.3.2

func (c *ApiService) CreateInsightsQuestionnairesQuestion(params *CreateInsightsQuestionnairesQuestionParams) (*FlexV1InsightsQuestionnairesQuestion, error)

To create a question for a Category

func (*ApiService) CreateInsightsSession added in v1.3.2

func (c *ApiService) CreateInsightsSession(params *CreateInsightsSessionParams) (*FlexV1InsightsSession, error)

To obtain session details for fetching reports and dashboards

func (*ApiService) CreateInteraction added in v0.23.0

func (c *ApiService) CreateInteraction(params *CreateInteractionParams) (*FlexV1Interaction, error)

Create a new Interaction.

func (*ApiService) CreateInteractionChannelInvite added in v0.23.0

func (c *ApiService) CreateInteractionChannelInvite(InteractionSid string, ChannelSid string, params *CreateInteractionChannelInviteParams) (*FlexV1InteractionChannelInvite, error)

Invite an Agent or a TaskQueue to a Channel.

func (*ApiService) CreateInteractionChannelParticipant added in v0.23.0

func (c *ApiService) CreateInteractionChannelParticipant(InteractionSid string, ChannelSid string, params *CreateInteractionChannelParticipantParams) (*FlexV1InteractionChannelParticipant, error)

Add a Participant to a Channel.

func (*ApiService) CreatePlugin added in v1.19.1

func (c *ApiService) CreatePlugin(params *CreatePluginParams) (*FlexV1Plugin, error)

func (*ApiService) CreatePluginConfiguration added in v1.19.1

func (c *ApiService) CreatePluginConfiguration(params *CreatePluginConfigurationParams) (*FlexV1PluginConfiguration, error)

func (*ApiService) CreatePluginRelease added in v1.19.1

func (c *ApiService) CreatePluginRelease(params *CreatePluginReleaseParams) (*FlexV1PluginRelease, error)

func (*ApiService) CreatePluginVersion added in v1.19.1

func (c *ApiService) CreatePluginVersion(PluginSid string, params *CreatePluginVersionParams) (*FlexV1PluginVersion, error)

func (*ApiService) CreateWebChannel added in v0.11.0

func (c *ApiService) CreateWebChannel(params *CreateWebChannelParams) (*FlexV1WebChannel, error)

func (*ApiService) DeleteChannel added in v0.11.0

func (c *ApiService) DeleteChannel(Sid string) error

func (*ApiService) DeleteFlexFlow added in v0.11.0

func (c *ApiService) DeleteFlexFlow(Sid string) error

func (*ApiService) DeleteInsightsQuestionnaires added in v1.3.3

func (c *ApiService) DeleteInsightsQuestionnaires(QuestionnaireSid string, params *DeleteInsightsQuestionnairesParams) error

To delete the questionnaire

func (*ApiService) DeleteInsightsQuestionnairesCategory added in v1.3.2

func (c *ApiService) DeleteInsightsQuestionnairesCategory(CategorySid string, params *DeleteInsightsQuestionnairesCategoryParams) error

func (*ApiService) DeleteInsightsQuestionnairesQuestion added in v1.3.2

func (c *ApiService) DeleteInsightsQuestionnairesQuestion(QuestionSid string, params *DeleteInsightsQuestionnairesQuestionParams) error

func (*ApiService) DeleteWebChannel added in v0.11.0

func (c *ApiService) DeleteWebChannel(Sid string) error

func (*ApiService) FetchChannel added in v0.11.0

func (c *ApiService) FetchChannel(Sid string) (*FlexV1Channel, error)

func (*ApiService) FetchConfiguration added in v0.11.0

func (c *ApiService) FetchConfiguration(params *FetchConfigurationParams) (*FlexV1Configuration, error)

func (*ApiService) FetchConfiguredPlugin added in v1.19.1

func (c *ApiService) FetchConfiguredPlugin(ConfigurationSid string, PluginSid string, params *FetchConfiguredPluginParams) (*FlexV1ConfiguredPlugin, error)

func (*ApiService) FetchFlexFlow added in v0.11.0

func (c *ApiService) FetchFlexFlow(Sid string) (*FlexV1FlexFlow, error)

func (*ApiService) FetchInsightsQuestionnaires added in v1.3.3

func (c *ApiService) FetchInsightsQuestionnaires(QuestionnaireSid string, params *FetchInsightsQuestionnairesParams) (*FlexV1InsightsQuestionnaires, error)

To get the Questionnaire Detail

func (*ApiService) FetchInsightsSettingsAnswersets added in v1.3.2

func (c *ApiService) FetchInsightsSettingsAnswersets(params *FetchInsightsSettingsAnswersetsParams) (*FlexV1InsightsSettingsAnswersets, error)

To get the Answer Set Settings for an Account

func (*ApiService) FetchInsightsSettingsComment added in v1.3.2

func (c *ApiService) FetchInsightsSettingsComment(params *FetchInsightsSettingsCommentParams) (*FlexV1InsightsSettingsComment, error)

To get the Comment Settings for an Account

func (*ApiService) FetchInsightsUserRoles added in v1.3.2

func (c *ApiService) FetchInsightsUserRoles(params *FetchInsightsUserRolesParams) (*FlexV1InsightsUserRoles, error)

This is used by Flex UI and Quality Management to fetch the Flex Insights roles for the user

func (*ApiService) FetchInteraction added in v0.23.0

func (c *ApiService) FetchInteraction(Sid string) (*FlexV1Interaction, error)

func (*ApiService) FetchInteractionChannel added in v0.23.0

func (c *ApiService) FetchInteractionChannel(InteractionSid string, Sid string) (*FlexV1InteractionChannel, error)

Fetch a Channel for an Interaction.

func (*ApiService) FetchPlugin added in v1.19.1

func (c *ApiService) FetchPlugin(Sid string, params *FetchPluginParams) (*FlexV1Plugin, error)

func (*ApiService) FetchPluginConfiguration added in v1.19.1

func (c *ApiService) FetchPluginConfiguration(Sid string, params *FetchPluginConfigurationParams) (*FlexV1PluginConfiguration, error)

func (*ApiService) FetchPluginRelease added in v1.19.1

func (c *ApiService) FetchPluginRelease(Sid string, params *FetchPluginReleaseParams) (*FlexV1PluginRelease, error)

func (*ApiService) FetchPluginVersion added in v1.19.1

func (c *ApiService) FetchPluginVersion(PluginSid string, Sid string, params *FetchPluginVersionParams) (*FlexV1PluginVersion, error)

func (*ApiService) FetchProvisioningStatus added in v1.15.1

func (c *ApiService) FetchProvisioningStatus() (*FlexV1ProvisioningStatus, error)

func (*ApiService) FetchWebChannel added in v0.11.0

func (c *ApiService) FetchWebChannel(Sid string) (*FlexV1WebChannel, error)

func (*ApiService) ListChannel added in v0.11.0

func (c *ApiService) ListChannel(params *ListChannelParams) ([]FlexV1Channel, error)

Lists Channel records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListConfiguredPlugin added in v1.19.1

func (c *ApiService) ListConfiguredPlugin(ConfigurationSid string, params *ListConfiguredPluginParams) ([]FlexV1ConfiguredPlugin, error)

Lists ConfiguredPlugin records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListFlexFlow added in v0.11.0

func (c *ApiService) ListFlexFlow(params *ListFlexFlowParams) ([]FlexV1FlexFlow, error)

Lists FlexFlow records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListInsightsAssessments added in v1.3.5

func (c *ApiService) ListInsightsAssessments(params *ListInsightsAssessmentsParams) ([]FlexV1InsightsAssessments, error)

Lists InsightsAssessments records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListInsightsAssessmentsComment added in v1.3.3

func (c *ApiService) ListInsightsAssessmentsComment(params *ListInsightsAssessmentsCommentParams) ([]FlexV1InsightsAssessmentsComment, error)

Lists InsightsAssessmentsComment records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListInsightsConversations added in v1.4.0

func (c *ApiService) ListInsightsConversations(params *ListInsightsConversationsParams) ([]FlexV1InsightsConversations, error)

Lists InsightsConversations records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListInsightsQuestionnaires added in v1.3.3

func (c *ApiService) ListInsightsQuestionnaires(params *ListInsightsQuestionnairesParams) ([]FlexV1InsightsQuestionnaires, error)

Lists InsightsQuestionnaires records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListInsightsQuestionnairesCategory added in v1.3.3

func (c *ApiService) ListInsightsQuestionnairesCategory(params *ListInsightsQuestionnairesCategoryParams) ([]FlexV1InsightsQuestionnairesCategory, error)

Lists InsightsQuestionnairesCategory records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListInsightsQuestionnairesQuestion added in v1.3.3

func (c *ApiService) ListInsightsQuestionnairesQuestion(params *ListInsightsQuestionnairesQuestionParams) ([]FlexV1InsightsQuestionnairesQuestion, error)

Lists InsightsQuestionnairesQuestion records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListInsightsSegments added in v1.3.4

func (c *ApiService) ListInsightsSegments(params *ListInsightsSegmentsParams) ([]FlexV1InsightsSegments, error)

Lists InsightsSegments records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListInteractionChannel added in v0.23.0

func (c *ApiService) ListInteractionChannel(InteractionSid string, params *ListInteractionChannelParams) ([]FlexV1InteractionChannel, error)

Lists InteractionChannel records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListInteractionChannelInvite added in v0.23.0

func (c *ApiService) ListInteractionChannelInvite(InteractionSid string, ChannelSid string, params *ListInteractionChannelInviteParams) ([]FlexV1InteractionChannelInvite, error)

Lists InteractionChannelInvite records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListInteractionChannelParticipant added in v0.23.0

func (c *ApiService) ListInteractionChannelParticipant(InteractionSid string, ChannelSid string, params *ListInteractionChannelParticipantParams) ([]FlexV1InteractionChannelParticipant, error)

Lists InteractionChannelParticipant records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListPlugin added in v1.19.1

func (c *ApiService) ListPlugin(params *ListPluginParams) ([]FlexV1Plugin, error)

Lists Plugin records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListPluginConfiguration added in v1.19.1

func (c *ApiService) ListPluginConfiguration(params *ListPluginConfigurationParams) ([]FlexV1PluginConfiguration, error)

Lists PluginConfiguration records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListPluginRelease added in v1.19.1

func (c *ApiService) ListPluginRelease(params *ListPluginReleaseParams) ([]FlexV1PluginRelease, error)

Lists PluginRelease records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListPluginVersion added in v1.19.1

func (c *ApiService) ListPluginVersion(PluginSid string, params *ListPluginVersionParams) ([]FlexV1PluginVersion, error)

Lists PluginVersion records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListWebChannel added in v0.11.0

func (c *ApiService) ListWebChannel(params *ListWebChannelParams) ([]FlexV1WebChannel, error)

Lists WebChannel records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) PageChannel added in v0.13.0

func (c *ApiService) PageChannel(params *ListChannelParams, pageToken, pageNumber string) (*ListChannelResponse, error)

Retrieve a single page of Channel records from the API. Request is executed immediately.

func (*ApiService) PageConfiguredPlugin added in v1.19.1

func (c *ApiService) PageConfiguredPlugin(ConfigurationSid string, params *ListConfiguredPluginParams, pageToken, pageNumber string) (*ListConfiguredPluginResponse, error)

Retrieve a single page of ConfiguredPlugin records from the API. Request is executed immediately.

func (*ApiService) PageFlexFlow added in v0.13.0

func (c *ApiService) PageFlexFlow(params *ListFlexFlowParams, pageToken, pageNumber string) (*ListFlexFlowResponse, error)

Retrieve a single page of FlexFlow records from the API. Request is executed immediately.

func (*ApiService) PageInsightsAssessments added in v1.3.5

func (c *ApiService) PageInsightsAssessments(params *ListInsightsAssessmentsParams, pageToken, pageNumber string) (*ListInsightsAssessmentsResponse, error)

Retrieve a single page of InsightsAssessments records from the API. Request is executed immediately.

func (*ApiService) PageInsightsAssessmentsComment added in v1.3.3

func (c *ApiService) PageInsightsAssessmentsComment(params *ListInsightsAssessmentsCommentParams, pageToken, pageNumber string) (*ListInsightsAssessmentsCommentResponse, error)

Retrieve a single page of InsightsAssessmentsComment records from the API. Request is executed immediately.

func (*ApiService) PageInsightsConversations added in v1.4.0

func (c *ApiService) PageInsightsConversations(params *ListInsightsConversationsParams, pageToken, pageNumber string) (*ListInsightsConversationsResponse, error)

Retrieve a single page of InsightsConversations records from the API. Request is executed immediately.

func (*ApiService) PageInsightsQuestionnaires added in v1.3.3

func (c *ApiService) PageInsightsQuestionnaires(params *ListInsightsQuestionnairesParams, pageToken, pageNumber string) (*ListInsightsQuestionnairesResponse, error)

Retrieve a single page of InsightsQuestionnaires records from the API. Request is executed immediately.

func (*ApiService) PageInsightsQuestionnairesCategory added in v1.3.3

func (c *ApiService) PageInsightsQuestionnairesCategory(params *ListInsightsQuestionnairesCategoryParams, pageToken, pageNumber string) (*ListInsightsQuestionnairesCategoryResponse, error)

Retrieve a single page of InsightsQuestionnairesCategory records from the API. Request is executed immediately.

func (*ApiService) PageInsightsQuestionnairesQuestion added in v1.3.3

func (c *ApiService) PageInsightsQuestionnairesQuestion(params *ListInsightsQuestionnairesQuestionParams, pageToken, pageNumber string) (*ListInsightsQuestionnairesQuestionResponse, error)

Retrieve a single page of InsightsQuestionnairesQuestion records from the API. Request is executed immediately.

func (*ApiService) PageInsightsSegments added in v1.3.4

func (c *ApiService) PageInsightsSegments(params *ListInsightsSegmentsParams, pageToken, pageNumber string) (*ListInsightsSegmentsResponse, error)

Retrieve a single page of InsightsSegments records from the API. Request is executed immediately.

func (*ApiService) PageInteractionChannel added in v0.23.0

func (c *ApiService) PageInteractionChannel(InteractionSid string, params *ListInteractionChannelParams, pageToken, pageNumber string) (*ListInteractionChannelResponse, error)

Retrieve a single page of InteractionChannel records from the API. Request is executed immediately.

func (*ApiService) PageInteractionChannelInvite added in v0.23.0

func (c *ApiService) PageInteractionChannelInvite(InteractionSid string, ChannelSid string, params *ListInteractionChannelInviteParams, pageToken, pageNumber string) (*ListInteractionChannelInviteResponse, error)

Retrieve a single page of InteractionChannelInvite records from the API. Request is executed immediately.

func (*ApiService) PageInteractionChannelParticipant added in v0.23.0

func (c *ApiService) PageInteractionChannelParticipant(InteractionSid string, ChannelSid string, params *ListInteractionChannelParticipantParams, pageToken, pageNumber string) (*ListInteractionChannelParticipantResponse, error)

Retrieve a single page of InteractionChannelParticipant records from the API. Request is executed immediately.

func (*ApiService) PagePlugin added in v1.19.1

func (c *ApiService) PagePlugin(params *ListPluginParams, pageToken, pageNumber string) (*ListPluginResponse, error)

Retrieve a single page of Plugin records from the API. Request is executed immediately.

func (*ApiService) PagePluginConfiguration added in v1.19.1

func (c *ApiService) PagePluginConfiguration(params *ListPluginConfigurationParams, pageToken, pageNumber string) (*ListPluginConfigurationResponse, error)

Retrieve a single page of PluginConfiguration records from the API. Request is executed immediately.

func (*ApiService) PagePluginRelease added in v1.19.1

func (c *ApiService) PagePluginRelease(params *ListPluginReleaseParams, pageToken, pageNumber string) (*ListPluginReleaseResponse, error)

Retrieve a single page of PluginRelease records from the API. Request is executed immediately.

func (*ApiService) PagePluginVersion added in v1.19.1

func (c *ApiService) PagePluginVersion(PluginSid string, params *ListPluginVersionParams, pageToken, pageNumber string) (*ListPluginVersionResponse, error)

Retrieve a single page of PluginVersion records from the API. Request is executed immediately.

func (*ApiService) PageWebChannel added in v0.13.0

func (c *ApiService) PageWebChannel(params *ListWebChannelParams, pageToken, pageNumber string) (*ListWebChannelResponse, error)

Retrieve a single page of WebChannel records from the API. Request is executed immediately.

func (*ApiService) StreamChannel added in v0.13.0

func (c *ApiService) StreamChannel(params *ListChannelParams) (chan FlexV1Channel, chan error)

Streams Channel records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamConfiguredPlugin added in v1.19.1

func (c *ApiService) StreamConfiguredPlugin(ConfigurationSid string, params *ListConfiguredPluginParams) (chan FlexV1ConfiguredPlugin, chan error)

Streams ConfiguredPlugin records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamFlexFlow added in v0.13.0

func (c *ApiService) StreamFlexFlow(params *ListFlexFlowParams) (chan FlexV1FlexFlow, chan error)

Streams FlexFlow records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamInsightsAssessments added in v1.3.5

func (c *ApiService) StreamInsightsAssessments(params *ListInsightsAssessmentsParams) (chan FlexV1InsightsAssessments, chan error)

Streams InsightsAssessments records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamInsightsAssessmentsComment added in v1.3.3

func (c *ApiService) StreamInsightsAssessmentsComment(params *ListInsightsAssessmentsCommentParams) (chan FlexV1InsightsAssessmentsComment, chan error)

Streams InsightsAssessmentsComment records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamInsightsConversations added in v1.4.0

func (c *ApiService) StreamInsightsConversations(params *ListInsightsConversationsParams) (chan FlexV1InsightsConversations, chan error)

Streams InsightsConversations records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamInsightsQuestionnaires added in v1.3.3

func (c *ApiService) StreamInsightsQuestionnaires(params *ListInsightsQuestionnairesParams) (chan FlexV1InsightsQuestionnaires, chan error)

Streams InsightsQuestionnaires records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamInsightsQuestionnairesCategory added in v1.3.3

func (c *ApiService) StreamInsightsQuestionnairesCategory(params *ListInsightsQuestionnairesCategoryParams) (chan FlexV1InsightsQuestionnairesCategory, chan error)

Streams InsightsQuestionnairesCategory records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamInsightsQuestionnairesQuestion added in v1.3.3

func (c *ApiService) StreamInsightsQuestionnairesQuestion(params *ListInsightsQuestionnairesQuestionParams) (chan FlexV1InsightsQuestionnairesQuestion, chan error)

Streams InsightsQuestionnairesQuestion records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamInsightsSegments added in v1.3.4

func (c *ApiService) StreamInsightsSegments(params *ListInsightsSegmentsParams) (chan FlexV1InsightsSegments, chan error)

Streams InsightsSegments records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamInteractionChannel added in v0.23.0

func (c *ApiService) StreamInteractionChannel(InteractionSid string, params *ListInteractionChannelParams) (chan FlexV1InteractionChannel, chan error)

Streams InteractionChannel records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamInteractionChannelInvite added in v0.23.0

func (c *ApiService) StreamInteractionChannelInvite(InteractionSid string, ChannelSid string, params *ListInteractionChannelInviteParams) (chan FlexV1InteractionChannelInvite, chan error)

Streams InteractionChannelInvite records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamInteractionChannelParticipant added in v0.23.0

func (c *ApiService) StreamInteractionChannelParticipant(InteractionSid string, ChannelSid string, params *ListInteractionChannelParticipantParams) (chan FlexV1InteractionChannelParticipant, chan error)

Streams InteractionChannelParticipant records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamPlugin added in v1.19.1

func (c *ApiService) StreamPlugin(params *ListPluginParams) (chan FlexV1Plugin, chan error)

Streams Plugin records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamPluginConfiguration added in v1.19.1

func (c *ApiService) StreamPluginConfiguration(params *ListPluginConfigurationParams) (chan FlexV1PluginConfiguration, chan error)

Streams PluginConfiguration records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamPluginRelease added in v1.19.1

func (c *ApiService) StreamPluginRelease(params *ListPluginReleaseParams) (chan FlexV1PluginRelease, chan error)

Streams PluginRelease records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamPluginVersion added in v1.19.1

func (c *ApiService) StreamPluginVersion(PluginSid string, params *ListPluginVersionParams) (chan FlexV1PluginVersion, chan error)

Streams PluginVersion records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamWebChannel added in v0.13.0

func (c *ApiService) StreamWebChannel(params *ListWebChannelParams) (chan FlexV1WebChannel, chan error)

Streams WebChannel records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) UpdateConfiguration added in v0.11.0

func (c *ApiService) UpdateConfiguration(params *UpdateConfigurationParams) (*FlexV1Configuration, error)

func (*ApiService) UpdateFlexFlow added in v0.11.0

func (c *ApiService) UpdateFlexFlow(Sid string, params *UpdateFlexFlowParams) (*FlexV1FlexFlow, error)

func (*ApiService) UpdateInsightsAssessments added in v1.3.4

func (c *ApiService) UpdateInsightsAssessments(AssessmentSid string, params *UpdateInsightsAssessmentsParams) (*FlexV1InsightsAssessments, error)

Update a specific Assessment assessed earlier

func (*ApiService) UpdateInsightsQuestionnaires added in v1.3.3

func (c *ApiService) UpdateInsightsQuestionnaires(QuestionnaireSid string, params *UpdateInsightsQuestionnairesParams) (*FlexV1InsightsQuestionnaires, error)

To update the questionnaire

func (*ApiService) UpdateInsightsQuestionnairesCategory added in v1.3.2

func (c *ApiService) UpdateInsightsQuestionnairesCategory(CategorySid string, params *UpdateInsightsQuestionnairesCategoryParams) (*FlexV1InsightsQuestionnairesCategory, error)

To update the category for Questions

func (*ApiService) UpdateInsightsQuestionnairesQuestion added in v1.3.2

func (c *ApiService) UpdateInsightsQuestionnairesQuestion(QuestionSid string, params *UpdateInsightsQuestionnairesQuestionParams) (*FlexV1InsightsQuestionnairesQuestion, error)

To update the question

func (*ApiService) UpdateInteractionChannel added in v0.23.0

func (c *ApiService) UpdateInteractionChannel(InteractionSid string, Sid string, params *UpdateInteractionChannelParams) (*FlexV1InteractionChannel, error)

Update an existing Interaction Channel.

func (*ApiService) UpdateInteractionChannelParticipant added in v0.23.0

func (c *ApiService) UpdateInteractionChannelParticipant(InteractionSid string, ChannelSid string, Sid string, params *UpdateInteractionChannelParticipantParams) (*FlexV1InteractionChannelParticipant, error)

Update an existing Channel Participant.

func (*ApiService) UpdatePlugin added in v1.19.1

func (c *ApiService) UpdatePlugin(Sid string, params *UpdatePluginParams) (*FlexV1Plugin, error)

func (*ApiService) UpdatePluginArchive added in v1.19.1

func (c *ApiService) UpdatePluginArchive(Sid string, params *UpdatePluginArchiveParams) (*FlexV1PluginArchive, error)

func (*ApiService) UpdatePluginConfigurationArchive added in v1.19.1

func (c *ApiService) UpdatePluginConfigurationArchive(Sid string, params *UpdatePluginConfigurationArchiveParams) (*FlexV1PluginConfigurationArchive, error)

func (*ApiService) UpdatePluginVersionArchive added in v1.19.1

func (c *ApiService) UpdatePluginVersionArchive(PluginSid string, Sid string, params *UpdatePluginVersionArchiveParams) (*FlexV1PluginVersionArchive, error)

func (*ApiService) UpdateWebChannel added in v0.11.0

func (c *ApiService) UpdateWebChannel(Sid string, params *UpdateWebChannelParams) (*FlexV1WebChannel, error)

type CreateChannelParams

type CreateChannelParams struct {
	// The SID of the Flex Flow.
	FlexFlowSid *string `json:"FlexFlowSid,omitempty"`
	// The `identity` value that uniquely identifies the new resource's chat User.
	Identity *string `json:"Identity,omitempty"`
	// The chat participant's friendly name.
	ChatUserFriendlyName *string `json:"ChatUserFriendlyName,omitempty"`
	// The chat channel's friendly name.
	ChatFriendlyName *string `json:"ChatFriendlyName,omitempty"`
	// The Target Contact Identity, for example the phone number of an SMS.
	Target *string `json:"Target,omitempty"`
	// The chat channel's unique name.
	ChatUniqueName *string `json:"ChatUniqueName,omitempty"`
	// The pre-engagement data.
	PreEngagementData *string `json:"PreEngagementData,omitempty"`
	// The SID of the TaskRouter Task. Only valid when integration type is `task`. `null` for integration types `studio` & `external`
	TaskSid *string `json:"TaskSid,omitempty"`
	// The Task attributes to be added for the TaskRouter Task.
	TaskAttributes *string `json:"TaskAttributes,omitempty"`
	// Whether to create the channel as long-lived.
	LongLived *bool `json:"LongLived,omitempty"`
}

Optional parameters for the method 'CreateChannel'

func (*CreateChannelParams) SetChatFriendlyName

func (params *CreateChannelParams) SetChatFriendlyName(ChatFriendlyName string) *CreateChannelParams

func (*CreateChannelParams) SetChatUniqueName

func (params *CreateChannelParams) SetChatUniqueName(ChatUniqueName string) *CreateChannelParams

func (*CreateChannelParams) SetChatUserFriendlyName

func (params *CreateChannelParams) SetChatUserFriendlyName(ChatUserFriendlyName string) *CreateChannelParams

func (*CreateChannelParams) SetFlexFlowSid

func (params *CreateChannelParams) SetFlexFlowSid(FlexFlowSid string) *CreateChannelParams

func (*CreateChannelParams) SetIdentity

func (params *CreateChannelParams) SetIdentity(Identity string) *CreateChannelParams

func (*CreateChannelParams) SetLongLived

func (params *CreateChannelParams) SetLongLived(LongLived bool) *CreateChannelParams

func (*CreateChannelParams) SetPreEngagementData

func (params *CreateChannelParams) SetPreEngagementData(PreEngagementData string) *CreateChannelParams

func (*CreateChannelParams) SetTarget

func (params *CreateChannelParams) SetTarget(Target string) *CreateChannelParams

func (*CreateChannelParams) SetTaskAttributes

func (params *CreateChannelParams) SetTaskAttributes(TaskAttributes string) *CreateChannelParams

func (*CreateChannelParams) SetTaskSid

func (params *CreateChannelParams) SetTaskSid(TaskSid string) *CreateChannelParams

type CreateFlexFlowParams

type CreateFlexFlowParams struct {
	// A descriptive string that you create to describe the Flex Flow resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The SID of the chat service.
	ChatServiceSid *string `json:"ChatServiceSid,omitempty"`
	//
	ChannelType *string `json:"ChannelType,omitempty"`
	// The channel contact's Identity.
	ContactIdentity *string `json:"ContactIdentity,omitempty"`
	// Whether the new Flex Flow is enabled.
	Enabled *bool `json:"Enabled,omitempty"`
	//
	IntegrationType *string `json:"IntegrationType,omitempty"`
	// The SID of the Studio Flow. Required when `integrationType` is `studio`.
	IntegrationFlowSid *string `json:"Integration.FlowSid,omitempty"`
	// The URL of the external webhook. Required when `integrationType` is `external`.
	IntegrationUrl *string `json:"Integration.Url,omitempty"`
	// The Workspace SID for a new Task. Required when `integrationType` is `task`.
	IntegrationWorkspaceSid *string `json:"Integration.WorkspaceSid,omitempty"`
	// The Workflow SID for a new Task. Required when `integrationType` is `task`.
	IntegrationWorkflowSid *string `json:"Integration.WorkflowSid,omitempty"`
	// The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`.
	IntegrationChannel *string `json:"Integration.Channel,omitempty"`
	// The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise.
	IntegrationTimeout *int `json:"Integration.Timeout,omitempty"`
	// The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise.
	IntegrationPriority *int `json:"Integration.Priority,omitempty"`
	// In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging.
	IntegrationCreationOnMessage *bool `json:"Integration.CreationOnMessage,omitempty"`
	// When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`.
	LongLived *bool `json:"LongLived,omitempty"`
	// When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`.
	JanitorEnabled *bool `json:"JanitorEnabled,omitempty"`
	// The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise.
	IntegrationRetryCount *int `json:"Integration.RetryCount,omitempty"`
}

Optional parameters for the method 'CreateFlexFlow'

func (*CreateFlexFlowParams) SetChannelType

func (params *CreateFlexFlowParams) SetChannelType(ChannelType string) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetChatServiceSid

func (params *CreateFlexFlowParams) SetChatServiceSid(ChatServiceSid string) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetContactIdentity

func (params *CreateFlexFlowParams) SetContactIdentity(ContactIdentity string) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetEnabled

func (params *CreateFlexFlowParams) SetEnabled(Enabled bool) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetFriendlyName

func (params *CreateFlexFlowParams) SetFriendlyName(FriendlyName string) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetIntegrationChannel

func (params *CreateFlexFlowParams) SetIntegrationChannel(IntegrationChannel string) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetIntegrationCreationOnMessage

func (params *CreateFlexFlowParams) SetIntegrationCreationOnMessage(IntegrationCreationOnMessage bool) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetIntegrationFlowSid

func (params *CreateFlexFlowParams) SetIntegrationFlowSid(IntegrationFlowSid string) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetIntegrationPriority

func (params *CreateFlexFlowParams) SetIntegrationPriority(IntegrationPriority int) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetIntegrationRetryCount

func (params *CreateFlexFlowParams) SetIntegrationRetryCount(IntegrationRetryCount int) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetIntegrationTimeout

func (params *CreateFlexFlowParams) SetIntegrationTimeout(IntegrationTimeout int) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetIntegrationType

func (params *CreateFlexFlowParams) SetIntegrationType(IntegrationType string) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetIntegrationUrl

func (params *CreateFlexFlowParams) SetIntegrationUrl(IntegrationUrl string) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetIntegrationWorkflowSid

func (params *CreateFlexFlowParams) SetIntegrationWorkflowSid(IntegrationWorkflowSid string) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetIntegrationWorkspaceSid

func (params *CreateFlexFlowParams) SetIntegrationWorkspaceSid(IntegrationWorkspaceSid string) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetJanitorEnabled

func (params *CreateFlexFlowParams) SetJanitorEnabled(JanitorEnabled bool) *CreateFlexFlowParams

func (*CreateFlexFlowParams) SetLongLived

func (params *CreateFlexFlowParams) SetLongLived(LongLived bool) *CreateFlexFlowParams

type CreateInsightsAssessmentsCommentParams added in v1.3.3

type CreateInsightsAssessmentsCommentParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// The ID of the category
	CategoryId *string `json:"CategoryId,omitempty"`
	// The name of the category
	CategoryName *string `json:"CategoryName,omitempty"`
	// The Assessment comment.
	Comment *string `json:"Comment,omitempty"`
	// The id of the segment.
	SegmentId *string `json:"SegmentId,omitempty"`
	// The id of the agent.
	AgentId *string `json:"AgentId,omitempty"`
	// The offset
	Offset *float32 `json:"Offset,omitempty"`
}

Optional parameters for the method 'CreateInsightsAssessmentsComment'

func (*CreateInsightsAssessmentsCommentParams) SetAgentId added in v1.3.3

func (*CreateInsightsAssessmentsCommentParams) SetAuthorization added in v1.7.1

func (*CreateInsightsAssessmentsCommentParams) SetCategoryId added in v1.3.3

func (*CreateInsightsAssessmentsCommentParams) SetCategoryName added in v1.3.3

func (*CreateInsightsAssessmentsCommentParams) SetComment added in v1.3.3

func (*CreateInsightsAssessmentsCommentParams) SetOffset added in v1.3.3

func (*CreateInsightsAssessmentsCommentParams) SetSegmentId added in v1.3.3

type CreateInsightsAssessmentsParams added in v1.3.4

type CreateInsightsAssessmentsParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// The SID of the category
	CategorySid *string `json:"CategorySid,omitempty"`
	// The name of the category
	CategoryName *string `json:"CategoryName,omitempty"`
	// Segment Id of the conversation
	SegmentId *string `json:"SegmentId,omitempty"`
	// The id of the Agent
	AgentId *string `json:"AgentId,omitempty"`
	// The offset of the conversation.
	Offset *float32 `json:"Offset,omitempty"`
	// The question SID selected for assessment
	MetricId *string `json:"MetricId,omitempty"`
	// The question name of the assessment
	MetricName *string `json:"MetricName,omitempty"`
	// The answer text selected by user
	AnswerText *string `json:"AnswerText,omitempty"`
	// The id of the answer selected by user
	AnswerId *string `json:"AnswerId,omitempty"`
	// Questionnaire SID of the associated question
	QuestionnaireSid *string `json:"QuestionnaireSid,omitempty"`
}

Optional parameters for the method 'CreateInsightsAssessments'

func (*CreateInsightsAssessmentsParams) SetAgentId added in v1.3.4

func (*CreateInsightsAssessmentsParams) SetAnswerId added in v1.3.4

func (*CreateInsightsAssessmentsParams) SetAnswerText added in v1.3.4

func (params *CreateInsightsAssessmentsParams) SetAnswerText(AnswerText string) *CreateInsightsAssessmentsParams

func (*CreateInsightsAssessmentsParams) SetAuthorization added in v1.7.1

func (params *CreateInsightsAssessmentsParams) SetAuthorization(Authorization string) *CreateInsightsAssessmentsParams

func (*CreateInsightsAssessmentsParams) SetCategoryName added in v1.3.4

func (params *CreateInsightsAssessmentsParams) SetCategoryName(CategoryName string) *CreateInsightsAssessmentsParams

func (*CreateInsightsAssessmentsParams) SetCategorySid added in v1.7.0

func (params *CreateInsightsAssessmentsParams) SetCategorySid(CategorySid string) *CreateInsightsAssessmentsParams

func (*CreateInsightsAssessmentsParams) SetMetricId added in v1.3.4

func (*CreateInsightsAssessmentsParams) SetMetricName added in v1.3.4

func (params *CreateInsightsAssessmentsParams) SetMetricName(MetricName string) *CreateInsightsAssessmentsParams

func (*CreateInsightsAssessmentsParams) SetOffset added in v1.3.4

func (*CreateInsightsAssessmentsParams) SetQuestionnaireSid added in v1.7.0

func (params *CreateInsightsAssessmentsParams) SetQuestionnaireSid(QuestionnaireSid string) *CreateInsightsAssessmentsParams

func (*CreateInsightsAssessmentsParams) SetSegmentId added in v1.3.4

type CreateInsightsQuestionnairesCategoryParams added in v1.3.2

type CreateInsightsQuestionnairesCategoryParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// The name of this category.
	Name *string `json:"Name,omitempty"`
}

Optional parameters for the method 'CreateInsightsQuestionnairesCategory'

func (*CreateInsightsQuestionnairesCategoryParams) SetAuthorization added in v1.7.1

func (*CreateInsightsQuestionnairesCategoryParams) SetName added in v1.3.2

type CreateInsightsQuestionnairesParams added in v1.3.3

type CreateInsightsQuestionnairesParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// The name of this questionnaire
	Name *string `json:"Name,omitempty"`
	// The description of this questionnaire
	Description *string `json:"Description,omitempty"`
	// The flag to enable or disable questionnaire
	Active *bool `json:"Active,omitempty"`
	// The list of questions sids under a questionnaire
	QuestionSids *[]string `json:"QuestionSids,omitempty"`
}

Optional parameters for the method 'CreateInsightsQuestionnaires'

func (*CreateInsightsQuestionnairesParams) SetActive added in v1.3.3

func (*CreateInsightsQuestionnairesParams) SetAuthorization added in v1.7.1

func (params *CreateInsightsQuestionnairesParams) SetAuthorization(Authorization string) *CreateInsightsQuestionnairesParams

func (*CreateInsightsQuestionnairesParams) SetDescription added in v1.3.3

func (*CreateInsightsQuestionnairesParams) SetName added in v1.3.3

func (*CreateInsightsQuestionnairesParams) SetQuestionSids added in v1.7.0

func (params *CreateInsightsQuestionnairesParams) SetQuestionSids(QuestionSids []string) *CreateInsightsQuestionnairesParams

type CreateInsightsQuestionnairesQuestionParams added in v1.3.2

type CreateInsightsQuestionnairesQuestionParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// The SID of the category
	CategorySid *string `json:"CategorySid,omitempty"`
	// The question.
	Question *string `json:"Question,omitempty"`
	// The answer_set for the question.
	AnswerSetId *string `json:"AnswerSetId,omitempty"`
	// The flag to enable for disable NA for answer.
	AllowNa *bool `json:"AllowNa,omitempty"`
	// The description for the question.
	Description *string `json:"Description,omitempty"`
}

Optional parameters for the method 'CreateInsightsQuestionnairesQuestion'

func (*CreateInsightsQuestionnairesQuestionParams) SetAllowNa added in v1.3.2

func (*CreateInsightsQuestionnairesQuestionParams) SetAnswerSetId added in v1.3.2

func (*CreateInsightsQuestionnairesQuestionParams) SetAuthorization added in v1.7.1

func (*CreateInsightsQuestionnairesQuestionParams) SetCategorySid added in v1.7.0

func (*CreateInsightsQuestionnairesQuestionParams) SetDescription added in v1.3.2

func (*CreateInsightsQuestionnairesQuestionParams) SetQuestion added in v1.3.2

type CreateInsightsSessionParams added in v1.3.2

type CreateInsightsSessionParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
}

Optional parameters for the method 'CreateInsightsSession'

func (*CreateInsightsSessionParams) SetAuthorization added in v1.3.3

func (params *CreateInsightsSessionParams) SetAuthorization(Authorization string) *CreateInsightsSessionParams

type CreateInteractionChannelInviteParams added in v0.23.0

type CreateInteractionChannelInviteParams struct {
	// The Interaction's routing logic.
	Routing *interface{} `json:"Routing,omitempty"`
}

Optional parameters for the method 'CreateInteractionChannelInvite'

func (*CreateInteractionChannelInviteParams) SetRouting added in v0.23.0

func (params *CreateInteractionChannelInviteParams) SetRouting(Routing interface{}) *CreateInteractionChannelInviteParams

type CreateInteractionChannelParticipantParams added in v0.23.0

type CreateInteractionChannelParticipantParams struct {
	//
	Type *string `json:"Type,omitempty"`
	// JSON representing the Media Properties for the new Participant.
	MediaProperties *interface{} `json:"MediaProperties,omitempty"`
	// Object representing the Routing Properties for the new Participant.
	RoutingProperties *interface{} `json:"RoutingProperties,omitempty"`
}

Optional parameters for the method 'CreateInteractionChannelParticipant'

func (*CreateInteractionChannelParticipantParams) SetMediaProperties added in v0.23.0

func (params *CreateInteractionChannelParticipantParams) SetMediaProperties(MediaProperties interface{}) *CreateInteractionChannelParticipantParams

func (*CreateInteractionChannelParticipantParams) SetRoutingProperties added in v1.19.0

func (params *CreateInteractionChannelParticipantParams) SetRoutingProperties(RoutingProperties interface{}) *CreateInteractionChannelParticipantParams

func (*CreateInteractionChannelParticipantParams) SetType added in v0.23.0

type CreateInteractionParams added in v0.23.0

type CreateInteractionParams struct {
	// The Interaction's channel.
	Channel *interface{} `json:"Channel,omitempty"`
	// The Interaction's routing logic.
	Routing *interface{} `json:"Routing,omitempty"`
	// The Interaction context sid is used for adding a context lookup sid
	InteractionContextSid *string `json:"InteractionContextSid,omitempty"`
}

Optional parameters for the method 'CreateInteraction'

func (*CreateInteractionParams) SetChannel added in v0.23.0

func (params *CreateInteractionParams) SetChannel(Channel interface{}) *CreateInteractionParams

func (*CreateInteractionParams) SetInteractionContextSid added in v1.10.0

func (params *CreateInteractionParams) SetInteractionContextSid(InteractionContextSid string) *CreateInteractionParams

func (*CreateInteractionParams) SetRouting added in v0.23.0

func (params *CreateInteractionParams) SetRouting(Routing interface{}) *CreateInteractionParams

type CreatePluginConfigurationParams added in v1.19.1

type CreatePluginConfigurationParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
	// The Flex Plugin Configuration's name.
	Name *string `json:"Name,omitempty"`
	// A list of objects that describe the plugin versions included in the configuration. Each object contains the sid of the plugin version.
	Plugins *[]interface{} `json:"Plugins,omitempty"`
	// The Flex Plugin Configuration's description.
	Description *string `json:"Description,omitempty"`
}

Optional parameters for the method 'CreatePluginConfiguration'

func (*CreatePluginConfigurationParams) SetDescription added in v1.19.1

func (params *CreatePluginConfigurationParams) SetDescription(Description string) *CreatePluginConfigurationParams

func (*CreatePluginConfigurationParams) SetFlexMetadata added in v1.19.1

func (params *CreatePluginConfigurationParams) SetFlexMetadata(FlexMetadata string) *CreatePluginConfigurationParams

func (*CreatePluginConfigurationParams) SetName added in v1.19.1

func (*CreatePluginConfigurationParams) SetPlugins added in v1.19.1

func (params *CreatePluginConfigurationParams) SetPlugins(Plugins []interface{}) *CreatePluginConfigurationParams

type CreatePluginParams added in v1.19.1

type CreatePluginParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
	// The Flex Plugin's unique name.
	UniqueName *string `json:"UniqueName,omitempty"`
	// The Flex Plugin's friendly name.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long
	Description *string `json:"Description,omitempty"`
}

Optional parameters for the method 'CreatePlugin'

func (*CreatePluginParams) SetDescription added in v1.19.1

func (params *CreatePluginParams) SetDescription(Description string) *CreatePluginParams

func (*CreatePluginParams) SetFlexMetadata added in v1.19.1

func (params *CreatePluginParams) SetFlexMetadata(FlexMetadata string) *CreatePluginParams

func (*CreatePluginParams) SetFriendlyName added in v1.19.1

func (params *CreatePluginParams) SetFriendlyName(FriendlyName string) *CreatePluginParams

func (*CreatePluginParams) SetUniqueName added in v1.19.1

func (params *CreatePluginParams) SetUniqueName(UniqueName string) *CreatePluginParams

type CreatePluginReleaseParams added in v1.19.1

type CreatePluginReleaseParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
	// The SID or the Version of the Flex Plugin Configuration to release.
	ConfigurationId *string `json:"ConfigurationId,omitempty"`
}

Optional parameters for the method 'CreatePluginRelease'

func (*CreatePluginReleaseParams) SetConfigurationId added in v1.19.1

func (params *CreatePluginReleaseParams) SetConfigurationId(ConfigurationId string) *CreatePluginReleaseParams

func (*CreatePluginReleaseParams) SetFlexMetadata added in v1.19.1

func (params *CreatePluginReleaseParams) SetFlexMetadata(FlexMetadata string) *CreatePluginReleaseParams

type CreatePluginVersionParams added in v1.19.1

type CreatePluginVersionParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
	// The Flex Plugin Version's version.
	Version *string `json:"Version,omitempty"`
	// The URL of the Flex Plugin Version bundle
	PluginUrl *string `json:"PluginUrl,omitempty"`
	// The changelog of the Flex Plugin Version.
	Changelog *string `json:"Changelog,omitempty"`
	// Whether this Flex Plugin Version requires authorization.
	Private *bool `json:"Private,omitempty"`
	// The version of Flex Plugins CLI used to create this plugin
	CliVersion *string `json:"CliVersion,omitempty"`
	// The validation status of the plugin, indicating whether it has been validated
	ValidateStatus *string `json:"ValidateStatus,omitempty"`
}

Optional parameters for the method 'CreatePluginVersion'

func (*CreatePluginVersionParams) SetChangelog added in v1.19.1

func (params *CreatePluginVersionParams) SetChangelog(Changelog string) *CreatePluginVersionParams

func (*CreatePluginVersionParams) SetCliVersion added in v1.20.0

func (params *CreatePluginVersionParams) SetCliVersion(CliVersion string) *CreatePluginVersionParams

func (*CreatePluginVersionParams) SetFlexMetadata added in v1.19.1

func (params *CreatePluginVersionParams) SetFlexMetadata(FlexMetadata string) *CreatePluginVersionParams

func (*CreatePluginVersionParams) SetPluginUrl added in v1.19.1

func (params *CreatePluginVersionParams) SetPluginUrl(PluginUrl string) *CreatePluginVersionParams

func (*CreatePluginVersionParams) SetPrivate added in v1.19.1

func (params *CreatePluginVersionParams) SetPrivate(Private bool) *CreatePluginVersionParams

func (*CreatePluginVersionParams) SetValidateStatus added in v1.20.0

func (params *CreatePluginVersionParams) SetValidateStatus(ValidateStatus string) *CreatePluginVersionParams

func (*CreatePluginVersionParams) SetVersion added in v1.19.1

func (params *CreatePluginVersionParams) SetVersion(Version string) *CreatePluginVersionParams

type CreateWebChannelParams

type CreateWebChannelParams struct {
	// The SID of the Flex Flow.
	FlexFlowSid *string `json:"FlexFlowSid,omitempty"`
	// The chat identity.
	Identity *string `json:"Identity,omitempty"`
	// The chat participant's friendly name.
	CustomerFriendlyName *string `json:"CustomerFriendlyName,omitempty"`
	// The chat channel's friendly name.
	ChatFriendlyName *string `json:"ChatFriendlyName,omitempty"`
	// The chat channel's unique name.
	ChatUniqueName *string `json:"ChatUniqueName,omitempty"`
	// The pre-engagement data.
	PreEngagementData *string `json:"PreEngagementData,omitempty"`
}

Optional parameters for the method 'CreateWebChannel'

func (*CreateWebChannelParams) SetChatFriendlyName

func (params *CreateWebChannelParams) SetChatFriendlyName(ChatFriendlyName string) *CreateWebChannelParams

func (*CreateWebChannelParams) SetChatUniqueName

func (params *CreateWebChannelParams) SetChatUniqueName(ChatUniqueName string) *CreateWebChannelParams

func (*CreateWebChannelParams) SetCustomerFriendlyName

func (params *CreateWebChannelParams) SetCustomerFriendlyName(CustomerFriendlyName string) *CreateWebChannelParams

func (*CreateWebChannelParams) SetFlexFlowSid

func (params *CreateWebChannelParams) SetFlexFlowSid(FlexFlowSid string) *CreateWebChannelParams

func (*CreateWebChannelParams) SetIdentity

func (params *CreateWebChannelParams) SetIdentity(Identity string) *CreateWebChannelParams

func (*CreateWebChannelParams) SetPreEngagementData

func (params *CreateWebChannelParams) SetPreEngagementData(PreEngagementData string) *CreateWebChannelParams

type DeleteInsightsQuestionnairesCategoryParams added in v1.3.2

type DeleteInsightsQuestionnairesCategoryParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
}

Optional parameters for the method 'DeleteInsightsQuestionnairesCategory'

func (*DeleteInsightsQuestionnairesCategoryParams) SetAuthorization added in v1.7.1

type DeleteInsightsQuestionnairesParams added in v1.3.3

type DeleteInsightsQuestionnairesParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
}

Optional parameters for the method 'DeleteInsightsQuestionnaires'

func (*DeleteInsightsQuestionnairesParams) SetAuthorization added in v1.7.1

func (params *DeleteInsightsQuestionnairesParams) SetAuthorization(Authorization string) *DeleteInsightsQuestionnairesParams

type DeleteInsightsQuestionnairesQuestionParams added in v1.3.2

type DeleteInsightsQuestionnairesQuestionParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
}

Optional parameters for the method 'DeleteInsightsQuestionnairesQuestion'

func (*DeleteInsightsQuestionnairesQuestionParams) SetAuthorization added in v1.7.1

type FetchConfigurationParams

type FetchConfigurationParams struct {
	// The Pinned UI version of the Configuration resource to fetch.
	UiVersion *string `json:"UiVersion,omitempty"`
}

Optional parameters for the method 'FetchConfiguration'

func (*FetchConfigurationParams) SetUiVersion

func (params *FetchConfigurationParams) SetUiVersion(UiVersion string) *FetchConfigurationParams

type FetchConfiguredPluginParams added in v1.19.1

type FetchConfiguredPluginParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
}

Optional parameters for the method 'FetchConfiguredPlugin'

func (*FetchConfiguredPluginParams) SetFlexMetadata added in v1.19.1

func (params *FetchConfiguredPluginParams) SetFlexMetadata(FlexMetadata string) *FetchConfiguredPluginParams

type FetchInsightsQuestionnairesParams added in v1.3.3

type FetchInsightsQuestionnairesParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
}

Optional parameters for the method 'FetchInsightsQuestionnaires'

func (*FetchInsightsQuestionnairesParams) SetAuthorization added in v1.7.1

func (params *FetchInsightsQuestionnairesParams) SetAuthorization(Authorization string) *FetchInsightsQuestionnairesParams

type FetchInsightsSettingsAnswersetsParams added in v1.3.2

type FetchInsightsSettingsAnswersetsParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
}

Optional parameters for the method 'FetchInsightsSettingsAnswersets'

func (*FetchInsightsSettingsAnswersetsParams) SetAuthorization added in v1.7.1

type FetchInsightsSettingsCommentParams added in v1.3.2

type FetchInsightsSettingsCommentParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
}

Optional parameters for the method 'FetchInsightsSettingsComment'

func (*FetchInsightsSettingsCommentParams) SetAuthorization added in v1.7.1

func (params *FetchInsightsSettingsCommentParams) SetAuthorization(Authorization string) *FetchInsightsSettingsCommentParams

type FetchInsightsUserRolesParams added in v1.3.2

type FetchInsightsUserRolesParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
}

Optional parameters for the method 'FetchInsightsUserRoles'

func (*FetchInsightsUserRolesParams) SetAuthorization added in v1.3.3

func (params *FetchInsightsUserRolesParams) SetAuthorization(Authorization string) *FetchInsightsUserRolesParams

type FetchPluginConfigurationParams added in v1.19.1

type FetchPluginConfigurationParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
}

Optional parameters for the method 'FetchPluginConfiguration'

func (*FetchPluginConfigurationParams) SetFlexMetadata added in v1.19.1

func (params *FetchPluginConfigurationParams) SetFlexMetadata(FlexMetadata string) *FetchPluginConfigurationParams

type FetchPluginParams added in v1.19.1

type FetchPluginParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
}

Optional parameters for the method 'FetchPlugin'

func (*FetchPluginParams) SetFlexMetadata added in v1.19.1

func (params *FetchPluginParams) SetFlexMetadata(FlexMetadata string) *FetchPluginParams

type FetchPluginReleaseParams added in v1.19.1

type FetchPluginReleaseParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
}

Optional parameters for the method 'FetchPluginRelease'

func (*FetchPluginReleaseParams) SetFlexMetadata added in v1.19.1

func (params *FetchPluginReleaseParams) SetFlexMetadata(FlexMetadata string) *FetchPluginReleaseParams

type FetchPluginVersionParams added in v1.19.1

type FetchPluginVersionParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
}

Optional parameters for the method 'FetchPluginVersion'

func (*FetchPluginVersionParams) SetFlexMetadata added in v1.19.1

func (params *FetchPluginVersionParams) SetFlexMetadata(FlexMetadata string) *FetchPluginVersionParams

type FlexV1Channel

type FlexV1Channel struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Channel resource and owns this Workflow.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the Flex Flow.
	FlexFlowSid *string `json:"flex_flow_sid,omitempty"`
	// The unique string that we created to identify the Channel resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the chat user.
	UserSid *string `json:"user_sid,omitempty"`
	// The SID of the TaskRouter Task. Only valid when integration type is `task`. `null` for integration types `studio` & `external`
	TaskSid *string `json:"task_sid,omitempty"`
	// The absolute URL of the Flex chat channel resource.
	Url *string `json:"url,omitempty"`
	// The date and time in GMT when the Flex chat channel was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the Flex chat channel was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
}

FlexV1Channel struct for FlexV1Channel

type FlexV1Configuration

type FlexV1Configuration struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Configuration resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The date and time in GMT when the Configuration resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the Configuration resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// An object that contains application-specific data.
	Attributes *interface{} `json:"attributes,omitempty"`
	Status     *string      `json:"status,omitempty"`
	// The SID of the TaskRouter Workspace.
	TaskrouterWorkspaceSid *string `json:"taskrouter_workspace_sid,omitempty"`
	// The SID of the TaskRouter target Workflow.
	TaskrouterTargetWorkflowSid *string `json:"taskrouter_target_workflow_sid,omitempty"`
	// The SID of the TaskRouter Target TaskQueue.
	TaskrouterTargetTaskqueueSid *string `json:"taskrouter_target_taskqueue_sid,omitempty"`
	// The list of TaskRouter TaskQueues.
	TaskrouterTaskqueues *[]interface{} `json:"taskrouter_taskqueues,omitempty"`
	// The Skill description for TaskRouter workers.
	TaskrouterSkills *[]interface{} `json:"taskrouter_skills,omitempty"`
	// The TaskRouter default channel capacities and availability for workers.
	TaskrouterWorkerChannels *interface{} `json:"taskrouter_worker_channels,omitempty"`
	// The TaskRouter Worker attributes.
	TaskrouterWorkerAttributes *interface{} `json:"taskrouter_worker_attributes,omitempty"`
	// The TaskRouter SID of the offline activity.
	TaskrouterOfflineActivitySid *string `json:"taskrouter_offline_activity_sid,omitempty"`
	// The URL where the Flex instance is hosted.
	RuntimeDomain *string `json:"runtime_domain,omitempty"`
	// The SID of the Messaging service instance.
	MessagingServiceInstanceSid *string `json:"messaging_service_instance_sid,omitempty"`
	// The SID of the chat service this user belongs to.
	ChatServiceInstanceSid *string `json:"chat_service_instance_sid,omitempty"`
	// The SID of the Flex service instance.
	FlexServiceInstanceSid *string `json:"flex_service_instance_sid,omitempty"`
	// The SID of the Flex instance.
	FlexInstanceSid *string `json:"flex_instance_sid,omitempty"`
	// The primary language of the Flex UI.
	UiLanguage *string `json:"ui_language,omitempty"`
	// The object that describes Flex UI characteristics and settings.
	UiAttributes *interface{} `json:"ui_attributes,omitempty"`
	// The object that defines the NPM packages and versions to be used in Hosted Flex.
	UiDependencies *interface{} `json:"ui_dependencies,omitempty"`
	// The Pinned UI version.
	UiVersion *string `json:"ui_version,omitempty"`
	// The Flex Service version.
	ServiceVersion *string `json:"service_version,omitempty"`
	// Whether call recording is enabled.
	CallRecordingEnabled *bool `json:"call_recording_enabled,omitempty"`
	// The call recording webhook URL.
	CallRecordingWebhookUrl *string `json:"call_recording_webhook_url,omitempty"`
	// Whether CRM is present for Flex.
	CrmEnabled *bool `json:"crm_enabled,omitempty"`
	// The CRM type.
	CrmType *string `json:"crm_type,omitempty"`
	// The CRM Callback URL.
	CrmCallbackUrl *string `json:"crm_callback_url,omitempty"`
	// The CRM Fallback URL.
	CrmFallbackUrl *string `json:"crm_fallback_url,omitempty"`
	// An object that contains the CRM attributes.
	CrmAttributes *interface{} `json:"crm_attributes,omitempty"`
	// The list of public attributes, which are visible to unauthenticated clients.
	PublicAttributes *interface{} `json:"public_attributes,omitempty"`
	// Whether the plugin service enabled.
	PluginServiceEnabled *bool `json:"plugin_service_enabled,omitempty"`
	// The plugin service attributes.
	PluginServiceAttributes *interface{} `json:"plugin_service_attributes,omitempty"`
	// A list of objects that contain the configurations for the Integrations supported in this configuration.
	Integrations *[]interface{} `json:"integrations,omitempty"`
	// The list of outbound call flows.
	OutboundCallFlows *interface{} `json:"outbound_call_flows,omitempty"`
	// The list of serverless service SIDs.
	ServerlessServiceSids *[]string `json:"serverless_service_sids,omitempty"`
	// Configurable parameters for Queues Statistics.
	QueueStatsConfiguration *interface{} `json:"queue_stats_configuration,omitempty"`
	// Configurable parameters for Notifications.
	Notifications *interface{} `json:"notifications,omitempty"`
	// Configurable parameters for Markdown.
	Markdown *interface{} `json:"markdown,omitempty"`
	// The absolute URL of the Configuration resource.
	Url *string `json:"url,omitempty"`
	// Object with enabled/disabled flag with list of workspaces.
	FlexInsightsHr *interface{} `json:"flex_insights_hr,omitempty"`
	// Setting this to true will redirect Flex UI to the URL set in flex_url
	FlexInsightsDrilldown *bool `json:"flex_insights_drilldown,omitempty"`
	// URL to redirect to in case drilldown is enabled.
	FlexUrl *string `json:"flex_url,omitempty"`
	// Settings for different limits for Flex Conversations channels attachments.
	ChannelConfigs *[]interface{} `json:"channel_configs,omitempty"`
	// Configurable parameters for Debugger Integration.
	DebuggerIntegration *interface{} `json:"debugger_integration,omitempty"`
	// Configurable parameters for Flex UI Status report.
	FlexUiStatusReport *interface{} `json:"flex_ui_status_report,omitempty"`
	// Agent conversation end methods.
	AgentConvEndMethods *interface{} `json:"agent_conv_end_methods,omitempty"`
	// Citrix voice vdi configuration and settings.
	CitrixVoiceVdi *interface{} `json:"citrix_voice_vdi,omitempty"`
	// Presence and presence ttl configuration
	OfflineConfig *interface{} `json:"offline_config,omitempty"`
}

FlexV1Configuration struct for FlexV1Configuration

type FlexV1ConfiguredPlugin added in v1.19.1

type FlexV1ConfiguredPlugin struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Flex Plugin resource is installed for.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the Flex Plugin Configuration that this Flex Plugin belongs to.
	ConfigurationSid *string `json:"configuration_sid,omitempty"`
	// The SID of the Flex Plugin.
	PluginSid *string `json:"plugin_sid,omitempty"`
	// The SID of the Flex Plugin Version.
	PluginVersionSid *string `json:"plugin_version_sid,omitempty"`
	// The phase this Flex Plugin would initialize at runtime.
	Phase *int `json:"phase,omitempty"`
	// The URL of where the Flex Plugin Version JavaScript bundle is hosted on.
	PluginUrl *string `json:"plugin_url,omitempty"`
	// The name that uniquely identifies this Flex Plugin resource.
	UniqueName *string `json:"unique_name,omitempty"`
	// The friendly name of this Flex Plugin resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long
	Description *string `json:"description,omitempty"`
	// Whether the Flex Plugin is archived. The default value is false.
	PluginArchived *bool `json:"plugin_archived,omitempty"`
	// The latest version of this Flex Plugin Version.
	Version *string `json:"version,omitempty"`
	// A changelog that describes the changes this Flex Plugin Version brings.
	Changelog *string `json:"changelog,omitempty"`
	// Whether the Flex Plugin Version is archived. The default value is false.
	PluginVersionArchived *bool `json:"plugin_version_archived,omitempty"`
	// Whether to validate the request is authorized to access the Flex Plugin Version.
	Private *bool `json:"private,omitempty"`
	// The date and time in GMT when the Flex Plugin was installed specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The absolute URL of the Flex Plugin resource.
	Url *string `json:"url,omitempty"`
}

FlexV1ConfiguredPlugin struct for FlexV1ConfiguredPlugin

type FlexV1FlexFlow

type FlexV1FlexFlow struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Flow resource and owns this Workflow.
	AccountSid *string `json:"account_sid,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The unique string that we created to identify the Flex Flow resource.
	Sid *string `json:"sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The SID of the chat service.
	ChatServiceSid *string `json:"chat_service_sid,omitempty"`
	ChannelType    *string `json:"channel_type,omitempty"`
	// The channel contact's Identity.
	ContactIdentity *string `json:"contact_identity,omitempty"`
	// Whether the Flex Flow is enabled.
	Enabled         *bool   `json:"enabled,omitempty"`
	IntegrationType *string `json:"integration_type,omitempty"`
	// An object that contains specific parameters for the integration.
	Integration *interface{} `json:"integration,omitempty"`
	// When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`.
	LongLived *bool `json:"long_lived,omitempty"`
	// When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`.
	JanitorEnabled *bool `json:"janitor_enabled,omitempty"`
	// The absolute URL of the Flex Flow resource.
	Url *string `json:"url,omitempty"`
}

FlexV1FlexFlow struct for FlexV1FlexFlow

type FlexV1InsightsAssessments added in v1.3.2

type FlexV1InsightsAssessments struct {
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the assessment
	AssessmentSid *string `json:"assessment_sid,omitempty"`
	// Offset of the conversation
	Offset *float32 `json:"offset,omitempty"`
	// The flag indicating if this assessment is part of report
	Report *bool `json:"report,omitempty"`
	// The weightage given to this comment
	Weight *float32 `json:"weight,omitempty"`
	// The id of the Agent
	AgentId *string `json:"agent_id,omitempty"`
	// Segment Id of conversation
	SegmentId *string `json:"segment_id,omitempty"`
	// The name of the user.
	UserName *string `json:"user_name,omitempty"`
	// The email id of the user.
	UserEmail *string `json:"user_email,omitempty"`
	// The answer text selected by user
	AnswerText *string `json:"answer_text,omitempty"`
	// The id of the answer selected by user
	AnswerId *string `json:"answer_id,omitempty"`
	// Assessment Details associated with an assessment
	Assessment *interface{} `json:"assessment,omitempty"`
	Timestamp  *float32     `json:"timestamp,omitempty"`
	Url        *string      `json:"url,omitempty"`
}

FlexV1InsightsAssessments struct for FlexV1InsightsAssessments

func (*FlexV1InsightsAssessments) UnmarshalJSON added in v1.3.4

func (response *FlexV1InsightsAssessments) UnmarshalJSON(bytes []byte) (err error)

type FlexV1InsightsAssessmentsComment added in v1.3.3

type FlexV1InsightsAssessmentsComment struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Insights resource and owns this resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the assessment.
	AssessmentSid *string `json:"assessment_sid,omitempty"`
	// The comment added for assessment.
	Comment *interface{} `json:"comment,omitempty"`
	// The offset
	Offset *float32 `json:"offset,omitempty"`
	// The flag indicating if this assessment is part of report
	Report *bool `json:"report,omitempty"`
	// The weightage given to this comment
	Weight *float32 `json:"weight,omitempty"`
	// The id of the agent.
	AgentId *string `json:"agent_id,omitempty"`
	// The id of the segment.
	SegmentId *string `json:"segment_id,omitempty"`
	// The name of the user.
	UserName *string `json:"user_name,omitempty"`
	// The email id of the user.
	UserEmail *string `json:"user_email,omitempty"`
	// The timestamp when the record is inserted
	Timestamp *float32 `json:"timestamp,omitempty"`
	Url       *string  `json:"url,omitempty"`
}

FlexV1InsightsAssessmentsComment struct for FlexV1InsightsAssessmentsComment

func (*FlexV1InsightsAssessmentsComment) UnmarshalJSON added in v1.3.3

func (response *FlexV1InsightsAssessmentsComment) UnmarshalJSON(bytes []byte) (err error)

type FlexV1InsightsConversations added in v1.4.0

type FlexV1InsightsConversations struct {
	// The id of the account.
	AccountId *string `json:"account_id,omitempty"`
	// The unique id of the conversation
	ConversationId *string `json:"conversation_id,omitempty"`
	// The count of segments for a conversation
	SegmentCount *int `json:"segment_count,omitempty"`
	// The Segments of a conversation
	Segments *[]interface{} `json:"segments,omitempty"`
}

FlexV1InsightsConversations struct for FlexV1InsightsConversations

type FlexV1InsightsQuestionnaires added in v1.3.3

type FlexV1InsightsQuestionnaires struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Insights resource and owns this resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The sid of this questionnaire
	QuestionnaireSid *string `json:"questionnaire_sid,omitempty"`
	// The name of this category.
	Name *string `json:"name,omitempty"`
	// The description of this questionnaire
	Description *string `json:"description,omitempty"`
	// The flag to enable or disable questionnaire
	Active *bool `json:"active,omitempty"`
	// The list of questions with category for a questionnaire
	Questions *[]interface{} `json:"questions,omitempty"`
	Url       *string        `json:"url,omitempty"`
}

FlexV1InsightsQuestionnaires struct for FlexV1InsightsQuestionnaires

type FlexV1InsightsQuestionnairesCategory added in v1.3.2

type FlexV1InsightsQuestionnairesCategory struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Insights resource and owns this resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the category
	CategorySid *string `json:"category_sid,omitempty"`
	// The name of this category.
	Name *string `json:"name,omitempty"`
	Url  *string `json:"url,omitempty"`
}

FlexV1InsightsQuestionnairesCategory struct for FlexV1InsightsQuestionnairesCategory

type FlexV1InsightsQuestionnairesQuestion added in v1.3.2

type FlexV1InsightsQuestionnairesQuestion struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Insights resource and owns this resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the question
	QuestionSid *string `json:"question_sid,omitempty"`
	// The question.
	Question *string `json:"question,omitempty"`
	// The description for the question.
	Description *string `json:"description,omitempty"`
	// The Category for the question.
	Category *interface{} `json:"category,omitempty"`
	// The answer_set for the question.
	AnswerSetId *string `json:"answer_set_id,omitempty"`
	// The flag  to enable for disable NA for answer.
	AllowNa *bool `json:"allow_na,omitempty"`
	// Integer value that tells a particular question is used by how many questionnaires
	Usage *int `json:"usage,omitempty"`
	// Set of answers for the question
	AnswerSet *interface{} `json:"answer_set,omitempty"`
	Url       *string      `json:"url,omitempty"`
}

FlexV1InsightsQuestionnairesQuestion struct for FlexV1InsightsQuestionnairesQuestion

type FlexV1InsightsSegments added in v1.3.3

type FlexV1InsightsSegments struct {
	// To unique id of the segment
	SegmentId *string `json:"segment_id,omitempty"`
	// The unique id for the conversation.
	ExternalId      *string `json:"external_id,omitempty"`
	Queue           *string `json:"queue,omitempty"`
	ExternalContact *string `json:"external_contact,omitempty"`
	// The uuid for the external_segment_link.
	ExternalSegmentLinkId *string `json:"external_segment_link_id,omitempty"`
	// The date of the conversation.
	Date *string `json:"date,omitempty"`
	// The unique id for the account.
	AccountId *string `json:"account_id,omitempty"`
	// The hyperlink to recording of the task event.
	ExternalSegmentLink *string `json:"external_segment_link,omitempty"`
	// The unique id for the agent.
	AgentId *string `json:"agent_id,omitempty"`
	// The phone number of the agent.
	AgentPhone *string `json:"agent_phone,omitempty"`
	// The name of the agent.
	AgentName *string `json:"agent_name,omitempty"`
	// The team name to which agent belongs.
	AgentTeamName *string `json:"agent_team_name,omitempty"`
	// he team name to which agent belongs.
	AgentTeamNameInHierarchy *string `json:"agent_team_name_in_hierarchy,omitempty"`
	// The link to the agent conversation.
	AgentLink *string `json:"agent_link,omitempty"`
	// The phone number of the customer.
	CustomerPhone *string `json:"customer_phone,omitempty"`
	// The name of the customer.
	CustomerName *string `json:"customer_name,omitempty"`
	// The link to the customer conversation.
	CustomerLink *string `json:"customer_link,omitempty"`
	// The offset value for the recording.
	SegmentRecordingOffset *string `json:"segment_recording_offset,omitempty"`
	// The media identifiers of the conversation.
	Media *interface{} `json:"media,omitempty"`
	// The type of the assessment.
	AssessmentType *interface{} `json:"assessment_type,omitempty"`
	// The percentage scored on the Assessments.
	AssessmentPercentage *interface{} `json:"assessment_percentage,omitempty"`
	Url                  *string      `json:"url,omitempty"`
}

FlexV1InsightsSegments struct for FlexV1InsightsSegments

type FlexV1InsightsSession added in v1.3.2

type FlexV1InsightsSession struct {
	// Unique ID to identify the user's workspace
	WorkspaceId *string `json:"workspace_id,omitempty"`
	// The session expiry date and time, given in ISO 8601 format.
	SessionExpiry *string `json:"session_expiry,omitempty"`
	// The unique ID for the session
	SessionId *string `json:"session_id,omitempty"`
	// The base URL to fetch reports and dashboards
	BaseUrl *string `json:"base_url,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

FlexV1InsightsSession struct for FlexV1InsightsSession

type FlexV1InsightsSettingsAnswersets added in v1.3.2

type FlexV1InsightsSettingsAnswersets struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Insights resource and owns this resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The lis of answer sets
	AnswerSets *interface{} `json:"answer_sets,omitempty"`
	// The list of answer set categories
	AnswerSetCategories *interface{} `json:"answer_set_categories,omitempty"`
	// The details for not applicable answer set
	NotApplicable *interface{} `json:"not_applicable,omitempty"`
	Url           *string      `json:"url,omitempty"`
}

FlexV1InsightsSettingsAnswersets struct for FlexV1InsightsSettingsAnswersets

type FlexV1InsightsSettingsComment added in v1.3.2

type FlexV1InsightsSettingsComment struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Insights resource and owns this resource.
	AccountSid *string      `json:"account_sid,omitempty"`
	Comments   *interface{} `json:"comments,omitempty"`
	Url        *string      `json:"url,omitempty"`
}

FlexV1InsightsSettingsComment struct for FlexV1InsightsSettingsComment

type FlexV1InsightsUserRoles added in v1.3.2

type FlexV1InsightsUserRoles struct {
	// Flex Insights roles for the user
	Roles *[]string `json:"roles,omitempty"`
	Url   *string   `json:"url,omitempty"`
}

FlexV1InsightsUserRoles struct for FlexV1InsightsUserRoles

type FlexV1Interaction added in v0.23.0

type FlexV1Interaction struct {
	// The unique string created by Twilio to identify an Interaction resource, prefixed with KD.
	Sid *string `json:"sid,omitempty"`
	// A JSON object that defines the Interaction’s communication channel and includes details about the channel. See the [Outbound SMS](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) and [inbound (API-initiated)](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#api-initiated-contact) Channel object examples.
	Channel *interface{} `json:"channel,omitempty"`
	// A JSON Object representing the routing rules for the Interaction Channel. See [Outbound SMS Example](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) for an example Routing object. The Interactions resource uses TaskRouter for all routing functionality.   All attributes in the Routing object on your Interaction request body are added “as is” to the task. For a list of known attributes consumed by the Flex UI and/or Flex Insights, see [Known Task Attributes](https://www.twilio.com/docs/flex/developer/conversations/interactions-api#task-attributes).
	Routing               *interface{}            `json:"routing,omitempty"`
	Url                   *string                 `json:"url,omitempty"`
	Links                 *map[string]interface{} `json:"links,omitempty"`
	InteractionContextSid *string                 `json:"interaction_context_sid,omitempty"`
}

FlexV1Interaction struct for FlexV1Interaction

type FlexV1InteractionChannel added in v0.23.0

type FlexV1InteractionChannel struct {
	// The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.
	Sid *string `json:"sid,omitempty"`
	// The unique string created by Twilio to identify an Interaction resource, prefixed with KD.
	InteractionSid *string `json:"interaction_sid,omitempty"`
	Type           *string `json:"type,omitempty"`
	Status         *string `json:"status,omitempty"`
	// The Twilio error code for a failed channel.
	ErrorCode *int `json:"error_code,omitempty"`
	// The error message for a failed channel.
	ErrorMessage *string                 `json:"error_message,omitempty"`
	Url          *string                 `json:"url,omitempty"`
	Links        *map[string]interface{} `json:"links,omitempty"`
}

FlexV1InteractionChannel struct for FlexV1InteractionChannel

type FlexV1InteractionChannelInvite added in v0.23.0

type FlexV1InteractionChannelInvite struct {
	// The unique string created by Twilio to identify an Interaction Channel Invite resource.
	Sid *string `json:"sid,omitempty"`
	// The Interaction SID for this Channel.
	InteractionSid *string `json:"interaction_sid,omitempty"`
	// The Channel SID for this Invite.
	ChannelSid *string `json:"channel_sid,omitempty"`
	// A JSON object representing the routing rules for the Interaction Channel. See [Outbound SMS Example](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) for an example Routing object. The Interactions resource uses TaskRouter for all routing functionality.   All attributes in the Routing object on your Interaction request body are added “as is” to the task. For a list of known attributes consumed by the Flex UI and/or Flex Insights, see [Known Task Attributes](https://www.twilio.com/docs/flex/developer/conversations/interactions-api#task-attributes).
	Routing *interface{} `json:"routing,omitempty"`
	Url     *string      `json:"url,omitempty"`
}

FlexV1InteractionChannelInvite struct for FlexV1InteractionChannelInvite

type FlexV1InteractionChannelParticipant added in v0.23.0

type FlexV1InteractionChannelParticipant struct {
	// The unique string created by Twilio to identify an Interaction Channel Participant resource.
	Sid  *string `json:"sid,omitempty"`
	Type *string `json:"type,omitempty"`
	// The Interaction Sid for this channel.
	InteractionSid *string `json:"interaction_sid,omitempty"`
	// The Channel Sid for this Participant.
	ChannelSid *string `json:"channel_sid,omitempty"`
	Url        *string `json:"url,omitempty"`
	// The Participant's routing properties.
	RoutingProperties *interface{} `json:"routing_properties,omitempty"`
}

FlexV1InteractionChannelParticipant struct for FlexV1InteractionChannelParticipant

type FlexV1Plugin added in v1.19.1

type FlexV1Plugin struct {
	// The unique string that we created to identify the Flex Plugin resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin resource and owns this resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The name that uniquely identifies this Flex Plugin resource.
	UniqueName *string `json:"unique_name,omitempty"`
	// The friendly name this Flex Plugin resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long
	Description *string `json:"description,omitempty"`
	// Whether the Flex Plugin is archived. The default value is false.
	Archived *bool `json:"archived,omitempty"`
	// The date and time in GMT-7 when the Flex Plugin was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT-7 when the Flex Plugin was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the Flex Plugin resource.
	Url   *string                 `json:"url,omitempty"`
	Links *map[string]interface{} `json:"links,omitempty"`
}

FlexV1Plugin struct for FlexV1Plugin

type FlexV1PluginArchive added in v1.19.1

type FlexV1PluginArchive struct {
	// The unique string that we created to identify the Flex Plugin resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin resource and owns this resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The name that uniquely identifies this Flex Plugin resource.
	UniqueName *string `json:"unique_name,omitempty"`
	// The friendly name this Flex Plugin resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long
	Description *string `json:"description,omitempty"`
	// Whether the Flex Plugin is archived. The default value is false.
	Archived *bool `json:"archived,omitempty"`
	// The date and time in GMT when the Flex Plugin was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the Flex Plugin was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the Flex Plugin resource.
	Url *string `json:"url,omitempty"`
}

FlexV1PluginArchive struct for FlexV1PluginArchive

type FlexV1PluginConfiguration added in v1.19.1

type FlexV1PluginConfiguration struct {
	// The unique string that we created to identify the Flex Plugin Configuration resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin Configuration resource and owns this resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The name of this Flex Plugin Configuration.
	Name *string `json:"name,omitempty"`
	// The description of the Flex Plugin Configuration resource.
	Description *string `json:"description,omitempty"`
	// Whether the Flex Plugin Configuration is archived. The default value is false.
	Archived *bool `json:"archived,omitempty"`
	// The date and time in GMT when the Flex Plugin Configuration was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The absolute URL of the Flex Plugin Configuration resource.
	Url   *string                 `json:"url,omitempty"`
	Links *map[string]interface{} `json:"links,omitempty"`
}

FlexV1PluginConfiguration struct for FlexV1PluginConfiguration

type FlexV1PluginConfigurationArchive added in v1.19.1

type FlexV1PluginConfigurationArchive struct {
	// The unique string that we created to identify the Flex Plugin Configuration resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin Configuration resource and owns this resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The name of this Flex Plugin Configuration.
	Name *string `json:"name,omitempty"`
	// The description of the Flex Plugin Configuration resource.
	Description *string `json:"description,omitempty"`
	// Whether the Flex Plugin Configuration is archived. The default value is false.
	Archived *bool `json:"archived,omitempty"`
	// The date and time in GMT when the Flex Plugin Configuration was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The absolute URL of the Flex Plugin Configuration resource.
	Url *string `json:"url,omitempty"`
}

FlexV1PluginConfigurationArchive struct for FlexV1PluginConfigurationArchive

type FlexV1PluginRelease added in v1.19.1

type FlexV1PluginRelease struct {
	// The unique string that we created to identify the Plugin Release resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Plugin Release resource and owns this resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the Plugin Configuration resource to release.
	ConfigurationSid *string `json:"configuration_sid,omitempty"`
	// The date and time in GMT when the Flex Plugin Release was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The absolute URL of the Plugin Release resource.
	Url *string `json:"url,omitempty"`
}

FlexV1PluginRelease struct for FlexV1PluginRelease

type FlexV1PluginVersion added in v1.19.1

type FlexV1PluginVersion struct {
	// The unique string that we created to identify the Flex Plugin Version resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the Flex Plugin resource this Flex Plugin Version belongs to.
	PluginSid *string `json:"plugin_sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin Version resource and owns this resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique version of this Flex Plugin Version.
	Version *string `json:"version,omitempty"`
	// The URL of where the Flex Plugin Version JavaScript bundle is hosted on.
	PluginUrl *string `json:"plugin_url,omitempty"`
	// A changelog that describes the changes this Flex Plugin Version brings.
	Changelog *string `json:"changelog,omitempty"`
	// Whether the Flex Plugin Version is validated. The default value is false.
	Private *bool `json:"private,omitempty"`
	// Whether the Flex Plugin Version is archived. The default value is false.
	Archived  *bool `json:"archived,omitempty"`
	Validated *bool `json:"validated,omitempty"`
	// The date and time in GMT when the Flex Plugin Version was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The absolute URL of the Flex Plugin Version resource.
	Url *string `json:"url,omitempty"`
}

FlexV1PluginVersion struct for FlexV1PluginVersion

type FlexV1PluginVersionArchive added in v1.19.1

type FlexV1PluginVersionArchive struct {
	// The unique string that we created to identify the Flex Plugin Version resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the Flex Plugin resource this Flex Plugin Version belongs to.
	PluginSid *string `json:"plugin_sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin Version resource and owns this resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique version of this Flex Plugin Version.
	Version *string `json:"version,omitempty"`
	// The URL of where the Flex Plugin Version JavaScript bundle is hosted on.
	PluginUrl *string `json:"plugin_url,omitempty"`
	// A changelog that describes the changes this Flex Plugin Version brings.
	Changelog *string `json:"changelog,omitempty"`
	// Whether to inject credentials while accessing this Plugin Version. The default value is false.
	Private *bool `json:"private,omitempty"`
	// Whether the Flex Plugin Version is archived. The default value is false.
	Archived *bool `json:"archived,omitempty"`
	// The date and time in GMT when the Flex Plugin Version was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The absolute URL of the Flex Plugin Version resource.
	Url *string `json:"url,omitempty"`
}

FlexV1PluginVersionArchive struct for FlexV1PluginVersionArchive

type FlexV1ProvisioningStatus added in v1.15.1

type FlexV1ProvisioningStatus struct {
	Status *string `json:"status,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
}

FlexV1ProvisioningStatus struct for FlexV1ProvisioningStatus

type FlexV1WebChannel

type FlexV1WebChannel struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the WebChannel resource and owns this Workflow.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the Flex Flow.
	FlexFlowSid *string `json:"flex_flow_sid,omitempty"`
	// The unique string that we created to identify the WebChannel resource.
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the WebChannel resource.
	Url *string `json:"url,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
}

FlexV1WebChannel struct for FlexV1WebChannel

type ListChannelParams

type ListChannelParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListChannel'

func (*ListChannelParams) SetLimit added in v0.13.0

func (params *ListChannelParams) SetLimit(Limit int) *ListChannelParams

func (*ListChannelParams) SetPageSize

func (params *ListChannelParams) SetPageSize(PageSize int) *ListChannelParams

type ListChannelResponse

type ListChannelResponse struct {
	FlexChatChannels []FlexV1Channel         `json:"flex_chat_channels,omitempty"`
	Meta             ListChannelResponseMeta `json:"meta,omitempty"`
}

ListChannelResponse struct for ListChannelResponse

type ListChannelResponseMeta

type ListChannelResponseMeta struct {
	FirstPageUrl    string  `json:"first_page_url,omitempty"`
	Key             string  `json:"key,omitempty"`
	NextPageUrl     *string `json:"next_page_url,omitempty"`
	Page            int     `json:"page,omitempty"`
	PageSize        int     `json:"page_size,omitempty"`
	PreviousPageUrl *string `json:"previous_page_url,omitempty"`
	Url             string  `json:"url,omitempty"`
}

ListChannelResponseMeta struct for ListChannelResponseMeta

type ListConfiguredPluginParams added in v1.19.1

type ListConfiguredPluginParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListConfiguredPlugin'

func (*ListConfiguredPluginParams) SetFlexMetadata added in v1.19.1

func (params *ListConfiguredPluginParams) SetFlexMetadata(FlexMetadata string) *ListConfiguredPluginParams

func (*ListConfiguredPluginParams) SetLimit added in v1.19.1

func (*ListConfiguredPluginParams) SetPageSize added in v1.19.1

func (params *ListConfiguredPluginParams) SetPageSize(PageSize int) *ListConfiguredPluginParams

type ListConfiguredPluginResponse added in v1.19.1

type ListConfiguredPluginResponse struct {
	Plugins []FlexV1ConfiguredPlugin `json:"plugins,omitempty"`
	Meta    ListChannelResponseMeta  `json:"meta,omitempty"`
}

ListConfiguredPluginResponse struct for ListConfiguredPluginResponse

type ListFlexFlowParams

type ListFlexFlowParams struct {
	// The `friendly_name` of the Flex Flow resources to read.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListFlexFlow'

func (*ListFlexFlowParams) SetFriendlyName

func (params *ListFlexFlowParams) SetFriendlyName(FriendlyName string) *ListFlexFlowParams

func (*ListFlexFlowParams) SetLimit added in v0.13.0

func (params *ListFlexFlowParams) SetLimit(Limit int) *ListFlexFlowParams

func (*ListFlexFlowParams) SetPageSize

func (params *ListFlexFlowParams) SetPageSize(PageSize int) *ListFlexFlowParams

type ListFlexFlowResponse

type ListFlexFlowResponse struct {
	FlexFlows []FlexV1FlexFlow        `json:"flex_flows,omitempty"`
	Meta      ListChannelResponseMeta `json:"meta,omitempty"`
}

ListFlexFlowResponse struct for ListFlexFlowResponse

type ListInsightsAssessmentsCommentParams added in v1.3.3

type ListInsightsAssessmentsCommentParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// The id of the segment.
	SegmentId *string `json:"SegmentId,omitempty"`
	// The id of the agent.
	AgentId *string `json:"AgentId,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListInsightsAssessmentsComment'

func (*ListInsightsAssessmentsCommentParams) SetAgentId added in v1.3.3

func (*ListInsightsAssessmentsCommentParams) SetAuthorization added in v1.7.1

func (params *ListInsightsAssessmentsCommentParams) SetAuthorization(Authorization string) *ListInsightsAssessmentsCommentParams

func (*ListInsightsAssessmentsCommentParams) SetLimit added in v1.3.3

func (*ListInsightsAssessmentsCommentParams) SetPageSize added in v1.3.3

func (*ListInsightsAssessmentsCommentParams) SetSegmentId added in v1.3.3

type ListInsightsAssessmentsCommentResponse added in v1.3.3

type ListInsightsAssessmentsCommentResponse struct {
	Comments []FlexV1InsightsAssessmentsComment `json:"comments,omitempty"`
	Meta     ListChannelResponseMeta            `json:"meta,omitempty"`
}

ListInsightsAssessmentsCommentResponse struct for ListInsightsAssessmentsCommentResponse

type ListInsightsAssessmentsParams added in v1.3.5

type ListInsightsAssessmentsParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// The id of the segment.
	SegmentId *string `json:"SegmentId,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListInsightsAssessments'

func (*ListInsightsAssessmentsParams) SetAuthorization added in v1.7.1

func (params *ListInsightsAssessmentsParams) SetAuthorization(Authorization string) *ListInsightsAssessmentsParams

func (*ListInsightsAssessmentsParams) SetLimit added in v1.3.5

func (*ListInsightsAssessmentsParams) SetPageSize added in v1.3.5

func (params *ListInsightsAssessmentsParams) SetPageSize(PageSize int) *ListInsightsAssessmentsParams

func (*ListInsightsAssessmentsParams) SetSegmentId added in v1.3.5

func (params *ListInsightsAssessmentsParams) SetSegmentId(SegmentId string) *ListInsightsAssessmentsParams

type ListInsightsAssessmentsResponse added in v1.3.5

type ListInsightsAssessmentsResponse struct {
	Assessments []FlexV1InsightsAssessments `json:"assessments,omitempty"`
	Meta        ListChannelResponseMeta     `json:"meta,omitempty"`
}

ListInsightsAssessmentsResponse struct for ListInsightsAssessmentsResponse

type ListInsightsConversationsParams added in v1.4.0

type ListInsightsConversationsParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// Unique Id of the segment for which conversation details needs to be fetched
	SegmentId *string `json:"SegmentId,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListInsightsConversations'

func (*ListInsightsConversationsParams) SetAuthorization added in v1.7.1

func (params *ListInsightsConversationsParams) SetAuthorization(Authorization string) *ListInsightsConversationsParams

func (*ListInsightsConversationsParams) SetLimit added in v1.4.0

func (*ListInsightsConversationsParams) SetPageSize added in v1.4.0

func (*ListInsightsConversationsParams) SetSegmentId added in v1.4.0

type ListInsightsConversationsResponse added in v1.4.0

type ListInsightsConversationsResponse struct {
	Conversations []FlexV1InsightsConversations `json:"conversations,omitempty"`
	Meta          ListChannelResponseMeta       `json:"meta,omitempty"`
}

ListInsightsConversationsResponse struct for ListInsightsConversationsResponse

type ListInsightsQuestionnairesCategoryParams added in v1.3.3

type ListInsightsQuestionnairesCategoryParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListInsightsQuestionnairesCategory'

func (*ListInsightsQuestionnairesCategoryParams) SetAuthorization added in v1.7.1

func (*ListInsightsQuestionnairesCategoryParams) SetLimit added in v1.3.3

func (*ListInsightsQuestionnairesCategoryParams) SetPageSize added in v1.3.3

type ListInsightsQuestionnairesCategoryResponse added in v1.3.3

type ListInsightsQuestionnairesCategoryResponse struct {
	Categories []FlexV1InsightsQuestionnairesCategory `json:"categories,omitempty"`
	Meta       ListChannelResponseMeta                `json:"meta,omitempty"`
}

ListInsightsQuestionnairesCategoryResponse struct for ListInsightsQuestionnairesCategoryResponse

type ListInsightsQuestionnairesParams added in v1.3.3

type ListInsightsQuestionnairesParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// Flag indicating whether to include inactive questionnaires or not
	IncludeInactive *bool `json:"IncludeInactive,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListInsightsQuestionnaires'

func (*ListInsightsQuestionnairesParams) SetAuthorization added in v1.7.1

func (params *ListInsightsQuestionnairesParams) SetAuthorization(Authorization string) *ListInsightsQuestionnairesParams

func (*ListInsightsQuestionnairesParams) SetIncludeInactive added in v1.3.3

func (params *ListInsightsQuestionnairesParams) SetIncludeInactive(IncludeInactive bool) *ListInsightsQuestionnairesParams

func (*ListInsightsQuestionnairesParams) SetLimit added in v1.3.3

func (*ListInsightsQuestionnairesParams) SetPageSize added in v1.3.3

type ListInsightsQuestionnairesQuestionParams added in v1.3.3

type ListInsightsQuestionnairesQuestionParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// The list of category SIDs
	CategorySid *[]string `json:"CategorySid,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListInsightsQuestionnairesQuestion'

func (*ListInsightsQuestionnairesQuestionParams) SetAuthorization added in v1.7.1

func (*ListInsightsQuestionnairesQuestionParams) SetCategorySid added in v1.7.0

func (*ListInsightsQuestionnairesQuestionParams) SetLimit added in v1.3.3

func (*ListInsightsQuestionnairesQuestionParams) SetPageSize added in v1.3.3

type ListInsightsQuestionnairesQuestionResponse added in v1.3.3

type ListInsightsQuestionnairesQuestionResponse struct {
	Questions []FlexV1InsightsQuestionnairesQuestion `json:"questions,omitempty"`
	Meta      ListChannelResponseMeta                `json:"meta,omitempty"`
}

ListInsightsQuestionnairesQuestionResponse struct for ListInsightsQuestionnairesQuestionResponse

type ListInsightsQuestionnairesResponse added in v1.3.3

type ListInsightsQuestionnairesResponse struct {
	Questionnaires []FlexV1InsightsQuestionnaires `json:"questionnaires,omitempty"`
	Meta           ListChannelResponseMeta        `json:"meta,omitempty"`
}

ListInsightsQuestionnairesResponse struct for ListInsightsQuestionnairesResponse

type ListInsightsSegmentsParams added in v1.3.4

type ListInsightsSegmentsParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// To unique id of the segment
	SegmentId *string `json:"SegmentId,omitempty"`
	// The list of reservation Ids
	ReservationId *[]string `json:"ReservationId,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListInsightsSegments'

func (*ListInsightsSegmentsParams) SetAuthorization added in v1.7.1

func (params *ListInsightsSegmentsParams) SetAuthorization(Authorization string) *ListInsightsSegmentsParams

func (*ListInsightsSegmentsParams) SetLimit added in v1.3.4

func (*ListInsightsSegmentsParams) SetPageSize added in v1.3.4

func (params *ListInsightsSegmentsParams) SetPageSize(PageSize int) *ListInsightsSegmentsParams

func (*ListInsightsSegmentsParams) SetReservationId added in v1.3.4

func (params *ListInsightsSegmentsParams) SetReservationId(ReservationId []string) *ListInsightsSegmentsParams

func (*ListInsightsSegmentsParams) SetSegmentId added in v1.7.0

func (params *ListInsightsSegmentsParams) SetSegmentId(SegmentId string) *ListInsightsSegmentsParams

type ListInsightsSegmentsResponse added in v1.3.4

type ListInsightsSegmentsResponse struct {
	Segments []FlexV1InsightsSegments `json:"segments,omitempty"`
	Meta     ListChannelResponseMeta  `json:"meta,omitempty"`
}

ListInsightsSegmentsResponse struct for ListInsightsSegmentsResponse

type ListInteractionChannelInviteParams added in v0.23.0

type ListInteractionChannelInviteParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListInteractionChannelInvite'

func (*ListInteractionChannelInviteParams) SetLimit added in v0.23.0

func (*ListInteractionChannelInviteParams) SetPageSize added in v0.23.0

type ListInteractionChannelInviteResponse added in v0.23.0

type ListInteractionChannelInviteResponse struct {
	Invites []FlexV1InteractionChannelInvite `json:"invites,omitempty"`
	Meta    ListChannelResponseMeta          `json:"meta,omitempty"`
}

ListInteractionChannelInviteResponse struct for ListInteractionChannelInviteResponse

type ListInteractionChannelParams added in v0.23.0

type ListInteractionChannelParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListInteractionChannel'

func (*ListInteractionChannelParams) SetLimit added in v0.23.0

func (*ListInteractionChannelParams) SetPageSize added in v0.23.0

func (params *ListInteractionChannelParams) SetPageSize(PageSize int) *ListInteractionChannelParams

type ListInteractionChannelParticipantParams added in v0.23.0

type ListInteractionChannelParticipantParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListInteractionChannelParticipant'

func (*ListInteractionChannelParticipantParams) SetLimit added in v0.23.0

func (*ListInteractionChannelParticipantParams) SetPageSize added in v0.23.0

type ListInteractionChannelParticipantResponse added in v0.23.0

type ListInteractionChannelParticipantResponse struct {
	Participants []FlexV1InteractionChannelParticipant `json:"participants,omitempty"`
	Meta         ListChannelResponseMeta               `json:"meta,omitempty"`
}

ListInteractionChannelParticipantResponse struct for ListInteractionChannelParticipantResponse

type ListInteractionChannelResponse added in v0.23.0

type ListInteractionChannelResponse struct {
	Channels []FlexV1InteractionChannel `json:"channels,omitempty"`
	Meta     ListChannelResponseMeta    `json:"meta,omitempty"`
}

ListInteractionChannelResponse struct for ListInteractionChannelResponse

type ListPluginConfigurationParams added in v1.19.1

type ListPluginConfigurationParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListPluginConfiguration'

func (*ListPluginConfigurationParams) SetFlexMetadata added in v1.19.1

func (params *ListPluginConfigurationParams) SetFlexMetadata(FlexMetadata string) *ListPluginConfigurationParams

func (*ListPluginConfigurationParams) SetLimit added in v1.19.1

func (*ListPluginConfigurationParams) SetPageSize added in v1.19.1

func (params *ListPluginConfigurationParams) SetPageSize(PageSize int) *ListPluginConfigurationParams

type ListPluginConfigurationResponse added in v1.19.1

type ListPluginConfigurationResponse struct {
	Configurations []FlexV1PluginConfiguration `json:"configurations,omitempty"`
	Meta           ListChannelResponseMeta     `json:"meta,omitempty"`
}

ListPluginConfigurationResponse struct for ListPluginConfigurationResponse

type ListPluginParams added in v1.19.1

type ListPluginParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListPlugin'

func (*ListPluginParams) SetFlexMetadata added in v1.19.1

func (params *ListPluginParams) SetFlexMetadata(FlexMetadata string) *ListPluginParams

func (*ListPluginParams) SetLimit added in v1.19.1

func (params *ListPluginParams) SetLimit(Limit int) *ListPluginParams

func (*ListPluginParams) SetPageSize added in v1.19.1

func (params *ListPluginParams) SetPageSize(PageSize int) *ListPluginParams

type ListPluginReleaseParams added in v1.19.1

type ListPluginReleaseParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListPluginRelease'

func (*ListPluginReleaseParams) SetFlexMetadata added in v1.19.1

func (params *ListPluginReleaseParams) SetFlexMetadata(FlexMetadata string) *ListPluginReleaseParams

func (*ListPluginReleaseParams) SetLimit added in v1.19.1

func (params *ListPluginReleaseParams) SetLimit(Limit int) *ListPluginReleaseParams

func (*ListPluginReleaseParams) SetPageSize added in v1.19.1

func (params *ListPluginReleaseParams) SetPageSize(PageSize int) *ListPluginReleaseParams

type ListPluginReleaseResponse added in v1.19.1

type ListPluginReleaseResponse struct {
	Releases []FlexV1PluginRelease   `json:"releases,omitempty"`
	Meta     ListChannelResponseMeta `json:"meta,omitempty"`
}

ListPluginReleaseResponse struct for ListPluginReleaseResponse

type ListPluginResponse added in v1.19.1

type ListPluginResponse struct {
	Plugins []FlexV1Plugin          `json:"plugins,omitempty"`
	Meta    ListChannelResponseMeta `json:"meta,omitempty"`
}

ListPluginResponse struct for ListPluginResponse

type ListPluginVersionParams added in v1.19.1

type ListPluginVersionParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListPluginVersion'

func (*ListPluginVersionParams) SetFlexMetadata added in v1.19.1

func (params *ListPluginVersionParams) SetFlexMetadata(FlexMetadata string) *ListPluginVersionParams

func (*ListPluginVersionParams) SetLimit added in v1.19.1

func (params *ListPluginVersionParams) SetLimit(Limit int) *ListPluginVersionParams

func (*ListPluginVersionParams) SetPageSize added in v1.19.1

func (params *ListPluginVersionParams) SetPageSize(PageSize int) *ListPluginVersionParams

type ListPluginVersionResponse added in v1.19.1

type ListPluginVersionResponse struct {
	PluginVersions []FlexV1PluginVersion   `json:"plugin_versions,omitempty"`
	Meta           ListChannelResponseMeta `json:"meta,omitempty"`
}

ListPluginVersionResponse struct for ListPluginVersionResponse

type ListWebChannelParams

type ListWebChannelParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListWebChannel'

func (*ListWebChannelParams) SetLimit added in v0.13.0

func (params *ListWebChannelParams) SetLimit(Limit int) *ListWebChannelParams

func (*ListWebChannelParams) SetPageSize

func (params *ListWebChannelParams) SetPageSize(PageSize int) *ListWebChannelParams

type ListWebChannelResponse

type ListWebChannelResponse struct {
	FlexChatChannels []FlexV1WebChannel      `json:"flex_chat_channels,omitempty"`
	Meta             ListChannelResponseMeta `json:"meta,omitempty"`
}

ListWebChannelResponse struct for ListWebChannelResponse

type UpdateConfigurationParams added in v1.20.0

type UpdateConfigurationParams struct {
	//
	Body *map[string]interface{} `json:"body,omitempty"`
}

Optional parameters for the method 'UpdateConfiguration'

func (*UpdateConfigurationParams) SetBody added in v1.20.0

func (params *UpdateConfigurationParams) SetBody(Body map[string]interface{}) *UpdateConfigurationParams

type UpdateFlexFlowParams

type UpdateFlexFlowParams struct {
	// A descriptive string that you create to describe the Flex Flow resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The SID of the chat service.
	ChatServiceSid *string `json:"ChatServiceSid,omitempty"`
	//
	ChannelType *string `json:"ChannelType,omitempty"`
	// The channel contact's Identity.
	ContactIdentity *string `json:"ContactIdentity,omitempty"`
	// Whether the new Flex Flow is enabled.
	Enabled *bool `json:"Enabled,omitempty"`
	//
	IntegrationType *string `json:"IntegrationType,omitempty"`
	// The SID of the Studio Flow. Required when `integrationType` is `studio`.
	IntegrationFlowSid *string `json:"Integration.FlowSid,omitempty"`
	// The URL of the external webhook. Required when `integrationType` is `external`.
	IntegrationUrl *string `json:"Integration.Url,omitempty"`
	// The Workspace SID for a new Task. Required when `integrationType` is `task`.
	IntegrationWorkspaceSid *string `json:"Integration.WorkspaceSid,omitempty"`
	// The Workflow SID for a new Task. Required when `integrationType` is `task`.
	IntegrationWorkflowSid *string `json:"Integration.WorkflowSid,omitempty"`
	// The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`.
	IntegrationChannel *string `json:"Integration.Channel,omitempty"`
	// The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise.
	IntegrationTimeout *int `json:"Integration.Timeout,omitempty"`
	// The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise.
	IntegrationPriority *int `json:"Integration.Priority,omitempty"`
	// In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging.
	IntegrationCreationOnMessage *bool `json:"Integration.CreationOnMessage,omitempty"`
	// When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`.
	LongLived *bool `json:"LongLived,omitempty"`
	// When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`.
	JanitorEnabled *bool `json:"JanitorEnabled,omitempty"`
	// The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise.
	IntegrationRetryCount *int `json:"Integration.RetryCount,omitempty"`
}

Optional parameters for the method 'UpdateFlexFlow'

func (*UpdateFlexFlowParams) SetChannelType

func (params *UpdateFlexFlowParams) SetChannelType(ChannelType string) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetChatServiceSid

func (params *UpdateFlexFlowParams) SetChatServiceSid(ChatServiceSid string) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetContactIdentity

func (params *UpdateFlexFlowParams) SetContactIdentity(ContactIdentity string) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetEnabled

func (params *UpdateFlexFlowParams) SetEnabled(Enabled bool) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetFriendlyName

func (params *UpdateFlexFlowParams) SetFriendlyName(FriendlyName string) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetIntegrationChannel

func (params *UpdateFlexFlowParams) SetIntegrationChannel(IntegrationChannel string) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetIntegrationCreationOnMessage

func (params *UpdateFlexFlowParams) SetIntegrationCreationOnMessage(IntegrationCreationOnMessage bool) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetIntegrationFlowSid

func (params *UpdateFlexFlowParams) SetIntegrationFlowSid(IntegrationFlowSid string) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetIntegrationPriority

func (params *UpdateFlexFlowParams) SetIntegrationPriority(IntegrationPriority int) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetIntegrationRetryCount

func (params *UpdateFlexFlowParams) SetIntegrationRetryCount(IntegrationRetryCount int) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetIntegrationTimeout

func (params *UpdateFlexFlowParams) SetIntegrationTimeout(IntegrationTimeout int) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetIntegrationType

func (params *UpdateFlexFlowParams) SetIntegrationType(IntegrationType string) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetIntegrationUrl

func (params *UpdateFlexFlowParams) SetIntegrationUrl(IntegrationUrl string) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetIntegrationWorkflowSid

func (params *UpdateFlexFlowParams) SetIntegrationWorkflowSid(IntegrationWorkflowSid string) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetIntegrationWorkspaceSid

func (params *UpdateFlexFlowParams) SetIntegrationWorkspaceSid(IntegrationWorkspaceSid string) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetJanitorEnabled

func (params *UpdateFlexFlowParams) SetJanitorEnabled(JanitorEnabled bool) *UpdateFlexFlowParams

func (*UpdateFlexFlowParams) SetLongLived

func (params *UpdateFlexFlowParams) SetLongLived(LongLived bool) *UpdateFlexFlowParams

type UpdateInsightsAssessmentsParams added in v1.3.4

type UpdateInsightsAssessmentsParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// The offset of the conversation
	Offset *float32 `json:"Offset,omitempty"`
	// The answer text selected by user
	AnswerText *string `json:"AnswerText,omitempty"`
	// The id of the answer selected by user
	AnswerId *string `json:"AnswerId,omitempty"`
}

Optional parameters for the method 'UpdateInsightsAssessments'

func (*UpdateInsightsAssessmentsParams) SetAnswerId added in v1.3.4

func (*UpdateInsightsAssessmentsParams) SetAnswerText added in v1.3.4

func (params *UpdateInsightsAssessmentsParams) SetAnswerText(AnswerText string) *UpdateInsightsAssessmentsParams

func (*UpdateInsightsAssessmentsParams) SetAuthorization added in v1.7.1

func (params *UpdateInsightsAssessmentsParams) SetAuthorization(Authorization string) *UpdateInsightsAssessmentsParams

func (*UpdateInsightsAssessmentsParams) SetOffset added in v1.3.4

type UpdateInsightsQuestionnairesCategoryParams added in v1.3.2

type UpdateInsightsQuestionnairesCategoryParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// The name of this category.
	Name *string `json:"Name,omitempty"`
}

Optional parameters for the method 'UpdateInsightsQuestionnairesCategory'

func (*UpdateInsightsQuestionnairesCategoryParams) SetAuthorization added in v1.7.1

func (*UpdateInsightsQuestionnairesCategoryParams) SetName added in v1.3.2

type UpdateInsightsQuestionnairesParams added in v1.3.3

type UpdateInsightsQuestionnairesParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// The flag to enable or disable questionnaire
	Active *bool `json:"Active,omitempty"`
	// The name of this questionnaire
	Name *string `json:"Name,omitempty"`
	// The description of this questionnaire
	Description *string `json:"Description,omitempty"`
	// The list of questions sids under a questionnaire
	QuestionSids *[]string `json:"QuestionSids,omitempty"`
}

Optional parameters for the method 'UpdateInsightsQuestionnaires'

func (*UpdateInsightsQuestionnairesParams) SetActive added in v1.3.3

func (*UpdateInsightsQuestionnairesParams) SetAuthorization added in v1.7.1

func (params *UpdateInsightsQuestionnairesParams) SetAuthorization(Authorization string) *UpdateInsightsQuestionnairesParams

func (*UpdateInsightsQuestionnairesParams) SetDescription added in v1.3.3

func (*UpdateInsightsQuestionnairesParams) SetName added in v1.3.3

func (*UpdateInsightsQuestionnairesParams) SetQuestionSids added in v1.7.0

func (params *UpdateInsightsQuestionnairesParams) SetQuestionSids(QuestionSids []string) *UpdateInsightsQuestionnairesParams

type UpdateInsightsQuestionnairesQuestionParams added in v1.3.2

type UpdateInsightsQuestionnairesQuestionParams struct {
	// The Authorization HTTP request header
	Authorization *string `json:"Authorization,omitempty"`
	// The flag to enable for disable NA for answer.
	AllowNa *bool `json:"AllowNa,omitempty"`
	// The SID of the category
	CategorySid *string `json:"CategorySid,omitempty"`
	// The question.
	Question *string `json:"Question,omitempty"`
	// The description for the question.
	Description *string `json:"Description,omitempty"`
	// The answer_set for the question.
	AnswerSetId *string `json:"AnswerSetId,omitempty"`
}

Optional parameters for the method 'UpdateInsightsQuestionnairesQuestion'

func (*UpdateInsightsQuestionnairesQuestionParams) SetAllowNa added in v1.3.2

func (*UpdateInsightsQuestionnairesQuestionParams) SetAnswerSetId added in v1.3.2

func (*UpdateInsightsQuestionnairesQuestionParams) SetAuthorization added in v1.7.1

func (*UpdateInsightsQuestionnairesQuestionParams) SetCategorySid added in v1.7.0

func (*UpdateInsightsQuestionnairesQuestionParams) SetDescription added in v1.3.2

func (*UpdateInsightsQuestionnairesQuestionParams) SetQuestion added in v1.3.2

type UpdateInteractionChannelParams added in v0.23.0

type UpdateInteractionChannelParams struct {
	//
	Status *string `json:"Status,omitempty"`
	// It changes the state of associated tasks. Routing status is required, When the channel status is set to `inactive`. Allowed Value for routing status is `closed`. Otherwise Optional, if not specified, all tasks will be set to `wrapping`.
	Routing *interface{} `json:"Routing,omitempty"`
}

Optional parameters for the method 'UpdateInteractionChannel'

func (*UpdateInteractionChannelParams) SetRouting added in v0.23.0

func (params *UpdateInteractionChannelParams) SetRouting(Routing interface{}) *UpdateInteractionChannelParams

func (*UpdateInteractionChannelParams) SetStatus added in v0.23.0

type UpdateInteractionChannelParticipantParams added in v0.23.0

type UpdateInteractionChannelParticipantParams struct {
	//
	Status *string `json:"Status,omitempty"`
}

Optional parameters for the method 'UpdateInteractionChannelParticipant'

func (*UpdateInteractionChannelParticipantParams) SetStatus added in v0.23.0

type UpdatePluginArchiveParams added in v1.19.1

type UpdatePluginArchiveParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
}

Optional parameters for the method 'UpdatePluginArchive'

func (*UpdatePluginArchiveParams) SetFlexMetadata added in v1.19.1

func (params *UpdatePluginArchiveParams) SetFlexMetadata(FlexMetadata string) *UpdatePluginArchiveParams

type UpdatePluginConfigurationArchiveParams added in v1.19.1

type UpdatePluginConfigurationArchiveParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
}

Optional parameters for the method 'UpdatePluginConfigurationArchive'

func (*UpdatePluginConfigurationArchiveParams) SetFlexMetadata added in v1.19.1

type UpdatePluginParams added in v1.19.1

type UpdatePluginParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
	// The Flex Plugin's friendly name.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long
	Description *string `json:"Description,omitempty"`
}

Optional parameters for the method 'UpdatePlugin'

func (*UpdatePluginParams) SetDescription added in v1.19.1

func (params *UpdatePluginParams) SetDescription(Description string) *UpdatePluginParams

func (*UpdatePluginParams) SetFlexMetadata added in v1.19.1

func (params *UpdatePluginParams) SetFlexMetadata(FlexMetadata string) *UpdatePluginParams

func (*UpdatePluginParams) SetFriendlyName added in v1.19.1

func (params *UpdatePluginParams) SetFriendlyName(FriendlyName string) *UpdatePluginParams

type UpdatePluginVersionArchiveParams added in v1.19.1

type UpdatePluginVersionArchiveParams struct {
	// The Flex-Metadata HTTP request header
	FlexMetadata *string `json:"Flex-Metadata,omitempty"`
}

Optional parameters for the method 'UpdatePluginVersionArchive'

func (*UpdatePluginVersionArchiveParams) SetFlexMetadata added in v1.19.1

func (params *UpdatePluginVersionArchiveParams) SetFlexMetadata(FlexMetadata string) *UpdatePluginVersionArchiveParams

type UpdateWebChannelParams

type UpdateWebChannelParams struct {
	//
	ChatStatus *string `json:"ChatStatus,omitempty"`
	// The post-engagement data.
	PostEngagementData *string `json:"PostEngagementData,omitempty"`
}

Optional parameters for the method 'UpdateWebChannel'

func (*UpdateWebChannelParams) SetChatStatus

func (params *UpdateWebChannelParams) SetChatStatus(ChatStatus string) *UpdateWebChannelParams

func (*UpdateWebChannelParams) SetPostEngagementData

func (params *UpdateWebChannelParams) SetPostEngagementData(PostEngagementData string) *UpdateWebChannelParams

Source Files

Jump to

Keyboard shortcuts

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