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/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_answersets.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, InsightsQuestionnairesCategoryContext, InsightsQuestionnairesCategoryInstance, InsightsQuestionnairesCategoryList, InsightsQuestionnairesCategoryPage, InsightsQuestionnairesContext, InsightsQuestionnairesInstance, InsightsQuestionnairesList, InsightsQuestionnairesPage, InsightsQuestionnairesQuestionContext, InsightsQuestionnairesQuestionInstance, InsightsQuestionnairesQuestionList, InsightsQuestionnairesQuestionPage, InsightsSegmentsContext, InsightsSegmentsInstance, InsightsSegmentsList, InsightsSegmentsPage, InsightsSessionContext, InsightsSessionInstance, InsightsSessionList, InsightsSessionPage, InsightsSettingsAnswerSetsInstance, InsightsSettingsAnswerSetsList, InsightsSettingsAnswerSetsPage, InsightsSettingsCommentInstance, InsightsSettingsCommentList, InsightsSettingsCommentPage, InsightsUserRolesContext, InsightsUserRolesInstance, InsightsUserRolesList, InsightsUserRolesPage, InteractionContext, InteractionInstance, InteractionList, InteractionPage, 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



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 15

def initialize(domain)
  super
  @version = 'v1'
  @channel = nil
  @configuration = nil
  @flex_flow = nil
  @assessments = nil
  @insights_assessments_comment = 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
  @web_channel = nil
end

Instance Method Details

#assessments(assessment_id = :unset) ⇒ Twilio::REST::Flex_api::V1::AssessmentsContext, Twilio::REST::Flex_api::V1::AssessmentsList

Parameters:

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

    The id of the assessment to be modified

Returns:

  • (Twilio::REST::Flex_api::V1::AssessmentsContext) —

    if assessment_id was passed.

  • (Twilio::REST::Flex_api::V1::AssessmentsList) 


75
76
77
78
79
80
81
82
83
84
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 75

def assessments(assessment_id=:unset)
  if assessment_id.nil?
      raise ArgumentError, 'assessment_id cannot be nil'
  end
  if assessment_id == :unset
      @assessments ||= AssessmentsList.new self
  else
      AssessmentsContext.new(self, assessment_id)
  end
end

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

Parameters:

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

    The SID of the Flex chat channel resource to fetch.

Returns:

  • (Twilio::REST::Flex_api::V1::ChannelContext) —

    if sid was passed.

  • (Twilio::REST::Flex_api::V1::ChannelList) 


39
40
41
42
43
44
45
46
47
48
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 39

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::Flex_api::V1::ConfigurationContext

Returns:

  • (Twilio::REST::Flex_api::V1::ConfigurationContext) 


52
53
54
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 52

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

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

Parameters:

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

    The SID of the Flex Flow resource to fetch.

Returns:

  • (Twilio::REST::Flex_api::V1::FlexFlowContext) —

    if sid was passed.

  • (Twilio::REST::Flex_api::V1::FlexFlowList) 


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

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::Flex_api::V1::InsightsAssessmentsCommentContext

Returns:

  • (Twilio::REST::Flex_api::V1::InsightsAssessmentsCommentContext) 


88
89
90
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 88

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

#insights_questionnaires(id = :unset) ⇒ Twilio::REST::Flex_api::V1::InsightsQuestionnairesContext, Twilio::REST::Flex_api::V1::InsightsQuestionnairesList

Parameters:

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

    The unique ID of the questionnaire

Returns:

  • (Twilio::REST::Flex_api::V1::InsightsQuestionnairesContext) —

    if id was passed.

  • (Twilio::REST::Flex_api::V1::InsightsQuestionnairesList) 


96
97
98
99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 96

def insights_questionnaires(id=:unset)
  if id.nil?
      raise ArgumentError, 'id cannot be nil'
  end
  if id == :unset
      @insights_questionnaires ||= InsightsQuestionnairesList.new self
  else
      InsightsQuestionnairesContext.new(self, id)
  end
end

