prelude-sdk 0.7.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (124) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +3 -5
  4. data/lib/prelude_sdk/client.rb +4 -0
  5. data/lib/prelude_sdk/internal/type/base_model.rb +5 -5
  6. data/lib/prelude_sdk/models/intel/kyc_match_params.rb +96 -0
  7. data/lib/prelude_sdk/models/intel/kyc_match_response.rb +305 -0
  8. data/lib/prelude_sdk/models/notify_reply_params.rb +60 -0
  9. data/lib/prelude_sdk/models/notify_reply_response.rb +65 -0
  10. data/lib/prelude_sdk/models/signals.rb +125 -0
  11. data/lib/prelude_sdk/models/target.rb +39 -0
  12. data/lib/prelude_sdk/models/verification/phone/history_list_params.rb +177 -0
  13. data/lib/prelude_sdk/models/verification/phone/history_list_response.rb +286 -0
  14. data/lib/prelude_sdk/models/verification/phone/history_retrieve_params.rb +24 -0
  15. data/lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb +910 -0
  16. data/lib/prelude_sdk/models/verification/phone/phone_verification_carrier.rb +29 -0
  17. data/lib/prelude_sdk/models/verification/phone/phone_verification_money.rb +35 -0
  18. data/lib/prelude_sdk/models/verification/phone/phone_verification_psd2_transaction.rb +29 -0
  19. data/lib/prelude_sdk/models/verification_check_params.rb +3 -38
  20. data/lib/prelude_sdk/models/verification_create_params.rb +6 -161
  21. data/lib/prelude_sdk/models/verification_create_response.rb +59 -33
  22. data/lib/prelude_sdk/models/verification_management/sandbox_add_phone_number_params.rb +37 -0
  23. data/lib/prelude_sdk/models/verification_management/sandbox_add_phone_number_response.rb +27 -0
  24. data/lib/prelude_sdk/models/verification_management/sandbox_delete_phone_number_params.rb +22 -0
  25. data/lib/prelude_sdk/models/verification_management/sandbox_delete_phone_number_response.rb +19 -0
  26. data/lib/prelude_sdk/models/verification_management/sandbox_list_phone_numbers_params.rb +16 -0
  27. data/lib/prelude_sdk/models/verification_management/sandbox_list_phone_numbers_response.rb +47 -0
  28. data/lib/prelude_sdk/models/watch_evaluate_params.rb +68 -0
  29. data/lib/prelude_sdk/models/watch_evaluate_response.rb +318 -0
  30. data/lib/prelude_sdk/models/watch_predict_params.rb +6 -160
  31. data/lib/prelude_sdk/models/watch_predict_response.rb +53 -30
  32. data/lib/prelude_sdk/models/watch_send_events_params.rb +3 -38
  33. data/lib/prelude_sdk/models/watch_send_feedbacks_params.rb +3 -38
  34. data/lib/prelude_sdk/models.rb +14 -0
  35. data/lib/prelude_sdk/resources/intel/kyc.rb +62 -0
  36. data/lib/prelude_sdk/resources/intel.rb +20 -0
  37. data/lib/prelude_sdk/resources/notify.rb +35 -0
  38. data/lib/prelude_sdk/resources/verification/phone/history.rb +104 -0
  39. data/lib/prelude_sdk/resources/verification/phone.rb +21 -0
  40. data/lib/prelude_sdk/resources/verification.rb +7 -3
  41. data/lib/prelude_sdk/resources/verification_management/sandbox.rb +99 -0
  42. data/lib/prelude_sdk/resources/verification_management.rb +5 -0
  43. data/lib/prelude_sdk/resources/watch.rb +45 -2
  44. data/lib/prelude_sdk/version.rb +1 -1
  45. data/lib/prelude_sdk.rb +26 -0
  46. data/rbi/prelude_sdk/client.rbi +3 -0
  47. data/rbi/prelude_sdk/models/intel/kyc_match_params.rbi +147 -0
  48. data/rbi/prelude_sdk/models/intel/kyc_match_response.rbi +736 -0
  49. data/rbi/prelude_sdk/models/notify_reply_params.rbi +87 -0
  50. data/rbi/prelude_sdk/models/notify_reply_response.rbi +94 -0
  51. data/rbi/prelude_sdk/models/signals.rbi +200 -0
  52. data/rbi/prelude_sdk/models/target.rbi +61 -0
  53. data/rbi/prelude_sdk/models/verification/phone/history_list_params.rbi +436 -0
  54. data/rbi/prelude_sdk/models/verification/phone/history_list_response.rbi +661 -0
  55. data/rbi/prelude_sdk/models/verification/phone/history_retrieve_params.rbi +42 -0
  56. data/rbi/prelude_sdk/models/verification/phone/history_retrieve_response.rbi +2290 -0
  57. data/rbi/prelude_sdk/models/verification/phone/phone_verification_carrier.rbi +39 -0
  58. data/rbi/prelude_sdk/models/verification/phone/phone_verification_money.rbi +46 -0
  59. data/rbi/prelude_sdk/models/verification/phone/phone_verification_psd2_transaction.rbi +68 -0
  60. data/rbi/prelude_sdk/models/verification_check_params.rbi +4 -85
  61. data/rbi/prelude_sdk/models/verification_create_params.rbi +8 -328
  62. data/rbi/prelude_sdk/models/verification_create_response.rbi +143 -65
  63. data/rbi/prelude_sdk/models/verification_management/sandbox_add_phone_number_params.rbi +58 -0
  64. data/rbi/prelude_sdk/models/verification_management/sandbox_add_phone_number_response.rbi +42 -0
  65. data/rbi/prelude_sdk/models/verification_management/sandbox_delete_phone_number_params.rbi +43 -0
  66. data/rbi/prelude_sdk/models/verification_management/sandbox_delete_phone_number_response.rbi +32 -0
  67. data/rbi/prelude_sdk/models/verification_management/sandbox_list_phone_numbers_params.rbi +34 -0
  68. data/rbi/prelude_sdk/models/verification_management/sandbox_list_phone_numbers_response.rbi +101 -0
  69. data/rbi/prelude_sdk/models/watch_evaluate_params.rbi +109 -0
  70. data/rbi/prelude_sdk/models/watch_evaluate_response.rbi +596 -0
  71. data/rbi/prelude_sdk/models/watch_predict_params.rbi +8 -320
  72. data/rbi/prelude_sdk/models/watch_predict_response.rbi +135 -62
  73. data/rbi/prelude_sdk/models/watch_send_events_params.rbi +4 -93
  74. data/rbi/prelude_sdk/models/watch_send_feedbacks_params.rbi +4 -95
  75. data/rbi/prelude_sdk/models.rbi +14 -0
  76. data/rbi/prelude_sdk/resources/intel/kyc.rbi +61 -0
  77. data/rbi/prelude_sdk/resources/intel.rbi +17 -0
  78. data/rbi/prelude_sdk/resources/notify.rbi +31 -0
  79. data/rbi/prelude_sdk/resources/verification/phone/history.rbi +112 -0
  80. data/rbi/prelude_sdk/resources/verification/phone.rbi +18 -0
  81. data/rbi/prelude_sdk/resources/verification.rbi +6 -3
  82. data/rbi/prelude_sdk/resources/verification_management/sandbox.rbi +76 -0
  83. data/rbi/prelude_sdk/resources/verification_management.rbi +4 -0
  84. data/rbi/prelude_sdk/resources/watch.rbi +49 -2
  85. data/sig/prelude_sdk/client.rbs +2 -0
  86. data/sig/prelude_sdk/models/intel/kyc_match_params.rbs +91 -0
  87. data/sig/prelude_sdk/models/intel/kyc_match_response.rbs +276 -0
  88. data/sig/prelude_sdk/models/notify_reply_params.rbs +50 -0
  89. data/sig/prelude_sdk/models/notify_reply_response.rbs +54 -0
  90. data/sig/prelude_sdk/models/signals.rbs +101 -0
  91. data/sig/prelude_sdk/models/target.rbs +29 -0
  92. data/sig/prelude_sdk/models/verification/phone/history_list_params.rbs +187 -0
  93. data/sig/prelude_sdk/models/verification/phone/history_list_response.rbs +241 -0
  94. data/sig/prelude_sdk/models/verification/phone/history_retrieve_params.rbs +27 -0
  95. data/sig/prelude_sdk/models/verification/phone/history_retrieve_response.rbs +887 -0
  96. data/sig/prelude_sdk/models/verification/phone/phone_verification_carrier.rbs +23 -0
  97. data/sig/prelude_sdk/models/verification/phone/phone_verification_money.rbs +21 -0
  98. data/sig/prelude_sdk/models/verification/phone/phone_verification_psd2_transaction.rbs +37 -0
  99. data/sig/prelude_sdk/models/verification_check_params.rbs +4 -37
  100. data/sig/prelude_sdk/models/verification_create_params.rbs +9 -142
  101. data/sig/prelude_sdk/models/verification_create_response.rbs +32 -14
  102. data/sig/prelude_sdk/models/verification_management/sandbox_add_phone_number_params.rbs +30 -0
  103. data/sig/prelude_sdk/models/verification_management/sandbox_add_phone_number_response.rbs +18 -0
  104. data/sig/prelude_sdk/models/verification_management/sandbox_delete_phone_number_params.rbs +26 -0
  105. data/sig/prelude_sdk/models/verification_management/sandbox_delete_phone_number_response.rbs +15 -0
  106. data/sig/prelude_sdk/models/verification_management/sandbox_list_phone_numbers_params.rbs +17 -0
  107. data/sig/prelude_sdk/models/verification_management/sandbox_list_phone_numbers_response.rbs +45 -0
  108. data/sig/prelude_sdk/models/watch_evaluate_params.rbs +52 -0
  109. data/sig/prelude_sdk/models/watch_evaluate_response.rbs +202 -0
  110. data/sig/prelude_sdk/models/watch_predict_params.rbs +9 -142
  111. data/sig/prelude_sdk/models/watch_predict_response.rbs +32 -14
  112. data/sig/prelude_sdk/models/watch_send_events_params.rbs +4 -37
  113. data/sig/prelude_sdk/models/watch_send_feedbacks_params.rbs +4 -37
  114. data/sig/prelude_sdk/models.rbs +14 -0
  115. data/sig/prelude_sdk/resources/intel/kyc.rbs +23 -0
  116. data/sig/prelude_sdk/resources/intel.rbs +9 -0
  117. data/sig/prelude_sdk/resources/notify.rbs +9 -0
  118. data/sig/prelude_sdk/resources/verification/phone/history.rbs +32 -0
  119. data/sig/prelude_sdk/resources/verification/phone.rbs +11 -0
  120. data/sig/prelude_sdk/resources/verification.rbs +5 -3
  121. data/sig/prelude_sdk/resources/verification_management/sandbox.rbs +24 -0
  122. data/sig/prelude_sdk/resources/verification_management.rbs +2 -0
  123. data/sig/prelude_sdk/resources/watch.rbs +11 -2
  124. metadata +80 -2
