Class: Twilio::REST::FlexApi::V1

Inherits:
Version
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1.rb,
lib/twilio-ruby/rest/flex_api/v1/plugin.rb,
lib/twilio-ruby/rest/flex_api/v1/channel.rb,
lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb,
lib/twilio-ruby/rest/flex_api/v1/assessments.rb,
lib/twilio-ruby/rest/flex_api/v1/interaction.rb,
lib/twilio-ruby/rest/flex_api/v1/web_channel.rb,
lib/twilio-ruby/rest/flex_api/v1/configuration.rb,
lib/twilio-ruby/rest/flex_api/v1/plugin_archive.rb,
lib/twilio-ruby/rest/flex_api/v1/plugin_release.rb,
lib/twilio-ruby/rest/flex_api/v1/insights_session.rb,
lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb,
lib/twilio-ruby/rest/flex_api/v1/insights_user_roles.rb,
lib/twilio-ruby/rest/flex_api/v1/provisioning_status.rb,
lib/twilio-ruby/rest/flex_api/v1/plugin_configuration.rb,
lib/twilio-ruby/rest/flex_api/v1/insights_conversations.rb,
lib/twilio-ruby/rest/flex_api/v1/plugin/plugin_versions.rb,
lib/twilio-ruby/rest/flex_api/v1/plugin_version_archive.rb,
lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires.rb,
lib/twilio-ruby/rest/flex_api/v1/insights_settings_comment.rb,
lib/twilio-ruby/rest/flex_api/v1/insights_assessments_comment.rb,
lib/twilio-ruby/rest/flex_api/v1/plugin_configuration_archive.rb,
lib/twilio-ruby/rest/flex_api/v1/insights_settings_answer_sets.rb,
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb,
lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_category.rb,
lib/twilio-ruby/rest/flex_api/v1/insights_questionnaires_question.rb,
lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb,
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_transfer.rb,
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb,
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb

Defined Under Namespace

Classes: AssessmentsContext, AssessmentsInstance, AssessmentsInstanceMetadata, AssessmentsList, AssessmentsListResponse, AssessmentsPage, AssessmentsPageMetadata, ChannelContext, ChannelInstance, ChannelInstanceMetadata, ChannelList, ChannelListResponse, ChannelPage, ChannelPageMetadata, ConfigurationContext, ConfigurationInstance, ConfigurationInstanceMetadata, ConfigurationList, ConfigurationListResponse, ConfigurationPage, ConfigurationPageMetadata, FlexFlowContext, FlexFlowInstance, FlexFlowInstanceMetadata, FlexFlowList, FlexFlowListResponse, FlexFlowPage, FlexFlowPageMetadata, InsightsAssessmentsCommentInstance, InsightsAssessmentsCommentList, InsightsAssessmentsCommentListResponse, InsightsAssessmentsCommentPage, InsightsAssessmentsCommentPageMetadata, InsightsConversationsInstance, InsightsConversationsList, InsightsConversationsListResponse, InsightsConversationsPage, InsightsConversationsPageMetadata, InsightsQuestionnairesCategoryContext, InsightsQuestionnairesCategoryInstance, InsightsQuestionnairesCategoryInstanceMetadata, InsightsQuestionnairesCategoryList, InsightsQuestionnairesCategoryListResponse, InsightsQuestionnairesCategoryPage, InsightsQuestionnairesCategoryPageMetadata, InsightsQuestionnairesContext, InsightsQuestionnairesInstance, InsightsQuestionnairesInstanceMetadata, InsightsQuestionnairesList, InsightsQuestionnairesListResponse, InsightsQuestionnairesPage, InsightsQuestionnairesPageMetadata, InsightsQuestionnairesQuestionContext, InsightsQuestionnairesQuestionInstance, InsightsQuestionnairesQuestionInstanceMetadata, InsightsQuestionnairesQuestionList, InsightsQuestionnairesQuestionListResponse, InsightsQuestionnairesQuestionPage, InsightsQuestionnairesQuestionPageMetadata, InsightsSegmentsInstance, InsightsSegmentsList, InsightsSegmentsListResponse, InsightsSegmentsPage, InsightsSegmentsPageMetadata, InsightsSessionContext, InsightsSessionInstance, InsightsSessionInstanceMetadata, InsightsSessionList, InsightsSessionListResponse, InsightsSessionPage, InsightsSessionPageMetadata, InsightsSettingsAnswerSetsInstance, InsightsSettingsAnswerSetsList, InsightsSettingsAnswerSetsListResponse, InsightsSettingsAnswerSetsPage, InsightsSettingsAnswerSetsPageMetadata, InsightsSettingsCommentInstance, InsightsSettingsCommentList, InsightsSettingsCommentListResponse, InsightsSettingsCommentPage, InsightsSettingsCommentPageMetadata, InsightsUserRolesContext, InsightsUserRolesInstance, InsightsUserRolesInstanceMetadata, InsightsUserRolesList, InsightsUserRolesListResponse, InsightsUserRolesPage, InsightsUserRolesPageMetadata, InteractionContext, InteractionInstance, InteractionInstanceMetadata, InteractionList, InteractionListResponse, InteractionPage, InteractionPageMetadata, PluginArchiveContext, PluginArchiveInstance, PluginArchiveInstanceMetadata, PluginArchiveList, PluginArchiveListResponse, PluginArchivePage, PluginArchivePageMetadata, PluginConfigurationArchiveContext, PluginConfigurationArchiveInstance, PluginConfigurationArchiveInstanceMetadata, PluginConfigurationArchiveList, PluginConfigurationArchiveListResponse, PluginConfigurationArchivePage, PluginConfigurationArchivePageMetadata, PluginConfigurationContext, PluginConfigurationInstance, PluginConfigurationInstanceMetadata, PluginConfigurationList, PluginConfigurationListResponse, PluginConfigurationPage, PluginConfigurationPageMetadata, PluginContext, PluginInstance, PluginInstanceMetadata, PluginList, PluginListResponse, PluginPage, PluginPageMetadata, PluginReleaseContext, PluginReleaseInstance, PluginReleaseInstanceMetadata, PluginReleaseList, PluginReleaseListResponse, PluginReleasePage, PluginReleasePageMetadata, PluginVersionArchiveContext, PluginVersionArchiveInstance, PluginVersionArchiveInstanceMetadata, PluginVersionArchiveList, PluginVersionArchiveListResponse, PluginVersionArchivePage, PluginVersionArchivePageMetadata, ProvisioningStatusContext, ProvisioningStatusInstance, ProvisioningStatusInstanceMetadata, ProvisioningStatusList, ProvisioningStatusListResponse, ProvisioningStatusPage, ProvisioningStatusPageMetadata, WebChannelContext, WebChannelInstance, WebChannelInstanceMetadata, WebChannelList, WebChannelListResponse, WebChannelPage, WebChannelPageMetadata

