Class: Twilio::REST::Preview::Wireless::SimInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/preview/wireless/sim.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the SimInstance

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

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

    The SID of the Call resource to fetch.



317
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
345
346
347
348
349
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 317

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'unique_name' => payload['unique_name'],
        'account_sid' => payload['account_sid'],
        'rate_plan_sid' => payload['rate_plan_sid'],
        'friendly_name' => payload['friendly_name'],
        'iccid' => payload['iccid'],
        'e_id' => payload['e_id'],
        'status' => payload['status'],
        'commands_callback_url' => payload['commands_callback_url'],
        'commands_callback_method' => payload['commands_callback_method'],
        'sms_fallback_method' => payload['sms_fallback_method'],
        'sms_fallback_url' => payload['sms_fallback_url'],
        'sms_method' => payload['sms_method'],
        'sms_url' => payload['sms_url'],
        'voice_fallback_method' => payload['voice_fallback_method'],
        'voice_fallback_url' => payload['voice_fallback_url'],
        'voice_method' => payload['voice_method'],
        'voice_url' => payload['voice_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

Returns:

  • (String) 


376
377
378
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 376

def 
    @properties['account_sid']
end

#commands_callback_method ⇒ String

Returns:

  • (String) 


418
419
420
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 418

def commands_callback_method
    @properties['commands_callback_method']
end

#commands_callback_url ⇒ String

Returns:

  • (String) 


412
413
414
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 412

def commands_callback_url
    @properties['commands_callback_url']
end

#context ⇒ SimContext

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

Returns:

  • (SimContext) —

    CallContext for this CallInstance



355
356
357
358
359
360
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 355

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

#date_created ⇒ Time

Returns:

  • (Time) 


472
473
474
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 472

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


478
479
480
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 478

def date_updated
    @properties['date_updated']
end

#e_id ⇒ String

Returns:

  • (String) 


400
401
402
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 400

def e_id
    @properties['e_id']
end

#fetch ⇒ SimInstance

Fetch the SimInstance

Returns:



497
498
499
500
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 497

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


388
389
390
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 388

def friendly_name
    @properties['friendly_name']
end

#iccid ⇒ String

Returns:

  • (String) 


394
395
396
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 394

def iccid
    @properties['iccid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



576
577
578
579
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 576

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

#links ⇒ Hash

Returns:

  • (Hash) 


490
491
492
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 490

def links
    @properties['links']
end

#rate_plan_sid ⇒ String

Returns:

  • (String) 


382
383
384
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 382

def rate_plan_sid
    @properties['rate_plan_sid']
end

#sid ⇒ String

Returns:

  • (String) 


364
365
366
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 364

def sid
    @properties['sid']
end

#sms_fallback_method ⇒ String

Returns:

  • (String) 


424
425
426
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 424

def sms_fallback_method
    @properties['sms_fallback_method']
end

#sms_fallback_url ⇒ String

Returns:

  • (String) 


430
431
432
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 430

def sms_fallback_url
    @properties['sms_fallback_url']
end

#sms_method ⇒ String

Returns:

  • (String) 


436
437
438
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 436

def sms_method
    @properties['sms_method']
end

#sms_url ⇒ String

Returns:

  • (String) 


442
443
444
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 442

def sms_url
    @properties['sms_url']
end

#status ⇒ String

Returns:

  • (String) 


406
407
408
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 406

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



569
570
571
572
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 569

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

#unique_name ⇒ String

Returns:

  • (String) 


370
371
372
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 370

def unique_name
    @properties['unique_name']
end

#update(unique_name: :unset, callback_method: :unset, callback_url: :unset, friendly_name: :unset, rate_plan: :unset, status: :unset, commands_callback_method: :unset, commands_callback_url: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset) ⇒ SimInstance

Update the SimInstance

Parameters:

  • unique_name (String) (defaults to: :unset)
  • callback_method (String) (defaults to: :unset)
  • callback_url (String) (defaults to: :unset)
  • friendly_name (String) (defaults to: :unset)
  • rate_plan (String) (defaults to: :unset)
  • status (String) (defaults to: :unset)
  • commands_callback_method (String) (defaults to: :unset)
  • commands_callback_url (String) (defaults to: :unset)
  • sms_fallback_method (String) (defaults to: :unset)
  • sms_fallback_url (String) (defaults to: :unset)
  • sms_method (String) (defaults to: :unset)
  • sms_url (String) (defaults to: :unset)
  • voice_fallback_method (String) (defaults to: :unset)
  • voice_fallback_url (String) (defaults to: :unset)
  • voice_method (String) (defaults to: :unset)
  • voice_url (String) (defaults to: :unset)

Returns:



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 521

def update(
    unique_name: :unset, 
    callback_method: :unset, 
    callback_url: :unset, 
    friendly_name: :unset, 
    rate_plan: :unset, 
    status: :unset, 
    commands_callback_method: :unset, 
    commands_callback_url: :unset, 
    sms_fallback_method: :unset, 
    sms_fallback_url: :unset, 
    sms_method: :unset, 
    sms_url: :unset, 
    voice_fallback_method: :unset, 
    voice_fallback_url: :unset, 
    voice_method: :unset, 
    voice_url: :unset
)

    context.update(
        unique_name: unique_name, 
        callback_method: callback_method, 
        callback_url: callback_url, 
        friendly_name: friendly_name, 
        rate_plan: rate_plan, 
        status: status, 
        commands_callback_method: commands_callback_method, 
        commands_callback_url: commands_callback_url, 
        sms_fallback_method: sms_fallback_method, 
        sms_fallback_url: sms_fallback_url, 
        sms_method: sms_method, 
        sms_url: sms_url, 
        voice_fallback_method: voice_fallback_method, 
        voice_fallback_url: voice_fallback_url, 
        voice_method: voice_method, 
        voice_url: voice_url, 
    )
end

#url ⇒ String

Returns:

  • (String) 


484
485
486
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 484

def url
    @properties['url']
end

#usage ⇒ usage

Access the usage

Returns:



563
564
565
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 563

def usage
    context.usage
end

#voice_fallback_method ⇒ String

Returns:

  • (String) 


448
449
450
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 448

def voice_fallback_method
    @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

Returns:

  • (String) 


454
455
456
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 454

def voice_fallback_url
    @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns:

  • (String) 


460
461
462
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 460

def voice_method
    @properties['voice_method']
end

#voice_url ⇒ String

Returns:

  • (String) 


466
467
468
 
# File 'lib/twilio-ruby/rest/preview/wireless/sim.rb', line 466

def voice_url
    @properties['voice_url']
end