prelude-sdk 0.6.0 → 0.8.0

data/lib/prelude_sdk/models/verification/phone/phone_verification_carrier.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    module Verification
+      module Phone
+        class PhoneVerificationCarrier < PreludeSDK::Internal::Type::BaseModel
+          # @!attribute mccmnc
+          #
+          #   @return [String]
+          required :mccmnc, String
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(mccmnc:, name: nil)
+          #   The end user's mobile network.
+          #
+          #   @param mccmnc [String]
+          #   @param name [String]
+        end
+      end
+
+      PhoneVerificationCarrier = Phone::PhoneVerificationCarrier
+    end
+  end
+end

data/lib/prelude_sdk/models/verification/phone/phone_verification_money.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    module Verification
+      module Phone
+        class PhoneVerificationMoney < PreludeSDK::Internal::Type::BaseModel
+          # @!attribute amount
+          #   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`.
+          #
+          #   @return [String]
+          required :amount, String
+
+          # @!attribute currency
+          #   ISO 4217 currency code.
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!method initialize(amount:, currency:)
+          #   Some parameter documentations has been truncated, see
+          #   {PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney} for more
+          #   details.
+          #
+          #   @param amount [String] Exact decimal amount. It is never rounded to the currency's minor units, so a su
+          #
+          #   @param currency [String] ISO 4217 currency code.
+        end
+      end
+
+      PhoneVerificationMoney = Phone::PhoneVerificationMoney
+    end
+  end
+end

data/lib/prelude_sdk/models/verification/phone/phone_verification_psd2_transaction.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    module Verification
+      module Phone
+        class PhoneVerificationPsd2Transaction < PreludeSDK::Internal::Type::BaseModel
+          # @!attribute amount
+          #
+          #   @return [PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney, nil]
+          optional :amount, -> { PreludeSDK::Verification::Phone::PhoneVerificationMoney }
+
+          # @!attribute recipient
+          #   Payee name displayed to the payer.
+          #
+          #   @return [String, nil]
+          optional :recipient, String
+
+          # @!method initialize(amount: nil, recipient: nil)
+          #   @param amount [PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney]
+          #
+          #   @param recipient [String] Payee name displayed to the payer.
+        end
+      end
+
+      PhoneVerificationPsd2Transaction = Phone::PhoneVerificationPsd2Transaction
+    end
+  end
+end

data/lib/prelude_sdk/models/verification_check_params.rb

@@ -17,8 +17,8 @@ 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.
       #
-      #   @return [PreludeSDK::Models::VerificationCheckParams::Target]
-      required :target, -> { PreludeSDK::VerificationCheckParams::Target }
+      #   @return [PreludeSDK::Models::Target]
+      required :target, -> { PreludeSDK::Target }
 
       # @!attribute psd2
       #   Required when checking a code issued under the `prelude:psd2` template. The
@@ -35,47 +35,12 @@ module PreludeSDK
       #
       #   @param code [String] The OTP code to validate.
       #
-      #   @param target [PreludeSDK::Models::VerificationCheckParams::Target] The verification target. Either a phone number or an email address. To use the e
+      #   @param target [PreludeSDK::Models::Target] The verification target. Either a phone number or an email address. To use the e
       #
       #   @param psd2 [PreludeSDK::Models::VerificationCheckParams::Psd2] Required when checking a code issued under the `prelude:psd2` template. The subm
       #
       #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
 
-      class Target < PreludeSDK::Internal::Type::BaseModel
-        # @!attribute type
-        #   The type of the target. Either "phone_number" or "email_address".
-        #
-        #   @return [Symbol, PreludeSDK::Models::VerificationCheckParams::Target::Type]
-        required :type, enum: -> { PreludeSDK::VerificationCheckParams::Target::Type }
-
-        # @!attribute value
-        #   An E.164 formatted phone number or an email address.
-        #
-        #   @return [String]
-        required :value, String
-
-        # @!method initialize(type:, 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.
-        #
-        #   @param type [Symbol, PreludeSDK::Models::VerificationCheckParams::Target::Type] The type of the target. Either "phone_number" or "email_address".
-        #
-        #   @param value [String] An E.164 formatted phone number or an email address.
-
-        # The type of the target. Either "phone_number" or "email_address".
-        #
-        # @see PreludeSDK::Models::VerificationCheckParams::Target#type
-        module Type
-          extend PreludeSDK::Internal::Type::Enum
-
-          PHONE_NUMBER = :phone_number
-          EMAIL_ADDRESS = :email_address
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
       class Psd2 < PreludeSDK::Internal::Type::BaseModel
         # @!attribute amount
         #   Decimal amount of the transaction.

