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

Inherits:
InstanceContext
  • 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, rate_limit_sid, sid) ⇒ BucketContext

Initialize the BucketContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

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

  • rate_limit_sid (String) —

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

  • sid (String) —

    A 34 character string that uniquely identifies this Bucket.



197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 197

def initialize(version, service_sid, rate_limit_sid, sid)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, rate_limit_sid: rate_limit_sid, sid: sid, }
  @uri = "/Services/#{@solution[:service_sid]}/RateLimits/#{@solution[:rate_limit_sid]}/Buckets/#{@solution[:sid]}"
end

Instance Method Details

#delete ⇒ Boolean

Deletes the BucketInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



253
254
255
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 253

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ BucketInstance

Fetch a BucketInstance

Returns:



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 232

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  BucketInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      rate_limit_sid: @solution[:rate_limit_sid],
      sid: @solution[:sid],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



266
267
268
269
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 266

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Verify.V2.BucketContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



259
260
261
262
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 259

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Verify.V2.BucketContext #{context}>"
end

#update(max: :unset, interval: :unset) ⇒ BucketInstance

Update the BucketInstance

Parameters:

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

    Maximum number of requests permitted in during the interval.

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

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

Returns:



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 211

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

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

  BucketInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      rate_limit_sid: @solution[:rate_limit_sid],
      sid: @solution[:sid],
  )
end