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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 329

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 



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

def 
    @properties['account_sid']
end

#closed_reason ⇒ String 



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

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



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

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

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_ended ⇒ Time 



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

def date_ended
    @properties['date_ended']
end

#date_expiry ⇒ Time 



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

def date_expiry
    @properties['date_expiry']
end

#date_last_interaction ⇒ Time 



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

def date_last_interaction
    @properties['date_last_interaction']
end

#date_started ⇒ Time 



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

def date_started
    @properties['date_started']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SessionInstance



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

def delete

    context.delete
end

#fetch ⇒ SessionInstance

Fetch the SessionInstance



475
476
477
478
 
# 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



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

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

#interactions ⇒ interactions

Access the interactions



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

def interactions
    context.interactions
end

#links ⇒ Hash 



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

def links
    @properties['links']
end

#mode ⇒ Mode 



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

def mode
    @properties['mode']
end

#participants ⇒ participants

Access the participants



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

def participants
    context.participants
end

#service_sid ⇒ String 



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#status ⇒ Status 



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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#ttl ⇒ String 



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

def ttl
    @properties['ttl']
end

#unique_name ⇒ String 



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

def unique_name
    @properties['unique_name']
end

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

Update the SessionInstance



486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 486

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

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

#url ⇒ String 



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

def url
    @properties['url']
end