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



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_sid ⇒ String 



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

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



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_created ⇒ Time 



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_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the BucketInstance



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

def delete
  context.delete
end

#fetch ⇒ BucketInstance

Fetch the BucketInstance



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

def fetch
  context.fetch
end

#inspect ⇒ Object

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

#interval ⇒ String 



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

def interval
  @properties['interval']
end

#max ⇒ String 



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

def max
  @properties['max']
end

#rate_limit_sid ⇒ String 



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_sid ⇒ String 



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

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



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

#url ⇒ String 



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

def url
  @properties['url']
end