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

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb,
lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb

Defined Under Namespace

Classes: BucketContext, BucketInstance, BucketInstanceMetadata, BucketList, BucketListResponse, BucketPage, BucketPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ RateLimitContext

Initialize the RateLimitContext

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.

  • sid (String) —

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



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

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

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

    # Dependents
    @buckets = nil
end

Instance Method Details

#buckets(sid = :unset) ⇒ BucketList, BucketContext

Access the buckets

Returns:

Raises:

  • (ArgumentError) 


387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 387

def buckets(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return BucketContext.new(@version, @solution[:service_sid], @solution[:sid],sid )
    end

    unless @buckets
        @buckets = BucketList.new(
            @version, service_sid: @solution[:service_sid], rate_limit_sid: @solution[:sid], )
    end

 @buckets
end

#delete ⇒ Boolean

Delete the RateLimitInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



248
249
250
251
252
253
254
255
256
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 248

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 RateLimitInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete_with_metadata

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

#fetch ⇒ RateLimitInstance

Fetch the RateLimitInstance

Returns:



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 280

def fetch

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

#fetch_with_metadata ⇒ RateLimitInstance

Fetch the RateLimitInstanceMetadata

Returns:



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 300

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



412
413
414
415
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 412

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

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(description: :unset) ⇒ RateLimitInstance

Update the RateLimitInstance

Parameters:

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

    Description of this Rate Limit

Returns:



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 327

def update(
  description: :unset
)

    data = Twilio::Values.of({
        'Description' => description,
    })

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

#update_with_metadata(description: :unset) ⇒ RateLimitInstance

Update the RateLimitInstanceMetadata

Parameters:

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

    Description of this Rate Limit

Returns:



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 354

def update_with_metadata(
  description: :unset
)

    data = Twilio::Values.of({
        'Description' => description,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    rate_limit_instance = RateLimitInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
    RateLimitInstanceMetadata.new(
        @version,
        rate_limit_instance,
        response.headers,
        response.status_code
    )
end