prelude-sdk 0.6.0 → 0.8.0

data/rbi/prelude_sdk/models/verification/phone/phone_verification_carrier.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    module Verification
+      PhoneVerificationCarrier = Phone::PhoneVerificationCarrier
+
+      module Phone
+        class PhoneVerificationCarrier < PreludeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                PreludeSDK::Verification::Phone::PhoneVerificationCarrier,
+                PreludeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :mccmnc
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          # The end user's mobile network.
+          sig { params(mccmnc: String, name: String).returns(T.attached_class) }
+          def self.new(mccmnc:, name: nil)
+          end
+
+          sig { override.returns({ mccmnc: String, name: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification/phone/phone_verification_money.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    module Verification
+      PhoneVerificationMoney = Phone::PhoneVerificationMoney
+
+      module Phone
+        class PhoneVerificationMoney < PreludeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                PreludeSDK::Verification::Phone::PhoneVerificationMoney,
+                PreludeSDK::Internal::AnyHash
+              )
+            end
+
+          # Exact decimal amount. It is never rounded to the currency's minor units, so a
+          # sub-cent cost reads as `0.0004` rather than as `0.00`.
+          sig { returns(String) }
+          attr_accessor :amount
+
+          # ISO 4217 currency code.
+          sig { returns(String) }
+          attr_accessor :currency
+
+          sig do
+            params(amount: String, currency: String).returns(T.attached_class)
+          end
+          def self.new(
+            # Exact decimal amount. It is never rounded to the currency's minor units, so a
+            # sub-cent cost reads as `0.0004` rather than as `0.00`.
+            amount:,
+            # ISO 4217 currency code.
+            currency:
+          )
+          end
+
+          sig { override.returns({ amount: String, currency: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification/phone/phone_verification_psd2_transaction.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    module Verification
+      PhoneVerificationPsd2Transaction = Phone::PhoneVerificationPsd2Transaction
+
+      module Phone
+        class PhoneVerificationPsd2Transaction < PreludeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                PreludeSDK::Verification::Phone::PhoneVerificationPsd2Transaction,
+                PreludeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T.nilable(PreludeSDK::Verification::Phone::PhoneVerificationMoney)
+            )
+          end
+          attr_reader :amount
+
+          sig do
+            params(
+              amount:
+                PreludeSDK::Verification::Phone::PhoneVerificationMoney::OrHash
+            ).void
+          end
+          attr_writer :amount
+
+          # Payee name displayed to the payer.
+          sig { returns(T.nilable(String)) }
+          attr_reader :recipient
+
+          sig { params(recipient: String).void }
+          attr_writer :recipient
+
+          sig do
+            params(
+              amount:
+                PreludeSDK::Verification::Phone::PhoneVerificationMoney::OrHash,
+              recipient: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            amount: nil,
+            # Payee name displayed to the payer.
+            recipient: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                amount: PreludeSDK::Verification::Phone::PhoneVerificationMoney,
+                recipient: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_check_params.rbi

@@ -20,12 +20,10 @@ module PreludeSDK
 
       # The verification target. Either a phone number or an email address. To use the
       # email verification feature contact us to discuss your use case.
-      sig { returns(PreludeSDK::VerificationCheckParams::Target) }
+      sig { returns(PreludeSDK::Target) }
       attr_reader :target
 
-      sig do
-        params(target: PreludeSDK::VerificationCheckParams::Target::OrHash).void
-      end
+      sig { params(target: PreludeSDK::Target::OrHash).void }
       attr_writer :target
 
       # Required when checking a code issued under the `prelude:psd2` template. The
@@ -43,7 +41,7 @@ module PreludeSDK
       sig do
         params(
           code: String,
-          target: PreludeSDK::VerificationCheckParams::Target::OrHash,
+          target: PreludeSDK::Target::OrHash,
           psd2: PreludeSDK::VerificationCheckParams::Psd2::OrHash,
           request_options: PreludeSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -67,7 +65,7 @@ module PreludeSDK
         override.returns(
           {
             code: String,
-            target: PreludeSDK::VerificationCheckParams::Target,
+            target: PreludeSDK::Target,
             psd2: PreludeSDK::VerificationCheckParams::Psd2,
             request_options: PreludeSDK::RequestOptions
           }
@@ -76,85 +74,6 @@ module PreludeSDK
       def to_hash
       end
 
-      class Target < PreludeSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              PreludeSDK::VerificationCheckParams::Target,
-              PreludeSDK::Internal::AnyHash
-            )
-          end
-
-        # The type of the target. Either "phone_number" or "email_address".
-        sig do
-          returns(PreludeSDK::VerificationCheckParams::Target::Type::OrSymbol)
-        end
-        attr_accessor :type
-
-        # An E.164 formatted phone number or an email address.
-        sig { returns(String) }
-        attr_accessor :value
-
-        # The verification target. Either a phone number or an email address. To use the
-        # email verification feature contact us to discuss your use case.
-        sig do
-          params(
-            type: PreludeSDK::VerificationCheckParams::Target::Type::OrSymbol,
-            value: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The type of the target. Either "phone_number" or "email_address".
-          type:,
-          # An E.164 formatted phone number or an email address.
-          value:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              type: PreludeSDK::VerificationCheckParams::Target::Type::OrSymbol,
-              value: String
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # The type of the target. Either "phone_number" or "email_address".
-        module Type
-          extend PreludeSDK::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, PreludeSDK::VerificationCheckParams::Target::Type)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          PHONE_NUMBER =
-            T.let(
-              :phone_number,
-              PreludeSDK::VerificationCheckParams::Target::Type::TaggedSymbol
-            )
-          EMAIL_ADDRESS =
-            T.let(
-              :email_address,
-              PreludeSDK::VerificationCheckParams::Target::Type::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                PreludeSDK::VerificationCheckParams::Target::Type::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
       class Psd2 < PreludeSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/prelude_sdk/models/verification_create_params.rbi

@@ -16,14 +16,10 @@ module PreludeSDK
 
       # The verification target. Either a phone number or an email address. To use the
       # email verification feature contact us to discuss your use case.
-      sig { returns(PreludeSDK::VerificationCreateParams::Target) }
+      sig { returns(PreludeSDK::Target) }
       attr_reader :target
 
-      sig do
-        params(
-          target: PreludeSDK::VerificationCreateParams::Target::OrHash
-        ).void
-      end
+      sig { params(target: PreludeSDK::Target::OrHash).void }
       attr_writer :target
 
       # The identifier of the dispatch that came from the front-end SDK.
@@ -58,23 +54,19 @@ module PreludeSDK
 
       # The signals used for anti-fraud. For more details, refer to
       # [Signals](/verify/v2/documentation/prevent-fraud#signals).
-      sig { returns(T.nilable(PreludeSDK::VerificationCreateParams::Signals)) }
+      sig { returns(T.nilable(PreludeSDK::Signals)) }
       attr_reader :signals
 
-      sig do
-        params(
-          signals: PreludeSDK::VerificationCreateParams::Signals::OrHash
-        ).void
-      end
+      sig { params(signals: PreludeSDK::Signals::OrHash).void }
       attr_writer :signals
 
       sig do
         params(
-          target: PreludeSDK::VerificationCreateParams::Target::OrHash,
+          target: PreludeSDK::Target::OrHash,
           dispatch_id: String,
           metadata: PreludeSDK::VerificationCreateParams::Metadata::OrHash,
           options: PreludeSDK::VerificationCreateParams::Options::OrHash,
-          signals: PreludeSDK::VerificationCreateParams::Signals::OrHash,
+          signals: PreludeSDK::Signals::OrHash,
           request_options: PreludeSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -99,11 +91,11 @@ module PreludeSDK
       sig do
         override.returns(
           {
-            target: PreludeSDK::VerificationCreateParams::Target,
+            target: PreludeSDK::Target,
             dispatch_id: String,
             metadata: PreludeSDK::VerificationCreateParams::Metadata,
             options: PreludeSDK::VerificationCreateParams::Options,
-            signals: PreludeSDK::VerificationCreateParams::Signals,
+            signals: PreludeSDK::Signals,
             request_options: PreludeSDK::RequestOptions
           }
         )
@@ -111,86 +103,6 @@ module PreludeSDK
       def to_hash
       end
 
-      class Target < PreludeSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              PreludeSDK::VerificationCreateParams::Target,
-              PreludeSDK::Internal::AnyHash
-            )
-          end
-
-        # The type of the target. Either "phone_number" or "email_address".
-        sig do
-          returns(PreludeSDK::VerificationCreateParams::Target::Type::OrSymbol)
-        end
-        attr_accessor :type
-
-        # An E.164 formatted phone number or an email address.
-        sig { returns(String) }
-        attr_accessor :value
-
-        # The verification target. Either a phone number or an email address. To use the
-        # email verification feature contact us to discuss your use case.
-        sig do
-          params(
-            type: PreludeSDK::VerificationCreateParams::Target::Type::OrSymbol,
-            value: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The type of the target. Either "phone_number" or "email_address".
-          type:,
-          # An E.164 formatted phone number or an email address.
-          value:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              type:
-                PreludeSDK::VerificationCreateParams::Target::Type::OrSymbol,
-              value: String
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # The type of the target. Either "phone_number" or "email_address".
-        module Type
-          extend PreludeSDK::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, PreludeSDK::VerificationCreateParams::Target::Type)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          PHONE_NUMBER =
-            T.let(
-              :phone_number,
-              PreludeSDK::VerificationCreateParams::Target::Type::TaggedSymbol
-            )
-          EMAIL_ADDRESS =
-            T.let(
-              :email_address,
-              PreludeSDK::VerificationCreateParams::Target::Type::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                PreludeSDK::VerificationCreateParams::Target::Type::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
       class Metadata < PreludeSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -812,219 +724,6 @@ module PreludeSDK
           end
         end
       end
-
-      class Signals < PreludeSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              PreludeSDK::VerificationCreateParams::Signals,
-              PreludeSDK::Internal::AnyHash
-            )
-          end
-
-        # The version of your application.
-        sig { returns(T.nilable(String)) }
-        attr_reader :app_version
-
-        sig { params(app_version: String).void }
-        attr_writer :app_version
-
-        # A unique ID for the user's device. You should ensure that each user device has a
-        # unique `device_id` value. Ideally, for Android, this corresponds to the
-        # `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
-        sig { returns(T.nilable(String)) }
-        attr_reader :device_id
-
-        sig { params(device_id: String).void }
-        attr_writer :device_id
-
-        # The model of the user's device.
-        sig { returns(T.nilable(String)) }
-        attr_reader :device_model
-
-        sig { params(device_model: String).void }
-        attr_writer :device_model
-
-        # The type of the user's device.
-        sig do
-          returns(
-            T.nilable(
-              PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::OrSymbol
-            )
-          )
-        end
-        attr_reader :device_platform
-
-        sig do
-          params(
-            device_platform:
-              PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::OrSymbol
-          ).void
-        end
-        attr_writer :device_platform
-
-        # The public IP v4 or v6 address of the end-user's device. You should collect this
-        # from your backend. If your backend is behind a proxy, use the `X-Forwarded-For`,
-        # `Forwarded`, `True-Client-IP`, `CF-Connecting-IP` or an equivalent header to get
-        # the actual public IP of the end-user's device.
-        sig { returns(T.nilable(String)) }
-        attr_reader :ip
-
-        sig { params(ip: String).void }
-        attr_writer :ip
-
-        # This signal should indicate a higher level of trust, explicitly stating that the
-        # user is genuine. Contact us to discuss your use case. For more details, refer to
-        # [Signals](/verify/v2/documentation/prevent-fraud#signals).
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :is_trusted_user
-
-        sig { params(is_trusted_user: T::Boolean).void }
-        attr_writer :is_trusted_user
-
-        # The JA4 fingerprint observed for the end-user's connection. Prelude will infer
-        # it automatically when you use our Frontend SDKs (which use Prelude's edge
-        # network), but you can also forward the value if you terminate TLS yourself.
-        sig { returns(T.nilable(String)) }
-        attr_reader :ja4_fingerprint
-
-        sig { params(ja4_fingerprint: String).void }
-        attr_writer :ja4_fingerprint
-
-        # The version of the user's device operating system.
-        sig { returns(T.nilable(String)) }
-        attr_reader :os_version
-
-        sig { params(os_version: String).void }
-        attr_writer :os_version
-
-        # The user agent of the user's device. If the individual fields (os_version,
-        # device_platform, device_model) are provided, we will prioritize those values
-        # instead of parsing them from the user agent string.
-        sig { returns(T.nilable(String)) }
-        attr_reader :user_agent
-
-        sig { params(user_agent: String).void }
-        attr_writer :user_agent
-
-        # The signals used for anti-fraud. For more details, refer to
-        # [Signals](/verify/v2/documentation/prevent-fraud#signals).
-        sig do
-          params(
-            app_version: String,
-            device_id: String,
-            device_model: String,
-            device_platform:
-              PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::OrSymbol,
-            ip: String,
-            is_trusted_user: T::Boolean,
-            ja4_fingerprint: String,
-            os_version: String,
-            user_agent: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The version of your application.
-          app_version: nil,
-          # A unique ID for the user's device. You should ensure that each user device has a
-          # unique `device_id` value. Ideally, for Android, this corresponds to the
-          # `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
-          device_id: nil,
-          # The model of the user's device.
-          device_model: nil,
-          # The type of the user's device.
-          device_platform: nil,
-          # The public IP v4 or v6 address of the end-user's device. You should collect this
-          # from your backend. If your backend is behind a proxy, use the `X-Forwarded-For`,
-          # `Forwarded`, `True-Client-IP`, `CF-Connecting-IP` or an equivalent header to get
-          # the actual public IP of the end-user's device.
-          ip: nil,
-          # This signal should indicate a higher level of trust, explicitly stating that the
-          # user is genuine. Contact us to discuss your use case. For more details, refer to
-          # [Signals](/verify/v2/documentation/prevent-fraud#signals).
-          is_trusted_user: nil,
-          # The JA4 fingerprint observed for the end-user's connection. Prelude will infer
-          # it automatically when you use our Frontend SDKs (which use Prelude's edge
-          # network), but you can also forward the value if you terminate TLS yourself.
-          ja4_fingerprint: nil,
-          # The version of the user's device operating system.
-          os_version: nil,
-          # The user agent of the user's device. If the individual fields (os_version,
-          # device_platform, device_model) are provided, we will prioritize those values
-          # instead of parsing them from the user agent string.
-          user_agent: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              app_version: String,
-              device_id: String,
-              device_model: String,
-              device_platform:
-                PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::OrSymbol,
-              ip: String,
-              is_trusted_user: T::Boolean,
-              ja4_fingerprint: String,
-              os_version: String,
-              user_agent: String
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # The type of the user's device.
-        module DevicePlatform
-          extend PreludeSDK::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                PreludeSDK::VerificationCreateParams::Signals::DevicePlatform
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          ANDROID =
-            T.let(
-              :android,
-              PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::TaggedSymbol
-            )
-          IOS =
-            T.let(
-              :ios,
-              PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::TaggedSymbol
-            )
-          IPADOS =
-            T.let(
-              :ipados,
-              PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::TaggedSymbol
-            )
-          TVOS =
-            T.let(
-              :tvos,
-              PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::TaggedSymbol
-            )
-          WEB =
-            T.let(
-              :web,
-              PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
     end
   end
 end

data/rbi/prelude_sdk/models/verification_management/sandbox_add_phone_number_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    module VerificationManagement
+      class SandboxAddPhoneNumberParams < PreludeSDK::Internal::Type::BaseModel
+        extend PreludeSDK::Internal::Type::RequestParameters::Converter
+        include PreludeSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::VerificationManagement::SandboxAddPhoneNumberParams,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # The fixed attempt code that will validate verification attempts for this phone
+        # number.
+        sig { returns(String) }
+        attr_accessor :attempt_code
+
+        # An E.164 formatted phone number to add to the sandbox list.
+        sig { returns(String) }
+        attr_accessor :phone_number
+
+        sig do
+          params(
+            attempt_code: String,
+            phone_number: String,
+            request_options: PreludeSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The fixed attempt code that will validate verification attempts for this phone
+          # number.
+          attempt_code:,
+          # An E.164 formatted phone number to add to the sandbox list.
+          phone_number:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              attempt_code: String,
+              phone_number: String,
+              request_options: PreludeSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end