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

  • service_sid (String) (defaults to: nil)

    The SID of the Service the resource is associated with.

  • rate_limit_sid (String) (defaults to: nil)

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

  • sid (String) (defaults to: nil)

    A 34 character string that uniquely identifies this Bucket.


261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 261

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'].to_i,
      '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,
      'rate_limit_sid' => rate_limit_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

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:


290
291
292
293
294
295
296
297
298
299
300
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 290

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 RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT when the resource was created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT when the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the BucketInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetchBucketInstance

Fetch the BucketInstance

Returns:


369
370
371
# 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


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

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.


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

def interval
  @properties['interval']
end

#maxString

Returns Max number of requests.

Returns:

  • (String)

    Max number of requests.


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

def max
  @properties['max']
end

#rate_limit_sidString

Returns Rate Limit Sid.

Returns:

  • (String)

    Rate Limit Sid.


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

def rate_limit_sid
  @properties['rate_limit_sid']
end

#service_sidString

Returns The SID of the Service that the resource is associated with.

Returns:

  • (String)

    The SID of the Service that the resource is associated with


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

def service_sid
  @properties['service_sid']
end

#sidString

Returns A string that uniquely identifies this Bucket.

Returns:

  • (String)

    A string that uniquely identifies this Bucket.


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

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


382
383
384
385
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 382

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:


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

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.


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

def url
  @properties['url']
end