Class: Twilio::REST::Memory::V1::ProfileList

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

Defined Under Namespace

Classes: ProfileData, ProfilePatch

Instance Method Summary collapse

Constructor Details

#initialize(version, store_id: nil) ⇒ ProfileList

Initialize the ProfileList

Parameters:

  • version (Version) —

    Version that contains the resource



80
81
82
83
84
85
86
87
88
 
# File 'lib/twilio-ruby/rest/memory/v1/profile.rb', line 80

def initialize(version, store_id: nil)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)
    # Path Solution
    @solution = { store_id: store_id }
    @uri = "/Stores/#{@solution[:store_id]}/Profiles"
    
end

Instance Method Details

#create(profile_data: nil) ⇒ ProfileInstance

Create the ProfileInstance

Parameters:

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/twilio-ruby/rest/memory/v1/profile.rb', line 93

def create(profile_data: 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: profile_data.to_json)
    ProfileInstance.new(
        @version,
        payload,
        store_id: @solution[:store_id],
    )
end

#create_with_metadata(profile_data: nil) ⇒ ProfileInstance

Create the ProfileInstanceMetadata

Parameters:

Returns:



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

def create_with_metadata(profile_data: 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: profile_data.to_json)
    profile_instance = ProfileInstance.new(
        @version,
        response.body,
        store_id: @solution[:store_id],
    )
    ProfileInstanceMetadata.new(
        @version,
        profile_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/twilio-ruby/rest/memory/v1/profile.rb', line 218

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 ProfileInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ProfileInstance



259
260
261
262
263
264
265
 
# File 'lib/twilio-ruby/rest/memory/v1/profile.rb', line 259

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

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

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

Parameters:

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

    The token for the page of results to retrieve.

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

    Either ‘ASC’ or ‘DESC’ to sort results ascending or descending respectively.

  • 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



151
152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/memory/v1/profile.rb', line 151

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

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



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

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)

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

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

Returns Page of ProfileInstance.

Returns:

  • (Page) —

    Page of ProfileInstance



239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/twilio-ruby/rest/memory/v1/profile.rb', line 239

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)

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

Parameters:

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

    The token for the page of results to retrieve.

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

    Either ‘ASC’ or ‘DESC’ to sort results ascending or descending respectively.

  • 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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/memory/v1/profile.rb', line 173

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



270
271
272
 
# File 'lib/twilio-ruby/rest/memory/v1/profile.rb', line 270

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