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

Parameters:

  • version (Version) —

    Version that contains the resource



29
30
31
32
33
34
35
36
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 29

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

Parameters:

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

    The unique SID identifier of the Factor.

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

    The date-time when this Challenge expires, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. The default value is five (5) minutes after Challenge creation. The max value is sixty (60) minutes after creation.

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

    Shown to the user when the push notification arrives. Required when factor_type is push. Can be up to 256 characters in length

  • details_fields (Array[Hash]) (defaults to: :unset) —

    A list of objects that describe the Fields included in the Challenge. Each object contains the label and value of the field, the label can be up to 36 characters in length and the value can be up to 128 characters in length. Used when factor_type is push. There can be up to 20 details fields.

  • hidden_details (Object) (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\"`. Can be up to 1024 characters in length

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

    Optional payload used to verify the Challenge upon creation. Only used with a Factor of type totp to carry the TOTP code that needs to be verified. For TOTP this value must be between 3 and 8 characters long.

Returns:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 46

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,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    ChallengeInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        identity: @solution[:identity],
    )
end

#create_with_metadata(factor_sid: nil, expiration_date: :unset, details_message: :unset, details_fields: :unset, hidden_details: :unset, auth_payload: :unset) ⇒ ChallengeInstance

Create the ChallengeInstanceMetadata

Parameters:

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

    The unique SID identifier of the Factor.

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

    The date-time when this Challenge expires, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. The default value is five (5) minutes after Challenge creation. The max value is sixty (60) minutes after creation.

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

    Shown to the user when the push notification arrives. Required when factor_type is push. Can be up to 256 characters in length

  • details_fields (Array[Hash]) (defaults to: :unset) —

    A list of objects that describe the Fields included in the Challenge. Each object contains the label and value of the field, the label can be up to 36 characters in length and the value can be up to 128 characters in length. Used when factor_type is push. There can be up to 20 details fields.

  • hidden_details (Object) (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\"`. Can be up to 1024 characters in length

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

    Optional payload used to verify the Challenge upon creation. Only used with a Factor of type totp to carry the TOTP code that needs to be verified. For TOTP this value must be between 3 and 8 characters long.

Returns:



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 88

def create_with_metadata(
  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,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    challenge_instance = ChallengeInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
        identity: @solution[:identity],
    )
    ChallengeInstanceMetadata.new(
        @version,
        challenge_instance,
        response.headers,
        response.status_code
    )
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.



210
211
212
213
214
215
216
217
218
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 210

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



253
254
255
256
257
258
259
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 253

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.

Parameters:

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

    The unique SID identifier of the Factor.

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

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

  • order (ListOrders) (defaults to: :unset) —

    The desired sort order of the Challenges list. One of asc or desc for ascending and descending respectively. Defaults to asc.

  • 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



142
143
144
145
146
147
148
149
150
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 142

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

#list_with_metadata(factor_sid: :unset, status: :unset, order: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

Parameters:

  • 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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 190

def list_with_metadata(factor_sid: :unset, status: :unset, order: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'FactorSid' => factor_sid,
        'Status' => status,
        'Order' => order,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    ChallengePageMetadata.new(@version, response, @solution, limits[:limit])
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.

Parameters:

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

    The unique SID identifier of the Factor.

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

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

  • order (ListOrders) (defaults to: :unset) —

    The desired sort order of the Challenges list. One of asc or desc for ascending and descending respectively. Defaults to asc.

  • 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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 230

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,
    })
    headers = Twilio::Values.of({})
    
    

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

    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.

Parameters:

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

    The unique SID identifier of the Factor.

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

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

  • order (ListOrders) (defaults to: :unset) —

    The desired sort order of the Challenges list. One of asc or desc for ascending and descending respectively. Defaults to asc.

  • 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



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

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



264
265
266
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb', line 264

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