Class: Twilio::REST::Wireless::V1::SimList

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/wireless/v1/sim.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ SimList

Initialize the SimList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 26

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/Sims"
    
end

Instance Method Details

#each ⇒ Object

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



129
130
131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 129

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



176
177
178
179
180
181
182
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 176

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

#list(status: :unset, iccid: :unset, rate_plan: :unset, e_id: :unset, sim_registration_code: :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 (Status) (defaults to: :unset) —

    Only return Sim resources with this status.

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

    Only return Sim resources with this ICCID. This will return a list with a maximum size of 1.

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

    The SID or unique name of a [RatePlan resource](www.twilio.com/docs/iot/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource.

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

    Deprecated.

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

    Only return Sim resources with this registration code. This will return a list with a maximum size of 1.

  • 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



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 51

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

#list_with_metadata(status: :unset, iccid: :unset, rate_plan: :unset, e_id: :unset, sim_registration_code: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

Parameters:

  • 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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 107

def list_with_metadata(status: :unset, iccid: :unset, rate_plan: :unset, e_id: :unset, sim_registration_code: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'Status' => status,
        'Iccid' => iccid,
        'RatePlan' => rate_plan,
        'EId' => e_id,
        'SimRegistrationCode' => sim_registration_code,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    SimPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(status: :unset, iccid: :unset, rate_plan: :unset, e_id: :unset, sim_registration_code: :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 (Status) (defaults to: :unset) —

    Only return Sim resources with this status.

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

    Only return Sim resources with this ICCID. This will return a list with a maximum size of 1.

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

    The SID or unique name of a [RatePlan resource](www.twilio.com/docs/iot/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource.

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

    Deprecated.

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

    Only return Sim resources with this registration code. This will return a list with a maximum size of 1.

  • 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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 151

def page(status: :unset, iccid: :unset, rate_plan: :unset, e_id: :unset, sim_registration_code: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'Status' => status,
        'Iccid' => iccid,
        'RatePlan' => rate_plan,
        'EId' => e_id,
        'SimRegistrationCode' => sim_registration_code,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(status: :unset, iccid: :unset, rate_plan: :unset, e_id: :unset, sim_registration_code: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • status (Status) (defaults to: :unset) —

    Only return Sim resources with this status.

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

    Only return Sim resources with this ICCID. This will return a list with a maximum size of 1.

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

    The SID or unique name of a [RatePlan resource](www.twilio.com/docs/iot/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource.

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

    Deprecated.

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

    Only return Sim resources with this registration code. This will return a list with a maximum size of 1.

  • 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



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 79

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

    page = self.page(
        status: status,
        iccid: iccid,
        rate_plan: rate_plan,
        e_id: e_id,
        sim_registration_code: sim_registration_code,
        page_size: limits[:page_size], )

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

#to_s ⇒ Object

Provide a user friendly representation



187
188
189
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 187

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