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

Instance Method Summary collapse

Constructor Details

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

Initialize the ChallengeList



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_message: :unset, details_fields: :unset, hidden_details: :unset, auth_payload: :unset) ⇒ ChallengeInstance

Create the ChallengeInstance



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 57

def create(factor_sid: nil, expiration_date: :unset, details_message: :unset, details_fields: :unset, hidden_details: :unset, auth_payload: :unset)
  data = Twilio::Values.of({
      'FactorSid' => factor_sid,
      'ExpirationDate' => Twilio.serialize_iso8601_datetime(expiration_date),
      'Details.Message' => details_message,
      'Details.Fields' => Twilio.serialize_list(details_fields) { |e| Twilio.serialize_object(e) },
      'HiddenDetails' => Twilio.serialize_object(hidden_details),
      'AuthPayload' => auth_payload,
  })

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

  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.



138
139
140
141
142
143
144
145
146
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 138

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.



181
182
183
184
185
186
187
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 181

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

#list(factor_sid: :unset, status: :unset, order: :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.



94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 94

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

#page(factor_sid: :unset, status: :unset, order: :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.



161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 161

def page(factor_sid: :unset, status: :unset, order: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'FactorSid' => factor_sid,
      'Status' => status,
      'Order' => order,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

#stream(factor_sid: :unset, status: :unset, order: :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.



121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 121

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

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



191
192
193
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 191

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