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.



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

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) 


220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 220

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



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

def delete

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

#fetch ⇒ RateLimitInstance

Fetch the RateLimitInstance

Returns:



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

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



245
246
247
248
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 245

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

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

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