Class: Twilio::REST::FlexApi

Inherits:
Domain
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api.rb,
lib/twilio-ruby/rest/flex_api/v1.rb,
lib/twilio-ruby/rest/flex_api/v2.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/v2/web_channels.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_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_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: V1, V2

Instance Attribute Summary

Attributes inherited from Domain

#client

Instance Method Summary collapse

Methods inherited from Domain

#absolute_url, #request

Constructor Details

#initialize(twilio) ⇒ FlexApi

Initialize the FlexApi Domain



14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 14

def initialize(twilio)
  super

  @base_url = 'https://flex-api.twilio.com'
  @host = 'flex-api.twilio.com'
  @port = 443

  # Versions
  @v1 = nil
  @v2 = nil
end

Instance Method Details

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

Parameters:

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

    The unique id of the assessment

Returns:

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

    if assessment_id was passed.

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


66
67
68
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 66

def assessments(assessment_id=:unset)
  self.v1.assessments(assessment_id)
end

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

Parameters:

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

    The unique string that we created to identify the Channel resource.

Returns:

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

    if sid was passed.

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


43
44
45
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 43

def channel(sid=:unset)
  self.v1.channel(sid)
end

#configuration ⇒ Twilio::REST::Flex_api::V1::ConfigurationInstance

Returns:

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


49
50
51
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 49

def configuration
  self.v1.configuration()
end

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

Parameters:

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

    The unique string that we created to identify the Flex Flow resource.

Returns:

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

    if sid was passed.

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


58
59
60
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 58

def flex_flow(sid=:unset)
  self.v1.flex_flow(sid)
end

#insights_assessments_comment ⇒ Twilio::REST::Flex_api::V1::InsightsAssessmentsCommentInstance

Returns:

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


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

def insights_assessments_comment
  self.v1.insights_assessments_comment()
end

#insights_conversations ⇒ Twilio::REST::Flex_api::V1::InsightsConversationsInstance

Returns:

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


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

def insights_conversations
  self.v1.insights_conversations()
end

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

Parameters:

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

    The unique id of this questionnaire

Returns:

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

    if id was passed.

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


86
87
88
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 86

def insights_questionnaires(id=:unset)
  self.v1.insights_questionnaires(id)
end

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

Parameters:

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

    The unique ID for the category

Returns:

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

    if category_id was passed.

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


94
95
96
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 94

def insights_questionnaires_category(category_id=:unset)
  self.v1.insights_questionnaires_category(category_id)
end

#insights_questionnaires_question(question_id = :unset) ⇒ Twilio::REST::Flex_api::V1::InsightsQuestionnairesQuestionInstance, 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::InsightsQuestionnairesQuestionInstance) —

    if question_id was passed.

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


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

def insights_questionnaires_question(question_id=:unset)
  self.v1.insights_questionnaires_question(question_id)
end

#insights_segments(segment_id = :unset) ⇒ Twilio::REST::Flex_api::V1::InsightsSegmentsInstance, 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::InsightsSegmentsInstance) —

    if segment_id was passed.

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


110
111
112
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 110

def insights_segments(segment_id=:unset)
  self.v1.insights_segments(segment_id)
end

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

Returns:

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


116
117
118
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 116

def insights_session
  self.v1.insights_session()
end

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

Returns:

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


122
123
124
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 122

def insights_settings_answer_sets
  self.v1.insights_settings_answer_sets()
end

#insights_settings_comment ⇒ Twilio::REST::Flex_api::V1::InsightsSettingsCommentInstance

Returns:

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


128
129
130
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 128

def insights_settings_comment
  self.v1.insights_settings_comment()
end

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

Returns:

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


134
135
136
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 134

def insights_user_roles
  self.v1.insights_user_roles()
end

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

Parameters:

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

    The unique string created by Twilio to identify an Interaction resource, prefixed with KD.

Returns:

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

    if sid was passed.

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


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

def interaction(sid=:unset)
  self.v1.interaction(sid)
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#v1 ⇒ Object

Version v1 of flex_api



28
29
30
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 28

def v1
  @v1 ||= V1.new self
end

#v2 ⇒ Object

Version v2 of flex_api



34
35
36
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 34

def v2
  @v2 ||= V2.new self
end

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

Parameters:

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

    The unique string that we created to identify the WebChannel resource.

Returns:

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

    if sid was passed.

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


152
153
154
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 152

def web_channel(sid=:unset)
  self.v1.web_channel(sid)
end

#web_channels ⇒ Twilio::REST::Flex_api::V2::WebChannelsInstance

Returns:

  • (Twilio::REST::Flex_api::V2::WebChannelsInstance) 


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

def web_channels
  self.v2.web_channels()
end