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

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Defined Under Namespace

Classes: BucketContext, BucketInstance, BucketList, BucketPage

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ RateLimitContext

Initialize the RateLimitContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

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

  • sid (String) —

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



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

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

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

  # Dependents
  @buckets = nil
end

Instance Method Details

#buckets(sid = :unset) ⇒ BucketList, BucketContext

Access the buckets

Returns:

Raises:

  • (ArgumentError) 


237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 237

def buckets(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return BucketContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
  end

  unless @buckets
    @buckets = BucketList.new(
        @version,
        service_sid: @solution[:service_sid],
        rate_limit_sid: @solution[:sid],
    )
  end

  @buckets
end

#delete ⇒ Boolean

Deletes the RateLimitInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

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

#fetch ⇒ RateLimitInstance

Fetch a RateLimitInstance

Returns:



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

def fetch
  params = Twilio::Values.of({})

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



264
265
266
267
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 264

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

#to_s ⇒ Object

Provide a user friendly representation



257
258
259
260
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 257

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

#update(description: :unset) ⇒ RateLimitInstance

Update the RateLimitInstance

Parameters:

  • description (String) (defaults to: :unset) —

    Description of this Rate Limit

Returns:



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

def update(description: :unset)
  data = Twilio::Values.of({'Description' => description, })

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

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