Class: Twilio::REST::Supersim::V1::SimInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/supersim/v1/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.



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/supersim/v1/sim.rb', line 329

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'unique_name' => payload['unique_name'],
        'account_sid' => payload['account_sid'],
        'iccid' => payload['iccid'],
        'status' => payload['status'],
        'fleet_sid' => payload['fleet_sid'],
        '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 SID of the [Account](www.twilio.com/docs/iam/api/account) that the Super SIM belongs to.

Returns:



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

def 
    @properties['account_sid']
end

#billing_periods ⇒ billing_periods

Access the billing_periods

Returns:



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

def billing_periods
    context.billing_periods
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/supersim/v1/sim.rb', line 355

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#fetch ⇒ SimInstance

Fetch the SimInstance

Returns:



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

def fetch

    context.fetch
end

#fleet_sid ⇒ String

Returns The unique ID of the Fleet configured for this SIM.

Returns:

  • (String) —

    The unique ID of the Fleet configured for this SIM.



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

def fleet_sid
    @properties['fleet_sid']
end

#iccid ⇒ String

Returns The [ICCID](en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the SIM.

Returns:



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

def iccid
    @properties['iccid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash

Returns:

  • (Hash) 


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

def links
    @properties['links']
end

#sid ⇒ String

Returns The unique string that identifies the Sim resource.

Returns:

  • (String) —

    The unique string that identifies the Sim resource.



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

def sid
    @properties['sid']
end

#sim_ip_addresses ⇒ sim_ip_addresses

Access the sim_ip_addresses

Returns:



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

def sim_ip_addresses
    context.sim_ip_addresses
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource.



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

def unique_name
    @properties['unique_name']
end

#update(unique_name: :unset, status: :unset, fleet: :unset, callback_url: :unset, callback_method: :unset, account_sid: :unset) ⇒ SimInstance

Update the SimInstance

Parameters:

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

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource.

  • status (StatusUpdate) (defaults to: :unset)
  • fleet (String) (defaults to: :unset) —

    The SID or unique name of the Fleet to which the SIM resource should be assigned.

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

    The URL we should call using the ‘callback_method` after an asynchronous update has finished.

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

    The HTTP method we should use to call ‘callback_url`. Can be: `GET` or `POST` and the default is POST.

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

    The SID of the Account to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a Subaccount of the requesting Account. Only valid when the Sim resource’s status is new.

Returns:



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 439

def update(
    unique_name: :unset, 
    status: :unset, 
    fleet: :unset, 
    callback_url: :unset, 
    callback_method: :unset, 
    account_sid: :unset
)

    context.update(
        unique_name: unique_name, 
        status: status, 
        fleet: fleet, 
        callback_url: callback_url, 
        callback_method: callback_method, 
        account_sid: , 
    )
end

#url ⇒ String

Returns The absolute URL of the Sim Resource.

Returns:

  • (String) —

    The absolute URL of the Sim Resource.



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

def url
    @properties['url']
end