Class: Twilio::REST::FlexApi::V2::WebChannelsList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api/v2/web_channels.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ WebChannelsList

Initialize the WebChannelsList

Parameters:

  • version (Version) —

    Version that contains the resource



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/flex_api/v2/web_channels.rb', line 18

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/WebChats"
end

Instance Method Details

#create(address_sid: nil, chat_friendly_name: :unset, customer_friendly_name: :unset, pre_engagement_data: :unset) ⇒ WebChannelsInstance

Create the WebChannelsInstance

Parameters:

  • address_sid (String) (defaults to: nil) —

    The SID of the Conversations Address. See Address Configuration Resource for configuration details. When a conversation is created on the Flex backend, the callback URL will be set to the corresponding Studio Flow SID or webhook URL in your address configuration.

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

    The Conversation’s friendly name. See the Conversation resource for an example.

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

    The Conversation participant’s friendly name. See the Conversation Participant Resource for an example.

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

    The pre-engagement data.

Returns:



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/flex_api/v2/web_channels.rb', line 44

def create(address_sid: nil, chat_friendly_name: :unset, customer_friendly_name: :unset, pre_engagement_data: :unset)
  data = Twilio::Values.of({
      'AddressSid' => address_sid,
      'ChatFriendlyName' => chat_friendly_name,
      'CustomerFriendlyName' => customer_friendly_name,
      'PreEngagementData' => pre_engagement_data,
  })

  payload = @version.create('POST', @uri, data: data)

  WebChannelsInstance.new(@version, payload, )
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
  '#<Twilio.FlexApi.V2.WebChannelsList>'
end