Class: Twilio::REST::Verify::V2::ServiceContext::RateLimitInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ RateLimitInstance

Initialize the RateLimitInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • service_sid (String) (defaults to: nil) —

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

  • sid (String) (defaults to: nil) —

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 275

def initialize(version, payload, service_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'service_sid' => payload['service_sid'],
      'account_sid' => payload['account_sid'],
      'unique_name' => payload['unique_name'],
      'description' => payload['description'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



321
322
323
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 321

def 
  @properties['account_sid']
end

#buckets ⇒ buckets

Access the buckets

Returns:



386
387
388
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 386

def buckets
  context.buckets
end

#context ⇒ RateLimitContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



300
301
302
303
304
305
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 300

def context
  unless @instance_context
    @instance_context = RateLimitContext.new(@version, @params['service_sid'], @params['sid'], )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created



339
340
341
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 339

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated



345
346
347
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 345

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the RateLimitInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



379
380
381
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 379

def delete
  context.delete
end

#description ⇒ String

Returns Description of this Rate Limit.

Returns:

  • (String) —

    Description of this Rate Limit



333
334
335
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 333

def description
  @properties['description']
end

#fetch ⇒ RateLimitInstance

Fetch a RateLimitInstance

Returns:



372
373
374
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 372

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



399
400
401
402
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 399

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Verify.V2.RateLimitInstance #{values}>"
end

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources



357
358
359
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 357

def links
  @properties['links']
end

#service_sid ⇒ String

Returns The SID of the Service that the resource is associated with.

Returns:

  • (String) —

    The SID of the Service that the resource is associated with



315
316
317
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 315

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns A string that uniquely identifies this Rate Limit.

Returns:

  • (String) —

    A string that uniquely identifies this Rate Limit.



309
310
311
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 309

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



392
393
394
395
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 392

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Verify.V2.RateLimitInstance #{values}>"
end

#unique_name ⇒ String

Returns A unique, developer assigned name of this Rate Limit.

Returns:

  • (String) —

    A unique, developer assigned name of this Rate Limit.



327
328
329
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 327

def unique_name
  @properties['unique_name']
end

#update(description: :unset) ⇒ RateLimitInstance

Update the RateLimitInstance

Parameters:

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

    Description of this Rate Limit

Returns:



365
366
367
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 365

def update(description: :unset)
  context.update(description: description, )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



351
352
353
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 351

def url
  @properties['url']
end