Class: Twilio::REST::Verify::V2::ServiceContext::EntityContext::ChallengeList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Verify::V2::ServiceContext::EntityContext::ChallengeList
- Defined in:
- lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb
Instance Method Summary collapse
-
#create(factor_sid: nil, expiration_date: :unset, details_message: :unset, details_fields: :unset, hidden_details: :unset, auth_payload: :unset) ⇒ ChallengeInstance
Create the ChallengeInstance.
-
#each ⇒ Object
When passed a block, yields ChallengeInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of ChallengeInstance records from the API.
-
#initialize(version, service_sid: nil, identity: nil) ⇒ ChallengeList
constructor
Initialize the ChallengeList.
-
#list(factor_sid: :unset, status: :unset, order: :unset, limit: nil, page_size: nil) ⇒ Array
Lists ChallengeInstance records from the API as a list.
-
#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.
-
#stream(factor_sid: :unset, status: :unset, order: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, service_sid: nil, identity: nil) ⇒ ChallengeList
Initialize the ChallengeList
28 29 30 31 32 33 34 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 28 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
44 45 46 47 48 49 50 51 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 44 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.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.
126 127 128 129 130 131 132 133 134 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 126 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.
170 171 172 173 174 175 176 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 170 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.
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, 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.
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 146 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 Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 110 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
181 182 183 |
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 181 def to_s '#<Twilio.Verify.V2.ChallengeList>' end |