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/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/interaction/interaction_channel.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: ChannelContext, ChannelInstance, ChannelList, ChannelPage, ConfigurationContext, ConfigurationInstance, ConfigurationList, ConfigurationPage, FlexFlowContext, FlexFlowInstance, FlexFlowList, FlexFlowPage, 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
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 15

def initialize(domain)
  super
  @version = 'v1'
  @channel = nil
  @configuration = nil
  @flex_flow = nil
  @interaction = nil
  @web_channel = nil
end

Instance Method Details

#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)

29
30
31
32
33
34
35
36
37
38
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 29

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

#configurationTwilio::REST::Flex_api::V1::ConfigurationContext

Returns:

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

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

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)

50
51
52
53
54
55
56
57
58
59
# File 'lib/twilio-ruby/rest/flex_api/v1.rb', line 50

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

#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)

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

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_sObject

Provide a user friendly representation


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

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)

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

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