class Twilio::REST::Verify::V2::ServiceContext::RateLimitContext::BucketContext

Public Class Methods

new(version, service_sid, rate_limit_sid, sid) click to toggle source

Initialize the BucketContext @param [Version] version Version that contains the resource @param [String] service_sid The SID of the

{Service}[https://www.twilio.com/docs/verify/api/service] the resource is
associated with.

@param [String] rate_limit_sid The Twilio-provided string that uniquely

identifies the Rate Limit resource.

@param [String] sid A 34 character string that uniquely identifies this Bucket. @return [BucketContext] BucketContext

Calls superclass method Twilio::REST::InstanceContext::new
    # File lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb
184 def initialize(version, service_sid, rate_limit_sid, sid)
185   super(version)
186 
187   # Path Solution
188   @solution = {service_sid: service_sid, rate_limit_sid: rate_limit_sid, sid: sid, }
189   @uri = "/Services/#{@solution[:service_sid]}/RateLimits/#{@solution[:rate_limit_sid]}/Buckets/#{@solution[:sid]}"
190 end

Public Instance Methods

delete() click to toggle source

Delete the BucketInstance @return [Boolean] true if delete succeeds, false otherwise

    # File lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb
230 def delete
231    @version.delete('DELETE', @uri)
232 end
fetch() click to toggle source

Fetch the BucketInstance @return [BucketInstance] Fetched BucketInstance

    # File lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb
215 def fetch
216   payload = @version.fetch('GET', @uri)
217 
218   BucketInstance.new(
219       @version,
220       payload,
221       service_sid: @solution[:service_sid],
222       rate_limit_sid: @solution[:rate_limit_sid],
223       sid: @solution[:sid],
224   )
225 end
inspect() click to toggle source

Provide a detailed, user friendly representation

    # File lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb
243 def inspect
244   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
245   "#<Twilio.Verify.V2.BucketContext #{context}>"
246 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb
236 def to_s
237   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
238   "#<Twilio.Verify.V2.BucketContext #{context}>"
239 end
update(max: :unset, interval: :unset) click to toggle source

Update the BucketInstance @param [String] max Maximum number of requests permitted in during the interval. @param [String] interval Number of seconds that the rate limit will be enforced

over.

@return [BucketInstance] Updated BucketInstance

    # File lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb
198 def update(max: :unset, interval: :unset)
199   data = Twilio::Values.of({'Max' => max, 'Interval' => interval, })
200 
201   payload = @version.update('POST', @uri, data: data)
202 
203   BucketInstance.new(
204       @version,
205       payload,
206       service_sid: @solution[:service_sid],
207       rate_limit_sid: @solution[:rate_limit_sid],
208       sid: @solution[:sid],
209   )
210 end