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

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, 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

  • service_sid (String) (defaults to: nil)

    The SID of the parent Service resource.

  • session_sid (String) (defaults to: nil)

    The SID of the parent Session resource.

  • participant_sid (String) (defaults to: nil)

    The SID of the Participant resource.

  • sid (String) (defaults to: nil)

    The Twilio-provided string that uniquely identifies the MessageInteraction resource to fetch.


257
258
259
260
261
262
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
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 257

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

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#contextMessageInteractionContext

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

Returns:


298
299
300
301
302
303
304
305
306
307
308
309
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 298

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

#dataString

Returns A JSON string that includes the message body sent to the participant.

Returns:

  • (String)

    A JSON string that includes the message body sent to the participant


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

def data
  @properties['data']
end

#date_createdTime

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#fetchMessageInteractionInstance

Fetch the MessageInteractionInstance

Returns:


434
435
436
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 434

def fetch
  context.fetch
end

#inbound_participant_sidString

Returns Always empty for Message Interactions.

Returns:

  • (String)

    Always empty for Message Interactions


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

def inbound_participant_sid
  @properties['inbound_participant_sid']
end

#inbound_resource_sidString

Returns Always empty for Message Interactions.

Returns:

  • (String)

    Always empty for Message Interactions


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

def inbound_resource_sid
  @properties['inbound_resource_sid']
end

#inbound_resource_statusmessage_interaction.ResourceStatus

Returns Always empty for Message Interactions.

Returns:

  • (message_interaction.ResourceStatus)

    Always empty for Message Interactions


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

def inbound_resource_status
  @properties['inbound_resource_status']
end

#inbound_resource_typeString

Returns Always empty for Message Interactions.

Returns:

  • (String)

    Always empty for Message Interactions


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

def inbound_resource_type
  @properties['inbound_resource_type']
end

#inbound_resource_urlString

Returns Always empty for Message Interactions.

Returns:

  • (String)

    Always empty for Message Interactions


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

def inbound_resource_url
  @properties['inbound_resource_url']
end

#inspectObject

Provide a detailed, user friendly representation


447
448
449
450
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 447

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

#outbound_participant_sidString

Returns The SID of the outbound Participant resource.

Returns:

  • (String)

    The SID of the outbound Participant resource


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

def outbound_participant_sid
  @properties['outbound_participant_sid']
end

#outbound_resource_sidString

Returns The SID of the outbound Message resource.

Returns:

  • (String)

    The SID of the outbound Message resource


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

def outbound_resource_sid
  @properties['outbound_resource_sid']
end

#outbound_resource_statusmessage_interaction.ResourceStatus

Returns The outbound resource status.

Returns:

  • (message_interaction.ResourceStatus)

    The outbound resource status


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

def outbound_resource_status
  @properties['outbound_resource_status']
end

#outbound_resource_typeString

Returns The outbound resource type.

Returns:

  • (String)

    The outbound resource type


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

def outbound_resource_type
  @properties['outbound_resource_type']
end

#outbound_resource_urlString

Returns The URL of the Twilio message resource.

Returns:

  • (String)

    The URL of the Twilio message resource


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

def outbound_resource_url
  @properties['outbound_resource_url']
end

#participant_sidString

Returns The SID of the Participant resource.

Returns:

  • (String)

    The SID of the Participant resource


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

def participant_sid
  @properties['participant_sid']
end

#service_sidString

Returns The SID of the resource's parent Service.

Returns:

  • (String)

    The SID of the resource's parent Service


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

def service_sid
  @properties['service_sid']
end

#session_sidString

Returns The SID of the resource's parent Session.

Returns:

  • (String)

    The SID of the resource's parent Session


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

def session_sid
  @properties['session_sid']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


440
441
442
443
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 440

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

#typemessage_interaction.Type

Returns The Type of Message Interaction.

Returns:

  • (message_interaction.Type)

    The Type of Message Interaction


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

def type
  @properties['type']
end

#urlString

Returns The absolute URL of the MessageInteraction resource.

Returns:

  • (String)

    The absolute URL of the MessageInteraction resource


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

def url
  @properties['url']
end