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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/proxy/v1/service/session/participant.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) ⇒ ParticipantInstance

Initialize the ParticipantInstance

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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 322

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'],
      'friendly_name' => payload['friendly_name'],
      'identifier' => payload['identifier'],
      'proxy_identifier' => payload['proxy_identifier'],
      'proxy_identifier_sid' => payload['proxy_identifier_sid'],
      'date_deleted' => Twilio.deserialize_iso8601_datetime(payload['date_deleted']),
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
      'links' => payload['links'],
  }

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



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

def 
  @properties['account_sid']
end

#context ⇒ ParticipantContext

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

Returns:



355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 355

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

#date_created ⇒ Time

Returns The date this Participant was created.

Returns:

  • (Time) —

    The date this Participant was created



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

def date_created
  @properties['date_created']
end

#date_deleted ⇒ Time

Returns The date this Participant was deleted.

Returns:

  • (Time) —

    The date this Participant was deleted



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

def date_deleted
  @properties['date_deleted']
end

#date_updated ⇒ Time

Returns The date this Participant was updated.

Returns:

  • (Time) —

    The date this Participant was updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ParticipantInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



455
456
457
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 455

def delete
  context.delete
end

#fetch ⇒ ParticipantInstance

Fetch a ParticipantInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human readable description of this resource.

Returns:

  • (String) —

    A human readable description of this resource.



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

def friendly_name
  @properties['friendly_name']
end

#identifier ⇒ String

Returns The phone number of this Participant.

Returns:

  • (String) —

    The phone number of this Participant.



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

def identifier
  @properties['identifier']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



493
494
495
496
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 493

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

#links ⇒ String

Returns Nested resource URLs.

Returns:

  • (String) —

    Nested resource URLs.



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

def links
  @properties['links']
end

#message_interactions ⇒ message_interactions

Access the message_interactions

Returns:



480
481
482
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 480

def message_interactions
  context.message_interactions
end

#proxy_identifier ⇒ String

Returns The proxy_identifier.

Returns:

  • (String) —

    The proxy_identifier



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

def proxy_identifier
  @properties['proxy_identifier']
end

#proxy_identifier_sid ⇒ String

Returns Proxy Identifier Sid.

Returns:

  • (String) —

    Proxy Identifier Sid.



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

def proxy_identifier_sid
  @properties['proxy_identifier_sid']
end

#service_sid ⇒ String

Returns Service Sid.

Returns:

  • (String) —

    Service Sid.



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

def service_sid
  @properties['service_sid']
end

#session_sid ⇒ String

Returns Session Sid.

Returns:

  • (String) —

    Session Sid.



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

def session_sid
  @properties['session_sid']
end

#sid ⇒ String

Returns A string that uniquely identifies this Participant.

Returns:

  • (String) —

    A string that uniquely identifies this Participant.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



486
487
488
489
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 486

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

#update(identifier: :unset, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset) ⇒ ParticipantInstance

Update the ParticipantInstance

Parameters:

  • identifier (String) (defaults to: :unset) —

    The phone number of this Participant.

  • friendly_name (String) (defaults to: :unset) —

    A human readable description of this resource, up to 64 characters.

  • proxy_identifier (String) (defaults to: :unset) —

    The proxy phone number for this Participant.

  • proxy_identifier_sid (String) (defaults to: :unset) —

    The unique SID identifier of the Proxy Identifier.

Returns:



468
469
470
471
472
473
474
475
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 468

def update(identifier: :unset, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset)
  context.update(
      identifier: identifier,
      friendly_name: friendly_name,
      proxy_identifier: proxy_identifier,
      proxy_identifier_sid: proxy_identifier_sid,
  )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

def url
  @properties['url']
end