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

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 the resource is associated with.

  • sid (String) —

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


171
172
173
174
175
176
177
178
179
180
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 171

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) 

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

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

Delete the RateLimitInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


206
207
208
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 206

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

#fetch ⇒ RateLimitInstance

Fetch the RateLimitInstance

Returns:


197
198
199
200
201
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 197

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation


241
242
243
244
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 241

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

#to_s ⇒ Object

Provide a user friendly representation


234
235
236
237
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 234

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:


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

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