Class: Twilio::REST::Supersim::V1::SimList

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/supersim/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) ⇒ SimList

Initialize the SimList

Parameters:

  • version (Version)

    Version that contains the resource


20
21
22
23
24
25
26
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 20

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Sims"
end

Instance Method Details

#create(iccid: nil, registration_code: nil) ⇒ SimInstance

Create the SimInstance

Parameters:

  • iccid (String) (defaults to: nil)

    The ICCID of the Super SIM to be added to your Account.

  • registration_code (String) (defaults to: nil)

    The 10-digit code required to claim the Super SIM for your Account.

Returns:


36
37
38
39
40
41
42
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 36

def create(iccid: nil, registration_code: nil)
  data = Twilio::Values.of({'Iccid' => iccid, 'RegistrationCode' => registration_code, })

  payload = @version.create('POST', @uri, data: data)

  SimInstance.new(@version, payload, )
end

#eachObject

When passed a block, yields SimInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.


98
99
100
101
102
103
104
105
106
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 98

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of SimInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of SimInstance


143
144
145
146
147
148
149
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 143

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  SimPage.new(@version, response, @solution)
end

#list(status: :unset, fleet: :unset, iccid: :unset, limit: nil, page_size: nil) ⇒ Array

Lists SimInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.

Parameters:

  • status (sim.Status) (defaults to: :unset)

    The status of the Sim resources to read. Can be `new`, `ready`, `active`, `inactive`, or `scheduled`.

  • fleet (String) (defaults to: :unset)

    The SID or unique name of the Fleet to which a list of Sims are assigned.

  • iccid (String) (defaults to: :unset)

    The ICCID associated with a Super SIM to filter the list by. Passing this parameter will always return a list containing zero or one SIMs.

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil)

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array)

    Array of up to limit results


63
64
65
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 63

def list(status: :unset, fleet: :unset, iccid: :unset, limit: nil, page_size: nil)
  self.stream(status: status, fleet: fleet, iccid: iccid, limit: limit, page_size: page_size).entries
end

#page(status: :unset, fleet: :unset, iccid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of SimInstance records from the API. Request is executed immediately.

Parameters:

  • status (sim.Status) (defaults to: :unset)

    The status of the Sim resources to read. Can be `new`, `ready`, `active`, `inactive`, or `scheduled`.

  • fleet (String) (defaults to: :unset)

    The SID or unique name of the Fleet to which a list of Sims are assigned.

  • iccid (String) (defaults to: :unset)

    The ICCID associated with a Super SIM to filter the list by. Passing this parameter will always return a list containing zero or one SIMs.

  • page_token (String) (defaults to: :unset)

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset)

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • (Page)

    Page of SimInstance


123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 123

def page(status: :unset, fleet: :unset, iccid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Status' => status,
      'Fleet' => fleet,
      'Iccid' => iccid,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  SimPage.new(@version, response, @solution)
end

#stream(status: :unset, fleet: :unset, iccid: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams SimInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • status (sim.Status) (defaults to: :unset)

    The status of the Sim resources to read. Can be `new`, `ready`, `active`, `inactive`, or `scheduled`.

  • fleet (String) (defaults to: :unset)

    The SID or unique name of the Fleet to which a list of Sims are assigned.

  • iccid (String) (defaults to: :unset)

    The ICCID associated with a Super SIM to filter the list by. Passing this parameter will always return a list containing zero or one SIMs.

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil)

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable)

    Enumerable that will yield up to limit results


86
87
88
89
90
91
92
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 86

def stream(status: :unset, fleet: :unset, iccid: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(status: status, fleet: fleet, iccid: iccid, page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_sObject

Provide a user friendly representation


153
154
155
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 153

def to_s
  '#<Twilio.Supersim.V1.SimList>'
end