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,29 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PreludeSDK
4
+ module Models
5
+ module Verification
6
+ module Phone
7
+ class PhoneVerificationCarrier < PreludeSDK::Internal::Type::BaseModel
8
+ # @!attribute mccmnc
9
+ #
10
+ # @return [String]
11
+ required :mccmnc, String
12
+
13
+ # @!attribute name
14
+ #
15
+ # @return [String, nil]
16
+ optional :name, String
17
+
18
+ # @!method initialize(mccmnc:, name: nil)
19
+ # The end user's mobile network.
20
+ #
21
+ # @param mccmnc [String]
22
+ # @param name [String]
23
+ end
24
+ end
25
+
26
+ PhoneVerificationCarrier = Phone::PhoneVerificationCarrier
27
+ end
28
+ end
29
+ end
@@ -0,0 +1,35 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PreludeSDK
4
+ module Models
5
+ module Verification
6
+ module Phone
7
+ class PhoneVerificationMoney < PreludeSDK::Internal::Type::BaseModel
8
+ # @!attribute amount
9
+ # Exact decimal amount. It is never rounded to the currency's minor units, so a
10
+ # sub-cent cost reads as `0.0004` rather than as `0.00`.
11
+ #
12
+ # @return [String]
13
+ required :amount, String
14
+
15
+ # @!attribute currency
16
+ # ISO 4217 currency code.
17
+ #
18
+ # @return [String]
19
+ required :currency, String
20
+
21
+ # @!method initialize(amount:, currency:)
22
+ # Some parameter documentations has been truncated, see
23
+ # {PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney} for more
24
+ # details.
25
+ #
26
+ # @param amount [String] Exact decimal amount. It is never rounded to the currency's minor units, so a su
27
+ #
28
+ # @param currency [String] ISO 4217 currency code.
29
+ end
30
+ end
31
+
32
+ PhoneVerificationMoney = Phone::PhoneVerificationMoney
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,29 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PreludeSDK
4
+ module Models
5
+ module Verification
6
+ module Phone
7
+ class PhoneVerificationPsd2Transaction < PreludeSDK::Internal::Type::BaseModel
8
+ # @!attribute amount
9
+ #
10
+ # @return [PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney, nil]
11
+ optional :amount, -> { PreludeSDK::Verification::Phone::PhoneVerificationMoney }
12
+
13
+ # @!attribute recipient
14
+ # Payee name displayed to the payer.
15
+ #
16
+ # @return [String, nil]
17
+ optional :recipient, String
18
+
19
+ # @!method initialize(amount: nil, recipient: nil)
20
+ # @param amount [PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney]
21
+ #
22
+ # @param recipient [String] Payee name displayed to the payer.
23
+ end
24
+ end
25
+
26
+ PhoneVerificationPsd2Transaction = Phone::PhoneVerificationPsd2Transaction
27
+ end
28
+ end
29
+ end
@@ -17,8 +17,8 @@ module PreludeSDK
17
17
  # The verification target. Either a phone number or an email address. To use the
18
18
  # email verification feature contact us to discuss your use case.
19
19
  #
20
- # @return [PreludeSDK::Models::VerificationCheckParams::Target]
21
- required :target, -> { PreludeSDK::VerificationCheckParams::Target }
20
+ # @return [PreludeSDK::Models::Target]
21
+ required :target, -> { PreludeSDK::Target }
22
22
 
23
23
  # @!attribute psd2
24
24
  # Required when checking a code issued under the `prelude:psd2` template. The
@@ -35,47 +35,12 @@ module PreludeSDK
35
35
  #
36
36
  # @param code [String] The OTP code to validate.
37
37
  #
38
- # @param target [PreludeSDK::Models::VerificationCheckParams::Target] The verification target. Either a phone number or an email address. To use the e
38
+ # @param target [PreludeSDK::Models::Target] The verification target. Either a phone number or an email address. To use the e
39
39
  #
40
40
  # @param psd2 [PreludeSDK::Models::VerificationCheckParams::Psd2] Required when checking a code issued under the `prelude:psd2` template. The subm