#insights_questionnaires_category(category_id = :unset) ⇒ Twilio::REST::Flex_api::V1::InsightsQuestionnairesCategoryContext, Twilio::REST::Flex_api::V1::InsightsQuestionnairesCategoryList

Parameters:

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

    The ID of the category to be update

Returns:

  • (Twilio::REST::Flex_api::V1::InsightsQuestionnairesCategoryContext) —

    if category_id was passed.

  • (Twilio::REST::Flex_api::V1::InsightsQuestionnairesCategoryList) 


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

def insights_questionnaires_category(category_id=:unset)
  if category_id.nil?
      raise ArgumentError, 'category_id cannot be nil'
  end
  if category_id == :unset
      @insights_questionnaires_category ||= InsightsQuestionnairesCategoryList.new self
  else
      InsightsQuestionnairesCategoryContext.new(self, category_id)
  end
end

#insights_questionnaires_question(question_id = :unset) ⇒ Twilio::REST::Flex_api::V1::InsightsQuestionnairesQuestionContext, Twilio::REST::Flex_api::V1::InsightsQuestionnairesQuestionList

Parameters:

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

    The unique ID of the question

Returns:

  • (Twilio::REST::Flex_api::V1::InsightsQuestionnairesQuestionContext) —

    if question_id was passed.

  • (Twilio::REST::Flex_api::V1::InsightsQuestionnairesQuestionList) 


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

def insights_questionnaires_question(question_id=:unset)
  if question_id.nil?
      raise ArgumentError, 'question_id cannot be nil'
  end
  if question_id == :unset
      @insights_questionnaires_question ||= InsightsQuestionnairesQuestionList.new self
  else
      InsightsQuestionnairesQuestionContext.new(self, question_id)
  end
end

#insights_segments(segment_id = :unset) ⇒ Twilio::REST::Flex_api::V1::InsightsSegmentsContext, Twilio::REST::Flex_api::V1::InsightsSegmentsList

Parameters:

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

    To unique id of the segment

Returns:

  • (Twilio::REST::Flex_api::V1::InsightsSegmentsContext) —

    if segment_id was passed.

  • (Twilio::REST::Flex_api::V1::InsightsSegmentsList) 


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

def insights_segments(segment_id=:unset)
  if segment_id.nil?
      raise ArgumentError, 'segment_id cannot be nil'
  end
  if segment_id == :unset
      @insights_segments ||= InsightsSegmentsList.new self
  else
      InsightsSegmentsContext.new(self, segment_id)
  end
end

#insights_session ⇒ Twilio::REST::Flex_api::V1::InsightsSessionContext

Returns:

  • (Twilio::REST::Flex_api::V1::InsightsSessionContext) 


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

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

#insights_settings_answer_sets ⇒ Twilio::REST::Flex_api::V1::InsightsSettingsAnswerSetsContext

Returns:

  • (Twilio::REST::Flex_api::V1::InsightsSettingsAnswerSetsContext) 


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::Flex_api::V1::InsightsSettingsCommentContext

Returns:

  • (Twilio::REST::Flex_api::V1::InsightsSettingsCommentContext) 


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

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

#insights_user_roles ⇒ Twilio::REST::Flex_api::V1::InsightsUserRolesContext

Returns:

  • (Twilio::REST::Flex_api::V1::InsightsUserRolesContext) 


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

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

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

Parameters:

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

    The SID of the Interaction resource to fetch.

Returns:

  • (Twilio::REST::Flex_api::V1::InteractionContext) —

    if sid was passed.

  • (Twilio::REST::Flex_api::V1::InteractionList) 


180
181
182
183
184
185
186
187
188
189
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 180

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

#to_s ⇒ Object

Provide a user friendly representation



208
209
210
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 208

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

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

Parameters:

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

    The SID of the WebChannel resource to fetch.

Returns:

  • (Twilio::REST::Flex_api::V1::WebChannelContext) —

    if sid was passed.

  • (Twilio::REST::Flex_api::V1::WebChannelList) 


195
196
197
198
199
200
201
202
203
204
 
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 195

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