Class: Twilio::REST::Intelligence::V3::VersionList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/intelligence/v3/version.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, id: nil) ⇒ VersionList

Initialize the VersionList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
33
34
 
# File 'lib/twilio-ruby/rest/intelligence/v3/version.rb', line 26

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

Instance Method Details

#each ⇒ Object

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



110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/intelligence/v3/version.rb', line 110

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of VersionInstance



149
150
151
152
153
154
155
 
# File 'lib/twilio-ruby/rest/intelligence/v3/version.rb', line 149

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

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

Lists VersionInstance 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) —

    Token for pagination

  • 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



48
49
50
51
52
53
54
 
# File 'lib/twilio-ruby/rest/intelligence/v3/version.rb', line 48

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

#list_with_metadata(page_token: :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



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/intelligence/v3/version.rb', line 92

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

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

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

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

Returns Page of VersionInstance.

Returns:

  • (Page) —

    Page of VersionInstance



130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/twilio-ruby/rest/intelligence/v3/version.rb', line 130

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

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

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

#stream(page_token: :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) —

    Token for pagination

  • 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



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/intelligence/v3/version.rb', line 68

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

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



160
161
162
 
# File 'lib/twilio-ruby/rest/intelligence/v3/version.rb', line 160

def to_s
    '#<Twilio.Intelligence.V3.VersionList>'
end