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



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.



93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 93

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.



141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 141

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.



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

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.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 117

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.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 74

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



151
152
153
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 151

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