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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Verify::V2::ServiceContext::RateLimitInstance

Defined in:

lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #buckets ⇒ buckets

  Access the buckets.

• #context ⇒ RateLimitContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #date_created ⇒ Time

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

• #date_updated ⇒ Time

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

• #delete ⇒ Boolean

  Delete the RateLimitInstance.

• #description ⇒ String

  Description of this Rate Limit.

• #fetch ⇒ RateLimitInstance

  Fetch the RateLimitInstance.

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

  Initialize the RateLimitInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #links ⇒ String

  The URLs of related resources.

• #service_sid ⇒ String

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

• #sid ⇒ String

  A string that uniquely identifies this Rate Limit.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #unique_name ⇒ String

  A unique, developer assigned name of this Rate Limit.

• #update(description: :unset) ⇒ RateLimitInstance

  Update the RateLimitInstance.

• #url ⇒ String

  The URL of this resource.

Constructor Details

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

Initialize the RateLimitInstance

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

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

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

def account_sid
  @properties['account_sid']
end

#buckets ⇒ buckets

Access the buckets

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

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

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

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

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RateLimitInstance

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

def delete
  context.delete
end

#description ⇒ String

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

def description
  @properties['description']
end

#fetch ⇒ RateLimitInstance

Fetch the RateLimitInstance

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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#links ⇒ String

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

def links
  @properties['links']
end

#service_sid ⇒ String

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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#unique_name ⇒ String

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

def unique_name
  @properties['unique_name']
end

#update(description: :unset) ⇒ RateLimitInstance

Update the RateLimitInstance

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

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

#url ⇒ String

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

def url
  @properties['url']
end