Class: Twilio::REST::Proxy::V1::ServiceInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ServiceInstance

Initialize the ServiceInstance



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 363

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'unique_name' => payload['unique_name'],
        'account_sid' => payload['account_sid'],
        'chat_instance_sid' => payload['chat_instance_sid'],
        'callback_url' => payload['callback_url'],
        'default_ttl' => payload['default_ttl'] == nil ? payload['default_ttl'] : payload['default_ttl'].to_i,
        'number_selection_behavior' => payload['number_selection_behavior'],
        'geo_match_level' => payload['geo_match_level'],
        'intercept_callback_url' => payload['intercept_callback_url'],
        'out_of_session_callback_url' => payload['out_of_session_callback_url'],
        '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 = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String 



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

def 
    @properties['account_sid']
end

#callback_url ⇒ String 



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

def callback_url
    @properties['callback_url']
end

#chat_instance_sid ⇒ String 



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

def chat_instance_sid
    @properties['chat_instance_sid']
end

#context ⇒ ServiceContext

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



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

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

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#default_ttl ⇒ String 



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

def default_ttl
    @properties['default_ttl']
end

#delete ⇒ Boolean

Delete the ServiceInstance



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

def delete

    context.delete
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance



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

def fetch

    context.fetch
end

#geo_match_level ⇒ GeoMatchLevel 



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

def geo_match_level
    @properties['geo_match_level']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



557
558
559
560
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 557

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

#intercept_callback_url ⇒ String 



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

def intercept_callback_url
    @properties['intercept_callback_url']
end

#links ⇒ Hash 



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

def links
    @properties['links']
end

#number_selection_behavior ⇒ NumberSelectionBehavior 



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

def number_selection_behavior
    @properties['number_selection_behavior']
end

#out_of_session_callback_url ⇒ String 



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

def out_of_session_callback_url
    @properties['out_of_session_callback_url']
end

#phone_numbers ⇒ phone_numbers

Access the phone_numbers



544
545
546
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 544

def phone_numbers
    context.phone_numbers
end

#sessions ⇒ sessions

Access the sessions



537
538
539
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 537

def sessions
    context.sessions
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



550
551
552
553
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 550

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

#unique_name ⇒ String 



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

def unique_name
    @properties['unique_name']
end

#update(unique_name: :unset, default_ttl: :unset, callback_url: :unset, geo_match_level: :unset, number_selection_behavior: :unset, intercept_callback_url: :unset, out_of_session_callback_url: :unset, chat_instance_sid: :unset) ⇒ ServiceInstance

Update the ServiceInstance



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 511

def update(
    unique_name: :unset, 
    default_ttl: :unset, 
    callback_url: :unset, 
    geo_match_level: :unset, 
    number_selection_behavior: :unset, 
    intercept_callback_url: :unset, 
    out_of_session_callback_url: :unset, 
    chat_instance_sid: :unset
)

    context.update(
        unique_name: unique_name, 
        default_ttl: default_ttl, 
        callback_url: callback_url, 
        geo_match_level: geo_match_level, 
        number_selection_behavior: number_selection_behavior, 
        intercept_callback_url: intercept_callback_url, 
        out_of_session_callback_url: out_of_session_callback_url, 
        chat_instance_sid: chat_instance_sid, 
    )
end

#url ⇒ String 



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

def url
    @properties['url']
end