41
41
  #
42
42
  # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
43
43
 
44
- class Target < PreludeSDK::Internal::Type::BaseModel
45
- # @!attribute type
46
- # The type of the target. Either "phone_number" or "email_address".
47
- #
48
- # @return [Symbol, PreludeSDK::Models::VerificationCheckParams::Target::Type]
49
- required :type, enum: -> { PreludeSDK::VerificationCheckParams::Target::Type }
50
-
51
- # @!attribute value
52
- # An E.164 formatted phone number or an email address.
53
- #
54
- # @return [String]
55
- required :value, String
56
-
57
- # @!method initialize(type:, value:)
58
- # The verification target. Either a phone number or an email address. To use the
59
- # email verification feature contact us to discuss your use case.
60
- #
61
- # @param type [Symbol, PreludeSDK::Models::VerificationCheckParams::Target::Type] The type of the target. Either "phone_number" or "email_address".
62
- #
63
- # @param value [String] An E.164 formatted phone number or an email address.
64
-
65
- # The type of the target. Either "phone_number" or "email_address".
66
- #
67
- # @see PreludeSDK::Models::VerificationCheckParams::Target#type
68
- module Type
69
- extend PreludeSDK::Internal::Type::Enum
70
-
71
- PHONE_NUMBER = :phone_number
72
- EMAIL_ADDRESS = :email_address
73
-
74
- # @!method self.values
75
- # @return [Array<Symbol>]
76
- end
77
- end
78
-
79
44
  class Psd2 < PreludeSDK::Internal::Type::BaseModel
80
45
  # @!attribute amount
81
46
  # Decimal amount of the transaction.
@@ -11,8 +11,8 @@ module PreludeSDK
11
11
  # The verification target. Either a phone number or an email address. To use the
12
12
  # email verification feature contact us to discuss your use case.
13
13
  #
14
- # @return [PreludeSDK::Models::VerificationCreateParams::Target]
15
- required :target, -> { PreludeSDK::VerificationCreateParams::Target }
14
+ # @return [PreludeSDK::Models::Target]
15
+ required :target, -> { PreludeSDK::Target }
16
16
 
17
17
  # @!attribute dispatch_id
18
18
  # The identifier of the dispatch that came from the front-end SDK.
@@ -37,14 +37,14 @@ module PreludeSDK
37
37
  # The signals used for anti-fraud. For more details, refer to
38
38
  # [Signals](/verify/v2/documentation/prevent-fraud#signals).
39
39
  #
40
- # @return [PreludeSDK::Models::VerificationCreateParams::Signals, nil]
41
- optional :signals, -> { PreludeSDK::VerificationCreateParams::Signals }
40
+ # @return [PreludeSDK::Models::Signals, nil]
41
+ optional :signals, -> { PreludeSDK::Signals }
42
42
 
43
43
  # @!method initialize(target:, dispatch_id: nil, metadata: nil, options: nil, signals: nil, request_options: {})
44
44
  # Some parameter documentations has been truncated, see
45
45
  # {PreludeSDK::Models::VerificationCreateParams} for more details.
46
46
  #
47
- # @param target [PreludeSDK::Models::VerificationCreateParams::Target] The verification target. Either a phone number or an email address. To use the e
47
+ # @param target [PreludeSDK::Models::Target] The verification target. Either a phone number or an email address. To use the e
48
48
  #
49
49
  # @param dispatch_id [String] The identifier of the dispatch that came from the front-end SDK.
50
50
  #
@@ -52,45 +52,10 @@ module PreludeSDK
52
52
  #
53
53
  # @param options [PreludeSDK::Models::VerificationCreateParams::Options] Verification options
54
54
  #
55
- # @param signals [PreludeSDK::Models::VerificationCreateParams::Signals] The signals used for anti-fraud. For more details, refer to [Signals](/verify/v2
55
+ # @param signals [PreludeSDK::Models::Signals] The signals used for anti-fraud. For more details, refer to [Signals](/verify/v2
56
56
  #
