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

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

Initialize the EsimProfileInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • sid (String) (defaults to: nil)

    The SID of the eSIM Profile resource to fetch.


241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 241

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'],
      '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_sidString

Returns The SID of the Account to which the eSIM Profile resource belongs.

Returns:

  • (String)

    The SID of the Account to which the eSIM Profile resource belongs


284
285
286
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 284

def 
  @properties['account_sid']
end

#contextEsimProfileContext

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

Returns:


269
270
271
272
273
274
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 269

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

#date_createdTime

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#eidString

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

Returns:

  • (String)

    Identifier of the eUICC that can claim the eSIM Profile


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

def eid
  @properties['eid']
end

#error_codeString

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


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

def error_code
  @properties['error_code']
end

#error_messageString

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


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

def error_message
  @properties['error_message']
end

#fetchEsimProfileInstance

Fetch the EsimProfileInstance

Returns:


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

def fetch
  context.fetch
end

#iccidString

Returns The ICCID associated with the Sim resource.

Returns:

  • (String)

    The ICCID associated with the Sim resource


290
291
292
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 290

def iccid
  @properties['iccid']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


278
279
280
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 278

def sid
  @properties['sid']
end

#sim_sidString

Returns The SID of the Sim resource that this eSIM Profile controls.

Returns:

  • (String)

    The SID of the Sim resource that this eSIM Profile controls


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

def sim_sid
  @properties['sim_sid']
end

#smdp_plus_addressString

Returns Address of the SM-DP+ server from which the Profile will be downloaded.

Returns:

  • (String)

    Address of the SM-DP+ server from which the Profile will be downloaded


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

def smdp_plus_address
  @properties['smdp_plus_address']
end

#statusesim_profile.Status

Returns The status of the eSIM Profile.

Returns:

  • (esim_profile.Status)

    The status of the eSIM Profile


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

def status
  @properties['status']
end

#to_sObject

Provide a user friendly representation


357
358
359
360
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 357

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

#urlString

Returns The absolute URL of the eSIM Profile resource.

Returns:

  • (String)

    The absolute URL of the eSIM Profile resource


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

def url
  @properties['url']
end