Class: Twilio::REST::Verify::V2::ServiceContext::RateLimitList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ RateLimitList

Initialize the RateLimitList



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 22

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

  # Path Solution
  @solution = {service_sid: service_sid}
  @uri = "/Services/#{@solution[:service_sid]}/RateLimits"
end

Instance Method Details

#create(unique_name: nil, description: :unset) ⇒ RateLimitInstance

Create the RateLimitInstance



37
38
39
40
41
42
43
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 37

def create(unique_name: nil, description: :unset)
  data = Twilio::Values.of({'UniqueName' => unique_name, 'Description' => description, })

  payload = @version.create('POST', @uri, data: data)

  RateLimitInstance.new(@version, payload, service_sid: @solution[:service_sid], )
end

#each ⇒ Object

When passed a block, yields RateLimitInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



83
84
85
86
87
88
89
90
91
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 83

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of RateLimitInstance records from the API. Request is executed immediately.



117
118
119
120
121
122
123
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 117

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  RateLimitPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists RateLimitInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.



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

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of RateLimitInstance records from the API. Request is executed immediately.



100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 100

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  RateLimitPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams RateLimitInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



71
72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 71

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
  '#<Twilio.Verify.V2.RateLimitList>'
end