Class: Twilio::REST::Memory::V1::TraitList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, store_id: nil, profile_id: nil) ⇒ TraitList

Initialize the TraitList

Parameters:

  • version (Version) —

    Version that contains the resource



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

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

Instance Method Details

#each ⇒ Object

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



122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/memory/v1/trait.rb', line 122

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of TraitInstance



165
166
167
168
169
170
171
 
# File 'lib/twilio-ruby/rest/memory/v1/trait.rb', line 165

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

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

Lists TraitInstance 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.

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

    Comma separated list of trait group names to include.

  • 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



50
51
52
53
54
55
56
57
58
 
# File 'lib/twilio-ruby/rest/memory/v1/trait.rb', line 50

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

#list_with_metadata(page_token: :unset, order_by: :unset, trait_groups: :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



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/memory/v1/trait.rb', line 102

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

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

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

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

Returns Page of TraitInstance.

Returns:

  • (Page) —

    Page of TraitInstance



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/memory/v1/trait.rb', line 144

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

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

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

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

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

    Comma separated list of trait group names to include.

  • 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



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

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

    page = self.page(
        page_token: page_token,
        order_by: order_by,
        trait_groups: trait_groups,
        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



176
177
178
 
# File 'lib/twilio-ruby/rest/memory/v1/trait.rb', line 176

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