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](www.twilio.com/docs/verify/api/service) the resource is associated with.

  • sid (String) —

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



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 158

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) 


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

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



171
172
173
174
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 171

def delete

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

#fetch ⇒ RateLimitInstance

Fetch the RateLimitInstance

Returns:



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 179

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



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

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

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

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