57
57
  # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
58
58
 
59
- class Target < PreludeSDK::Internal::Type::BaseModel
60
- # @!attribute type
61
- # The type of the target. Either "phone_number" or "email_address".
62
- #
63
- # @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Target::Type]
64
- required :type, enum: -> { PreludeSDK::VerificationCreateParams::Target::Type }
65
-
66
- # @!attribute value
67
- # An E.164 formatted phone number or an email address.
68
- #
69
- # @return [String]
70
- required :value, String
71
-
72
- # @!method initialize(type:, value:)
73
- # The verification target. Either a phone number or an email address. To use the
74
- # email verification feature contact us to discuss your use case.
75
- #
76
- # @param type [Symbol, PreludeSDK::Models::VerificationCreateParams::Target::Type] The type of the target. Either "phone_number" or "email_address".
77
- #
78
- # @param value [String] An E.164 formatted phone number or an email address.
79
-
80
- # The type of the target. Either "phone_number" or "email_address".
81
- #
82
- # @see PreludeSDK::Models::VerificationCreateParams::Target#type
83
- module Type
84
- extend PreludeSDK::Internal::Type::Enum
85
-
86
- PHONE_NUMBER = :phone_number
87
- EMAIL_ADDRESS = :email_address
88
-
89
- # @!method self.values
90
- # @return [Array<Symbol>]
91
- end
92
- end
93
-
94
59
  class Metadata < PreludeSDK::Internal::Type::BaseModel
95
60
  # @!attribute correlation_id
96
61
  # A user-defined identifier to correlate this verification with. It is returned in
@@ -377,126 +342,6 @@ module PreludeSDK
377
342
  # @return [Array<Symbol>]
378
343
  end
379
344
  end
