Class: Twilio::REST::Verify::V2::ServiceContext::RateLimitContext::BucketList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, rate_limit_sid: nil) ⇒ BucketList

Initialize the BucketList

Parameters:

  • version (Version) —

    Version that contains the resource



29
30
31
32
33
34
35
36
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 29

def initialize(version, service_sid: nil, rate_limit_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { service_sid: service_sid, rate_limit_sid: rate_limit_sid }
    @uri = "/Services/#{@solution[:service_sid]}/RateLimits/#{@solution[:rate_limit_sid]}/Buckets"
    
end

Instance Method Details

#create(max: nil, interval: nil) ⇒ BucketInstance

Create the BucketInstance

Parameters:

  • max (String) (defaults to: nil) —

    Maximum number of requests permitted in during the interval.

  • interval (String) (defaults to: nil) —

    Number of seconds that the rate limit will be enforced over.

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 42

def create(
  max: nil, 
  interval: nil
)

    data = Twilio::Values.of({
        'Max' => max,
        'Interval' => interval,
    })

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

#create_with_metadata(max: nil, interval: nil) ⇒ BucketInstance

Create the BucketInstanceMetadata

Parameters:

  • max (String) (defaults to: nil) —

    Maximum number of requests permitted in during the interval.

  • interval (String) (defaults to: nil) —

    Number of seconds that the rate limit will be enforced over.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 72

def create_with_metadata(
  max: nil, 
  interval: nil
)

    data = Twilio::Values.of({
        'Max' => max,
        'Interval' => interval,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    bucket_instance = BucketInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
        rate_limit_sid: @solution[:rate_limit_sid],
    )
    BucketInstanceMetadata.new(
        @version,
        bucket_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 172

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of BucketInstance



213
214
215
216
217
218
219
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 213

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

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

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

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



115
116
117
118
119
120
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 115

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

#list_with_metadata(limit: nil, page_size: nil) ⇒ Array

Lists BucketPageMetadata records from the API as a list.

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



155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 155

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

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

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

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

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

Parameters:

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

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of BucketInstance



193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 193

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

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

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

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

  • 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



133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 133

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

    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
end

#to_s ⇒ Object

Provide a user friendly representation



224
225
226
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 224

def to_s
    '#<Twilio.Verify.V2.BucketList>'
end