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](www.twilio.com/docs/verify/api/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.



164
165
166
167
168
169
170
171
172
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 164

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



176
177
178
179
180
181
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 176

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ BucketInstance

Fetch the BucketInstance

Returns:



186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 186

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    payload = @version.fetch('GET', @uri, headers: headers)
    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



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

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

#to_s ⇒ Object

Provide a user friendly representation



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

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:



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb', line 205

def update(
    max: :unset, 
    interval: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    BucketInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        rate_limit_sid: @solution[:rate_limit_sid],
        sid: @solution[:sid],
    )
end