data/lib/prelude_sdk/models/verification_create_params.rb

@@ -11,8 +11,8 @@ 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.
       #
-      #   @return [PreludeSDK::Models::VerificationCreateParams::Target]
-      required :target, -> { PreludeSDK::VerificationCreateParams::Target }
+      #   @return [PreludeSDK::Models::Target]
+      required :target, -> { PreludeSDK::Target }
 
       # @!attribute dispatch_id
       #   The identifier of the dispatch that came from the front-end SDK.
@@ -37,14 +37,14 @@ module PreludeSDK
       #   The signals used for anti-fraud. For more details, refer to
       #   [Signals](/verify/v2/documentation/prevent-fraud#signals).
       #
-      #   @return [PreludeSDK::Models::VerificationCreateParams::Signals, nil]
-      optional :signals, -> { PreludeSDK::VerificationCreateParams::Signals }
+      #   @return [PreludeSDK::Models::Signals, nil]
+      optional :signals, -> { PreludeSDK::Signals }
 
       # @!method initialize(target:, dispatch_id: nil, metadata: nil, options: nil, signals: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::VerificationCreateParams} for more details.
       #
-      #   @param target [PreludeSDK::Models::VerificationCreateParams::Target] The verification target. Either a phone number or an email address. To use the e
+      #   @param target [PreludeSDK::Models::Target] The verification target. Either a phone number or an email address. To use the e
       #
       #   @param dispatch_id [String] The identifier of the dispatch that came from the front-end SDK.
       #
@@ -52,45 +52,10 @@ module PreludeSDK
       #
       #   @param options [PreludeSDK::Models::VerificationCreateParams::Options] Verification options
       #
-      #   @param signals [PreludeSDK::Models::VerificationCreateParams::Signals] The signals used for anti-fraud. For more details, refer to [Signals](/verify/v2
+      #   @param signals [PreludeSDK::Models::Signals] The signals used for anti-fraud. For more details, refer to [Signals](/verify/v2
       #
       #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
 
-      class Target < PreludeSDK::Internal::Type::BaseModel
-        # @!attribute type
-        #   The type of the target. Either "phone_number" or "email_address".
-        #
-        #   @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Target::Type]
-        required :type, enum: -> { PreludeSDK::VerificationCreateParams::Target::Type }
-
-        # @!attribute value
-        #   An E.164 formatted phone number or an email address.
-        #
-        #   @return [String]
-        required :value, String
-
-        # @!method initialize(type:, 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.
-        #
-        #   @param type [Symbol, PreludeSDK::Models::VerificationCreateParams::Target::Type] The type of the target. Either "phone_number" or "email_address".
-        #
-        #   @param value [String] An E.164 formatted phone number or an email address.
-
-        # The type of the target. Either "phone_number" or "email_address".
-        #
-        # @see PreludeSDK::Models::VerificationCreateParams::Target#type
-        module Type
-          extend PreludeSDK::Internal::Type::Enum
-
-          PHONE_NUMBER = :phone_number
-          EMAIL_ADDRESS = :email_address
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
       class Metadata < PreludeSDK::Internal::Type::BaseModel
         # @!attribute correlation_id
         #   A user-defined identifier to correlate this verification with. It is returned in
@@ -377,114 +342,6 @@ module PreludeSDK
           #   @return [Array<Symbol>]
         end
       end
