Class: Twilio::REST::Proxy::V1::ServiceContext::SessionInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ SessionInstance

Initialize the SessionInstance

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

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

    The SID of the Call resource to fetch.



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

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'service_sid' => payload['service_sid'],
        'account_sid' => payload['account_sid'],
        'date_started' => Twilio.deserialize_iso8601_datetime(payload['date_started']),
        'date_ended' => Twilio.deserialize_iso8601_datetime(payload['date_ended']),
        'date_last_interaction' => Twilio.deserialize_iso8601_datetime(payload['date_last_interaction']),
        'date_expiry' => Twilio.deserialize_iso8601_datetime(payload['date_expiry']),
        'unique_name' => payload['unique_name'],
        'status' => payload['status'],
        'closed_reason' => payload['closed_reason'],
        'ttl' => payload['ttl'] == nil ? payload['ttl'] : payload['ttl'].to_i,
        'mode' => payload['mode'],
        '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  || @properties['service_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 Session resource.

Returns:



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

def 
    @properties['account_sid']
end

#closed_reason ⇒ String

Returns The reason the Session ended.

Returns:

  • (String) —

    The reason the Session ended.



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

def closed_reason
    @properties['closed_reason']
end

#context ⇒ SessionContext

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

Returns:



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

def context
    unless @instance_context
        @instance_context = SessionContext.new(@version , @params['service_sid'], @params['sid'])
    end
    @instance_context
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:



437
438
439
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 437

def date_created
    @properties['date_created']
end

#date_ended ⇒ Time

Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date when the Session ended.

Returns:



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

def date_ended
    @properties['date_ended']
end

#date_expiry ⇒ Time

Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the ‘ttl` value.

Returns:

  • (Time) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the ‘ttl` value.



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

def date_expiry
    @properties['date_expiry']
end

#date_last_interaction ⇒ Time

Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date when the Session last had an interaction.

Returns:



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

def date_last_interaction
    @properties['date_last_interaction']
end

#date_started ⇒ Time

Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date when the Session started.

Returns:



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

def date_started
    @properties['date_started']
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:



443
444
445
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 443

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SessionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



462
463
464
465
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 462

def delete

    context.delete
end

#fetch ⇒ SessionInstance

Fetch the SessionInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



517
518
519
520
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 517

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

#interactions ⇒ interactions

Access the interactions

Returns:



497
498
499
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 497

def interactions
    context.interactions
end

#links ⇒ Hash

Returns The URLs of resources related to the Session.

Returns:

  • (Hash) —

    The URLs of resources related to the Session.



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

def links
    @properties['links']
end

#mode ⇒ Mode

Returns:

  • (Mode) 


431
432
433
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 431

def mode
    @properties['mode']
end

#participants ⇒ participants

Access the participants

Returns:



504
505
506
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 504

def participants
    context.participants
end

#service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/proxy/api/service) the session is associated with.

Returns:



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



510
511
512
513
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 510

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

#ttl ⇒ String

Returns The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session’s last Interaction.

Returns:

  • (String) —

    The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session’s last Interaction.



425
426
427
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 425

def ttl
    @properties['ttl']
end

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. Supports UTF-8 characters. **This value should not have PII.**.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. Supports UTF-8 characters. **This value should not have PII.**



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

def unique_name
    @properties['unique_name']
end

#update(date_expiry: :unset, ttl: :unset, status: :unset) ⇒ SessionInstance

Update the SessionInstance

Parameters:

  • date_expiry (Time) (defaults to: :unset) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the ‘ttl` value.

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

    The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session’s last Interaction.

  • status (Status) (defaults to: :unset)

Returns:



481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 481

def update(
    date_expiry: :unset, 
    ttl: :unset, 
    status: :unset
)

    context.update(
        date_expiry: date_expiry, 
        ttl: ttl, 
        status: status, 
    )
end

#url ⇒ String

Returns The absolute URL of the Session resource.

Returns:

  • (String) —

    The absolute URL of the Session resource.



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

def url
    @properties['url']
end