Instance Attribute Summary

Attributes inherited from Version

#domain, #version

Instance Method Summary collapse

Methods inherited from Version

#absolute_url, #create, #create_with_metadata, #delete, #delete_with_metadata, #exception, #fetch, #fetch_with_metadata, #page, #patch, #read_limits, #relative_uri, #request, #stream, #stream_with_metadata, #update, #update_with_metadata

Constructor Details

#initialize(domain) ⇒ V1

Initialize the V1 version of FlexApi



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 21

def initialize(domain)
    super
    @version = 'v1'
    @assessments = nil
    @channel = nil
    @configuration = nil
    @flex_flow = nil
    @insights_assessments_comment = nil
    @insights_conversations = nil
    @insights_questionnaires = nil
    @insights_questionnaires_category = nil
    @insights_questionnaires_question = nil
    @insights_segments = nil
    @insights_session = nil
    @insights_settings_answer_sets = nil
    @insights_settings_comment = nil
    @insights_user_roles = nil
    @interaction = nil
    @plugins = nil
    @plugin_archive = nil
    @plugin_configurations = nil
    @plugin_configuration_archive = nil
    @plugin_releases = nil
    @plugin_version_archive = nil
    @provisioning_status = nil
    @web_channel = nil
end

Instance Method Details

#assessments(assessment_sid = :unset) ⇒ Twilio::REST::FlexApi::V1::AssessmentsContext, Twilio::REST::FlexApi::V1::AssessmentsList

Parameters:

  • assessment_sid (String) (defaults to: :unset) —

    The SID of the assessment to be modified

Returns:



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 53

def assessments(assessment_sid=:unset)
    if assessment_sid.nil?
        raise ArgumentError, 'assessment_sid cannot be nil'
    end

    if assessment_sid == :unset
        @assessments ||= AssessmentsList.new self
    else
        AssessmentsContext.new(self, assessment_sid)
    end
end

#channel(sid = :unset) ⇒ Twilio::REST::FlexApi::V1::ChannelContext, Twilio::REST::FlexApi::V1::ChannelList

Parameters:

  • sid (String) (defaults to: :unset) —

    The SID of the Flex chat channel resource to fetch.

Returns:



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 68

