Class: Twilio::REST::Supersim::V1::EsimProfileInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/supersim/v1/esim_profile.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the EsimProfileInstance

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

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

    The SID of the Call resource to fetch.



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 256

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'iccid' => payload['iccid'],
        'sim_sid' => payload['sim_sid'],
        'status' => payload['status'],
        'eid' => payload['eid'],
        'smdp_plus_address' => payload['smdp_plus_address'],
        'matching_id' => payload['matching_id'],
        'activation_code' => payload['activation_code'],
        'error_code' => payload['error_code'],
        'error_message' => payload['error_message'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

    # 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) to which the eSIM Profile resource belongs.

Returns:



301
302
303
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 301

def 
    @properties['account_sid']
end

#activation_code ⇒ String

Returns Combined machine-readable activation code for acquiring an eSIM Profile with the Activation Code download method. Can be used in a QR code to download an eSIM profile.

Returns:

  • (String) —

    Combined machine-readable activation code for acquiring an eSIM Profile with the Activation Code download method. Can be used in a QR code to download an eSIM profile.



343
344
345
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 343

def activation_code
    @properties['activation_code']
end

#context ⇒ EsimProfileContext

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

Returns:



286
287
288
289
290
291
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 286

def context
    unless @instance_context
        @instance_context = EsimProfileContext.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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#eid ⇒ String

Returns Identifier of the eUICC that can claim the eSIM Profile.

Returns:

  • (String) —

    Identifier of the eUICC that can claim the eSIM Profile.



325
326
327
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 325

def eid
    @properties['eid']
end

#error_code ⇒ String

Returns Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in ‘failed` state.

Returns:

  • (String) —

    Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in ‘failed` state.



349
350
351
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 349

def error_code
    @properties['error_code']
end

#error_message ⇒ String

Returns Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in ‘failed` state.

Returns:

  • (String) —

    Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in ‘failed` state.



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

def error_message
    @properties['error_message']
end

#fetch ⇒ EsimProfileInstance

Fetch the EsimProfileInstance

Returns:



380
381
382
383
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 380

def fetch

    context.fetch
end

#iccid ⇒ String

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

Returns:



307
308
309
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 307

def iccid
    @properties['iccid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#matching_id ⇒ String

Returns Unique identifier of the eSIM profile that can be used to identify and download the eSIM profile from the SM-DP+ server. Populated if ‘generate_matching_id` is set to `true` when creating the eSIM profile reservation.

Returns:

  • (String) —

    Unique identifier of the eSIM profile that can be used to identify and download the eSIM profile from the SM-DP+ server. Populated if ‘generate_matching_id` is set to `true` when creating the eSIM profile reservation.



337
338
339
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 337

def matching_id
    @properties['matching_id']
end

#sid ⇒ String

Returns The unique string that we created to identify the eSIM Profile resource.

Returns:

  • (String) —

    The unique string that we created to identify the eSIM Profile resource.



295
296
297
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 295

def sid
    @properties['sid']
end

#sim_sid ⇒ String

Returns The SID of the [Sim](www.twilio.com/docs/iot/wireless/api/sim-resource) resource that this eSIM Profile controls.

Returns:



313
314
315
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 313

def sim_sid
    @properties['sim_sid']
end

#smdp_plus_address ⇒ String

Returns Address of the SM-DP+ server from which the Profile will be downloaded. The URL will appear once the eSIM Profile reaches the status ‘available`.

Returns:

  • (String) —

    Address of the SM-DP+ server from which the Profile will be downloaded. The URL will appear once the eSIM Profile reaches the status ‘available`.



331
332
333
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 331

def smdp_plus_address
    @properties['smdp_plus_address']
end

#status ⇒ Status

Returns:

  • (Status) 


319
320
321
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 319

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The absolute URL of the eSIM Profile resource.

Returns:

  • (String) —

    The absolute URL of the eSIM Profile resource.



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

def url
    @properties['url']
end