Class: Twilio::REST::Verify::V2::ServiceContext::EntityContext::ChallengeList

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, identity: nil) ⇒ ChallengeList

Initialize the ChallengeList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The unique SID identifier of the Service.

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

    Customer unique identity for the Entity owner of the Challenge



25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 25

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

  # Path Solution
  @solution = {service_sid: service_sid, identity: identity}
  @uri = "/Services/#{@solution[:service_sid]}/Entities/#{@solution[:identity]}/Challenges"
end

Instance Method Details

#create(factor_sid: nil, expiration_date: :unset, details: :unset, hidden_details: :unset, twilio_sandbox_mode: :unset) ⇒ ChallengeInstance

Create the ChallengeInstance

Parameters:

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

    The unique SID identifier of the Factor.

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

    The future date in which this Challenge will expire, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

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

    Details provided to give context about the Challenge. Shown to the end user. It must be a stringified JSON with the following structure: “string”, “fields”: [ { “label”: “string”, “value”: “string”]}. ‘message` is required. If you send the `fields` property, each field has to include `label` and `value` properties. If you had set `include_date=true` in the `push` configuration of the [service](www.twilio.com/docs/verify/api/service), the response will also include the challenge’s date created value as an additional field called ‘date`

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

    Details provided to give context about the Challenge. Not shown to the end user. It must be a stringified JSON with only strings values eg. ‘“172.168.1.234”`

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

    The Twilio-Sandbox-Mode HTTP request header

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 52

def create(factor_sid: nil, expiration_date: :unset, details: :unset, hidden_details: :unset, twilio_sandbox_mode: :unset)
  data = Twilio::Values.of({
      'FactorSid' => factor_sid,
      'ExpirationDate' => Twilio.serialize_iso8601_datetime(expiration_date),
      'Details' => details,
      'HiddenDetails' => hidden_details,
  })
  headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })

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

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

#each ⇒ Object

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



128
129
130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 128

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ChallengeInstance



169
170
171
172
173
174
175
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 169

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

#list(factor_sid: :unset, status: :unset, twilio_sandbox_mode: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

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

    The unique SID identifier of the Factor.

  • status (challenge.ChallengeStatuses) (defaults to: :unset) —

    The Status of the Challenges to fetch. One of ‘pending`, `expired`, `approved` or `denied`.

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

    The Twilio-Sandbox-Mode HTTP request header

  • 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



86
87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 86

def list(factor_sid: :unset, status: :unset, twilio_sandbox_mode: :unset, limit: nil, page_size: nil)
  self.stream(
      factor_sid: factor_sid,
      status: status,
      twilio_sandbox_mode: twilio_sandbox_mode,
      limit: limit,
      page_size: page_size
  ).entries
end

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

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

Parameters:

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

    The unique SID identifier of the Factor.

  • status (challenge.ChallengeStatuses) (defaults to: :unset) —

    The Status of the Challenges to fetch. One of ‘pending`, `expired`, `approved` or `denied`.

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

    The Twilio-Sandbox-Mode HTTP request header

  • 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 ChallengeInstance



149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 149

def page(factor_sid: :unset, status: :unset, twilio_sandbox_mode: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'FactorSid' => factor_sid,
      'Status' => status,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })

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

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

#stream(factor_sid: :unset, status: :unset, twilio_sandbox_mode: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

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

    The unique SID identifier of the Factor.

  • status (challenge.ChallengeStatuses) (defaults to: :unset) —

    The Status of the Challenges to fetch. One of ‘pending`, `expired`, `approved` or `denied`.

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

    The Twilio-Sandbox-Mode HTTP request header

  • 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



111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 111

def stream(factor_sid: :unset, status: :unset, twilio_sandbox_mode: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      factor_sid: factor_sid,
      status: status,
      twilio_sandbox_mode: twilio_sandbox_mode,
      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



179
180
181
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 179

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