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



305
306
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
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 305

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



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

def 
  @properties['account_sid']
end

#commands_callback_method ⇒ String

Returns The commands_callback_method.

Returns:

  • (String) —

    The commands_callback_method



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

def commands_callback_method
  @properties['commands_callback_method']
end

#commands_callback_url ⇒ String

Returns The commands_callback_url.

Returns:

  • (String) —

    The commands_callback_url



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

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



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

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:



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

def data_sessions
  context.data_sessions
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#e_id ⇒ String

Returns The e_id.

Returns:

  • (String) —

    The e_id



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

def e_id
  @properties['e_id']
end

#fetch ⇒ SimInstance

Fetch a SimInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#iccid ⇒ String

Returns The iccid.

Returns:

  • (String) —

    The iccid



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

def iccid
  @properties['iccid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

def ip_address
  @properties['ip_address']
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#rate_plan_sid ⇒ String

Returns The rate_plan_sid.

Returns:

  • (String) —

    The rate_plan_sid



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

def rate_plan_sid
  @properties['rate_plan_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#sms_fallback_method ⇒ String

Returns The sms_fallback_method.

Returns:

  • (String) —

    The sms_fallback_method



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

def sms_fallback_method
  @properties['sms_fallback_method']
end

#sms_fallback_url ⇒ String

Returns The sms_fallback_url.

Returns:

  • (String) —

    The sms_fallback_url



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

def sms_fallback_url
  @properties['sms_fallback_url']
end

#sms_method ⇒ String

Returns The sms_method.

Returns:

  • (String) —

    The sms_method



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

def sms_method
  @properties['sms_method']
end

#sms_url ⇒ String

Returns The sms_url.

Returns:

  • (String) —

    The sms_url



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

def sms_url
  @properties['sms_url']
end

#status ⇒ sim.Status

Returns The status.

Returns:

  • (sim.Status) —

    The status



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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:



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

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



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

def url
  @properties['url']
end

#usage_records ⇒ usage_records

Access the usage_records

Returns:



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

def usage_records
  context.usage_records
end

#voice_fallback_method ⇒ String

Returns The voice_fallback_method.

Returns:

  • (String) —

    The voice_fallback_method



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

def voice_fallback_method
  @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

Returns The voice_fallback_url.

Returns:

  • (String) —

    The voice_fallback_url



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

def voice_fallback_url
  @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns The voice_method.

Returns:

  • (String) —

    The voice_method



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

def voice_method
  @properties['voice_method']
end

#voice_url ⇒ String

Returns The voice_url.

Returns:

  • (String) —

    The voice_url



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

def voice_url
  @properties['voice_url']
end