-
-      class Signals < PreludeSDK::Internal::Type::BaseModel
-        # @!attribute app_version
-        #   The version of your application.
-        #
-        #   @return [String, nil]
-        optional :app_version, String
-
-        # @!attribute device_id
-        #   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`.
-        #
-        #   @return [String, nil]
-        optional :device_id, String
-
-        # @!attribute device_model
-        #   The model of the user's device.
-        #
-        #   @return [String, nil]
-        optional :device_model, String
-
-        # @!attribute device_platform
-        #   The type of the user's device.
-        #
-        #   @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Signals::DevicePlatform, nil]
-        optional :device_platform, enum: -> { PreludeSDK::VerificationCreateParams::Signals::DevicePlatform }
-
-        # @!attribute ip
-        #   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.
-        #
-        #   @return [String, nil]
-        optional :ip, String
-
-        # @!attribute is_trusted_user
-        #   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).
-        #
-        #   @return [Boolean, nil]
-        optional :is_trusted_user, PreludeSDK::Internal::Type::Boolean
-
-        # @!attribute ja4_fingerprint
-        #   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.
-        #
-        #   @return [String, nil]
-        optional :ja4_fingerprint, String
-
-        # @!attribute os_version
-        #   The version of the user's device operating system.
-        #
-        #   @return [String, nil]
-        optional :os_version, String
-
-        # @!attribute user_agent
-        #   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.
-        #
-        #   @return [String, nil]
-        optional :user_agent, String
-
-        # @!method initialize(app_version: nil, device_id: nil, device_model: nil, device_platform: nil, ip: nil, is_trusted_user: nil, ja4_fingerprint: nil, os_version: nil, user_agent: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {PreludeSDK::Models::VerificationCreateParams::Signals} for more details.
-        #
-        #   The signals used for anti-fraud. For more details, refer to
-        #   [Signals](/verify/v2/documentation/prevent-fraud#signals).
-        #
-        #   @param app_version [String] The version of your application.
-        #
-        #   @param device_id [String] A unique ID for the user's device. You should ensure that each user device has a
-        #
-        #   @param device_model [String] The model of the user's device.
-        #
-        #   @param device_platform [Symbol, PreludeSDK::Models::VerificationCreateParams::Signals::DevicePlatform] The type of the user's device.
-        #
-        #   @param ip [String] The public IP v4 or v6 address of the end-user's device. You should collect this
-        #
-        #   @param is_trusted_user [Boolean] This signal should indicate a higher level of trust, explicitly stating that the
-        #
-        #   @param ja4_fingerprint [String] The JA4 fingerprint observed for the end-user's connection. Prelude will infer i
-        #
-        #   @param os_version [String] The version of the user's device operating system.
-        #
-        #   @param user_agent [String] The user agent of the user's device. If the individual fields (os_version, devic
-
-        # The type of the user's device.
-        #
-        # @see PreludeSDK::Models::VerificationCreateParams::Signals#device_platform
-        module DevicePlatform
-          extend PreludeSDK::Internal::Type::Enum
-
-          ANDROID = :android
-          IOS = :ios
-          IPADOS = :ipados
-          TVOS = :tvos
-          WEB = :web
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
     end
   end
 end

