github.com/twilio/twilio-go@v1.20.1/rest/flex/v1/README.md (about) 1 # Go API client for openapi 2 3 This is the public Twilio REST API. 4 5 ## Overview 6 This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project from the OpenAPI specs located at [twilio/twilio-oai](https://github.com/twilio/twilio-oai/tree/main/spec). By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. 7 8 - API version: 1.0.0 9 - Package version: 1.0.0 10 - Build package: com.twilio.oai.TwilioGoGenerator 11 For more information, please visit [https://support.twilio.com](https://support.twilio.com) 12 13 ## Installation 14 15 Install the following dependencies: 16 17 ```shell 18 go get github.com/stretchr/testify/assert 19 go get golang.org/x/net/context 20 ``` 21 22 Put the package under your project folder and add the following in import: 23 24 ```golang 25 import "./openapi" 26 ``` 27 28 ## Documentation for API Endpoints 29 30 All URIs are relative to *https://flex-api.twilio.com* 31 32 Class | Method | HTTP request | Description 33 ------------ | ------------- | ------------- | ------------- 34 *AccountProvisionStatusApi* | [**FetchProvisioningStatus**](docs/AccountProvisionStatusApi.md#fetchprovisioningstatus) | **Get** /v1/account/provision/status | 35 *ChannelsApi* | [**CreateChannel**](docs/ChannelsApi.md#createchannel) | **Post** /v1/Channels | 36 *ChannelsApi* | [**DeleteChannel**](docs/ChannelsApi.md#deletechannel) | **Delete** /v1/Channels/{Sid} | 37 *ChannelsApi* | [**FetchChannel**](docs/ChannelsApi.md#fetchchannel) | **Get** /v1/Channels/{Sid} | 38 *ChannelsApi* | [**ListChannel**](docs/ChannelsApi.md#listchannel) | **Get** /v1/Channels | 39 *ConfigurationApi* | [**FetchConfiguration**](docs/ConfigurationApi.md#fetchconfiguration) | **Get** /v1/Configuration | 40 *ConfigurationApi* | [**UpdateConfiguration**](docs/ConfigurationApi.md#updateconfiguration) | **Post** /v1/Configuration | 41 *FlexFlowsApi* | [**CreateFlexFlow**](docs/FlexFlowsApi.md#createflexflow) | **Post** /v1/FlexFlows | 42 *FlexFlowsApi* | [**DeleteFlexFlow**](docs/FlexFlowsApi.md#deleteflexflow) | **Delete** /v1/FlexFlows/{Sid} | 43 *FlexFlowsApi* | [**FetchFlexFlow**](docs/FlexFlowsApi.md#fetchflexflow) | **Get** /v1/FlexFlows/{Sid} | 44 *FlexFlowsApi* | [**ListFlexFlow**](docs/FlexFlowsApi.md#listflexflow) | **Get** /v1/FlexFlows | 45 *FlexFlowsApi* | [**UpdateFlexFlow**](docs/FlexFlowsApi.md#updateflexflow) | **Post** /v1/FlexFlows/{Sid} | 46 *InsightsConversationsApi* | [**ListInsightsConversations**](docs/InsightsConversationsApi.md#listinsightsconversations) | **Get** /v1/Insights/Conversations | 47 *InsightsQualityManagementAssessmentsApi* | [**CreateInsightsAssessments**](docs/InsightsQualityManagementAssessmentsApi.md#createinsightsassessments) | **Post** /v1/Insights/QualityManagement/Assessments | 48 *InsightsQualityManagementAssessmentsApi* | [**ListInsightsAssessments**](docs/InsightsQualityManagementAssessmentsApi.md#listinsightsassessments) | **Get** /v1/Insights/QualityManagement/Assessments | 49 *InsightsQualityManagementAssessmentsApi* | [**UpdateInsightsAssessments**](docs/InsightsQualityManagementAssessmentsApi.md#updateinsightsassessments) | **Post** /v1/Insights/QualityManagement/Assessments/{AssessmentSid} | 50 *InsightsQualityManagementAssessmentsCommentsApi* | [**CreateInsightsAssessmentsComment**](docs/InsightsQualityManagementAssessmentsCommentsApi.md#createinsightsassessmentscomment) | **Post** /v1/Insights/QualityManagement/Assessments/Comments | 51 *InsightsQualityManagementAssessmentsCommentsApi* | [**ListInsightsAssessmentsComment**](docs/InsightsQualityManagementAssessmentsCommentsApi.md#listinsightsassessmentscomment) | **Get** /v1/Insights/QualityManagement/Assessments/Comments | 52 *InsightsQualityManagementCategoriesApi* | [**CreateInsightsQuestionnairesCategory**](docs/InsightsQualityManagementCategoriesApi.md#createinsightsquestionnairescategory) | **Post** /v1/Insights/QualityManagement/Categories | 53 *InsightsQualityManagementCategoriesApi* | [**DeleteInsightsQuestionnairesCategory**](docs/InsightsQualityManagementCategoriesApi.md#deleteinsightsquestionnairescategory) | **Delete** /v1/Insights/QualityManagement/Categories/{CategorySid} | 54 *InsightsQualityManagementCategoriesApi* | [**ListInsightsQuestionnairesCategory**](docs/InsightsQualityManagementCategoriesApi.md#listinsightsquestionnairescategory) | **Get** /v1/Insights/QualityManagement/Categories | 55 *InsightsQualityManagementCategoriesApi* | [**UpdateInsightsQuestionnairesCategory**](docs/InsightsQualityManagementCategoriesApi.md#updateinsightsquestionnairescategory) | **Post** /v1/Insights/QualityManagement/Categories/{CategorySid} | 56 *InsightsQualityManagementQuestionnairesApi* | [**CreateInsightsQuestionnaires**](docs/InsightsQualityManagementQuestionnairesApi.md#createinsightsquestionnaires) | **Post** /v1/Insights/QualityManagement/Questionnaires | 57 *InsightsQualityManagementQuestionnairesApi* | [**DeleteInsightsQuestionnaires**](docs/InsightsQualityManagementQuestionnairesApi.md#deleteinsightsquestionnaires) | **Delete** /v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid} | 58 *InsightsQualityManagementQuestionnairesApi* | [**FetchInsightsQuestionnaires**](docs/InsightsQualityManagementQuestionnairesApi.md#fetchinsightsquestionnaires) | **Get** /v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid} | 59 *InsightsQualityManagementQuestionnairesApi* | [**ListInsightsQuestionnaires**](docs/InsightsQualityManagementQuestionnairesApi.md#listinsightsquestionnaires) | **Get** /v1/Insights/QualityManagement/Questionnaires | 60 *InsightsQualityManagementQuestionnairesApi* | [**UpdateInsightsQuestionnaires**](docs/InsightsQualityManagementQuestionnairesApi.md#updateinsightsquestionnaires) | **Post** /v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid} | 61 *InsightsQualityManagementQuestionsApi* | [**CreateInsightsQuestionnairesQuestion**](docs/InsightsQualityManagementQuestionsApi.md#createinsightsquestionnairesquestion) | **Post** /v1/Insights/QualityManagement/Questions | 62 *InsightsQualityManagementQuestionsApi* | [**DeleteInsightsQuestionnairesQuestion**](docs/InsightsQualityManagementQuestionsApi.md#deleteinsightsquestionnairesquestion) | **Delete** /v1/Insights/QualityManagement/Questions/{QuestionSid} | 63 *InsightsQualityManagementQuestionsApi* | [**ListInsightsQuestionnairesQuestion**](docs/InsightsQualityManagementQuestionsApi.md#listinsightsquestionnairesquestion) | **Get** /v1/Insights/QualityManagement/Questions | 64 *InsightsQualityManagementQuestionsApi* | [**UpdateInsightsQuestionnairesQuestion**](docs/InsightsQualityManagementQuestionsApi.md#updateinsightsquestionnairesquestion) | **Post** /v1/Insights/QualityManagement/Questions/{QuestionSid} | 65 *InsightsQualityManagementSettingsAnswerSetsApi* | [**FetchInsightsSettingsAnswersets**](docs/InsightsQualityManagementSettingsAnswerSetsApi.md#fetchinsightssettingsanswersets) | **Get** /v1/Insights/QualityManagement/Settings/AnswerSets | 66 *InsightsQualityManagementSettingsCommentTagsApi* | [**FetchInsightsSettingsComment**](docs/InsightsQualityManagementSettingsCommentTagsApi.md#fetchinsightssettingscomment) | **Get** /v1/Insights/QualityManagement/Settings/CommentTags | 67 *InsightsSegmentsApi* | [**ListInsightsSegments**](docs/InsightsSegmentsApi.md#listinsightssegments) | **Get** /v1/Insights/Segments | 68 *InsightsSessionApi* | [**CreateInsightsSession**](docs/InsightsSessionApi.md#createinsightssession) | **Post** /v1/Insights/Session | 69 *InsightsUserRolesApi* | [**FetchInsightsUserRoles**](docs/InsightsUserRolesApi.md#fetchinsightsuserroles) | **Get** /v1/Insights/UserRoles | 70 *InteractionsApi* | [**CreateInteraction**](docs/InteractionsApi.md#createinteraction) | **Post** /v1/Interactions | 71 *InteractionsApi* | [**FetchInteraction**](docs/InteractionsApi.md#fetchinteraction) | **Get** /v1/Interactions/{Sid} | 72 *InteractionsChannelsApi* | [**FetchInteractionChannel**](docs/InteractionsChannelsApi.md#fetchinteractionchannel) | **Get** /v1/Interactions/{InteractionSid}/Channels/{Sid} | 73 *InteractionsChannelsApi* | [**ListInteractionChannel**](docs/InteractionsChannelsApi.md#listinteractionchannel) | **Get** /v1/Interactions/{InteractionSid}/Channels | 74 *InteractionsChannelsApi* | [**UpdateInteractionChannel**](docs/InteractionsChannelsApi.md#updateinteractionchannel) | **Post** /v1/Interactions/{InteractionSid}/Channels/{Sid} | 75 *InteractionsChannelsInvitesApi* | [**CreateInteractionChannelInvite**](docs/InteractionsChannelsInvitesApi.md#createinteractionchannelinvite) | **Post** /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites | 76 *InteractionsChannelsInvitesApi* | [**ListInteractionChannelInvite**](docs/InteractionsChannelsInvitesApi.md#listinteractionchannelinvite) | **Get** /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites | 77 *InteractionsChannelsParticipantsApi* | [**CreateInteractionChannelParticipant**](docs/InteractionsChannelsParticipantsApi.md#createinteractionchannelparticipant) | **Post** /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants | 78 *InteractionsChannelsParticipantsApi* | [**ListInteractionChannelParticipant**](docs/InteractionsChannelsParticipantsApi.md#listinteractionchannelparticipant) | **Get** /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants | 79 *InteractionsChannelsParticipantsApi* | [**UpdateInteractionChannelParticipant**](docs/InteractionsChannelsParticipantsApi.md#updateinteractionchannelparticipant) | **Post** /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid} | 80 *PluginServiceConfigurationsApi* | [**CreatePluginConfiguration**](docs/PluginServiceConfigurationsApi.md#createpluginconfiguration) | **Post** /v1/PluginService/Configurations | 81 *PluginServiceConfigurationsApi* | [**FetchPluginConfiguration**](docs/PluginServiceConfigurationsApi.md#fetchpluginconfiguration) | **Get** /v1/PluginService/Configurations/{Sid} | 82 *PluginServiceConfigurationsApi* | [**ListPluginConfiguration**](docs/PluginServiceConfigurationsApi.md#listpluginconfiguration) | **Get** /v1/PluginService/Configurations | 83 *PluginServiceConfigurationsArchiveApi* | [**UpdatePluginConfigurationArchive**](docs/PluginServiceConfigurationsArchiveApi.md#updatepluginconfigurationarchive) | **Post** /v1/PluginService/Configurations/{Sid}/Archive | 84 *PluginServiceConfigurationsPluginsApi* | [**FetchConfiguredPlugin**](docs/PluginServiceConfigurationsPluginsApi.md#fetchconfiguredplugin) | **Get** /v1/PluginService/Configurations/{ConfigurationSid}/Plugins/{PluginSid} | 85 *PluginServiceConfigurationsPluginsApi* | [**ListConfiguredPlugin**](docs/PluginServiceConfigurationsPluginsApi.md#listconfiguredplugin) | **Get** /v1/PluginService/Configurations/{ConfigurationSid}/Plugins | 86 *PluginServicePluginsApi* | [**CreatePlugin**](docs/PluginServicePluginsApi.md#createplugin) | **Post** /v1/PluginService/Plugins | 87 *PluginServicePluginsApi* | [**FetchPlugin**](docs/PluginServicePluginsApi.md#fetchplugin) | **Get** /v1/PluginService/Plugins/{Sid} | 88 *PluginServicePluginsApi* | [**ListPlugin**](docs/PluginServicePluginsApi.md#listplugin) | **Get** /v1/PluginService/Plugins | 89 *PluginServicePluginsApi* | [**UpdatePlugin**](docs/PluginServicePluginsApi.md#updateplugin) | **Post** /v1/PluginService/Plugins/{Sid} | 90 *PluginServicePluginsArchiveApi* | [**UpdatePluginArchive**](docs/PluginServicePluginsArchiveApi.md#updatepluginarchive) | **Post** /v1/PluginService/Plugins/{Sid}/Archive | 91 *PluginServicePluginsVersionsApi* | [**CreatePluginVersion**](docs/PluginServicePluginsVersionsApi.md#createpluginversion) | **Post** /v1/PluginService/Plugins/{PluginSid}/Versions | 92 *PluginServicePluginsVersionsApi* | [**FetchPluginVersion**](docs/PluginServicePluginsVersionsApi.md#fetchpluginversion) | **Get** /v1/PluginService/Plugins/{PluginSid}/Versions/{Sid} | 93 *PluginServicePluginsVersionsApi* | [**ListPluginVersion**](docs/PluginServicePluginsVersionsApi.md#listpluginversion) | **Get** /v1/PluginService/Plugins/{PluginSid}/Versions | 94 *PluginServicePluginsVersionsArchiveApi* | [**UpdatePluginVersionArchive**](docs/PluginServicePluginsVersionsArchiveApi.md#updatepluginversionarchive) | **Post** /v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}/Archive | 95 *PluginServiceReleasesApi* | [**CreatePluginRelease**](docs/PluginServiceReleasesApi.md#createpluginrelease) | **Post** /v1/PluginService/Releases | 96 *PluginServiceReleasesApi* | [**FetchPluginRelease**](docs/PluginServiceReleasesApi.md#fetchpluginrelease) | **Get** /v1/PluginService/Releases/{Sid} | 97 *PluginServiceReleasesApi* | [**ListPluginRelease**](docs/PluginServiceReleasesApi.md#listpluginrelease) | **Get** /v1/PluginService/Releases | 98 *WebChannelsApi* | [**CreateWebChannel**](docs/WebChannelsApi.md#createwebchannel) | **Post** /v1/WebChannels | 99 *WebChannelsApi* | [**DeleteWebChannel**](docs/WebChannelsApi.md#deletewebchannel) | **Delete** /v1/WebChannels/{Sid} | 100 *WebChannelsApi* | [**FetchWebChannel**](docs/WebChannelsApi.md#fetchwebchannel) | **Get** /v1/WebChannels/{Sid} | 101 *WebChannelsApi* | [**ListWebChannel**](docs/WebChannelsApi.md#listwebchannel) | **Get** /v1/WebChannels | 102 *WebChannelsApi* | [**UpdateWebChannel**](docs/WebChannelsApi.md#updatewebchannel) | **Post** /v1/WebChannels/{Sid} | 103 104 105 ## Documentation For Models 106 107 - [ListInteractionChannelResponse](docs/ListInteractionChannelResponse.md) 108 - [FlexV1InsightsSettingsAnswersets](docs/FlexV1InsightsSettingsAnswersets.md) 109 - [FlexV1InsightsSession](docs/FlexV1InsightsSession.md) 110 - [ListInsightsQuestionnairesQuestionResponse](docs/ListInsightsQuestionnairesQuestionResponse.md) 111 - [FlexV1InteractionChannel](docs/FlexV1InteractionChannel.md) 112 - [ListChannelResponse](docs/ListChannelResponse.md) 113 - [FlexV1InteractionChannelParticipant](docs/FlexV1InteractionChannelParticipant.md) 114 - [ListPluginConfigurationResponse](docs/ListPluginConfigurationResponse.md) 115 - [ListInsightsQuestionnairesCategoryResponse](docs/ListInsightsQuestionnairesCategoryResponse.md) 116 - [ListInsightsQuestionnairesResponse](docs/ListInsightsQuestionnairesResponse.md) 117 - [FlexV1InsightsQuestionnaires](docs/FlexV1InsightsQuestionnaires.md) 118 - [FlexV1ConfiguredPlugin](docs/FlexV1ConfiguredPlugin.md) 119 - [ListInsightsConversationsResponse](docs/ListInsightsConversationsResponse.md) 120 - [FlexV1Interaction](docs/FlexV1Interaction.md) 121 - [FlexV1InsightsQuestionnairesQuestion](docs/FlexV1InsightsQuestionnairesQuestion.md) 122 - [ListFlexFlowResponse](docs/ListFlexFlowResponse.md) 123 - [ListConfiguredPluginResponse](docs/ListConfiguredPluginResponse.md) 124 - [FlexV1InsightsAssessmentsComment](docs/FlexV1InsightsAssessmentsComment.md) 125 - [FlexV1InteractionChannelInvite](docs/FlexV1InteractionChannelInvite.md) 126 - [FlexV1InsightsUserRoles](docs/FlexV1InsightsUserRoles.md) 127 - [ListPluginResponse](docs/ListPluginResponse.md) 128 - [ListPluginReleaseResponse](docs/ListPluginReleaseResponse.md) 129 - [FlexV1Channel](docs/FlexV1Channel.md) 130 - [ListInsightsAssessmentsResponse](docs/ListInsightsAssessmentsResponse.md) 131 - [FlexV1PluginRelease](docs/FlexV1PluginRelease.md) 132 - [ListInsightsSegmentsResponse](docs/ListInsightsSegmentsResponse.md) 133 - [FlexV1InsightsSettingsComment](docs/FlexV1InsightsSettingsComment.md) 134 - [FlexV1WebChannel](docs/FlexV1WebChannel.md) 135 - [FlexV1PluginConfigurationArchive](docs/FlexV1PluginConfigurationArchive.md) 136 - [FlexV1PluginVersion](docs/FlexV1PluginVersion.md) 137 - [FlexV1InsightsSegments](docs/FlexV1InsightsSegments.md) 138 - [FlexV1PluginConfiguration](docs/FlexV1PluginConfiguration.md) 139 - [FlexV1PluginArchive](docs/FlexV1PluginArchive.md) 140 - [ListInteractionChannelParticipantResponse](docs/ListInteractionChannelParticipantResponse.md) 141 - [FlexV1FlexFlow](docs/FlexV1FlexFlow.md) 142 - [ListInsightsAssessmentsCommentResponse](docs/ListInsightsAssessmentsCommentResponse.md) 143 - [ListWebChannelResponse](docs/ListWebChannelResponse.md) 144 - [FlexV1Configuration](docs/FlexV1Configuration.md) 145 - [FlexV1InsightsAssessments](docs/FlexV1InsightsAssessments.md) 146 - [FlexV1InsightsQuestionnairesCategory](docs/FlexV1InsightsQuestionnairesCategory.md) 147 - [FlexV1InsightsConversations](docs/FlexV1InsightsConversations.md) 148 - [ListPluginVersionResponse](docs/ListPluginVersionResponse.md) 149 - [FlexV1ProvisioningStatus](docs/FlexV1ProvisioningStatus.md) 150 - [FlexV1Plugin](docs/FlexV1Plugin.md) 151 - [FlexV1PluginVersionArchive](docs/FlexV1PluginVersionArchive.md) 152 - [ListChannelResponseMeta](docs/ListChannelResponseMeta.md) 153 - [ListInteractionChannelInviteResponse](docs/ListInteractionChannelInviteResponse.md) 154 155 156 ## Documentation For Authorization 157 158 159 160 ## accountSid_authToken 161 162 - **Type**: HTTP basic authentication 163 164 Example 165 166 ```golang 167 auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{ 168 UserName: "username", 169 Password: "password", 170 }) 171 r, err := client.Service.Operation(auth, args) 172 ``` 173