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

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

  • 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.



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 228

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  || @properties['service_sid']  ,'session_sid' => session_sid  || @properties['session_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Interaction resource.

Returns:



290
291
292
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 290

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:



263
264
265
266
267
268
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 263

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 A JSON string that includes the message body of message interactions (e.g. ‘"hello"`) or the call duration (when available) of a call (e.g. `"5"`).

Returns:

  • (String) —

    A JSON string that includes the message body of message interactions (e.g. ‘"hello"`) or the call duration (when available) of a call (e.g. `"5"`).



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

def data
    @properties['data']
end

#date_created ⇒ Time

Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Interaction was created.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the InteractionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ InteractionInstance

Fetch the InteractionInstance

Returns:



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

def fetch

    context.fetch
end

#inbound_participant_sid ⇒ String

Returns The SID of the inbound [Participant](www.twilio.com/docs/proxy/api/participant) resource.

Returns:



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

def inbound_participant_sid
    @properties['inbound_participant_sid']
end

#inbound_resource_sid ⇒ String

Returns The SID of the inbound resource; either the [Call](www.twilio.com/docs/voice/api/call-resource) or [Message](www.twilio.com/docs/sms/api/message-resource).

Returns:



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

def inbound_resource_sid
    @properties['inbound_resource_sid']
end

#inbound_resource_status ⇒ ResourceStatus

Returns:

  • (ResourceStatus) 


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

def inbound_resource_status
    @properties['inbound_resource_status']
end

#inbound_resource_type ⇒ String

Returns The inbound resource type. Can be [Call](www.twilio.com/docs/voice/api/call-resource) or [Message](www.twilio.com/docs/sms/api/message-resource).

Returns:



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

def inbound_resource_type
    @properties['inbound_resource_type']
end

#inbound_resource_url ⇒ String

Returns The URL of the Twilio inbound resource.

Returns:

  • (String) —

    The URL of the Twilio inbound resource



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

def inbound_resource_url
    @properties['inbound_resource_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



409
410
411
412
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 409

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

#outbound_participant_sid ⇒ String

Returns The SID of the outbound [Participant](www.twilio.com/docs/proxy/api/participant)).

Returns:



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

def outbound_participant_sid
    @properties['outbound_participant_sid']
end

#outbound_resource_sid ⇒ String

Returns The SID of the outbound resource; either the [Call](www.twilio.com/docs/voice/api/call-resource) or [Message](www.twilio.com/docs/sms/api/message-resource).

Returns:



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

def outbound_resource_sid
    @properties['outbound_resource_sid']
end

#outbound_resource_status ⇒ ResourceStatus

Returns:

  • (ResourceStatus) 


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

def outbound_resource_status
    @properties['outbound_resource_status']
end

#outbound_resource_type ⇒ String

Returns The outbound resource type. Can be: [Call](www.twilio.com/docs/voice/api/call-resource) or [Message](www.twilio.com/docs/sms/api/message-resource).

Returns:



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

def outbound_resource_type
    @properties['outbound_resource_type']
end

#outbound_resource_url ⇒ String

Returns The URL of the Twilio outbound resource.

Returns:

  • (String) —

    The URL of the Twilio outbound resource.



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

def outbound_resource_url
    @properties['outbound_resource_url']
end

#service_sid ⇒ String

Returns The SID of the parent [Service](www.twilio.com/docs/proxy/api/service) resource.

Returns:



284
285
286
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 284

def service_sid
    @properties['service_sid']
end

#session_sid ⇒ String

Returns The SID of the parent [Session](www.twilio.com/docs/proxy/api/session) resource.

Returns:



278
279
280
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 278

def session_sid
    @properties['session_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Interaction resource.

Returns:

  • (String) —

    The unique string that we created to identify the Interaction resource.



272
273
274
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 272

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



402
403
404
405
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 402

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

#type ⇒ Type

Returns:

  • (Type) 


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

def type
    @properties['type']
end

#url ⇒ String

Returns The absolute URL of the Interaction resource.

Returns:

  • (String) —

    The absolute URL of the Interaction resource.



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

def url
    @properties['url']
end