data/lib/prelude_sdk/models/verification_management/sandbox_add_phone_number_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    module VerificationManagement
+      # @see PreludeSDK::Resources::VerificationManagement::Sandbox#add_phone_number
+      class SandboxAddPhoneNumberParams < PreludeSDK::Internal::Type::BaseModel
+        extend PreludeSDK::Internal::Type::RequestParameters::Converter
+        include PreludeSDK::Internal::Type::RequestParameters
+
+        # @!attribute attempt_code
+        #   The fixed attempt code that will validate verification attempts for this phone
+        #   number.
+        #
+        #   @return [String]
+        required :attempt_code, String
+
+        # @!attribute phone_number
+        #   An E.164 formatted phone number to add to the sandbox list.
+        #
+        #   @return [String]
+        required :phone_number, String
+
+        # @!method initialize(attempt_code:, phone_number:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::VerificationManagement::SandboxAddPhoneNumberParams} for
+        #   more details.
+        #
+        #   @param attempt_code [String] The fixed attempt code that will validate verification attempts for this phone n
+        #
+        #   @param phone_number [String] An E.164 formatted phone number to add to the sandbox list.
+        #
+        #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/verification_management/sandbox_add_phone_number_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    module VerificationManagement
+      # @see PreludeSDK::Resources::VerificationManagement::Sandbox#add_phone_number
+      class SandboxAddPhoneNumberResponse < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute attempt_code
+        #   The fixed attempt code associated with the sandbox phone number.
+        #
+        #   @return [String]
+        required :attempt_code, String
+
+        # @!attribute phone_number
+        #   The E.164 formatted phone number that was added to the sandbox list.
+        #
+        #   @return [String]
+        required :phone_number, String
+
+        # @!method initialize(attempt_code:, phone_number:)
+        #   @param attempt_code [String] The fixed attempt code associated with the sandbox phone number.
+        #
+        #   @param phone_number [String] The E.164 formatted phone number that was added to the sandbox list.
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/verification_management/sandbox_delete_phone_number_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    module VerificationManagement
+      # @see PreludeSDK::Resources::VerificationManagement::Sandbox#delete_phone_number
+      class SandboxDeletePhoneNumberParams < PreludeSDK::Internal::Type::BaseModel
+        extend PreludeSDK::Internal::Type::RequestParameters::Converter
+        include PreludeSDK::Internal::Type::RequestParameters
+
+        # @!attribute phone_number
+        #
+        #   @return [String]
+        required :phone_number, String
+
+        # @!method initialize(phone_number:, request_options: {})
+        #   @param phone_number [String]
+        #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/verification_management/sandbox_delete_phone_number_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    module VerificationManagement
+      # @see PreludeSDK::Resources::VerificationManagement::Sandbox#delete_phone_number
+      class SandboxDeletePhoneNumberResponse < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute phone_number
+        #   The E.164 formatted phone number that was removed from the sandbox list.
+        #
+        #   @return [String]
+        required :phone_number, String
+
+        # @!method initialize(phone_number:)
+        #   @param phone_number [String] The E.164 formatted phone number that was removed from the sandbox list.
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/verification_management/sandbox_list_phone_numbers_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    module VerificationManagement
+      # @see PreludeSDK::Resources::VerificationManagement::Sandbox#list_phone_numbers
+      class SandboxListPhoneNumbersParams < PreludeSDK::Internal::Type::BaseModel
+        extend PreludeSDK::Internal::Type::RequestParameters::Converter
+        include PreludeSDK::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/verification_management/sandbox_list_phone_numbers_response.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    module VerificationManagement
+      # @see PreludeSDK::Resources::VerificationManagement::Sandbox#list_phone_numbers
+      class SandboxListPhoneNumbersResponse < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute phone_numbers
+        #   A list of sandbox phone numbers.
+        #
+        #   @return [Array<PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersResponse::PhoneNumber>]
+        required :phone_numbers,
+                 -> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersResponse::PhoneNumber] }
+
+        # @!method initialize(phone_numbers:)
+        #   @param phone_numbers [Array<PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersResponse::PhoneNumber>] A list of sandbox phone numbers.
+
+        class PhoneNumber < PreludeSDK::Internal::Type::BaseModel
+          # @!attribute attempt_code
+          #   The fixed attempt code associated with the sandbox phone number.
+          #
+          #   @return [String]
+          required :attempt_code, String
+
+          # @!attribute created_at
+          #   The date and time when the phone number was added to the sandbox list.
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute phone_number
+          #   An E.164 formatted phone number.
+          #
+          #   @return [String]
+          required :phone_number, String
+
+          # @!method initialize(attempt_code:, created_at:, phone_number:)
+          #   @param attempt_code [String] The fixed attempt code associated with the sandbox phone number.
+          #
+          #   @param created_at [Time] The date and time when the phone number was added to the sandbox list.
+          #
+          #   @param phone_number [String] An E.164 formatted phone number.
+        end
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/watch_evaluate_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Watch#evaluate
+    class WatchEvaluateParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      # @!attribute flow_id
+      #   The flow to evaluate. A flow names the moment you are guarding and selects the
+      #   recipes that run.
+      #
+      #   @return [String]
+      required :flow_id, String
+
+      # @!attribute target
+      #   The identifier to score — a phone number or email address.
+      #
+      #   @return [PreludeSDK::Models::Target]
+      required :target, -> { PreludeSDK::Target }
+
+      # @!attribute attributes
+      #   Values for the attributes the flow's recipes declare, keyed without the `attr.`
+      #   namespace a rule uses to reference them.
+      #
+      #   An attribute a recipe declares and this request omits is treated as missing
+      #   evidence, not as an empty value: the rules reading it report `NOT_EVALUATED`
+      #   rather than being scored as though the condition were false. A key no recipe in
+      #   the flow declares is ignored rather than rejected, so one payload can serve
+      #   flows that read different attributes.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :attributes, PreludeSDK::Internal::Type::HashOf[String]
+
+      # @!attribute dispatch_id
+      #   The identifier of the dispatch that came from the front-end SDK. Signals it
+      #   carries fill in anything the request did not state; the request wins where both
+      #   supply a value.
+      #
+      #   @return [String, nil]
+      optional :dispatch_id, String
+
+      # @!attribute signals
+      #   The signals used for anti-fraud. For more details, refer to
+      #   [Signals](/verify/v2/documentation/prevent-fraud#signals).
+      #
+      #   @return [PreludeSDK::Models::Signals, nil]
+      optional :signals, -> { PreludeSDK::Signals }
+
+      # @!method initialize(flow_id:, target:, attributes: nil, dispatch_id: nil, signals: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::WatchEvaluateParams} for more details.
+      #
+      #   @param flow_id [String] The flow to evaluate. A flow names the moment you are guarding and selects the r
+      #
+      #   @param target [PreludeSDK::Models::Target] The identifier to score — a phone number or email address.
+      #
+      #   @param attributes [Hash{Symbol=>String}] Values for the attributes the flow's recipes declare, keyed without the `attr.`
+      #
+      #   @param dispatch_id [String] The identifier of the dispatch that came from the front-end SDK. Signals it carr
+      #
+      #   @param signals [PreludeSDK::Models::Signals] The signals used for anti-fraud. For more details, refer to [Signals](/verify/v2
+      #
+      #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end