@@ -0,0 +1,2290 @@
1
+ # typed: strong
2
+
3
+ module PreludeSDK
4
+ module Models
5
+ module Verification
6
+ module Phone
7
+ class HistoryRetrieveResponse < PreludeSDK::Internal::Type::BaseModel
8
+ OrHash =
9
+ T.type_alias do
10
+ T.any(
11
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse,
12
+ PreludeSDK::Internal::AnyHash
13
+ )
14
+ end
15
+
16
+ # The verification identifier.
17
+ sig { returns(String) }
18
+ attr_accessor :id
19
+
20
+ sig { returns(Time) }
21
+ attr_accessor :created_at
22
+
23
+ sig { returns(Time) }
24
+ attr_accessor :expires_at
25
+
26
+ # The E.164 phone number the verification targeted.
27
+ sig { returns(String) }
28
+ attr_accessor :phone_number
29
+
30
+ # The outcome of the verification.
31
+ #
32
+ # - `converted` - The end user submitted a valid code.
33
+ # - `not_converted` - The verification expired without a valid code.
34
+ # - `pending_check` - A code was delivered and Prelude is still waiting for a
35
+ # check.
36
+ # - `sent` - A code was sent and the verification window is still open.
37
+ # - `challenged` - The verification was restricted to non-SMS and non-voice
38
+ # channels.
39
+ # - `suspected_fraud` - The anti-fraud system blocked the verification.
40
+ # - `in_blocklist` - The phone number is on the configured block list.
41
+ # - `invalid_line` - The phone number is not a valid line type.
42
+ # - `invalid_number` - The phone number is not a valid number.
43
+ # - `rate_limited` - The verification was refused by a rate limit.
44
+ # - `expired_signals` - The SDK signals were collected too long before the request
45
+ # to still attest to it.
46
+ # - `shadowed` - The anti-fraud system flagged the verification without blocking
47
+ # it.
48
+ sig do
49
+ returns(
50
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol
51
+ )
52
+ end
53
+ attr_accessor :status
54
+
55
+ # Version of your application, when known.
56
+ sig { returns(T.nilable(String)) }
57
+ attr_reader :app_version
58
+
59
+ sig { params(app_version: String).void }
60
+ attr_writer :app_version
61
+
62
+ # Why the anti-fraud system blocked the verification. Empty unless it did. These
63
+ # are the same labels the Verify and Watch APIs serve as `risk_factors`.
64
+ #
65
+ # - `automation_signature` - The request appears to come from an automated client
66
+ # rather than a person.
67
+ # - `carrier_not_permitted` - The destination carrier is one this account does not
68
+ # accept traffic for.
69
+ # - `client_fingerprint_mismatch` - The client does not appear to be the platform
70
+ # it identifies itself as.
71
+ # - `custom_policy` - A rule configured for your account matched this request.
72
+ # - `device_emulator` - The request appears to come from an emulator rather than a
73
+ # physical device.
74
+ # - `device_not_permitted` - The device platform is one your account blocks.
75
+ # - `device_reuse` - One device is driving verifications for an unusual number of
76
+ # phone numbers.
77
+ # - `expired_signals` - The SDK signals were collected too long before the request
78
+ # to still attest to it.
79
+ # - `fraud_database` - The phone number is flagged in one or more of the fraud
80
+ # databases Prelude consults.
81
+ # - `invalid_signature` - The SDK signature did not verify, so the request cannot
82
+ # be attributed to the device it claims to come from.
83
+ # - `ip_concentration` - The request shares its origin with an unusual volume of
84
+ # other verifications.
85
+ # - `ip_reputation` - The originating IP address is not trusted.
86
+ # - `location_mismatch` - The network location and the phone number's country are
87
+ # inconsistent.
88
+ # - `missing_signals` - The verification expected Prelude SDK signals and none
89
+ # arrived.
90
+ # - `number_range_abuse` - The phone number belongs to a range currently
91
+ # associated with abuse.
92
+ # - `poor_conversion_history` - Traffic resembling this request rarely completes a
93
+ # verification.
94
+ # - `proxy_network` - The request did not arrive over the subscriber's own access
95
+ # network.
96
+ # - `repeated_attempts` - The phone number exceeded the allowed number of
97
+ # verification attempts in a short period.
98
+ # - `temporary_phone_number` - The phone number belongs to a disposable or
99
+ # short-lived numbering service.
100
+ sig do
101
+ returns(
102
+ T.nilable(
103
+ T::Array[
104
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
105
+ ]
106
+ )
107
+ )
108
+ end
109
+ attr_reader :block_reasons
110
+
111
+ sig do
112
+ params(
113
+ block_reasons:
114
+ T::Array[
115
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::OrSymbol
116
+ ]
117
+ ).void
118
+ end
119
+ attr_writer :block_reasons
120
+
121
+ # The end user's mobile network.
122
+ sig do
123
+ returns(
124
+ T.nilable(
125
+ PreludeSDK::Verification::Phone::PhoneVerificationCarrier
126
+ )
127
+ )
128
+ end
129
+ attr_reader :carrier
130
+
131
+ sig do
132
+ params(
133
+ carrier:
134
+ PreludeSDK::Verification::Phone::PhoneVerificationCarrier::OrHash
135
+ ).void
136
+ end
137
+ attr_writer :carrier
138
+
139
+ # The correlation identifier you supplied when creating the verification.
140
+ sig { returns(T.nilable(String)) }
141
+ attr_reader :correlation_id
142
+
143
+ sig { params(correlation_id: String).void }
144
+ attr_writer :correlation_id
145
+
146
+ # Model of the end-user device, when known.
147
+ sig { returns(T.nilable(String)) }
148
+ attr_reader :device_model
149
+
150
+ sig { params(device_model: String).void }
151
+ attr_writer :device_model
152
+
153
+ # Platform of the end-user device, when known.
154
+ sig do
155
+ returns(
156
+ T.nilable(
157
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::DevicePlatform::TaggedSymbol
158
+ )
159
+ )
160
+ end
161
+ attr_reader :device_platform
162
+
163
+ sig do
164
+ params(
165
+ device_platform:
166
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::DevicePlatform::OrSymbol
167
+ ).void
168
+ end
169
+ attr_writer :device_platform
170
+
171
+ # IP address the verification was created from.
172
+ sig { returns(T.nilable(String)) }
173
+ attr_reader :ip_address
174
+
175
+ sig { params(ip_address: String).void }
176
+ attr_writer :ip_address
177
+
178
+ # ISO 3166-1 alpha-2 region of the caller's IP address.
179
+ sig { returns(T.nilable(String)) }
180
+ attr_reader :ip_address_region
181
+
182
+ sig { params(ip_address_region: String).void }
183
+ attr_writer :ip_address_region
184
+
185
+ # Distance between the phone number region and the IP location.
186
+ sig { returns(T.nilable(Integer)) }
187
+ attr_reader :ip_distance_meters
188
+
189
+ sig { params(ip_distance_meters: Integer).void }
190
+ attr_writer :ip_distance_meters
191
+
192
+ # Chronological timeline of the verification: creation, message attempts with
193
+ # delivery events, code checks and signals reception. Omitted when Prelude holds
194
+ # no timeline for the verification.
195
+ sig do
196
+ returns(
197
+ T.nilable(
198
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle
199
+ )
200
+ )
201
+ end
202
+ attr_reader :lifecycle
203
+
204
+ sig do
205
+ params(
206
+ lifecycle:
207
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::OrHash
208
+ ).void
209
+ end
210
+ attr_writer :lifecycle
211
+
212
+ # Whether the phone number was allow-listed, block-listed, or sandboxed at
213
+ # verification time.
214
+ sig do
215
+ returns(
216
+ T.nilable(
217
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCondition::TaggedSymbol
218
+ )
219
+ )
220
+ end
221
+ attr_reader :phone_number_condition
222
+
223
+ sig do
224
+ params(
225
+ phone_number_condition:
226
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCondition::OrSymbol
227
+ ).void
228
+ end
229
+ attr_writer :phone_number_condition
230
+
231
+ # Whether the phone number is currently allow-listed, block-listed, or sandboxed.
232
+ sig do
233
+ returns(
234
+ T.nilable(
235
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCurrentCondition::TaggedSymbol
236
+ )
237
+ )
238
+ end
239
+ attr_reader :phone_number_current_condition
240
+
241
+ sig do
242
+ params(
243
+ phone_number_current_condition:
244
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCurrentCondition::OrSymbol
245
+ ).void
246
+ end
247
+ attr_writer :phone_number_current_condition
248
+
249
+ # ISO 3166-1 alpha-2 region of the phone number.
250
+ sig { returns(T.nilable(String)) }
251
+ attr_reader :phone_number_region
252
+
253
+ sig { params(phone_number_region: String).void }
254
+ attr_writer :phone_number_region
255
+
256
+ # The anti-fraud signals you forwarded when creating the verification.
257
+ sig do
258
+ returns(
259
+ T.nilable(
260
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Signals
261
+ )
262
+ )
263
+ end
264
+ attr_reader :signals
265
+
266
+ sig do
267
+ params(
268
+ signals:
269
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Signals::OrHash
270
+ ).void
271
+ end
272
+ attr_writer :signals
273
+
274
+ # Whether the SDK signals integrity check passed.
275
+ sig do
276
+ returns(
277
+ T.nilable(
278
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::SignalsHashStatus::TaggedSymbol
279
+ )
280
+ )
281
+ end
282
+ attr_reader :signals_hash_status
283
+
284
+ sig do
285
+ params(
286
+ signals_hash_status:
287
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::SignalsHashStatus::OrSymbol
288
+ ).void
289
+ end
290
+ attr_writer :signals_hash_status
291
+
292
+ # The template used for this verification.
293
+ sig { returns(T.nilable(String)) }
294
+ attr_reader :template_id
295
+
296
+ sig { params(template_id: String).void }
297
+ attr_writer :template_id
298
+
299
+ # A verification and everything Prelude recorded about it.
300
+ sig do
301
+ params(
302
+ id: String,
303
+ created_at: Time,
304
+ expires_at: Time,
305
+ phone_number: String,
306
+ status:
307
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::OrSymbol,
308
+ app_version: String,
309
+ block_reasons:
310
+ T::Array[
311
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::OrSymbol
312
+ ],
313
+ carrier:
314
+ PreludeSDK::Verification::Phone::PhoneVerificationCarrier::OrHash,
315
+ correlation_id: String,
316
+ device_model: String,
317
+ device_platform:
318
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::DevicePlatform::OrSymbol,
319
+ ip_address: String,
320
+ ip_address_region: String,
321
+ ip_distance_meters: Integer,
322
+ lifecycle:
323
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::OrHash,
324
+ phone_number_condition:
325
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCondition::OrSymbol,
326
+ phone_number_current_condition:
327
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCurrentCondition::OrSymbol,
328
+ phone_number_region: String,
329
+ signals:
330
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Signals::OrHash,
331
+ signals_hash_status:
332
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::SignalsHashStatus::OrSymbol,
333
+ template_id: String
334
+ ).returns(T.attached_class)
335
+ end
336
+ def self.new(
337
+ # The verification identifier.
338
+ id:,
339
+ created_at:,
340
+ expires_at:,
341
+ # The E.164 phone number the verification targeted.
342
+ phone_number:,
343
+ # The outcome of the verification.
344
+ #
345
+ # - `converted` - The end user submitted a valid code.
346
+ # - `not_converted` - The verification expired without a valid code.
347
+ # - `pending_check` - A code was delivered and Prelude is still waiting for a
348
+ # check.
349
+ # - `sent` - A code was sent and the verification window is still open.
350
+ # - `challenged` - The verification was restricted to non-SMS and non-voice
351
+ # channels.
352
+ # - `suspected_fraud` - The anti-fraud system blocked the verification.
353
+ # - `in_blocklist` - The phone number is on the configured block list.
354
+ # - `invalid_line` - The phone number is not a valid line type.
355
+ # - `invalid_number` - The phone number is not a valid number.
356
+ # - `rate_limited` - The verification was refused by a rate limit.
357
+ # - `expired_signals` - The SDK signals were collected too long before the request
358
+ # to still attest to it.
359
+ # - `shadowed` - The anti-fraud system flagged the verification without blocking
360
+ # it.
361
+ status:,
362
+ # Version of your application, when known.
363
+ app_version: nil,
364
+ # Why the anti-fraud system blocked the verification. Empty unless it did. These
365
+ # are the same labels the Verify and Watch APIs serve as `risk_factors`.
366
+ #
367
+ # - `automation_signature` - The request appears to come from an automated client
368
+ # rather than a person.
369
+ # - `carrier_not_permitted` - The destination carrier is one this account does not
370
+ # accept traffic for.
371
+ # - `client_fingerprint_mismatch` - The client does not appear to be the platform
372
+ # it identifies itself as.
373
+ # - `custom_policy` - A rule configured for your account matched this request.
374
+ # - `device_emulator` - The request appears to come from an emulator rather than a
375
+ # physical device.
376
+ # - `device_not_permitted` - The device platform is one your account blocks.
377
+ # - `device_reuse` - One device is driving verifications for an unusual number of
378
+ # phone numbers.
379
+ # - `expired_signals` - The SDK signals were collected too long before the request
380
+ # to still attest to it.
381
+ # - `fraud_database` - The phone number is flagged in one or more of the fraud
382
+ # databases Prelude consults.
383
+ # - `invalid_signature` - The SDK signature did not verify, so the request cannot
384
+ # be attributed to the device it claims to come from.
385
+ # - `ip_concentration` - The request shares its origin with an unusual volume of
386
+ # other verifications.
387
+ # - `ip_reputation` - The originating IP address is not trusted.
388
+ # - `location_mismatch` - The network location and the phone number's country are
389
+ # inconsistent.
390
+ # - `missing_signals` - The verification expected Prelude SDK signals and none
391
+ # arrived.
392
+ # - `number_range_abuse` - The phone number belongs to a range currently
393
+ # associated with abuse.
394
+ # - `poor_conversion_history` - Traffic resembling this request rarely completes a
395
+ # verification.
396
+ # - `proxy_network` - The request did not arrive over the subscriber's own access
397
+ # network.
398
+ # - `repeated_attempts` - The phone number exceeded the allowed number of
399
+ # verification attempts in a short period.
400
+ # - `temporary_phone_number` - The phone number belongs to a disposable or
401
+ # short-lived numbering service.
402
+ block_reasons: nil,
403
+ # The end user's mobile network.
404
+ carrier: nil,
405
+ # The correlation identifier you supplied when creating the verification.
406
+ correlation_id: nil,
407
+ # Model of the end-user device, when known.
408
+ device_model: nil,
409
+ # Platform of the end-user device, when known.
410
+ device_platform: nil,
411
+ # IP address the verification was created from.
412
+ ip_address: nil,
413
+ # ISO 3166-1 alpha-2 region of the caller's IP address.
414
+ ip_address_region: nil,
415
+ # Distance between the phone number region and the IP location.
416
+ ip_distance_meters: nil,
417
+ # Chronological timeline of the verification: creation, message attempts with
418
+ # delivery events, code checks and signals reception. Omitted when Prelude holds
419
+ # no timeline for the verification.
420
+ lifecycle: nil,
421
+ # Whether the phone number was allow-listed, block-listed, or sandboxed at
422
+ # verification time.
423
+ phone_number_condition: nil,
424
+ # Whether the phone number is currently allow-listed, block-listed, or sandboxed.
425
+ phone_number_current_condition: nil,
426
+ # ISO 3166-1 alpha-2 region of the phone number.
427
+ phone_number_region: nil,
428
+ # The anti-fraud signals you forwarded when creating the verification.
429
+ signals: nil,
430
+ # Whether the SDK signals integrity check passed.
431
+ signals_hash_status: nil,
432
+ # The template used for this verification.
433
+ template_id: nil
434
+ )
435
+ end
436
+
437
+ sig do
438
+ override.returns(
439
+ {
440
+ id: String,
441
+ created_at: Time,
442
+ expires_at: Time,
443
+ phone_number: String,
444
+ status:
445
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol,
446
+ app_version: String,
447
+ block_reasons:
448
+ T::Array[
449
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
450
+ ],
451
+ carrier:
452
+ PreludeSDK::Verification::Phone::PhoneVerificationCarrier,
453
+ correlation_id: String,
454
+ device_model: String,
455
+ device_platform:
456
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::DevicePlatform::TaggedSymbol,
457
+ ip_address: String,
458
+ ip_address_region: String,
459
+ ip_distance_meters: Integer,
460
+ lifecycle:
461
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle,
462
+ phone_number_condition:
463
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCondition::TaggedSymbol,
464
+ phone_number_current_condition:
465
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCurrentCondition::TaggedSymbol,
466
+ phone_number_region: String,
467
+ signals:
468
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Signals,
469
+ signals_hash_status:
470
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::SignalsHashStatus::TaggedSymbol,
471
+ template_id: String
472
+ }
473
+ )
474
+ end
475
+ def to_hash
476
+ end
477
+
478
+ # The outcome of the verification.
479
+ #
480
+ # - `converted` - The end user submitted a valid code.
481
+ # - `not_converted` - The verification expired without a valid code.
482
+ # - `pending_check` - A code was delivered and Prelude is still waiting for a
483
+ # check.
484
+ # - `sent` - A code was sent and the verification window is still open.
485
+ # - `challenged` - The verification was restricted to non-SMS and non-voice
486
+ # channels.
487
+ # - `suspected_fraud` - The anti-fraud system blocked the verification.
488
+ # - `in_blocklist` - The phone number is on the configured block list.
489
+ # - `invalid_line` - The phone number is not a valid line type.
490
+ # - `invalid_number` - The phone number is not a valid number.
491
+ # - `rate_limited` - The verification was refused by a rate limit.
492
+ # - `expired_signals` - The SDK signals were collected too long before the request
493
+ # to still attest to it.
494
+ # - `shadowed` - The anti-fraud system flagged the verification without blocking
495
+ # it.
496
+ module Status
497
+ extend PreludeSDK::Internal::Type::Enum
498
+
499
+ TaggedSymbol =
500
+ T.type_alias do
501
+ T.all(
502
+ Symbol,
503
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status
504
+ )
505
+ end
506
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
507
+
508
+ CONVERTED =
509
+ T.let(
510
+ :converted,
511
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol
512
+ )
513
+ NOT_CONVERTED =
514
+ T.let(
515
+ :not_converted,
516
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol
517
+ )
518
+ PENDING_CHECK =
519
+ T.let(
520
+ :pending_check,
521
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol
522
+ )
523
+ SENT =
524
+ T.let(
525
+ :sent,
526
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol
527
+ )
528
+ CHALLENGED =
529
+ T.let(
530
+ :challenged,
531
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol
532
+ )
533
+ SUSPECTED_FRAUD =
534
+ T.let(
535
+ :suspected_fraud,
536
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol
537
+ )
538
+ IN_BLOCKLIST =
539
+ T.let(
540
+ :in_blocklist,
541
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol
542
+ )
543
+ INVALID_LINE =
544
+ T.let(
545
+ :invalid_line,
546
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol
547
+ )
548
+ INVALID_NUMBER =
549
+ T.let(
550
+ :invalid_number,
551
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol
552
+ )
553
+ RATE_LIMITED =
554
+ T.let(
555
+ :rate_limited,
556
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol
557
+ )
558
+ EXPIRED_SIGNALS =
559
+ T.let(
560
+ :expired_signals,
561
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol
562
+ )
563
+ SHADOWED =
564
+ T.let(
565
+ :shadowed,
566
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol
567
+ )
568
+
569
+ sig do
570
+ override.returns(
571
+ T::Array[
572
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Status::TaggedSymbol
573
+ ]
574
+ )
575
+ end
576
+ def self.values
577
+ end
578
+ end
579
+
580
+ module BlockReason
581
+ extend PreludeSDK::Internal::Type::Enum
582
+
583
+ TaggedSymbol =
584
+ T.type_alias do
585
+ T.all(
586
+ Symbol,
587
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason
588
+ )
589
+ end
590
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
591
+
592
+ AUTOMATION_SIGNATURE =
593
+ T.let(
594
+ :automation_signature,
595
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
596
+ )
597
+ CARRIER_NOT_PERMITTED =
598
+ T.let(
599
+ :carrier_not_permitted,
600
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
601
+ )
602
+ CLIENT_FINGERPRINT_MISMATCH =
603
+ T.let(
604
+ :client_fingerprint_mismatch,
605
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
606
+ )
607
+ CUSTOM_POLICY =
608
+ T.let(
609
+ :custom_policy,
610
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
611
+ )
612
+ DEVICE_EMULATOR =
613
+ T.let(
614
+ :device_emulator,
615
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
616
+ )
617
+ DEVICE_NOT_PERMITTED =
618
+ T.let(
619
+ :device_not_permitted,
620
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
621
+ )
622
+ DEVICE_REUSE =
623
+ T.let(
624
+ :device_reuse,
625
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
626
+ )
627
+ EXPIRED_SIGNALS =
628
+ T.let(
629
+ :expired_signals,
630
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
631
+ )
632
+ FRAUD_DATABASE =
633
+ T.let(
634
+ :fraud_database,
635
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
636
+ )
637
+ INVALID_SIGNATURE =
638
+ T.let(
639
+ :invalid_signature,
640
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
641
+ )
642
+ IP_CONCENTRATION =
643
+ T.let(
644
+ :ip_concentration,
645
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
646
+ )
647
+ IP_REPUTATION =
648
+ T.let(
649
+ :ip_reputation,
650
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
651
+ )
652
+ LOCATION_MISMATCH =
653
+ T.let(
654
+ :location_mismatch,
655
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
656
+ )
657
+ MISSING_SIGNALS =
658
+ T.let(
659
+ :missing_signals,
660
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
661
+ )
662
+ NUMBER_RANGE_ABUSE =
663
+ T.let(
664
+ :number_range_abuse,
665
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
666
+ )
667
+ POOR_CONVERSION_HISTORY =
668
+ T.let(
669
+ :poor_conversion_history,
670
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
671
+ )
672
+ PROXY_NETWORK =
673
+ T.let(
674
+ :proxy_network,
675
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
676
+ )
677
+ REPEATED_ATTEMPTS =
678
+ T.let(
679
+ :repeated_attempts,
680
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
681
+ )
682
+ TEMPORARY_PHONE_NUMBER =
683
+ T.let(
684
+ :temporary_phone_number,
685
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
686
+ )
687
+
688
+ sig do
689
+ override.returns(
690
+ T::Array[
691
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::BlockReason::TaggedSymbol
692
+ ]
693
+ )
694
+ end
695
+ def self.values
696
+ end
697
+ end
698
+
699
+ # Platform of the end-user device, when known.
700
+ module DevicePlatform
701
+ extend PreludeSDK::Internal::Type::Enum
702
+
703
+ TaggedSymbol =
704
+ T.type_alias do
705
+ T.all(
706
+ Symbol,
707
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::DevicePlatform
708
+ )
709
+ end
710
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
711
+
712
+ ANDROID =
713
+ T.let(
714
+ :android,
715
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::DevicePlatform::TaggedSymbol
716
+ )
717
+ IOS =
718
+ T.let(
719
+ :ios,
720
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::DevicePlatform::TaggedSymbol
721
+ )
722
+ IPADOS =
723
+ T.let(
724
+ :ipados,
725
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::DevicePlatform::TaggedSymbol
726
+ )
727
+ TVOS =
728
+ T.let(
729
+ :tvos,
730
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::DevicePlatform::TaggedSymbol
731
+ )
732
+ WEB =
733
+ T.let(
734
+ :web,
735
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::DevicePlatform::TaggedSymbol
736
+ )
737
+
738
+ sig do
739
+ override.returns(
740
+ T::Array[
741
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::DevicePlatform::TaggedSymbol
742
+ ]
743
+ )
744
+ end
745
+ def self.values
746
+ end
747
+ end
748
+
749
+ class Lifecycle < PreludeSDK::Internal::Type::BaseModel
750
+ OrHash =
751
+ T.type_alias do
752
+ T.any(
753
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle,
754
+ PreludeSDK::Internal::AnyHash
755
+ )
756
+ end
757
+
758
+ sig do
759
+ returns(
760
+ T::Array[
761
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event
762
+ ]
763
+ )
764
+ end
765
+ attr_accessor :events
766
+
767
+ sig do
768
+ returns(
769
+ T.nilable(
770
+ PreludeSDK::Verification::Phone::PhoneVerificationMoney
771
+ )
772
+ )
773
+ end
774
+ attr_reader :total_cost
775
+
776
+ sig do
777
+ params(
778
+ total_cost:
779
+ PreludeSDK::Verification::Phone::PhoneVerificationMoney::OrHash
780
+ ).void
781
+ end
782
+ attr_writer :total_cost
783
+
784
+ # How many times the message was reported undeliverable by independent routes.
785
+ # Above zero usually means the phone number is incorrect or the device
786
+ # unreachable.
787
+ sig { returns(T.nilable(Integer)) }
788
+ attr_reader :undeliverable_route_count
789
+
790
+ sig { params(undeliverable_route_count: Integer).void }
791
+ attr_writer :undeliverable_route_count
792
+
793
+ # Chronological timeline of the verification: creation, message attempts with
794
+ # delivery events, code checks and signals reception. Omitted when Prelude holds
795
+ # no timeline for the verification.
796
+ sig do
797
+ params(
798
+ events:
799
+ T::Array[
800
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::OrHash
801
+ ],
802
+ total_cost:
803
+ PreludeSDK::Verification::Phone::PhoneVerificationMoney::OrHash,
804
+ undeliverable_route_count: Integer
805
+ ).returns(T.attached_class)
806
+ end
807
+ def self.new(
808
+ events:,
809
+ total_cost: nil,
810
+ # How many times the message was reported undeliverable by independent routes.
811
+ # Above zero usually means the phone number is incorrect or the device
812
+ # unreachable.
813
+ undeliverable_route_count: nil
814
+ )
815
+ end
816
+
817
+ sig do
818
+ override.returns(
819
+ {
820
+ events:
821
+ T::Array[
822
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event
823
+ ],
824
+ total_cost:
825
+ PreludeSDK::Verification::Phone::PhoneVerificationMoney,
826
+ undeliverable_route_count: Integer
827
+ }
828
+ )
829
+ end
830
+ def to_hash
831
+ end
832
+
833
+ class Event < PreludeSDK::Internal::Type::BaseModel
834
+ OrHash =
835
+ T.type_alias do
836
+ T.any(
837
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event,
838
+ PreludeSDK::Internal::AnyHash
839
+ )
840
+ end
841
+
842
+ sig do
843
+ returns(
844
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type::TaggedSymbol
845
+ )
846
+ end
847
+ attr_accessor :type
848
+
849
+ # One message sent for this verification.
850
+ sig do
851
+ returns(
852
+ T.nilable(
853
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt
854
+ )
855
+ )
856
+ end
857
+ attr_reader :attempt
858
+
859
+ sig do
860
+ params(
861
+ attempt:
862
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::OrHash
863
+ ).void
864
+ end
865
+ attr_writer :attempt
866
+
867
+ # One code submission for this verification.
868
+ sig do
869
+ returns(
870
+ T.nilable(
871
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check
872
+ )
873
+ )
874
+ end
875
+ attr_reader :check
876
+
877
+ sig do
878
+ params(
879
+ check:
880
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::OrHash
881
+ ).void
882
+ end
883
+ attr_writer :check
884
+
885
+ sig do
886
+ returns(
887
+ T.nilable(
888
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Create
889
+ )
890
+ )
891
+ end
892
+ attr_reader :create
893
+
894
+ sig do
895
+ params(
896
+ create:
897
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Create::OrHash
898
+ ).void
899
+ end
900
+ attr_writer :create
901
+
902
+ sig do
903
+ returns(
904
+ T.nilable(
905
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals
906
+ )
907
+ )
908
+ end
909
+ attr_reader :signals
910
+
911
+ sig do
912
+ params(
913
+ signals:
914
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals::OrHash
915
+ ).void
916
+ end
917
+ attr_writer :signals
918
+
919
+ # One timeline entry. `type` names the single payload field that is set.
920
+ sig do
921
+ params(
922
+ type:
923
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type::OrSymbol,
924
+ attempt:
925
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::OrHash,
926
+ check:
927
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::OrHash,
928
+ create:
929
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Create::OrHash,
930
+ signals:
931
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals::OrHash
932
+ ).returns(T.attached_class)
933
+ end
934
+ def self.new(
935
+ type:,
936
+ # One message sent for this verification.
937
+ attempt: nil,
938
+ # One code submission for this verification.
939
+ check: nil,
940
+ create: nil,
941
+ signals: nil
942
+ )
943
+ end
944
+
945
+ sig do
946
+ override.returns(
947
+ {
948
+ type:
949
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type::TaggedSymbol,
950
+ attempt:
951
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt,
952
+ check:
953
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check,
954
+ create:
955
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Create,
956
+ signals:
957
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals
958
+ }
959
+ )
960
+ end
961
+ def to_hash
962
+ end
963
+
964
+ module Type
965
+ extend PreludeSDK::Internal::Type::Enum
966
+
967
+ TaggedSymbol =
968
+ T.type_alias do
969
+ T.all(
970
+ Symbol,
971
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type
972
+ )
973
+ end
974
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
975
+
976
+ CREATE =
977
+ T.let(
978
+ :create,
979
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type::TaggedSymbol
980
+ )
981
+ ATTEMPT =
982
+ T.let(
983
+ :attempt,
984
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type::TaggedSymbol
985
+ )
986
+ CHECK =
987
+ T.let(
988
+ :check,
989
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type::TaggedSymbol
990
+ )
991
+ SIGNALS =
992
+ T.let(
993
+ :signals,
994
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type::TaggedSymbol
995
+ )
996
+
997
+ sig do
998
+ override.returns(
999
+ T::Array[
1000
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type::TaggedSymbol
1001
+ ]
1002
+ )
1003
+ end
1004
+ def self.values
1005
+ end
1006
+ end
1007
+
1008
+ class Attempt < PreludeSDK::Internal::Type::BaseModel
1009
+ OrHash =
1010
+ T.type_alias do
1011
+ T.any(
1012
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt,
1013
+ PreludeSDK::Internal::AnyHash
1014
+ )
1015
+ end
1016
+
1017
+ sig { returns(String) }
1018
+ attr_accessor :id
1019
+
1020
+ sig { returns(Time) }
1021
+ attr_accessor :created_at
1022
+
1023
+ # The end user's mobile network.
1024
+ sig do
1025
+ returns(
1026
+ T.nilable(
1027
+ PreludeSDK::Verification::Phone::PhoneVerificationCarrier
1028
+ )
1029
+ )
1030
+ end
1031
+ attr_reader :carrier
1032
+
1033
+ sig do
1034
+ params(
1035
+ carrier:
1036
+ PreludeSDK::Verification::Phone::PhoneVerificationCarrier::OrHash
1037
+ ).void
1038
+ end
1039
+ attr_writer :carrier
1040
+
1041
+ sig do
1042
+ returns(
1043
+ T.nilable(
1044
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel::TaggedSymbol
1045
+ )
1046
+ )
1047
+ end
1048
+ attr_reader :channel
1049
+
1050
+ sig do
1051
+ params(
1052
+ channel:
1053
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel::OrSymbol
1054
+ ).void
1055
+ end
1056
+ attr_writer :channel
1057
+
1058
+ # Message body. While the verification can still be completed, the code inside it
1059
+ # is masked rather than removed.
1060
+ sig { returns(T.nilable(String)) }
1061
+ attr_reader :content
1062
+
1063
+ sig { params(content: String).void }
1064
+ attr_writer :content
1065
+
1066
+ sig do
1067
+ returns(
1068
+ T.nilable(
1069
+ PreludeSDK::Verification::Phone::PhoneVerificationMoney
1070
+ )
1071
+ )
1072
+ end
1073
+ attr_reader :cost
1074
+
1075
+ sig do
1076
+ params(
1077
+ cost:
1078
+ PreludeSDK::Verification::Phone::PhoneVerificationMoney::OrHash
1079
+ ).void
1080
+ end
1081
+ attr_writer :cost
1082
+
1083
+ sig do
1084
+ returns(
1085
+ T.nilable(
1086
+ T::Array[
1087
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent
1088
+ ]
1089
+ )
1090
+ )
1091
+ end
1092
+ attr_reader :delivery_events
1093
+
1094
+ sig do
1095
+ params(
1096
+ delivery_events:
1097
+ T::Array[
1098
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::OrHash
1099
+ ]
1100
+ ).void
1101
+ end
1102
+ attr_writer :delivery_events
1103
+
1104
+ sig do
1105
+ returns(
1106
+ T.nilable(
1107
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus::TaggedSymbol
1108
+ )
1109
+ )
1110
+ end
1111
+ attr_reader :delivery_status
1112
+
1113
+ sig do
1114
+ params(
1115
+ delivery_status:
1116
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus::OrSymbol
1117
+ ).void
1118
+ end
1119
+ attr_writer :delivery_status
1120
+
1121
+ # Channel you asked for, when it differs from the one used.
1122
+ sig do
1123
+ returns(
1124
+ T.nilable(
1125
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel::TaggedSymbol
1126
+ )
1127
+ )
1128
+ end
1129
+ attr_reader :preferred_channel
1130
+
1131
+ sig do
1132
+ params(
1133
+ preferred_channel:
1134
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel::OrSymbol
1135
+ ).void
1136
+ end
1137
+ attr_writer :preferred_channel
1138
+
1139
+ sig do
1140
+ returns(
1141
+ T.nilable(
1142
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Status::TaggedSymbol
1143
+ )
1144
+ )
1145
+ end
1146
+ attr_reader :status
1147
+
1148
+ sig do
1149
+ params(
1150
+ status:
1151
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Status::OrSymbol
1152
+ ).void
1153
+ end
1154
+ attr_writer :status
1155
+
1156
+ # What caused the attempt.
1157
+ sig do
1158
+ returns(
1159
+ T.nilable(
1160
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger::TaggedSymbol
1161
+ )
1162
+ )
1163
+ end
1164
+ attr_reader :trigger
1165
+
1166
+ sig do
1167
+ params(
1168
+ trigger:
1169
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger::OrSymbol
1170
+ ).void
1171
+ end
1172
+ attr_writer :trigger
1173
+
1174
+ # One message sent for this verification.
1175
+ sig do
1176
+ params(
1177
+ id: String,
1178
+ created_at: Time,
1179
+ carrier:
1180
+ PreludeSDK::Verification::Phone::PhoneVerificationCarrier::OrHash,
1181
+ channel:
1182
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel::OrSymbol,
1183
+ content: String,
1184
+ cost:
1185
+ PreludeSDK::Verification::Phone::PhoneVerificationMoney::OrHash,
1186
+ delivery_events:
1187
+ T::Array[
1188
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::OrHash
1189
+ ],
1190
+ delivery_status:
1191
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus::OrSymbol,
1192
+ preferred_channel:
1193
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel::OrSymbol,
1194
+ status:
1195
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Status::OrSymbol,
1196
+ trigger:
1197
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger::OrSymbol
1198
+ ).returns(T.attached_class)
1199
+ end
1200
+ def self.new(
1201
+ id:,
1202
+ created_at:,
1203
+ # The end user's mobile network.
1204
+ carrier: nil,
1205
+ channel: nil,
1206
+ # Message body. While the verification can still be completed, the code inside it
1207
+ # is masked rather than removed.
1208
+ content: nil,
1209
+ cost: nil,
1210
+ delivery_events: nil,
1211
+ delivery_status: nil,
1212
+ # Channel you asked for, when it differs from the one used.
1213
+ preferred_channel: nil,
1214
+ status: nil,
1215
+ # What caused the attempt.
1216
+ trigger: nil
1217
+ )
1218
+ end
1219
+
1220
+ sig do
1221
+ override.returns(
1222
+ {
1223
+ id: String,
1224
+ created_at: Time,
1225
+ carrier:
1226
+ PreludeSDK::Verification::Phone::PhoneVerificationCarrier,
1227
+ channel:
1228
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel::TaggedSymbol,
1229
+ content: String,
1230
+ cost:
1231
+ PreludeSDK::Verification::Phone::PhoneVerificationMoney,
1232
+ delivery_events:
1233
+ T::Array[
1234
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent
1235
+ ],
1236
+ delivery_status:
1237
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus::TaggedSymbol,
1238
+ preferred_channel:
1239
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel::TaggedSymbol,
1240
+ status:
1241
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Status::TaggedSymbol,
1242
+ trigger:
1243
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger::TaggedSymbol
1244
+ }
1245
+ )
1246
+ end
1247
+ def to_hash
1248
+ end
1249
+
1250
+ module Channel
1251
+ extend PreludeSDK::Internal::Type::Enum
1252
+
1253
+ TaggedSymbol =
1254
+ T.type_alias do
1255
+ T.all(
1256
+ Symbol,
1257
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel
1258
+ )
1259
+ end
1260
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1261
+
1262
+ SMS =
1263
+ T.let(
1264
+ :sms,
1265
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel::TaggedSymbol
1266
+ )
1267
+ RCS =
1268
+ T.let(
1269
+ :rcs,
1270
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel::TaggedSymbol
1271
+ )
1272
+ WHATSAPP =
1273
+ T.let(
1274
+ :whatsapp,
1275
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel::TaggedSymbol
1276
+ )
1277
+ VIBER =
1278
+ T.let(
1279
+ :viber,
1280
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel::TaggedSymbol
1281
+ )
1282
+ ZALO =
1283
+ T.let(
1284
+ :zalo,
1285
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel::TaggedSymbol
1286
+ )
1287
+ TELEGRAM =
1288
+ T.let(
1289
+ :telegram,
1290
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel::TaggedSymbol
1291
+ )
1292
+ VOICE =
1293
+ T.let(
1294
+ :voice,
1295
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel::TaggedSymbol
1296
+ )
1297
+ SILENT =
1298
+ T.let(
1299
+ :silent,
1300
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel::TaggedSymbol
1301
+ )
1302
+
1303
+ sig do
1304
+ override.returns(
1305
+ T::Array[
1306
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel::TaggedSymbol
1307
+ ]
1308
+ )
1309
+ end
1310
+ def self.values
1311
+ end
1312
+ end
1313
+
1314
+ class DeliveryEvent < PreludeSDK::Internal::Type::BaseModel
1315
+ OrHash =
1316
+ T.type_alias do
1317
+ T.any(
1318
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent,
1319
+ PreludeSDK::Internal::AnyHash
1320
+ )
1321
+ end
1322
+
1323
+ sig { returns(Time) }
1324
+ attr_accessor :received_at
1325
+
1326
+ # The state this event reported. It is finer-grained than the attempt's
1327
+ # `delivery_status` and includes the states a silent verification goes through.
1328
+ sig do
1329
+ returns(
1330
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status::TaggedSymbol
1331
+ )
1332
+ end
1333
+ attr_accessor :status
1334
+
1335
+ sig do
1336
+ params(
1337
+ received_at: Time,
1338
+ status:
1339
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status::OrSymbol
1340
+ ).returns(T.attached_class)
1341
+ end
1342
+ def self.new(
1343
+ received_at:,
1344
+ # The state this event reported. It is finer-grained than the attempt's
1345
+ # `delivery_status` and includes the states a silent verification goes through.
1346
+ status:
1347
+ )
1348
+ end
1349
+
1350
+ sig do
1351
+ override.returns(
1352
+ {
1353
+ received_at: Time,
1354
+ status:
1355
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status::TaggedSymbol
1356
+ }
1357
+ )
1358
+ end
1359
+ def to_hash
1360
+ end
1361
+
1362
+ # The state this event reported. It is finer-grained than the attempt's
1363
+ # `delivery_status` and includes the states a silent verification goes through.
1364
+ module Status
1365
+ extend PreludeSDK::Internal::Type::Enum
1366
+
1367
+ TaggedSymbol =
1368
+ T.type_alias do
1369
+ T.all(
1370
+ Symbol,
1371
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status
1372
+ )
1373
+ end
1374
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1375
+
1376
+ UNKNOWN =
1377
+ T.let(
1378
+ :unknown,
1379
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status::TaggedSymbol
1380
+ )
1381
+ SUBMITTED =
1382
+ T.let(
1383
+ :submitted,
1384
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status::TaggedSymbol
1385
+ )
1386
+ IN_TRANSIT =
1387
+ T.let(
1388
+ :in_transit,
1389
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status::TaggedSymbol
1390
+ )
1391
+ DELIVERED =
1392
+ T.let(
1393
+ :delivered,
1394
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status::TaggedSymbol
1395
+ )
1396
+ UNDELIVERABLE =
1397
+ T.let(
1398
+ :undeliverable,
1399
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status::TaggedSymbol
1400
+ )
1401
+ EXPIRED =
1402
+ T.let(
1403
+ :expired,
1404
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status::TaggedSymbol
1405
+ )
1406
+ READ =
1407
+ T.let(
1408
+ :read,
1409
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status::TaggedSymbol
1410
+ )
1411
+ SILENT_STARTED =
1412
+ T.let(
1413
+ :silent_started,
1414
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status::TaggedSymbol
1415
+ )
1416
+ SILENT_VERIFIED =
1417
+ T.let(
1418
+ :silent_verified,
1419
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status::TaggedSymbol
1420
+ )
1421
+ SILENT_MISMATCH =
1422
+ T.let(
1423
+ :silent_mismatch,
1424
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status::TaggedSymbol
1425
+ )
1426
+
1427
+ sig do
1428
+ override.returns(
1429
+ T::Array[
1430
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status::TaggedSymbol
1431
+ ]
1432
+ )
1433
+ end
1434
+ def self.values
1435
+ end
1436
+ end
1437
+ end
1438
+
1439
+ module DeliveryStatus
1440
+ extend PreludeSDK::Internal::Type::Enum
1441
+
1442
+ TaggedSymbol =
1443
+ T.type_alias do
1444
+ T.all(
1445
+ Symbol,
1446
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus
1447
+ )
1448
+ end
1449
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1450
+
1451
+ UNKNOWN =
1452
+ T.let(
1453
+ :unknown,
1454
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus::TaggedSymbol
1455
+ )
1456
+ IN_TRANSIT =
1457
+ T.let(
1458
+ :in_transit,
1459
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus::TaggedSymbol
1460
+ )
1461
+ DELIVERED =
1462
+ T.let(
1463
+ :delivered,
1464
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus::TaggedSymbol
1465
+ )
1466
+ UNDELIVERABLE =
1467
+ T.let(
1468
+ :undeliverable,
1469
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus::TaggedSymbol
1470
+ )
1471
+ READ =
1472
+ T.let(
1473
+ :read,
1474
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus::TaggedSymbol
1475
+ )
1476
+
1477
+ sig do
1478
+ override.returns(
1479
+ T::Array[
1480
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus::TaggedSymbol
1481
+ ]
1482
+ )
1483
+ end
1484
+ def self.values
1485
+ end
1486
+ end
1487
+
1488
+ # Channel you asked for, when it differs from the one used.
1489
+ module PreferredChannel
1490
+ extend PreludeSDK::Internal::Type::Enum
1491
+
1492
+ TaggedSymbol =
1493
+ T.type_alias do
1494
+ T.all(
1495
+ Symbol,
1496
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel
1497
+ )
1498
+ end
1499
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1500
+
1501
+ SMS =
1502
+ T.let(
1503
+ :sms,
1504
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel::TaggedSymbol
1505
+ )
1506
+ RCS =
1507
+ T.let(
1508
+ :rcs,
1509
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel::TaggedSymbol
1510
+ )
1511
+ WHATSAPP =
1512
+ T.let(
1513
+ :whatsapp,
1514
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel::TaggedSymbol
1515
+ )
1516
+ VIBER =
1517
+ T.let(
1518
+ :viber,
1519
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel::TaggedSymbol
1520
+ )
1521
+ ZALO =
1522
+ T.let(
1523
+ :zalo,
1524
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel::TaggedSymbol
1525
+ )
1526
+ TELEGRAM =
1527
+ T.let(
1528
+ :telegram,
1529
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel::TaggedSymbol
1530
+ )
1531
+ VOICE =
1532
+ T.let(
1533
+ :voice,
1534
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel::TaggedSymbol
1535
+ )
1536
+ SILENT =
1537
+ T.let(
1538
+ :silent,
1539
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel::TaggedSymbol
1540
+ )
1541
+
1542
+ sig do
1543
+ override.returns(
1544
+ T::Array[
1545
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel::TaggedSymbol
1546
+ ]
1547
+ )
1548
+ end
1549
+ def self.values
1550
+ end
1551
+ end
1552
+
1553
+ module Status
1554
+ extend PreludeSDK::Internal::Type::Enum
1555
+
1556
+ TaggedSymbol =
1557
+ T.type_alias do
1558
+ T.all(
1559
+ Symbol,
1560
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Status
1561
+ )
1562
+ end
1563
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1564
+
1565
+ SUCCEEDED =
1566
+ T.let(
1567
+ :succeeded,
1568
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Status::TaggedSymbol
1569
+ )
1570
+ FAILED =
1571
+ T.let(
1572
+ :failed,
1573
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Status::TaggedSymbol
1574
+ )
1575
+
1576
+ sig do
1577
+ override.returns(
1578
+ T::Array[
1579
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Status::TaggedSymbol
1580
+ ]
1581
+ )
1582
+ end
1583
+ def self.values
1584
+ end
1585
+ end
1586
+
1587
+ # What caused the attempt.
1588
+ module Trigger
1589
+ extend PreludeSDK::Internal::Type::Enum
1590
+
1591
+ TaggedSymbol =
1592
+ T.type_alias do
1593
+ T.all(
1594
+ Symbol,
1595
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger
1596
+ )
1597
+ end
1598
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1599
+
1600
+ INITIAL =
1601
+ T.let(
1602
+ :initial,
1603
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger::TaggedSymbol
1604
+ )
1605
+ AUTO_RETRY =
1606
+ T.let(
1607
+ :auto_retry,
1608
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger::TaggedSymbol
1609
+ )
1610
+ USER_RETRY =
1611
+ T.let(
1612
+ :user_retry,
1613
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger::TaggedSymbol
1614
+ )
1615
+
1616
+ sig do
1617
+ override.returns(
1618
+ T::Array[
1619
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger::TaggedSymbol
1620
+ ]
1621
+ )
1622
+ end
1623
+ def self.values
1624
+ end
1625
+ end
1626
+ end
1627
+
1628
+ class Check < PreludeSDK::Internal::Type::BaseModel
1629
+ OrHash =
1630
+ T.type_alias do
1631
+ T.any(
1632
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check,
1633
+ PreludeSDK::Internal::AnyHash
1634
+ )
1635
+ end
1636
+
1637
+ sig { returns(Time) }
1638
+ attr_accessor :created_at
1639
+
1640
+ sig { returns(T::Boolean) }
1641
+ attr_accessor :is_valid
1642
+
1643
+ sig do
1644
+ returns(
1645
+ T.nilable(
1646
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel::TaggedSymbol
1647
+ )
1648
+ )
1649
+ end
1650
+ attr_reader :channel
1651
+
1652
+ sig do
1653
+ params(
1654
+ channel:
1655
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel::OrSymbol
1656
+ ).void
1657
+ end
1658
+ attr_writer :channel
1659
+
1660
+ # Present on checks against a `prelude:psd2` code.
1661
+ sig do
1662
+ returns(
1663
+ T.nilable(
1664
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Psd2Info
1665
+ )
1666
+ )
1667
+ end
1668
+ attr_reader :psd2_info
1669
+
1670
+ sig do
1671
+ params(
1672
+ psd2_info:
1673
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Psd2Info::OrHash
1674
+ ).void
1675
+ end
1676
+ attr_writer :psd2_info
1677
+
1678
+ # Why an invalid check failed, when known.
1679
+ sig do
1680
+ returns(
1681
+ T.nilable(
1682
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::StatusDetail::TaggedSymbol
1683
+ )
1684
+ )
1685
+ end
1686
+ attr_reader :status_detail
1687
+
1688
+ sig do
1689
+ params(
1690
+ status_detail:
1691
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::StatusDetail::OrSymbol
1692
+ ).void
1693
+ end
1694
+ attr_writer :status_detail
1695
+
1696
+ # The submitted code. Absent while the verification can still be completed, so
1697
+ # that a check in flight cannot be read back through this endpoint, and absent on
1698
+ # silent verification checks, which carry no code.
1699
+ sig { returns(T.nilable(String)) }
1700
+ attr_reader :value
1701
+
1702
+ sig { params(value: String).void }
1703
+ attr_writer :value
1704
+
1705
+ # One code submission for this verification.
1706
+ sig do
1707
+ params(
1708
+ created_at: Time,
1709
+ is_valid: T::Boolean,
1710
+ channel:
1711
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel::OrSymbol,
1712
+ psd2_info:
1713
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Psd2Info::OrHash,
1714
+ status_detail:
1715
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::StatusDetail::OrSymbol,
1716
+ value: String
1717
+ ).returns(T.attached_class)
1718
+ end
1719
+ def self.new(
1720
+ created_at:,
1721
+ is_valid:,
1722
+ channel: nil,
1723
+ # Present on checks against a `prelude:psd2` code.
1724
+ psd2_info: nil,
1725
+ # Why an invalid check failed, when known.
1726
+ status_detail: nil,
1727
+ # The submitted code. Absent while the verification can still be completed, so
1728
+ # that a check in flight cannot be read back through this endpoint, and absent on
1729
+ # silent verification checks, which carry no code.
1730
+ value: nil
1731
+ )
1732
+ end
1733
+
1734
+ sig do
1735
+ override.returns(
1736
+ {
1737
+ created_at: Time,
1738
+ is_valid: T::Boolean,
1739
+ channel:
1740
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel::TaggedSymbol,
1741
+ psd2_info:
1742
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Psd2Info,
1743
+ status_detail:
1744
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::StatusDetail::TaggedSymbol,
1745
+ value: String
1746
+ }
1747
+ )
1748
+ end
1749
+ def to_hash
1750
+ end
1751
+
1752
+ module Channel
1753
+ extend PreludeSDK::Internal::Type::Enum
1754
+
1755
+ TaggedSymbol =
1756
+ T.type_alias do
1757
+ T.all(
1758
+ Symbol,
1759
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel
1760
+ )
1761
+ end
1762
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1763
+
1764
+ SMS =
1765
+ T.let(
1766
+ :sms,
1767
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel::TaggedSymbol
1768
+ )
1769
+ RCS =
1770
+ T.let(
1771
+ :rcs,
1772
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel::TaggedSymbol
1773
+ )
1774
+ WHATSAPP =
1775
+ T.let(
1776
+ :whatsapp,
1777
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel::TaggedSymbol
1778
+ )
1779
+ VIBER =
1780
+ T.let(
1781
+ :viber,
1782
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel::TaggedSymbol
1783
+ )
1784
+ ZALO =
1785
+ T.let(
1786
+ :zalo,
1787
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel::TaggedSymbol
1788
+ )
1789
+ TELEGRAM =
1790
+ T.let(
1791
+ :telegram,
1792
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel::TaggedSymbol
1793
+ )
1794
+ VOICE =
1795
+ T.let(
1796
+ :voice,
1797
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel::TaggedSymbol
1798
+ )
1799
+ SILENT =
1800
+ T.let(
1801
+ :silent,
1802
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel::TaggedSymbol
1803
+ )
1804
+
1805
+ sig do
1806
+ override.returns(
1807
+ T::Array[
1808
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel::TaggedSymbol
1809
+ ]
1810
+ )
1811
+ end
1812
+ def self.values
1813
+ end
1814
+ end
1815
+
1816
+ class Psd2Info < PreludeSDK::Internal::Type::BaseModel
1817
+ OrHash =
1818
+ T.type_alias do
1819
+ T.any(
1820
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Psd2Info,
1821
+ PreludeSDK::Internal::AnyHash
1822
+ )
1823
+ end
1824
+
1825
+ # The transaction submitted when the code was issued.
1826
+ sig do
1827
+ returns(
1828
+ T.nilable(
1829
+ PreludeSDK::Verification::Phone::PhoneVerificationPsd2Transaction
1830
+ )
1831
+ )
1832
+ end
1833
+ attr_reader :expected_transaction
1834
+
1835
+ sig do
1836
+ params(
1837
+ expected_transaction:
1838
+ PreludeSDK::Verification::Phone::PhoneVerificationPsd2Transaction::OrHash
1839
+ ).void
1840
+ end
1841
+ attr_writer :expected_transaction
1842
+
1843
+ # The transaction submitted with this check. Differs from `expected_transaction`
1844
+ # when `status_detail` is `transaction_mismatch`.
1845
+ sig do
1846
+ returns(
1847
+ T.nilable(
1848
+ PreludeSDK::Verification::Phone::PhoneVerificationPsd2Transaction
1849
+ )
1850
+ )
1851
+ end
1852
+ attr_reader :received_transaction
1853
+
1854
+ sig do
1855
+ params(
1856
+ received_transaction:
1857
+ PreludeSDK::Verification::Phone::PhoneVerificationPsd2Transaction::OrHash
1858
+ ).void
1859
+ end
1860
+ attr_writer :received_transaction
1861
+
1862
+ # Present on checks against a `prelude:psd2` code.
1863
+ sig do
1864
+ params(
1865
+ expected_transaction:
1866
+ PreludeSDK::Verification::Phone::PhoneVerificationPsd2Transaction::OrHash,
1867
+ received_transaction:
1868
+ PreludeSDK::Verification::Phone::PhoneVerificationPsd2Transaction::OrHash
1869
+ ).returns(T.attached_class)
1870
+ end
1871
+ def self.new(
1872
+ # The transaction submitted when the code was issued.
1873
+ expected_transaction: nil,
1874
+ # The transaction submitted with this check. Differs from `expected_transaction`
1875
+ # when `status_detail` is `transaction_mismatch`.
1876
+ received_transaction: nil
1877
+ )
1878
+ end
1879
+
1880
+ sig do
1881
+ override.returns(
1882
+ {
1883
+ expected_transaction:
1884
+ PreludeSDK::Verification::Phone::PhoneVerificationPsd2Transaction,
1885
+ received_transaction:
1886
+ PreludeSDK::Verification::Phone::PhoneVerificationPsd2Transaction
1887
+ }
1888
+ )
1889
+ end
1890
+ def to_hash
1891
+ end
1892
+ end
1893
+
1894
+ # Why an invalid check failed, when known.
1895
+ module StatusDetail
1896
+ extend PreludeSDK::Internal::Type::Enum
1897
+
1898
+ TaggedSymbol =
1899
+ T.type_alias do
1900
+ T.all(
1901
+ Symbol,
1902
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::StatusDetail
1903
+ )
1904
+ end
1905
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1906
+
1907
+ EXPIRED_ATTEMPT =
1908
+ T.let(
1909
+ :expired_attempt,
1910
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::StatusDetail::TaggedSymbol
1911
+ )
1912
+ EXPIRED_AUTH =
1913
+ T.let(
1914
+ :expired_auth,
1915
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::StatusDetail::TaggedSymbol
1916
+ )
1917
+ RATE_LIMITED =
1918
+ T.let(
1919
+ :rate_limited,
1920
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::StatusDetail::TaggedSymbol
1921
+ )
1922
+ TRANSACTION_MISSING =
1923
+ T.let(
1924
+ :transaction_missing,
1925
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::StatusDetail::TaggedSymbol
1926
+ )
1927
+ TRANSACTION_MISMATCH =
1928
+ T.let(
1929
+ :transaction_mismatch,
1930
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::StatusDetail::TaggedSymbol
1931
+ )
1932
+
1933
+ sig do
1934
+ override.returns(
1935
+ T::Array[
1936
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::StatusDetail::TaggedSymbol
1937
+ ]
1938
+ )
1939
+ end
1940
+ def self.values
1941
+ end
1942
+ end
1943
+ end
1944
+
1945
+ class Create < PreludeSDK::Internal::Type::BaseModel
1946
+ OrHash =
1947
+ T.type_alias do
1948
+ T.any(
1949
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Create,
1950
+ PreludeSDK::Internal::AnyHash
1951
+ )
1952
+ end
1953
+
1954
+ sig { returns(Time) }
1955
+ attr_accessor :created_at
1956
+
1957
+ sig do
1958
+ returns(
1959
+ T.nilable(
1960
+ PreludeSDK::Verification::Phone::PhoneVerificationMoney
1961
+ )
1962
+ )
1963
+ end
1964
+ attr_reader :cost
1965
+
1966
+ sig do
1967
+ params(
1968
+ cost:
1969
+ PreludeSDK::Verification::Phone::PhoneVerificationMoney::OrHash
1970
+ ).void
1971
+ end
1972
+ attr_writer :cost
1973
+
1974
+ sig do
1975
+ params(
1976
+ created_at: Time,
1977
+ cost:
1978
+ PreludeSDK::Verification::Phone::PhoneVerificationMoney::OrHash
1979
+ ).returns(T.attached_class)
1980
+ end
1981
+ def self.new(created_at:, cost: nil)
1982
+ end
1983
+
1984
+ sig do
1985
+ override.returns(
1986
+ {
1987
+ created_at: Time,
1988
+ cost:
1989
+ PreludeSDK::Verification::Phone::PhoneVerificationMoney
1990
+ }
1991
+ )
1992
+ end
1993
+ def to_hash
1994
+ end
1995
+ end
1996
+
1997
+ class Signals < PreludeSDK::Internal::Type::BaseModel
1998
+ OrHash =
1999
+ T.type_alias do
2000
+ T.any(
2001
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals,
2002
+ PreludeSDK::Internal::AnyHash
2003
+ )
2004
+ end
2005
+
2006
+ sig { returns(Time) }
2007
+ attr_accessor :received_at
2008
+
2009
+ sig { returns(T.nilable(Time)) }
2010
+ attr_reader :expired_at
2011
+
2012
+ sig { params(expired_at: Time).void }
2013
+ attr_writer :expired_at
2014
+
2015
+ sig do
2016
+ returns(
2017
+ T.nilable(
2018
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals::Status::TaggedSymbol
2019
+ )
2020
+ )
2021
+ end
2022
+ attr_reader :status
2023
+
2024
+ sig do
2025
+ params(
2026
+ status:
2027
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals::Status::OrSymbol
2028
+ ).void
2029
+ end
2030
+ attr_writer :status
2031
+
2032
+ sig do
2033
+ params(
2034
+ received_at: Time,
2035
+ expired_at: Time,
2036
+ status:
2037
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals::Status::OrSymbol
2038
+ ).returns(T.attached_class)
2039
+ end
2040
+ def self.new(received_at:, expired_at: nil, status: nil)
2041
+ end
2042
+
2043
+ sig do
2044
+ override.returns(
2045
+ {
2046
+ received_at: Time,
2047
+ expired_at: Time,
2048
+ status:
2049
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals::Status::TaggedSymbol
2050
+ }
2051
+ )
2052
+ end
2053
+ def to_hash
2054
+ end
2055
+
2056
+ module Status
2057
+ extend PreludeSDK::Internal::Type::Enum
2058
+
2059
+ TaggedSymbol =
2060
+ T.type_alias do
2061
+ T.all(
2062
+ Symbol,
2063
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals::Status
2064
+ )
2065
+ end
2066
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2067
+
2068
+ VALID =
2069
+ T.let(
2070
+ :valid,
2071
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals::Status::TaggedSymbol
2072
+ )
2073
+ INVALID =
2074
+ T.let(
2075
+ :invalid,
2076
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals::Status::TaggedSymbol
2077
+ )
2078
+
2079
+ sig do
2080
+ override.returns(
2081
+ T::Array[
2082
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals::Status::TaggedSymbol
2083
+ ]
2084
+ )
2085
+ end
2086
+ def self.values
2087
+ end
2088
+ end
2089
+ end
2090
+ end
2091
+ end
2092
+
2093
+ # Whether the phone number was allow-listed, block-listed, or sandboxed at
2094
+ # verification time.
2095
+ module PhoneNumberCondition
2096
+ extend PreludeSDK::Internal::Type::Enum
2097
+
2098
+ TaggedSymbol =
2099
+ T.type_alias do
2100
+ T.all(
2101
+ Symbol,
2102
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCondition
2103
+ )
2104
+ end
2105
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2106
+
2107
+ ALLOW_LISTED =
2108
+ T.let(
2109
+ :allow_listed,
2110
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCondition::TaggedSymbol
2111
+ )
2112
+ BLOCK_LISTED =
2113
+ T.let(
2114
+ :block_listed,
2115
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCondition::TaggedSymbol
2116
+ )
2117
+ SANDBOXED =
2118
+ T.let(
2119
+ :sandboxed,
2120
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCondition::TaggedSymbol
2121
+ )
2122
+
2123
+ sig do
2124
+ override.returns(
2125
+ T::Array[
2126
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCondition::TaggedSymbol
2127
+ ]
2128
+ )
2129
+ end
2130
+ def self.values
2131
+ end
2132
+ end
2133
+
2134
+ # Whether the phone number is currently allow-listed, block-listed, or sandboxed.
2135
+ module PhoneNumberCurrentCondition
2136
+ extend PreludeSDK::Internal::Type::Enum
2137
+
2138
+ TaggedSymbol =
2139
+ T.type_alias do
2140
+ T.all(
2141
+ Symbol,
2142
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCurrentCondition
2143
+ )
2144
+ end
2145
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2146
+
2147
+ ALLOW_LISTED =
2148
+ T.let(
2149
+ :allow_listed,
2150
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCurrentCondition::TaggedSymbol
2151
+ )
2152
+ BLOCK_LISTED =
2153
+ T.let(
2154
+ :block_listed,
2155
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCurrentCondition::TaggedSymbol
2156
+ )
2157
+ SANDBOXED =
2158
+ T.let(
2159
+ :sandboxed,
2160
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCurrentCondition::TaggedSymbol
2161
+ )
2162
+
2163
+ sig do
2164
+ override.returns(
2165
+ T::Array[
2166
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::PhoneNumberCurrentCondition::TaggedSymbol
2167
+ ]
2168
+ )
2169
+ end
2170
+ def self.values
2171
+ end
2172
+ end
2173
+
2174
+ class Signals < PreludeSDK::Internal::Type::BaseModel
2175
+ OrHash =
2176
+ T.type_alias do
2177
+ T.any(
2178
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Signals,
2179
+ PreludeSDK::Internal::AnyHash
2180
+ )
2181
+ end
2182
+
2183
+ # Whether you flagged this end user as trusted when creating the verification.
2184
+ # Declared by you, not computed by Prelude.
2185
+ sig { returns(T::Boolean) }
2186
+ attr_accessor :is_trusted_user
2187
+
2188
+ # End-user device identifier you forwarded.
2189
+ sig { returns(T.nilable(String)) }
2190
+ attr_reader :device_id
2191
+
2192
+ sig { params(device_id: String).void }
2193
+ attr_writer :device_id
2194
+
2195
+ # TLS fingerprint you forwarded.
2196
+ sig { returns(T.nilable(String)) }
2197
+ attr_reader :ja4_fingerprint
2198
+
2199
+ sig { params(ja4_fingerprint: String).void }
2200
+ attr_writer :ja4_fingerprint
2201
+
2202
+ sig { returns(T.nilable(String)) }
2203
+ attr_reader :os_version
2204
+
2205
+ sig { params(os_version: String).void }
2206
+ attr_writer :os_version
2207
+
2208
+ sig { returns(T.nilable(String)) }
2209
+ attr_reader :user_agent
2210
+
2211
+ sig { params(user_agent: String).void }
2212
+ attr_writer :user_agent
2213
+
2214
+ # The anti-fraud signals you forwarded when creating the verification.
2215
+ sig do
2216
+ params(
2217
+ is_trusted_user: T::Boolean,
2218
+ device_id: String,
2219
+ ja4_fingerprint: String,
2220
+ os_version: String,
2221
+ user_agent: String
2222
+ ).returns(T.attached_class)
2223
+ end
2224
+ def self.new(
2225
+ # Whether you flagged this end user as trusted when creating the verification.
2226
+ # Declared by you, not computed by Prelude.
2227
+ is_trusted_user:,
2228
+ # End-user device identifier you forwarded.
2229
+ device_id: nil,
2230
+ # TLS fingerprint you forwarded.
2231
+ ja4_fingerprint: nil,
2232
+ os_version: nil,
2233
+ user_agent: nil
2234
+ )
2235
+ end
2236
+
2237
+ sig do
2238
+ override.returns(
2239
+ {
2240
+ is_trusted_user: T::Boolean,
2241
+ device_id: String,
2242
+ ja4_fingerprint: String,
2243
+ os_version: String,
2244
+ user_agent: String
2245
+ }
2246
+ )
2247
+ end
2248
+ def to_hash
2249
+ end
2250
+ end
2251
+
2252
+ # Whether the SDK signals integrity check passed.
2253
+ module SignalsHashStatus
2254
+ extend PreludeSDK::Internal::Type::Enum
2255
+
2256
+ TaggedSymbol =
2257
+ T.type_alias do
2258
+ T.all(
2259
+ Symbol,
2260
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::SignalsHashStatus
2261
+ )
2262
+ end
2263
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2264
+
2265
+ VALID =
2266
+ T.let(
2267
+ :valid,
2268
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::SignalsHashStatus::TaggedSymbol
2269
+ )
2270
+ INVALID =
2271
+ T.let(
2272
+ :invalid,
2273
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::SignalsHashStatus::TaggedSymbol
2274
+ )
2275
+
2276
+ sig do
2277
+ override.returns(
2278
+ T::Array[
2279
+ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::SignalsHashStatus::TaggedSymbol
2280
+ ]
2281
+ )
2282
+ end
2283
+ def self.values
2284
+ end
2285
+ end
2286
+ end
2287
+ end
2288
+ end
2289
+ end
2290
+ end