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



226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 226

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

Raises:

  • (ArgumentError) 


379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 379

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



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

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 253

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 272

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 292

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



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

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

#to_s ⇒ Object

Provide a user friendly representation



397
398
399
400
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 397

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

#update(description: :unset) ⇒ RateLimitInstance

Update the RateLimitInstance



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 319

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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 346

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