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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 337

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'].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 



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

def 
  @properties['account_sid']
end

#closed_reason ⇒ String 



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

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



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

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

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_ended ⇒ Time 



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

def date_ended
  @properties['date_ended']
end

#date_expiry ⇒ Time 



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

def date_expiry
  @properties['date_expiry']
end

#date_last_interaction ⇒ Time 



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

def date_last_interaction
  @properties['date_last_interaction']
end

#date_started ⇒ Time 



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

def date_started
  @properties['date_started']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the SessionInstance



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

def delete
  context.delete
end

#fetch ⇒ SessionInstance

Fetch a SessionInstance



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



534
535
536
537
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 534

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

#interactions ⇒ interactions

Access the interactions



514
515
516
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 514

def interactions
  context.interactions
end

#links ⇒ String 



468
469
470
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 468

def links
  @properties['links']
end

#mode ⇒ session.Mode 



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

def mode
  @properties['mode']
end

#participants ⇒ participants

Access the participants



521
522
523
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 521

def participants
  context.participants
end

#service_sid ⇒ String 



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#status ⇒ session.Status 



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



527
528
529
530
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 527

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

#ttl ⇒ String 



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

def ttl
  @properties['ttl']
end

#unique_name ⇒ String 



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

def unique_name
  @properties['unique_name']
end

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

Update the SessionInstance



500
501
502
503
504
505
506
507
508
509
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 500

def update(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset)
  context.update(
      unique_name: unique_name,
      date_expiry: date_expiry,
      ttl: ttl,
      mode: mode,
      status: status,
      participants: participants,
  )
end

#url ⇒ String 



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

def url
  @properties['url']
end