Class: Twilio::REST::Proxy::V1::ServiceContext::SessionContext::ParticipantContext::MessageInteractionInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the MessageInteractionInstance

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 MessageInteraction resource.

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

    The SID of the Call resource to fetch.



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
278
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 248

def initialize(version, payload , service_sid: nil, session_sid: nil, participant_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'],
        'participant_sid' => payload['participant_sid'],
        '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']  ,'participant_sid' => participant_sid  || @properties['participant_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 MessageInteraction resource.

Returns:



311
312
313
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 311

def 
    @properties['account_sid']
end

#context ⇒ MessageInteractionContext

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

Returns:



284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 284

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

#data ⇒ String

Returns A JSON string that includes the message body sent to the participant. (e.g. ‘"hello"`).

Returns:

  • (String) —

    A JSON string that includes the message body sent to the participant. (e.g. ‘"hello"`)



317
318
319
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 317

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 resource was created.

Returns:



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

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:



401
402
403
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 401

def date_updated
    @properties['date_updated']
end

#fetch ⇒ MessageInteractionInstance

Fetch the MessageInteractionInstance

Returns:



414
415
416
417
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 414

def fetch

    context.fetch
end

#inbound_participant_sid ⇒ String

Returns Always empty for created Message Interactions.

Returns:

  • (String) —

    Always empty for created Message Interactions.



335
336
337
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 335

def inbound_participant_sid
    @properties['inbound_participant_sid']
end

#inbound_resource_sid ⇒ String

Returns Always empty for created Message Interactions.

Returns:

  • (String) —

    Always empty for created Message Interactions.



341
342
343
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 341

def inbound_resource_sid
    @properties['inbound_resource_sid']
end

#inbound_resource_status ⇒ ResourceStatus

Returns:

  • (ResourceStatus) 


347
348
349
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 347

def inbound_resource_status
    @properties['inbound_resource_status']
end

#inbound_resource_type ⇒ String

Returns Always empty for created Message Interactions.

Returns:

  • (String) —

    Always empty for created Message Interactions.



353
354
355
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 353

def inbound_resource_type
    @properties['inbound_resource_type']
end

#inbound_resource_url ⇒ String

Returns Always empty for created Message Interactions.

Returns:

  • (String) —

    Always empty for created Message Interactions.



359
360
361
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 359

def inbound_resource_url
    @properties['inbound_resource_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



428
429
430
431
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 428

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

#outbound_participant_sid ⇒ String

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

Returns:



365
366
367
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 365

def outbound_participant_sid
    @properties['outbound_participant_sid']
end

#outbound_resource_sid ⇒ String

Returns The SID of the outbound [Message](www.twilio.com/docs/sms/api/message-resource) resource.

Returns:



371
372
373
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 371

def outbound_resource_sid
    @properties['outbound_resource_sid']
end

#outbound_resource_status ⇒ ResourceStatus

Returns:

  • (ResourceStatus) 


377
378
379
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 377

def outbound_resource_status
    @properties['outbound_resource_status']
end

#outbound_resource_type ⇒ String

Returns The outbound resource type. This value is always ‘Message`.

Returns:

  • (String) —

    The outbound resource type. This value is always ‘Message`.



383
384
385
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 383

def outbound_resource_type
    @properties['outbound_resource_type']
end

#outbound_resource_url ⇒ String

Returns The URL of the Twilio message resource.

Returns:

  • (String) —

    The URL of the Twilio message resource.



389
390
391
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 389

def outbound_resource_url
    @properties['outbound_resource_url']
end

#participant_sid ⇒ String

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

Returns:



329
330
331
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 329

def participant_sid
    @properties['participant_sid']
end

#service_sid ⇒ String

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

Returns:



305
306
307
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 305

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:



299
300
301
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 299

def session_sid
    @properties['session_sid']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



293
294
295
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 293

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



421
422
423
424
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 421

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

#type ⇒ Type

Returns:

  • (Type) 


323
324
325
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 323

def type
    @properties['type']
end

#url ⇒ String

Returns The absolute URL of the MessageInteraction resource.

Returns:

  • (String) —

    The absolute URL of the MessageInteraction resource.



407
408
409
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 407

def url
    @properties['url']
end