380
-
381
- class Signals < PreludeSDK::Internal::Type::BaseModel
382
- # @!attribute app_version
383
- # The version of your application.
384
- #
385
- # @return [String, nil]
386
- optional :app_version, String
387
-
388
- # @!attribute device_id
389
- # A unique ID for the user's device. You should ensure that each user device has a
390
- # unique `device_id` value. Ideally, for Android, this corresponds to the
391
- # `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
392
- #
393
- # @return [String, nil]
394
- optional :device_id, String
395
-
396
- # @!attribute device_model
397
- # The model of the user's device.
398
- #
399
- # @return [String, nil]
400
- optional :device_model, String
401
-
402
- # @!attribute device_platform
403
- # The type of the user's device.
404
- #
405
- # @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Signals::DevicePlatform, nil]
406
- optional :device_platform, enum: -> { PreludeSDK::VerificationCreateParams::Signals::DevicePlatform }
407
-
408
- # @!attribute existing_user
409
- # Whether the end-user already exists in your system, for example an existing
410
- # account signing in again rather than a first-time signup. Unlike
411
- # `is_trusted_user`, this signal does not bypass fraud checks; it is taken into
412
- # account as one additional anti-fraud signal. For more details, refer to
413
- # [Signals](/verify/v2/documentation/prevent-fraud#signals).
414
- #
415
- # @return [Boolean, nil]
416
- optional :existing_user, PreludeSDK::Internal::Type::Boolean
417
-
418
- # @!attribute ip
419
- # The public IP v4 or v6 address of the end-user's device. You should collect this
420
- # from your backend. If your backend is behind a proxy, use the `X-Forwarded-For`,
421
- # `Forwarded`, `True-Client-IP`, `CF-Connecting-IP` or an equivalent header to get
422
- # the actual public IP of the end-user's device.
423
- #
424
- # @return [String, nil]
425
- optional :ip, String
426
-
427
- # @!attribute is_trusted_user
428
- # This signal should indicate a higher level of trust, explicitly stating that the
429
- # user is genuine. Contact us to discuss your use case. For more details, refer to
430
- # [Signals](/verify/v2/documentation/prevent-fraud#signals).
431
- #
432
- # @return [Boolean, nil]
433
- optional :is_trusted_user, PreludeSDK::Internal::Type::Boolean
434
-
435
- # @!attribute ja4_fingerprint
436
- # The JA4 fingerprint observed for the end-user's connection. Prelude will infer
437
- # it automatically when you use our Frontend SDKs (which use Prelude's edge
438
- # network), but you can also forward the value if you terminate TLS yourself.
439
- #
440
- # @return [String, nil]
441
- optional :ja4_fingerprint, String
442
-
443
- # @!attribute os_version
444
- # The version of the user's device operating system.
445
- #
446
- # @return [String, nil]
447
- optional :os_version, String
448
-
449
- # @!attribute user_agent
450
- # The user agent of the user's device. If the individual fields (os_version,
451
- # device_platform, device_model) are provided, we will prioritize those values
452
- # instead of parsing them from the user agent string.
453
- #
454
- # @return [String, nil]
455
- optional :user_agent, String
456
-
457
- # @!method initialize(app_version: nil, device_id: nil, device_model: nil, device_platform: nil, existing_user: nil, ip: nil, is_trusted_user: nil, ja4_fingerprint: nil, os_version: nil, user_agent: nil)
458
- # Some parameter documentations has been truncated, see
459
- # {PreludeSDK::Models::VerificationCreateParams::Signals} for more details.
460
- #
461
- # The signals used for anti-fraud. For more details, refer to
462
- # [Signals](/verify/v2/documentation/prevent-fraud#signals).
463
- #
464
- # @param app_version [String] The version of your application.
465
- #
466
- # @param device_id [String] A unique ID for the user's device. You should ensure that each user device has a
467
- #
468
- # @param device_model [String] The model of the user's device.
469
- #
470
- # @param device_platform [Symbol, PreludeSDK::Models::VerificationCreateParams::Signals::DevicePlatform] The type of the user's device.
471
- #
472
- # @param existing_user [Boolean] Whether the end-user already exists in your system, for example an existing acco
473
- #
474
- # @param ip [String] The public IP v4 or v6 address of the end-user's device. You should collect this
475
- #
476
- # @param is_trusted_user [Boolean] This signal should indicate a higher level of trust, explicitly stating that the
477
- #
478
- # @param ja4_fingerprint [String] The JA4 fingerprint observed for the end-user's connection. Prelude will infer i
479
- #
480
- # @param os_version [String] The version of the user's device operating system.
481
- #
482
- # @param user_agent [String] The user agent of the user's device. If the individual fields (os_version, devic
483
-
484
- # The type of the user's device.
485
- #
486
- # @see PreludeSDK::Models::VerificationCreateParams::Signals#device_platform
487
- module DevicePlatform
488
- extend PreludeSDK::Internal::Type::Enum
489
-
490
- ANDROID = :android
491
- IOS = :ios
492
- IPADOS = :ipados
493
- TVOS = :tvos
494
- WEB = :web
495
-
496
- # @!method self.values
497
- # @return [Array<Symbol>]
498
- end
499
- end
500
345
  end
501
346
  end
502
347
  end
@@ -58,9 +58,10 @@ module PreludeSDK
58
58
  # landline).
59
59
  # - `invalid_phone_number` - The phone number is not a valid phone number (e.g.
60
60
  # unallocated range).
61
- # - `invalid_signature` - The signature of the SDK signals is invalid.
62
- # - `repeated_attempts` - The phone number has made too many verification
63
- # attempts.
61
+ # - `invalid_signature` - The SDK signature did not verify, so the request cannot
62
+ # be attributed to the device it claims to come from.
63
+ # - `repeated_attempts` - The phone number exceeded the allowed number of
64
+ # verification attempts in a short period.
64
65
  # - `suspicious` - The verification attempt was deemed suspicious by the
65
66
  # anti-fraud system.
66
67
  #
@@ -77,26 +78,41 @@ module PreludeSDK
77
78
  # present when status is "blocked" or "shadow_blocked" and the anti-fraud system
78
79
  # detected specific risk signals.
79
80
  #