def channel(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @channel ||= ChannelList.new self
    else
        ChannelContext.new(self, sid)
    end
end

#configuration ⇒ Twilio::REST::FlexApi::V1::configurationContext

Returns:

  • (Twilio::REST::FlexApi::V1::configurationContext) 


81
82
83
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 81

def configuration
    @configuration ||= ConfigurationContext.new self
end

#flex_flow(sid = :unset) ⇒ Twilio::REST::FlexApi::V1::FlexFlowContext, Twilio::REST::FlexApi::V1::FlexFlowList

Parameters:

  • sid (String) (defaults to: :unset) —

    The SID of the Flex Flow resource to fetch.

Returns:



88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 88

def flex_flow(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @flex_flow ||= FlexFlowList.new self
    else
        FlexFlowContext.new(self, sid)
    end
end

#insights_assessments_comment ⇒ Twilio::REST::FlexApi::V1::InsightsAssessmentsCommentList

Returns:



101
102
103
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 101

def insights_assessments_comment
    @insights_assessments_comment ||= InsightsAssessmentsCommentList.new self
end

#insights_conversations ⇒ Twilio::REST::FlexApi::V1::InsightsConversationsList

Returns:



106
107
108
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 106

def insights_conversations
    @insights_conversations ||= InsightsConversationsList.new self
end

#insights_questionnaires(questionnaire_sid = :unset) ⇒ Twilio::REST::FlexApi::V1::InsightsQuestionnairesContext, Twilio::REST::FlexApi::V1::InsightsQuestionnairesList

Parameters:

  • questionnaire_sid (String) (defaults to: :unset) —

    The SID of the questionnaire

Returns:



113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 113

def insights_questionnaires(questionnaire_sid=:unset)
    if questionnaire_sid.nil?
        raise ArgumentError, 'questionnaire_sid cannot be nil'
    end

    if questionnaire_sid == :unset
        @insights_questionnaires ||= InsightsQuestionnairesList.new self
    else
        InsightsQuestionnairesContext.new(self, questionnaire_sid)
    end
end

#insights_questionnaires_category(category_sid = :unset) ⇒ Twilio::REST::FlexApi::V1::InsightsQuestionnairesCategoryContext, Twilio::REST::FlexApi::V1::InsightsQuestionnairesCategoryList

Parameters:

  • category_sid (String) (defaults to: :unset) —

    The SID of the category to be updated

Returns:



128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 128

def insights_questionnaires_category(category_sid=:unset)
    if category_sid.nil?
        raise ArgumentError, 'category_sid cannot be nil'
    end

    if category_sid == :unset
        @insights_questionnaires_category ||= InsightsQuestionnairesCategoryList.new self
    else
        InsightsQuestionnairesCategoryContext.new(self, category_sid)
    end
end

#insights_questionnaires_question(question_sid = :unset) ⇒ Twilio::REST::FlexApi::V1::InsightsQuestionnairesQuestionContext, Twilio::REST::FlexApi::V1::InsightsQuestionnairesQuestionList

Parameters:

  • question_sid (String) (defaults to: :unset) —

    The SID of the question

Returns:



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 143

def insights_questionnaires_question(question_sid=:unset)
    if question_sid.nil?
        raise ArgumentError, 'question_sid cannot be nil'
    end

    if question_sid == :unset
        @insights_questionnaires_question ||= InsightsQuestionnairesQuestionList.new self
    else
        InsightsQuestionnairesQuestionContext.new(self, question_sid)
    end
end

#insights_segments ⇒ Twilio::REST::FlexApi::V1::InsightsSegmentsList

Returns:



156
157
158
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 156

def insights_segments
    @insights_segments ||= InsightsSegmentsList.new self
end

#insights_session ⇒ Twilio::REST::FlexApi::V1::insightsSessionContext

Returns:

  • (Twilio::REST::FlexApi::V1::insightsSessionContext) 


161
162
163
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 161

def insights_session
    @insights_session ||= InsightsSessionContext.new self
end

#insights_settings_answer_sets ⇒ Twilio::REST::FlexApi::V1::InsightsSettingsAnswerSetsList

Returns:



166
167
168
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 166

def insights_settings_answer_sets
    @insights_settings_answer_sets ||= InsightsSettingsAnswerSetsList.new self
end

#insights_settings_comment ⇒ Twilio::REST::FlexApi::V1::InsightsSettingsCommentList

Returns:



171
172
173
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 171

def insights_settings_comment
    @insights_settings_comment ||= InsightsSettingsCommentList.new self
end

#insights_user_roles ⇒ Twilio::REST::FlexApi::V1::insightsUserRolesContext

Returns:

  • (Twilio::REST::FlexApi::V1::insightsUserRolesContext) 


176
177
178
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 176

def insights_user_roles
    @insights_user_roles ||= InsightsUserRolesContext.new self
end

#interaction(sid = :unset) ⇒ Twilio::REST::FlexApi::V1::InteractionContext, Twilio::REST::FlexApi::V1::InteractionList

Parameters:

  • sid (String) (defaults to: :unset) —

    The SID of the Interaction resource to fetch.

Returns:



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 183

def interaction(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @interaction ||= InteractionList.new self
    else
        InteractionContext.new(self, sid)
    end
end

#plugin_archive(sid = :unset) ⇒ Twilio::REST::FlexApi::V1::PluginArchiveContext, Twilio::REST::FlexApi::V1::PluginArchiveList

Parameters:

  • sid (String) (defaults to: :unset) —

    The SID of the Flex Plugin resource to archive.

Returns:



213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 213

def plugin_archive(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @plugin_archive ||= PluginArchiveList.new self
    else
        PluginArchiveContext.new(self, sid)
    end
end

#plugin_configuration_archive(sid = :unset) ⇒ Twilio::REST::FlexApi::V1::PluginConfigurationArchiveContext, Twilio::REST::FlexApi::V1::PluginConfigurationArchiveList

Parameters:

  • sid (String) (defaults to: :unset) —

    The SID of the Flex Plugin Configuration resource to archive.

Returns:



243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 243

def plugin_configuration_archive(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @plugin_configuration_archive ||= PluginConfigurationArchiveList.new self
    else
        PluginConfigurationArchiveContext.new(self, sid)
    end
end

#plugin_configurations(sid = :unset) ⇒ Twilio::REST::FlexApi::V1::PluginConfigurationContext, Twilio::REST::FlexApi::V1::PluginConfigurationList

Parameters:

  • sid (String) (defaults to: :unset) —

    The SID of the Flex Plugin Configuration resource to fetch.

Returns:



228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 228

def plugin_configurations(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @plugin_configurations ||= PluginConfigurationList.new self
    else
        PluginConfigurationContext.new(self, sid)
    end
end

#plugin_releases(sid = :unset) ⇒ Twilio::REST::FlexApi::V1::PluginReleaseContext, Twilio::REST::FlexApi::V1::PluginReleaseList

Parameters:

  • sid (String) (defaults to: :unset) —

    The SID of the Flex Plugin Release resource to fetch.

Returns:



258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 258

def plugin_releases(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @plugin_releases ||= PluginReleaseList.new self
    else
        PluginReleaseContext.new(self, sid)
    end
end

#plugin_version_archive(plugin_sid = :unset, sid = :unset) ⇒ Twilio::REST::FlexApi::V1::PluginVersionArchiveContext, Twilio::REST::FlexApi::V1::PluginVersionArchiveList

Parameters:

  • plugin_sid (String) (defaults to: :unset) —

    The SID of the Flex Plugin the resource to belongs to.

  • sid (String) (defaults to: :unset) —

    The SID of the Flex Plugin Version resource to archive.

Returns:



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 274

def plugin_version_archive(plugin_sid=:unset, sid=:unset)
    if plugin_sid.nil?
        raise ArgumentError, 'plugin_sid cannot be nil'
    end
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if plugin_sid == :unset && sid == :unset
        @plugin_version_archive ||= PluginVersionArchiveList.new self
    elsif plugin_sid != :unset && sid == :unset
        PluginVersionArchiveList.new(self, plugin_sid: plugin_sid)
    else
        PluginVersionArchiveContext.new(self, plugin_sid, sid)
    end
end

#plugins(sid = :unset) ⇒ Twilio::REST::FlexApi::V1::PluginContext, Twilio::REST::FlexApi::V1::PluginList

Parameters:

  • sid (String) (defaults to: :unset) —

    The SID of the Flex Plugin resource to fetch.

Returns:



198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 198

def plugins(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @plugins ||= PluginList.new self
    else
        PluginContext.new(self, sid)
    end
end

#provisioning_status ⇒ Twilio::REST::FlexApi::V1::provisioningStatusContext

Returns:

  • (Twilio::REST::FlexApi::V1::provisioningStatusContext) 


313
314
315
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 313

def provisioning_status
    @provisioning_status ||= ProvisioningStatusContext.new self
end

#to_s ⇒ Object

Provide a user friendly representation



333
334
335
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 333

def to_s
    '<Twilio::REST::FlexApi::V1>';
end

#web_channel(sid = :unset) ⇒ Twilio::REST::FlexApi::V1::WebChannelContext, Twilio::REST::FlexApi::V1::WebChannelList

Parameters:

  • sid (String) (defaults to: :unset) —

    The SID of the WebChannel resource to fetch.

Returns:



320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 320

def web_channel(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @web_channel ||= WebChannelList.new self
    else
        WebChannelContext.new(self, sid)
    end
end