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

Parameters:

  • version (Version) —

    Version that contains the resource


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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of VerificationAttemptInstance


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.

Parameters:

  • date_created_after (Time) (defaults to: :unset) —

    Datetime filter used to query Verification Attempts created after this datetime. Given as GMT in RFC 2822 format.

  • date_created_before (Time) (defaults to: :unset) —

    Datetime filter used to query Verification Attempts created before this datetime. Given as GMT in RFC 2822 format.

  • channel_data_to (String) (defaults to: :unset) —

    Destination of a verification. It is phone number in E.164 format.

  • country (String) (defaults to: :unset) —

    Filter used to query Verification Attempts sent to the specified destination country.

  • channel (verification_attempt.Channels) (defaults to: :unset) —

    Filter used to query Verification Attempts by communication channel. Valid values are `SMS` and `CALL`

  • verify_service_sid (String) (defaults to: :unset) —

    Filter used to query Verification Attempts by verify service. Only attempts of the provided SID will be returned.

  • verification_sid (String) (defaults to: :unset) —

    Filter used to return all the Verification Attempts of a single verification. Only attempts of the provided verification SID will be returned.

  • status (verification_attempt.ConversionStatus) (defaults to: :unset) —

    Filter used to query Verification Attempts by conversion status. Valid values are `UNCONVERTED`, for attempts that were not converted, and `CONVERTED`, for attempts that were confirmed.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results


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.

Parameters:

  • date_created_after (Time) (defaults to: :unset) —

    Datetime filter used to query Verification Attempts created after this datetime. Given as GMT in RFC 2822 format.

  • date_created_before (Time) (defaults to: :unset) —

    Datetime filter used to query Verification Attempts created before this datetime. Given as GMT in RFC 2822 format.

  • channel_data_to (String) (defaults to: :unset) —

    Destination of a verification. It is phone number in E.164 format.

  • country (String) (defaults to: :unset) —

    Filter used to query Verification Attempts sent to the specified destination country.

  • channel (verification_attempt.Channels) (defaults to: :unset) —

    Filter used to query Verification Attempts by communication channel. Valid values are `SMS` and `CALL`

  • verify_service_sid (String) (defaults to: :unset) —

    Filter used to query Verification Attempts by verify service. Only attempts of the provided SID will be returned.

  • verification_sid (String) (defaults to: :unset) —

    Filter used to return all the Verification Attempts of a single verification. Only attempts of the provided verification SID will be returned.

  • status (verification_attempt.ConversionStatus) (defaults to: :unset) —

    Filter used to query Verification Attempts by conversion status. Valid values are `UNCONVERTED`, for attempts that were not converted, and `CONVERTED`, for attempts that were confirmed.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of VerificationAttemptInstance


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.

Parameters:

  • date_created_after (Time) (defaults to: :unset) —

    Datetime filter used to query Verification Attempts created after this datetime. Given as GMT in RFC 2822 format.

  • date_created_before (Time) (defaults to: :unset) —

    Datetime filter used to query Verification Attempts created before this datetime. Given as GMT in RFC 2822 format.

  • channel_data_to (String) (defaults to: :unset) —

    Destination of a verification. It is phone number in E.164 format.

  • country (String) (defaults to: :unset) —

    Filter used to query Verification Attempts sent to the specified destination country.

  • channel (verification_attempt.Channels) (defaults to: :unset) —

    Filter used to query Verification Attempts by communication channel. Valid values are `SMS` and `CALL`

  • verify_service_sid (String) (defaults to: :unset) —

    Filter used to query Verification Attempts by verify service. Only attempts of the provided SID will be returned.

  • verification_sid (String) (defaults to: :unset) —

    Filter used to return all the Verification Attempts of a single verification. Only attempts of the provided verification SID will be returned.

  • status (verification_attempt.ConversionStatus) (defaults to: :unset) —

    Filter used to query Verification Attempts by conversion status. Valid values are `UNCONVERTED`, for attempts that were not converted, and `CONVERTED`, for attempts that were confirmed.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results


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