80
- # - `behavioral_pattern` - The phone number past behavior during verification
81
- # flows exhibits suspicious patterns.
82
- # - `device_attribute` - The device exhibits characteristics associated with
83
- # suspicious activity patterns.
84
- # - `fraud_database` - The phone number has been flagged as suspicious in one or
85
- # more of our fraud databases.
86
- # - `location_discrepancy` - The phone number prefix and IP address discrepancy
87
- # indicates potential fraud.
88
- # - `network_fingerprint` - The network connection exhibits characteristics
89
- # associated with suspicious activity patterns.
90
- # - `poor_conversion_history` - The phone number has a history of poorly
91
- # converting to a verified phone number.
92
- # - `prefix_concentration` - The phone number is part of a range known to be
93
- # associated with suspicious activity patterns.
94
- # - `suspected_request_tampering` - The SDK signature is invalid and the request
95
- # is considered to be tampered with.
96
- # - `suspicious_ip_address` - The IP address is deemed to be associated with
97
- # suspicious activity patterns.
98
- # - `temporary_phone_number` - The phone number is known to be a temporary or
99
- # disposable number.
81
+ # - `automation_signature` - The request appears to come from an automated client
82
+ # rather than a person.
83
+ # - `carrier_not_permitted` - The destination carrier is one this account does not
84
+ # accept traffic for.
85
+ # - `client_fingerprint_mismatch` - The client does not appear to be the platform
86
+ # it identifies itself as.
87
+ # - `custom_policy` - A rule configured for your account matched this request.
88
+ # - `device_emulator` - The request appears to come from an emulator rather than a
89
+ # physical device.
90
+ # - `device_not_permitted` - The device platform is one your account blocks.
91
+ # - `device_reuse` - One device is driving verifications for an unusual number of
92
+ # phone numbers.
93
+ # - `expired_signals` - The SDK signals were collected too long before the request
94
+ # to still attest to it.
95
+ # - `fraud_database` - The phone number is flagged in one or more of the fraud
96
+ # databases Prelude consults.
97
+ # - `invalid_signature` - The SDK signature did not verify, so the request cannot
98
+ # be attributed to the device it claims to come from.
99
+ # - `ip_concentration` - The request shares its origin with an unusual volume of
100
+ # other verifications.
101
+ # - `ip_reputation` - The originating IP address is not trusted.
102
+ # - `location_mismatch` - The network location and the phone number's country are
103
+ # inconsistent.
104
+ # - `missing_signals` - The verification expected Prelude SDK signals and none
105
+ # arrived.
106
+ # - `number_range_abuse` - The phone number belongs to a range currently
107
+ # associated with abuse.
108
+ # - `poor_conversion_history` - Traffic resembling this request rarely completes a
109
+ # verification.
110
+ # - `proxy_network` - The request did not arrive over the subscriber's own access
111
+ # network.
112
+ # - `repeated_attempts` - The phone number exceeded the allowed number of
113
+ # verification attempts in a short period.
114
+ # - `temporary_phone_number` - The phone number belongs to a disposable or
115
+ # short-lived numbering service.
100
116
  #
101
117
  # @return [Array<Symbol, PreludeSDK::Models::VerificationCreateResponse::RiskFactor>, nil]
102
118
  optional :risk_factors,
@@ -215,9 +231,10 @@ module PreludeSDK
215
231
  # landline).
216
232
  # - `invalid_phone_number` - The phone number is not a valid phone number (e.g.
217
233
  # unallocated range).
218
- # - `invalid_signature` - The signature of the SDK signals is invalid.
219
- # - `repeated_attempts` - The phone number has made too many verification
220
- # attempts.
234
+ # - `invalid_signature` - The SDK signature did not verify, so the request cannot
235
+ # be attributed to the device it claims to come from.
236
+ # - `repeated_attempts` - The phone number exceeded the allowed number of
237
+ # verification attempts in a short period.
221
238
  # - `suspicious` - The verification attempt was deemed suspicious by the
222
239
  # anti-fraud system.
