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, AssessmentsList, AssessmentsPage, ChannelContext, ChannelInstance, ChannelList, ChannelPage, ConfigurationContext, ConfigurationInstance, ConfigurationList, ConfigurationPage, FlexFlowContext, FlexFlowInstance, FlexFlowList, FlexFlowPage, InsightsAssessmentsCommentInstance, InsightsAssessmentsCommentList, InsightsAssessmentsCommentPage, InsightsConversationsInstance, InsightsConversationsList, InsightsConversationsPage, InsightsQuestionnairesCategoryContext, InsightsQuestionnairesCategoryInstance, InsightsQuestionnairesCategoryList, InsightsQuestionnairesCategoryPage, InsightsQuestionnairesContext, InsightsQuestionnairesInstance, InsightsQuestionnairesList, InsightsQuestionnairesPage, InsightsQuestionnairesQuestionContext, InsightsQuestionnairesQuestionInstance, InsightsQuestionnairesQuestionList, InsightsQuestionnairesQuestionPage, InsightsSegmentsInstance, InsightsSegmentsList, InsightsSegmentsPage, InsightsSessionContext, InsightsSessionInstance, InsightsSessionList, InsightsSessionPage, InsightsSettingsAnswerSetsInstance, InsightsSettingsAnswerSetsList, InsightsSettingsAnswerSetsPage, InsightsSettingsCommentInstance, InsightsSettingsCommentList, InsightsSettingsCommentPage, InsightsUserRolesContext, InsightsUserRolesInstance, InsightsUserRolesList, InsightsUserRolesPage, InteractionContext, InteractionInstance, InteractionList, InteractionPage, PluginArchiveContext, PluginArchiveInstance, PluginArchiveList, PluginArchivePage, PluginConfigurationArchiveContext, PluginConfigurationArchiveInstance, PluginConfigurationArchiveList, PluginConfigurationArchivePage, PluginConfigurationContext, PluginConfigurationInstance, PluginConfigurationList, PluginConfigurationPage, PluginContext, PluginInstance, PluginList, PluginPage, PluginReleaseContext, PluginReleaseInstance, PluginReleaseList, PluginReleasePage, PluginVersionArchiveContext, PluginVersionArchiveInstance, PluginVersionArchiveList, PluginVersionArchivePage, ProvisioningStatusContext, ProvisioningStatusInstance, ProvisioningStatusList, ProvisioningStatusPage, WebChannelContext, WebChannelInstance, WebChannelList, WebChannelPage

Instance Attribute Summary

Attributes inherited from Version

#domain

Instance Method Summary collapse

Methods inherited from Version

#absolute_url, #create, #delete, #exception, #fetch, #page, #patch, #read_limits, #relative_uri, #request, #stream, #update

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 



53
54
55
56
57
58
59
60
61
62
 
# 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 



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

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 



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

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

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



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

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 



98
99
100
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 98

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

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



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

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

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



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 110

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 



124
125
126
127
128
129
130
131
132
133
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 124

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 



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 138

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 



150
151
152
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 150

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

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



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

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

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



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

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

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



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

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

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



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

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

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



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 177

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 



205
206
207
208
209
210
211
212
213
214
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 205

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 



233
234
235
236
237
238
239
240
241
242
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 233

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 



219
220
221
222
223
224
225
226
227
228
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 219

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 



247
248
249
250
251
252
253
254
255
256
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 247

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 



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 262

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
    else
        PluginVersionArchiveContext.new(self, plugin_sid, sid)
    end
end

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



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 191

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 



295
296
297
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 295

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

#to_s ⇒ Object

Provide a user friendly representation



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

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

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



302
303
304
305
306
307
308
309
310
311
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 302

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