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

  • account_sid (String) —

    The SID of the Account that created this RateLimit resource.

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

    The SID of the Call resource to fetch.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 556

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  || @properties['service_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the Rate Limit resource.

Returns:

  • (String) —

    The SID of the Account that created the Rate Limit resource.



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

def 
    @properties['account_sid']
end

#buckets ⇒ buckets

Access the buckets

Returns:



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

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:



582
583
584
585
586
587
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 582

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

#date_created ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RateLimitInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



646
647
648
649
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 646

def delete

    context.delete
end

#description ⇒ String

Returns Description of this Rate Limit.

Returns:

  • (String) —

    Description of this Rate Limit



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

def description
    @properties['description']
end

#fetch ⇒ RateLimitInstance

Fetch the RateLimitInstance

Returns:



654
655
656
657
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 654

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



688
689
690
691
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 688

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



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

def links
    @properties['links']
end

#service_sid ⇒ String

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

Returns:

  • (String) —

    The SID of the Service the resource is associated with.



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this Rate Limit.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this Rate Limit.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



681
682
683
684
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 681

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

#unique_name ⇒ String

Returns Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. This value should not contain PII..

Returns:

  • (String) —

    Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. This value should not contain PII.



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

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:



663
664
665
666
667
668
669
670
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 663

def update(
    description: :unset
)

    context.update(
        description: description, 
    )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

def url
    @properties['url']
end