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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 307

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'],
      'ip_address' => payload['ip_address'],
  }

  # 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



367
368
369
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 367

def 
  @properties['account_sid']
end

#commands_callback_method ⇒ String

Returns The commands_callback_method.

Returns:

  • (String) —

    The commands_callback_method



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

def commands_callback_method
  @properties['commands_callback_method']
end

#commands_callback_url ⇒ String

Returns The commands_callback_url.

Returns:

  • (String) —

    The commands_callback_url



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

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



346
347
348
349
350
351
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 346

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:



548
549
550
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 548

def data_sessions
  context.data_sessions
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#e_id ⇒ String

Returns The e_id.

Returns:

  • (String) —

    The e_id



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

def e_id
  @properties['e_id']
end

#fetch ⇒ SimInstance

Fetch a SimInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#iccid ⇒ String

Returns The iccid.

Returns:

  • (String) —

    The iccid



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

def iccid
  @properties['iccid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



561
562
563
564
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 561

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

#ip_address ⇒ String

Returns The ip_address.

Returns:

  • (String) —

    The ip_address



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

def ip_address
  @properties['ip_address']
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#rate_plan_sid ⇒ String

Returns The rate_plan_sid.

Returns:

  • (String) —

    The rate_plan_sid



373
374
375
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 373

def rate_plan_sid
  @properties['rate_plan_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



355
356
357
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 355

def sid
  @properties['sid']
end

#sms_fallback_method ⇒ String

Returns The sms_fallback_method.

Returns:

  • (String) —

    The sms_fallback_method



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

def sms_fallback_method
  @properties['sms_fallback_method']
end

#sms_fallback_url ⇒ String

Returns The sms_fallback_url.

Returns:

  • (String) —

    The sms_fallback_url



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

def sms_fallback_url
  @properties['sms_fallback_url']
end

#sms_method ⇒ String

Returns The sms_method.

Returns:

  • (String) —

    The sms_method



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

def sms_method
  @properties['sms_method']
end

#sms_url ⇒ String

Returns The sms_url.

Returns:

  • (String) —

    The sms_url



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

def sms_url
  @properties['sms_url']
end

#status ⇒ sim.Status

Returns The status.

Returns:

  • (sim.Status) —

    The status



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



554
555
556
557
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 554

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



361
362
363
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 361

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:



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 517

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



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

def url
  @properties['url']
end

#usage_records ⇒ usage_records

Access the usage_records

Returns:



541
542
543
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 541

def usage_records
  context.usage_records
end

#voice_fallback_method ⇒ String

Returns The voice_fallback_method.

Returns:

  • (String) —

    The voice_fallback_method



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

def voice_fallback_method
  @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

Returns The voice_fallback_url.

Returns:

  • (String) —

    The voice_fallback_url



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

def voice_fallback_url
  @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns The voice_method.

Returns:

  • (String) —

    The voice_method



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

def voice_method
  @properties['voice_method']
end

#voice_url ⇒ String

Returns The voice_url.

Returns:

  • (String) —

    The voice_url



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

def voice_url
  @properties['voice_url']
end