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/v1/channel.rb,
lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb,
lib/twilio-ruby/rest/flex_api/v1/web_channel.rb,
lib/twilio-ruby/rest/flex_api/v1/configuration.rb

Defined Under Namespace

Classes: V1

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

Instance Method Details

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

Parameters:

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

    The unique SID identifier of the Flex Chat Channel

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) 


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

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 ID of the FlexFlow

Returns:

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

    if sid was passed.

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


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

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

#to_s ⇒ Object

Provide a user friendly representation



63
64
65
 
# File 'lib/twilio-ruby/rest/flex_api.rb', line 63

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

#v1 ⇒ Object

Version v1 of flex_api



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

def v1
  @v1 ||= V1.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 SID identifier of the Flex Chat Channel

Returns:

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

    if sid was passed.

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


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

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