Class: Twilio::REST::Wireless::V1::SimInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/wireless/v1/sim.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, sid: nil) ⇒ SimInstance

Initialize the SimInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The sid



326
327
328
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
356
357
358
359
360
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 326

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 The account_sid.

Returns:

  • (String) —

    The account_sid



390
391
392
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 390

def 
  @properties['account_sid']
end

#commands_callback_method ⇒ String

Returns The commands_callback_method.

Returns:

  • (String) —

    The commands_callback_method



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

def commands_callback_method
  @properties['commands_callback_method']
end

#commands_callback_url ⇒ String

Returns The commands_callback_url.

Returns:

  • (String) —

    The commands_callback_url



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

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

    SimContext for this SimInstance



366
367
368
369
370
371
372
373
374
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 366

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

#data_sessions ⇒ data_sessions

Access the data_sessions

Returns:



565
566
567
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 565

def data_sessions
  context.data_sessions
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



486
487
488
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 486

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



492
493
494
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 492

def date_updated
  @properties['date_updated']
end

#e_id ⇒ String

Returns The e_id.

Returns:

  • (String) —

    The e_id



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

def e_id
  @properties['e_id']
end

#fetch ⇒ SimInstance

Fetch a SimInstance

Returns:



511
512
513
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 511

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#iccid ⇒ String

Returns The iccid.

Returns:

  • (String) —

    The iccid



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

def iccid
  @properties['iccid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



578
579
580
581
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 578

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



504
505
506
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 504

def links
  @properties['links']
end

#rate_plan_sid ⇒ String

Returns The rate_plan_sid.

Returns:

  • (String) —

    The rate_plan_sid



396
397
398
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 396

def rate_plan_sid
  @properties['rate_plan_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



378
379
380
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 378

def sid
  @properties['sid']
end

#sms_fallback_method ⇒ String

Returns The sms_fallback_method.

Returns:

  • (String) —

    The sms_fallback_method



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

def sms_fallback_method
  @properties['sms_fallback_method']
end

#sms_fallback_url ⇒ String

Returns The sms_fallback_url.

Returns:

  • (String) —

    The sms_fallback_url



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

def sms_fallback_url
  @properties['sms_fallback_url']
end

#sms_method ⇒ String

Returns The sms_method.

Returns:

  • (String) —

    The sms_method



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

def sms_method
  @properties['sms_method']
end

#sms_url ⇒ String

Returns The sms_url.

Returns:

  • (String) —

    The sms_url



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

def sms_url
  @properties['sms_url']
end

#status ⇒ sim.Status

Returns The status.

Returns:

  • (sim.Status) —

    The status



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



571
572
573
574
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 571

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

#unique_name ⇒ String

Returns The unique_name.

Returns:

  • (String) —

    The unique_name



384
385
386
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 384

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

    The unique_name

  • callback_method (String) (defaults to: :unset) —

    The callback_method

  • callback_url (String) (defaults to: :unset) —

    The callback_url

  • friendly_name (String) (defaults to: :unset) —

    The friendly_name

  • rate_plan (String) (defaults to: :unset) —

    The rate_plan

  • status (sim.Status) (defaults to: :unset) —

    The status

  • commands_callback_method (String) (defaults to: :unset) —

    The commands_callback_method

  • commands_callback_url (String) (defaults to: :unset) —

    The commands_callback_url

  • sms_fallback_method (String) (defaults to: :unset) —

    The sms_fallback_method

  • sms_fallback_url (String) (defaults to: :unset) —

    The sms_fallback_url

  • sms_method (String) (defaults to: :unset) —

    The sms_method

  • sms_url (String) (defaults to: :unset) —

    The sms_url

  • voice_fallback_method (String) (defaults to: :unset) —

    The voice_fallback_method

  • voice_fallback_url (String) (defaults to: :unset) —

    The voice_fallback_url

  • voice_method (String) (defaults to: :unset) —

    The voice_method

  • voice_url (String) (defaults to: :unset) —

    The voice_url

Returns:



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 534

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 The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#usage_records ⇒ usage_records

Access the usage_records

Returns:



558
559
560
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 558

def usage_records
  context.usage_records
end

#voice_fallback_method ⇒ String

Returns The voice_fallback_method.

Returns:

  • (String) —

    The voice_fallback_method



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

def voice_fallback_method
  @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

Returns The voice_fallback_url.

Returns:

  • (String) —

    The voice_fallback_url



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

def voice_fallback_url
  @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns The voice_method.

Returns:

  • (String) —

    The voice_method



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

def voice_method
  @properties['voice_method']
end

#voice_url ⇒ String

Returns The voice_url.

Returns:

  • (String) —

    The voice_url



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

def voice_url
  @properties['voice_url']
end