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.



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

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_sidString

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

Returns:



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

def 
    @properties['account_sid']
end

#contextBucketContext

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

Returns:



297
298
299
300
301
302
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 297

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

#date_createdTime

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

Returns:



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

def date_created
    @properties['date_created']
end

#date_updatedTime

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:



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

def date_updated
    @properties['date_updated']
end

#deleteBoolean

Delete the BucketInstance

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetchBucketInstance

Fetch the BucketInstance

Returns:



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

def fetch

    context.fetch
end

#inspectObject

Provide a detailed, user friendly representation



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

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

#intervalString

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.



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

def interval
    @properties['interval']
end

#maxString

Returns Maximum number of requests permitted in during the interval.

Returns:

  • (String)

    Maximum number of requests permitted in during the interval.



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

def max
    @properties['max']
end

#rate_limit_sidString

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.



312
313
314
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 312

def rate_limit_sid
    @properties['rate_limit_sid']
end

#service_sidString

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

Returns:



318
319
320
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 318

def service_sid
    @properties['service_sid']
end

#sidString

Returns A 34 character string that uniquely identifies this Bucket.

Returns:

  • (String)

    A 34 character string that uniquely identifies this Bucket.



306
307
308
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 306

def sid
    @properties['sid']
end

#to_sObject

Provide a user friendly representation



392
393
394
395
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 392

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:



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

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

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

#urlString

Returns The URL of this resource.

Returns:

  • (String)

    The URL of this resource.



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

def url
    @properties['url']
end