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



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 28

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 41

def create(
    unique_name: nil, 
    description: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    RateLimitInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
    )
end

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

Create the RateLimitInstanceMetadata



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 70

def create_with_metadata(
  unique_name: nil, 
  description: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    rate_limit_instance = RateLimitInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
    )
    RateLimitInstanceMetadata.new(
        @version,
        rate_limit_instance,
        response.headers,
        response.status_code
    )
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.



165
166
167
168
169
170
171
172
173
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 165

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.



202
203
204
205
206
207
208
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 202

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.



112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 112

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

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

Lists RateLimitPageMetadata records from the API as a list.



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 148

def list_with_metadata(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    RateLimitPageMetadata.new(@version, response, @solution, limits[:limit])
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.



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

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

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

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

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

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



130
131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb', line 130

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



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

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