Class: Twilio::REST::Memory::V1::TraitGroupList

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

Defined Under Namespace

Classes: PatchTraitGroupRequest, TraitDefinition, TraitGroupRequest, ValidationRule

Instance Method Summary collapse

Constructor Details

#initialize(version, store_id: nil) ⇒ TraitGroupList

Initialize the TraitGroupList

Parameters:

  • version (Version) —

    Version that contains the resource



204
205
206
207
208
209
210
211
212
 
# File 'lib/twilio-ruby/rest/memory/v1/trait_group.rb', line 204

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

Instance Method Details

#create(trait_group_request: :unset) ⇒ TraitGroupInstance

Create the TraitGroupInstance

Parameters:

Returns:



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

def create(trait_group_request: :unset
)

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

#create_with_metadata(trait_group_request: :unset) ⇒ TraitGroupInstance

Create the TraitGroupInstanceMetadata

Parameters:

Returns:



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/twilio-ruby/rest/memory/v1/trait_group.rb', line 238

def create_with_metadata(trait_group_request: :unset
)

    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: trait_group_request.to_json)
    trait_group_instance = TraitGroupInstance.new(
        @version,
        response.body,
        store_id: @solution[:store_id],
    )
    TraitGroupInstanceMetadata.new(
        @version,
        trait_group_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/twilio-ruby/rest/memory/v1/trait_group.rb', line 348

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of TraitGroupInstance



391
392
393
394
395
396
397
 
# File 'lib/twilio-ruby/rest/memory/v1/trait_group.rb', line 391

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

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

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

Parameters:

  • include_traits (Boolean) (defaults to: :unset) —

    Whether to include trait definitions in the response

  • 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



276
277
278
279
280
281
282
283
284
 
# File 'lib/twilio-ruby/rest/memory/v1/trait_group.rb', line 276

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

#list_with_metadata(include_traits: :unset, 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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/twilio-ruby/rest/memory/v1/trait_group.rb', line 328

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

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

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

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

Returns Page of TraitGroupInstance.

Returns:

  • (Page) —

    Page of TraitGroupInstance



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/twilio-ruby/rest/memory/v1/trait_group.rb', line 370

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

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

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

#stream(include_traits: :unset, 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:

  • include_traits (Boolean) (defaults to: :unset) —

    Whether to include trait definitions in the response

  • 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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/twilio-ruby/rest/memory/v1/trait_group.rb', line 300

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

    page = self.page(
        include_traits: include_traits,
        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



402
403
404
 
# File 'lib/twilio-ruby/rest/memory/v1/trait_group.rb', line 402

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