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

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



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 18

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.



89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 89

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



137
138
139
140
141
142
143
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 137

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 (sim.Status) (defaults to: :unset) —

    The status

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

    The iccid

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

    The rate_plan

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

    The e_id

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

    The sim_registration_code

  • 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



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 42

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

#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 (sim.Status) (defaults to: :unset) —

    The status

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

    The iccid

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

    The rate_plan

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

    The e_id

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

    The sim_registration_code

  • 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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 113

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,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  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 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

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

    The iccid

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

    The rate_plan

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

    The e_id

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

    The sim_registration_code

  • 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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 70

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



147
148
149
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 147

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