223
240
  #
@@ -240,15 +257,24 @@ module PreludeSDK
240
257
  module RiskFactor
241
258
  extend PreludeSDK::Internal::Type::Enum
242
259
 
243
- BEHAVIORAL_PATTERN = :behavioral_pattern
244
- DEVICE_ATTRIBUTE = :device_attribute
260
+ AUTOMATION_SIGNATURE = :automation_signature
261
+ CARRIER_NOT_PERMITTED = :carrier_not_permitted
262
+ CLIENT_FINGERPRINT_MISMATCH = :client_fingerprint_mismatch
263
+ CUSTOM_POLICY = :custom_policy
264
+ DEVICE_EMULATOR = :device_emulator
265
+ DEVICE_NOT_PERMITTED = :device_not_permitted
266
+ DEVICE_REUSE = :device_reuse
267
+ EXPIRED_SIGNALS = :expired_signals
245
268
  FRAUD_DATABASE = :fraud_database
246
- LOCATION_DISCREPANCY = :location_discrepancy
247
- NETWORK_FINGERPRINT = :network_fingerprint
269
+ INVALID_SIGNATURE = :invalid_signature
270
+ IP_CONCENTRATION = :ip_concentration
271
+ IP_REPUTATION = :ip_reputation
272
+ LOCATION_MISMATCH = :location_mismatch
273
+ MISSING_SIGNALS = :missing_signals
274
+ NUMBER_RANGE_ABUSE = :number_range_abuse
248
275
  POOR_CONVERSION_HISTORY = :poor_conversion_history
249
- PREFIX_CONCENTRATION = :prefix_concentration
250
- SUSPECTED_REQUEST_TAMPERING = :suspected_request_tampering
251
- SUSPICIOUS_IP_ADDRESS = :suspicious_ip_address
276
+ PROXY_NETWORK = :proxy_network
277
+ REPEATED_ATTEMPTS = :repeated_attempts
252
278
  TEMPORARY_PHONE_NUMBER = :temporary_phone_number
253
279
 
254
280
  # @!method self.values
