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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, rate_limit_sid: nil, sid: nil) ⇒ BucketInstance

Initialize the BucketInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Bucket resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



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

def initialize(version, payload , service_sid: nil, rate_limit_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'rate_limit_sid' => payload['rate_limit_sid'],
        'service_sid' => payload['service_sid'],
        'account_sid' => payload['account_sid'],
        'max' => payload['max'] == nil ? payload['max'] : payload['max'].to_i,
        'interval' => payload['interval'] == nil ? payload['interval'] : payload['interval'].to_i,
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'rate_limit_sid' => rate_limit_sid  || @properties['rate_limit_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Rate Limit resource.

Returns:



350
351
352
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 350

def 
    @properties['account_sid']
end

#context ⇒ BucketContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



323
324
325
326
327
328
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 323

def context
    unless @instance_context
        @instance_context = BucketContext.new(@version , @params['service_sid'], @params['rate_limit_sid'], @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



368
369
370
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 368

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



374
375
376
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 374

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the BucketInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



387
388
389
390
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 387

def delete

    context.delete
end

#fetch ⇒ BucketInstance

Fetch the BucketInstance

Returns:



395
396
397
398
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 395

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



425
426
427
428
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 425

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Verify.V2.BucketInstance #{values}>"
end

#interval ⇒ String

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

Returns:

  • (String) —

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



362
363
364
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 362

def interval
    @properties['interval']
end

#max ⇒ String

Returns Maximum number of requests permitted in during the interval.

Returns:

  • (String) —

    Maximum number of requests permitted in during the interval.



356
357
358
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 356

def max
    @properties['max']
end

#rate_limit_sid ⇒ String

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

Returns:

  • (String) —

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



338
339
340
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 338

def rate_limit_sid
    @properties['rate_limit_sid']
end

#service_sid ⇒ String

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

Returns:



344
345
346
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 344

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this Bucket.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this Bucket.



332
333
334
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 332

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



418
419
420
421
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 418

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Verify.V2.BucketInstance #{values}>"
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:



405
406
407
408
409
410
411
412
413
414
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 405

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

    context.update(
        max: max, 
        interval: interval, 
    )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



380
381
382
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 380

def url
    @properties['url']
end