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



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

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



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 39

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.



90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 90

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.



124
125
126
127
128
129
130
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 124

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.



63
64
65
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 63

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.



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 107

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: 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.



78
79
80
81
82
83
84
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 78

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



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

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