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

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

Initialize the SessionInstance

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 Service the session is associated with.

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

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



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

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#closed_reason ⇒ String

Returns The reason the Session ended.

Returns:

  • (String) —

    The reason the Session ended



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

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:



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

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



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

def date_created
  @properties['date_created']
end

#date_ended ⇒ Time

Returns The ISO 8601 date when the Session ended.

Returns:

  • (Time) —

    The ISO 8601 date when the Session ended



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

def date_ended
  @properties['date_ended']
end

#date_expiry ⇒ Time

Returns The ISO 8601 date when the Session should expire.

Returns:

  • (Time) —

    The ISO 8601 date when the Session should expire



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

def date_expiry
  @properties['date_expiry']
end

#date_last_interaction ⇒ Time

Returns The ISO 8601 date when the Session last had an interaction.

Returns:

  • (Time) —

    The ISO 8601 date when the Session last had an interaction



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

def date_last_interaction
  @properties['date_last_interaction']
end

#date_started ⇒ Time

Returns The ISO 8601 date when the Session started.

Returns:

  • (Time) —

    The ISO 8601 date when the Session started



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

def date_started
  @properties['date_started']
end

#date_updated ⇒ Time

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SessionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#fetch ⇒ SessionInstance

Fetch the SessionInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#interactions ⇒ interactions

Access the interactions

Returns:



484
485
486
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 484

def interactions
  context.interactions
end

#links ⇒ String

Returns The URLs of resources related to the Session.

Returns:

  • (String) —

    The URLs of resources related to the Session



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

def links
  @properties['links']
end

#mode ⇒ session.Mode

Returns The Mode of the Session.

Returns:

  • (session.Mode) —

    The Mode of the Session



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

def mode
  @properties['mode']
end

#participants ⇒ participants

Access the participants

Returns:



491
492
493
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 491

def participants
  context.participants
end

#service_sid ⇒ String

Returns The SID of the resource’s parent Service.

Returns:

  • (String) —

    The SID of the resource’s parent Service



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#status ⇒ session.Status

Returns The status of the Session.

Returns:

  • (session.Status) —

    The status of the Session



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#ttl ⇒ String

Returns When the session will expire.

Returns:

  • (String) —

    When the session will expire



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

def ttl
  @properties['ttl']
end

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource



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

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 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 (session.Status) (defaults to: :unset) —

    The new status of the resource. Can be: ‘in-progress` to re-open a session or `closed` to close a session.

Returns:



477
478
479
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 477

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



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

def url
  @properties['url']
end