Class: Twilio::REST::Memory::V1::StoreList

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

Defined Under Namespace

Classes: PatchStoreRequest, ServiceRequest

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ StoreList

Initialize the StoreList



92
93
94
95
96
97
98
99
100
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 92

def initialize(version)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)
    # Path Solution
    @solution = {  }
    @uri = "/ControlPlane/Stores"
    
end

Instance Method Details

#create(service_request: nil) ⇒ StoreInstance

Create the StoreInstance



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 105

def create(service_request: nil
)

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

#create_with_metadata(service_request: nil) ⇒ StoreInstance

Create the StoreInstanceMetadata



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 125

def create_with_metadata(service_request: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, headers: headers, data: service_request.to_json)
    store_instance = StoreInstance.new(
        @version,
        response.body,
    )
    StoreInstanceMetadata.new(
        @version,
        store_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 228

def each
    limits = @version.read_limits

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

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

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



269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 269

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

#list(page_token: :unset, order_by: :unset, limit: nil, page_size: nil) ⇒ Array

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



161
162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 161

def list(page_token: :unset, order_by: :unset, limit: nil, page_size: nil)
    self.stream(
        page_token: page_token,
        order_by: order_by,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(page_token: :unset, order_by: :unset, limit: nil, page_size: nil) ⇒ Array 



209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 209

def list_with_metadata(page_token: :unset, order_by: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'pageToken' => page_token,
        'orderBy' => order_by,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

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

#page(page_token: :unset, order_by: :unset, page_size: :unset) ⇒ Page 



249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 249

def page(page_token: :unset, order_by: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'pageToken' => page_token,
        'orderBy' => order_by,
                                    'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(page_token: :unset, order_by: :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.



183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 183

def stream(page_token: :unset, order_by: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

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

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



280
281
282
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 280

def to_s
    '#<Twilio.Memory.V1.StoreList>'
end