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.



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

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:



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

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:



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

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"`)



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

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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#fetch ⇒ MessageInteractionInstance

Fetch the MessageInteractionInstance

Returns:



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

def fetch

    context.fetch
end

#inbound_participant_sid ⇒ String

Returns Always empty for created Message Interactions.

Returns:

  • (String) —

    Always empty for created Message Interactions.



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

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.



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

def inbound_resource_sid
    @properties['inbound_resource_sid']
end

#inbound_resource_status ⇒ ResourceStatus

Returns:

  • (ResourceStatus) 


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

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.



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

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.



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

def inbound_resource_url
    @properties['inbound_resource_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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:



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

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:



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

def outbound_resource_sid
    @properties['outbound_resource_sid']
end

#outbound_resource_status ⇒ ResourceStatus

Returns:

  • (ResourceStatus) 


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

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



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

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.



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

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:



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

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:



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

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:



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

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.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#type ⇒ Type

Returns:

  • (Type) 


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

def type
    @properties['type']
end

#url ⇒ String

Returns The absolute URL of the MessageInteraction resource.

Returns:

  • (String) —

    The absolute URL of the MessageInteraction resource.



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

def url
    @properties['url']
end