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

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ SimList

Initialize the SimList



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

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

Instance Method Details

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

Create the SimInstance



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 39

def create(
    iccid: nil, 
    registration_code: nil
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    SimInstance.new(
        @version,
        payload,
    )
end

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

Create the SimInstanceMetadata



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 67

def create_with_metadata(
  iccid: nil, 
  registration_code: nil
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    sim_instance = SimInstance.new(
        @version,
        response.body,
    )
    SimInstanceMetadata.new(
        @version,
        sim_instance,
        response.headers,
        response.status_code
    )
end

#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.



179
180
181
182
183
184
185
186
187
 
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 179

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.



222
223
224
225
226
227
228
 
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 222

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.



111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 111

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

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 159

def list_with_metadata(status: :unset, fleet: :unset, iccid: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'Status' => status,
        'Fleet' => fleet,
        'Iccid' => iccid,
        
        '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, 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.



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 199

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,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(status: :unset, fleet: :unset, iccid: :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.



135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 135

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_s ⇒ Object

Provide a user friendly representation



233
234
235
 
# File 'lib/twilio-ruby/rest/supersim/v1/sim.rb', line 233

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