@@ -0,0 +1,37 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PreludeSDK
4
+ module Models
5
+ module VerificationManagement
6
+ # @see PreludeSDK::Resources::VerificationManagement::Sandbox#add_phone_number
7
+ class SandboxAddPhoneNumberParams < PreludeSDK::Internal::Type::BaseModel
8
+ extend PreludeSDK::Internal::Type::RequestParameters::Converter
9
+ include PreludeSDK::Internal::Type::RequestParameters
10
+
11
+ # @!attribute attempt_code
12
+ # The fixed attempt code that will validate verification attempts for this phone
13
+ # number.
14
+ #
15
+ # @return [String]
16
+ required :attempt_code, String
17
+
18
+ # @!attribute phone_number
19
+ # An E.164 formatted phone number to add to the sandbox list.
20
+ #
21
+ # @return [String]
22
+ required :phone_number, String
23
+
24
+ # @!method initialize(attempt_code:, phone_number:, request_options: {})
25
+ # Some parameter documentations has been truncated, see
26
+ # {PreludeSDK::Models::VerificationManagement::SandboxAddPhoneNumberParams} for
27
+ # more details.
28
+ #
29
+ # @param attempt_code [String] The fixed attempt code that will validate verification attempts for this phone n
30
+ #
31
+ # @param phone_number [String] An E.164 formatted phone number to add to the sandbox list.
32
+ #
33
+ # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
34
+ end
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PreludeSDK
4
+ module Models
5
+ module VerificationManagement
6
+ # @see PreludeSDK::Resources::VerificationManagement::Sandbox#add_phone_number
7
+ class SandboxAddPhoneNumberResponse < PreludeSDK::Internal::Type::BaseModel
8
+ # @!attribute attempt_code
9
+ # The fixed attempt code associated with the sandbox phone number.
10
+ #
11
+ # @return [String]
12
+ required :attempt_code, String
13
+
14
+ # @!attribute phone_number
15
+ # The E.164 formatted phone number that was added to the sandbox list.
16
+ #
17
+ # @return [String]
18
+ required :phone_number, String
19
+
20
+ # @!method initialize(attempt_code:, phone_number:)
21
+ # @param attempt_code [String] The fixed attempt code associated with the sandbox phone number.
22
+ #
23
+ # @param phone_number [String] The E.164 formatted phone number that was added to the sandbox list.
24
+ end
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PreludeSDK
4
+ module Models
5
+ module VerificationManagement
6
+ # @see PreludeSDK::Resources::VerificationManagement::Sandbox#delete_phone_number
7
+ class SandboxDeletePhoneNumberParams < PreludeSDK::Internal::Type::BaseModel
8
+ extend PreludeSDK::Internal::Type::RequestParameters::Converter
9
+ include PreludeSDK::Internal::Type::RequestParameters
10
+
11
+ # @!attribute phone_number
12
+ #
13
+ # @return [String]
14
+ required :phone_number, String
15
+
16
+ # @!method initialize(phone_number:, request_options: {})
17
+ # @param phone_number [String]
18
+ # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PreludeSDK
4
+ module Models
5
+ module VerificationManagement
6
+ # @see PreludeSDK::Resources::VerificationManagement::Sandbox#delete_phone_number
7
+ class SandboxDeletePhoneNumberResponse < PreludeSDK::Internal::Type::BaseModel
8
+ # @!attribute phone_number
9
+ # The E.164 formatted phone number that was removed from the sandbox list.
10
+ #
11
+ # @return [String]
12
+ required :phone_number, String
13
+
14
+ # @!method initialize(phone_number:)
15
+ # @param phone_number [String] The E.164 formatted phone number that was removed from the sandbox list.
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PreludeSDK
4
+ module Models
5
+ module VerificationManagement
6
+ # @see PreludeSDK::Resources::VerificationManagement::Sandbox#list_phone_numbers
7
+ class SandboxListPhoneNumbersParams < PreludeSDK::Internal::Type::BaseModel
8
+ extend PreludeSDK::Internal::Type::RequestParameters::Converter
9
+ include PreludeSDK::Internal::Type::RequestParameters
10
+
11
+ # @!method initialize(request_options: {})
12
+ # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
13
+ end
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,47 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PreludeSDK
4
+ module Models
5
+ module VerificationManagement
6
+ # @see PreludeSDK::Resources::VerificationManagement::Sandbox#list_phone_numbers
7
+ class SandboxListPhoneNumbersResponse < PreludeSDK::Internal::Type::BaseModel
8
+ # @!attribute phone_numbers
9
+ # A list of sandbox phone numbers.
10
+ #
11
+ # @return [Array<PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersResponse::PhoneNumber>]
12
+ required :phone_numbers,
13
+ -> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersResponse::PhoneNumber] }
14
+
15
+ # @!method initialize(phone_numbers:)
16
+ # @param phone_numbers [Array<PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersResponse::PhoneNumber>] A list of sandbox phone numbers.
17
+
18
+ class PhoneNumber < PreludeSDK::Internal::Type::BaseModel
19
+ # @!attribute attempt_code
20
+ # The fixed attempt code associated with the sandbox phone number.
21
+ #
22
+ # @return [String]
23
+ required :attempt_code, String
24
+
25
+ # @!attribute created_at
26
+ # The date and time when the phone number was added to the sandbox list.
27
+ #
28
+ # @return [Time]
29
+ required :created_at, Time
30
+
31
+ # @!attribute phone_number
32
+ # An E.164 formatted phone number.
33
+ #
34
+ # @return [String]
35
+ required :phone_number, String
36
+
37
+ # @!method initialize(attempt_code:, created_at:, phone_number:)
38
+ # @param attempt_code [String] The fixed attempt code associated with the sandbox phone number.
39
+ #
40
+ # @param created_at [Time] The date and time when the phone number was added to the sandbox list.
41
+ #
42
+ # @param phone_number [String] An E.164 formatted phone number.
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end