Class: Twilio::REST::Verify::V2::VerificationAttemptList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ VerificationAttemptList

Initialize the VerificationAttemptList



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 18

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Attempts"
end

Instance Method Details

#each ⇒ Object

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



123
124
125
126
127
128
129
130
131
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 123

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 VerificationAttemptInstance records from the API. Request is executed immediately.



184
185
186
187
188
189
190
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 184

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

#list(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, country: :unset, channel: :unset, verify_service_sid: :unset, verification_sid: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array

Lists VerificationAttemptInstance 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
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 56

def list(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, country: :unset, channel: :unset, verify_service_sid: :unset, verification_sid: :unset, status: :unset, limit: nil, page_size: nil)
  self.stream(
      date_created_after: date_created_after,
      date_created_before: date_created_before,
      channel_data_to: channel_data_to,
      country: country,
      channel: channel,
      verify_service_sid: verify_service_sid,
      verification_sid: verification_sid,
      status: status,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, country: :unset, channel: :unset, verify_service_sid: :unset, verification_sid: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 159

def page(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, country: :unset, channel: :unset, verify_service_sid: :unset, verification_sid: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'DateCreatedAfter' => Twilio.serialize_iso8601_datetime(date_created_after),
      'DateCreatedBefore' => Twilio.serialize_iso8601_datetime(date_created_before),
      'ChannelData.To' => channel_data_to,
      'Country' => country,
      'Channel' => channel,
      'VerifyServiceSid' => verify_service_sid,
      'VerificationSid' => verification_sid,
      'Status' => status,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

#stream(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, country: :unset, channel: :unset, verify_service_sid: :unset, verification_sid: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 101

def stream(date_created_after: :unset, date_created_before: :unset, channel_data_to: :unset, country: :unset, channel: :unset, verify_service_sid: :unset, verification_sid: :unset, status: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      date_created_after: date_created_after,
      date_created_before: date_created_before,
      channel_data_to: channel_data_to,
      country: country,
      channel: channel,
      verify_service_sid: verify_service_sid,
      verification_sid: verification_sid,
      status: status,
      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



194
195
196
 
# File 'lib/twilio-ruby/rest/verify/v2/verification_attempt.rb', line 194

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