Class: Twilio::REST::FlexApi::V1::InteractionInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/interaction.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ InteractionInstance

Initialize the InteractionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Interaction resource.

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

    The SID of the Call resource to fetch.



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 166

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'channel' => payload['channel'],
        'routing' => payload['routing'],
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#channel ⇒ Hash

Returns A JSON object that defines the Interaction’s communication channel and includes details about the channel. See the [Outbound SMS](www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) and [inbound (API-initiated)](www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#api-initiated-contact) Channel object examples.

Returns:



202
203
204
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 202

def channel
    @properties['channel']
end

#channels ⇒ channels

Access the channels

Returns:



235
236
237
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 235

def channels
    context.channels
end

#context ⇒ InteractionContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



187
188
189
190
191
192
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 187

def context
    unless @instance_context
        @instance_context = InteractionContext.new(@version , @params['sid'])
    end
    @instance_context
end

#fetch ⇒ InteractionInstance

Fetch the InteractionInstance

Returns:



227
228
229
230
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 227

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



248
249
250
251
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 248

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.FlexApi.V1.InteractionInstance #{values}>"
end

#links ⇒ Hash

Returns:

  • (Hash) 


220
221
222
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 220

def links
    @properties['links']
end

#routing ⇒ Hash

Returns A JSON Object representing the routing rules for the Interaction Channel. See [Outbound SMS Example](www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) for an example Routing object. The Interactions resource uses TaskRouter for all routing functionality. All attributes in the Routing object on your Interaction request body are added “as is” to the task. For a list of known attributes consumed by the Flex UI and/or Flex Insights, see [Known Task Attributes](www.twilio.com/docs/flex/developer/conversations/interactions-api#task-attributes).

Returns:



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

def routing
    @properties['routing']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



196
197
198
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 196

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



241
242
243
244
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 241

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.FlexApi.V1.InteractionInstance #{values}>"
end

#url ⇒ String

Returns:

  • (String) 


214
215
216
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 214

def url
    @properties['url']
end