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

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/service) 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.



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

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

Delete the BucketInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



251
252
253
254
255
256
257
258
259
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 251

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the BucketInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 264

def delete_with_metadata

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

#fetch ⇒ BucketInstance

Fetch the BucketInstance

Returns:



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 283

def fetch

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

#fetch_with_metadata ⇒ BucketInstance

Fetch the BucketInstanceMetadata

Returns:



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 304

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



406
407
408
409
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 406

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

#to_s ⇒ Object

Provide a user friendly representation



399
400
401
402
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 399

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:



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 333

def update(
  max: :unset, 
  interval: :unset
)

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

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

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

Update the BucketInstanceMetadata

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:



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 364

def update_with_metadata(
  max: :unset, 
  interval: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_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],
        sid: @solution[:sid],
    )
    BucketInstanceMetadata.new(
        @version,
        bucket_instance,
        response.headers,
        response.status_code
    )
end