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/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/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/insights_conversations.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/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/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, 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, #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
 
# 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
    @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:



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 47

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:



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 61

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) 


73
74
75
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 73

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:



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 80

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:



92
93
94
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 92

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

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

Returns:



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

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:



104
105
106
107
108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 104

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:



118
119
120
121
122
123
124
125
126
127
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 118

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:



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 132

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:



144
145
146
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 144

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

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

Returns:

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


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

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

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

Returns:



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

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

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

Returns:



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

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) 


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

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:



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 171

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

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

Returns:

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


183
184
185
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 183

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

#to_s ⇒ Object

Provide a user friendly representation



202
203
204
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 202

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:



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

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