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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, rate_limit_sid, sid) ⇒ BucketContext

Initialize the BucketContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the Service the resource is associated with.

  • rate_limit_sid (String) —

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

  • sid (String) —

    A 34 character string that uniquely identifies this Bucket.


184
185
186
187
188
189
190
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 184

def initialize(version, service_sid, rate_limit_sid, sid)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, rate_limit_sid: rate_limit_sid, sid: sid, }
  @uri = "/Services/#{@solution[:service_sid]}/RateLimits/#{@solution[:rate_limit_sid]}/Buckets/#{@solution[:sid]}"
end

Instance Method Details

#delete ⇒ Boolean

Delete the BucketInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


230
231
232
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 230

def delete
   @version.delete('DELETE', @uri)
end

#fetch ⇒ BucketInstance

Fetch the BucketInstance

Returns:


215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 215

def fetch
  payload = @version.fetch('GET', @uri)

  BucketInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      rate_limit_sid: @solution[:rate_limit_sid],
      sid: @solution[:sid],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


243
244
245
246
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 243

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

#to_s ⇒ Object

Provide a user friendly representation


236
237
238
239
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 236

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


198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 198

def update(max: :unset, interval: :unset)
  data = Twilio::Values.of({'Max' => max, 'Interval' => interval, })

  payload = @version.update('POST', @uri, data: data)

  BucketInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      rate_limit_sid: @solution[:rate_limit_sid],
      sid: @solution[:sid],
  )
end