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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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

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

    The SID of the [Service](www.twilio.com/docs/verify/api-beta/service-beta) the resource is associated with.

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

    The Twilio-provided string that uniquely identifies the Rate Limit resource.



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

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

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

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
 
# 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, })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  BucketInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      rate_limit_sid: @solution[:rate_limit_sid],
  )
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.



97
98
99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 97

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).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



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

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



70
71
72
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 70

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
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



114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 114

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  BucketPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams BucketInstance 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



85
86
87
88
89
90
91
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 85

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

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



143
144
145
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 143

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