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

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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.



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 263

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'],
      'type' => payload['type'],
      '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.



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

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:



302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 302

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 Further details about an interaction.

Returns:

  • (String) —

    Further details about an interaction.



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

def data
  @properties['data']
end

#date_created ⇒ Time

Returns The date this Interaction was created.

Returns:

  • (Time) —

    The date this Interaction was created



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the InteractionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



438
439
440
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 438

def delete
  context.delete
end

#fetch ⇒ InteractionInstance

Fetch a InteractionInstance

Returns:



431
432
433
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 431

def fetch
  context.fetch
end

#inbound_participant_sid ⇒ String

Returns Inbound Participant Sid.

Returns:

  • (String) —

    Inbound Participant Sid.



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

def inbound_participant_sid
  @properties['inbound_participant_sid']
end

#inbound_resource_sid ⇒ String

Returns Inbound Resource Sid.

Returns:

  • (String) —

    Inbound Resource Sid.



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

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



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

def inbound_resource_status
  @properties['inbound_resource_status']
end

#inbound_resource_type ⇒ String

Returns The type of the Inbound Resource, Call or Message.

Returns:

  • (String) —

    The type of the Inbound Resource, Call or Message.



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

def inbound_resource_type
  @properties['inbound_resource_type']
end

#inbound_resource_url ⇒ String

Returns The URL of the Twilio resource.

Returns:

  • (String) —

    The URL of the Twilio resource.



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

def inbound_resource_url
  @properties['inbound_resource_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



451
452
453
454
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 451

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

#outbound_participant_sid ⇒ String

Returns Outbound Participant Sid.

Returns:

  • (String) —

    Outbound Participant Sid.



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

def outbound_participant_sid
  @properties['outbound_participant_sid']
end

#outbound_resource_sid ⇒ String

Returns Outbound Resource Sid.

Returns:

  • (String) —

    Outbound Resource Sid.



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

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



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

def outbound_resource_status
  @properties['outbound_resource_status']
end

#outbound_resource_type ⇒ String

Returns The type of the Outbound Resource, Call or Message.

Returns:

  • (String) —

    The type of the Outbound Resource, Call or Message.



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

def outbound_resource_type
  @properties['outbound_resource_type']
end

#outbound_resource_url ⇒ String

Returns The URL of the Twilio resource.

Returns:

  • (String) —

    The URL of the Twilio resource.



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

def outbound_resource_url
  @properties['outbound_resource_url']
end

#service_sid ⇒ String

Returns Service Sid.

Returns:

  • (String) —

    Service Sid.



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

def service_sid
  @properties['service_sid']
end

#session_sid ⇒ String

Returns Session Sid.

Returns:

  • (String) —

    Session Sid.



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

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.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



444
445
446
447
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 444

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

#type ⇒ interaction.Type

Returns The Type of this Interaction.

Returns:

  • (interaction.Type) —

    The Type of this Interaction



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

def type
  @properties['type']
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



424
425
426
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 424

def url
  @properties['url']
end