Class: Twilio::REST::Preview::Proxy::ServiceContext::SessionContext::InteractionInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

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

Initialize the InteractionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique SID identifier of the Service.

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

    The unique SID identifier of the Session.

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

    A 34 character string that uniquely identifies this Interaction.



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 244

def initialize(version, payload, service_sid: nil, session_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'session_sid' => payload['session_sid'],
      'service_sid' => payload['service_sid'],
      'account_sid' => payload['account_sid'],
      'data' => payload['data'],
      'status' => payload['status'],
      'inbound_participant_sid' => payload['inbound_participant_sid'],
      'inbound_resource_sid' => payload['inbound_resource_sid'],
      'inbound_resource_status' => payload['inbound_resource_status'],
      'inbound_resource_type' => payload['inbound_resource_type'],
      'inbound_resource_url' => payload['inbound_resource_url'],
      'outbound_participant_sid' => payload['outbound_participant_sid'],
      'outbound_resource_sid' => payload['outbound_resource_sid'],
      'outbound_resource_status' => payload['outbound_resource_status'],
      'outbound_resource_type' => payload['outbound_resource_type'],
      'outbound_resource_url' => payload['outbound_resource_url'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns Account Sid.

Returns:

  • (String) —

    Account Sid.



315
316
317
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 315

def 
  @properties['account_sid']
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:



283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 283

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

#data ⇒ String

Returns What happened in this Interaction.

Returns:

  • (String) —

    What happened in this Interaction.



321
322
323
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 321

def data
  @properties['data']
end

#date_created ⇒ Time

Returns The date this Interaction was created.

Returns:

  • (Time) —

    The date this Interaction was created



393
394
395
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 393

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Interaction was updated.

Returns:

  • (Time) —

    The date this Interaction was updated



399
400
401
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 399

def date_updated
  @properties['date_updated']
end

#fetch ⇒ InteractionInstance

Fetch a InteractionInstance

Returns:



412
413
414
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 412

def fetch
  context.fetch
end

#inbound_participant_sid ⇒ String

Returns The inbound_participant_sid.

Returns:

  • (String) —

    The inbound_participant_sid



333
334
335
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 333

def inbound_participant_sid
  @properties['inbound_participant_sid']
end

#inbound_resource_sid ⇒ String

Returns The SID of the inbound resource.

Returns:

  • (String) —

    The SID of the inbound resource.



339
340
341
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 339

def inbound_resource_sid
  @properties['inbound_resource_sid']
end

#inbound_resource_status ⇒ interaction.ResourceStatus

Returns The Inbound Resource Status of this Interaction.

Returns:

  • (interaction.ResourceStatus) —

    The Inbound Resource Status of this Interaction



345
346
347
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 345

def inbound_resource_status
  @properties['inbound_resource_status']
end

#inbound_resource_type ⇒ String

Returns The Twilio object type of the inbound resource.

Returns:

  • (String) —

    The Twilio object type of the inbound resource.



351
352
353
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 351

def inbound_resource_type
  @properties['inbound_resource_type']
end

#inbound_resource_url ⇒ String

Returns The URL of the inbound resource.

Returns:

  • (String) —

    The URL of the inbound resource.



357
358
359
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 357

def inbound_resource_url
  @properties['inbound_resource_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



425
426
427
428
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 425

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

#outbound_participant_sid ⇒ String

Returns The outbound_participant_sid.

Returns:

  • (String) —

    The outbound_participant_sid



363
364
365
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 363

def outbound_participant_sid
  @properties['outbound_participant_sid']
end

#outbound_resource_sid ⇒ String

Returns The SID of the outbound resource.

Returns:

  • (String) —

    The SID of the outbound resource.



369
370
371
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 369

def outbound_resource_sid
  @properties['outbound_resource_sid']
end

#outbound_resource_status ⇒ interaction.ResourceStatus

Returns The Outbound Resource Status of this Interaction.

Returns:

  • (interaction.ResourceStatus) —

    The Outbound Resource Status of this Interaction



375
376
377
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 375

def outbound_resource_status
  @properties['outbound_resource_status']
end

#outbound_resource_type ⇒ String

Returns The Twilio object type of the outbound resource.

Returns:

  • (String) —

    The Twilio object type of the outbound resource.



381
382
383
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 381

def outbound_resource_type
  @properties['outbound_resource_type']
end

#outbound_resource_url ⇒ String

Returns The URL of the outbound resource.

Returns:

  • (String) —

    The URL of the outbound resource.



387
388
389
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 387

def outbound_resource_url
  @properties['outbound_resource_url']
end

#service_sid ⇒ String

Returns Service Sid.

Returns:

  • (String) —

    Service Sid.



309
310
311
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 309

def service_sid
  @properties['service_sid']
end

#session_sid ⇒ String

Returns Session Sid.

Returns:

  • (String) —

    Session Sid.



303
304
305
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 303

def session_sid
  @properties['session_sid']
end

#sid ⇒ String

Returns A string that uniquely identifies this Interaction.

Returns:

  • (String) —

    A string that uniquely identifies this Interaction.



297
298
299
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 297

def sid
  @properties['sid']
end

#status ⇒ interaction.Status

Returns The Status of this Interaction.

Returns:

  • (interaction.Status) —

    The Status of this Interaction



327
328
329
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 327

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



418
419
420
421
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 418

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

#url ⇒ String

Returns The URL of this Interaction.

Returns:

  • (String) —

    The URL of this Interaction.



405
406
407
 
# File 'lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb', line 405

def url
  @properties['url']
end