prelude-sdk 0.7.0 → 0.9.0

data/rbi/prelude_sdk/resources/watch.rbi

@@ -4,6 +4,53 @@ module PreludeSDK
   module Resources
     # Evaluate email addresses and phone numbers for trustworthiness.
     class Watch
+      # **Beta.** The request and response shapes may still change. Talk to us before
+      # you build against it. Flows, recipes and rules are authored through the Watch
+      # Management API, or configured by Prelude on your behalf.
+      #
+      # Score a target against the rules configured for one moment in your product —
+      # signup, checkout, password reset. The flow selects which recipes run; each
+      # recipe scores its rules against a threshold and returns its own verdict, and the
+      # evaluation answers with the most severe verdict and action across them. Where
+      # Predict returns a single model-derived outcome, Eval returns the full breakdown,
+      # so you can see which rules fired and which could not run. Scoring-only — it does
+      # not update counters by itself.
+      sig do
+        params(
+          flow_id: String,
+          target: PreludeSDK::Target::OrHash,
+          attributes: T::Hash[Symbol, String],
+          dispatch_id: String,
+          signals: PreludeSDK::Signals::OrHash,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(PreludeSDK::Models::WatchEvaluateResponse)
+      end
+      def evaluate(
+        # The flow to evaluate. A flow names the moment you are guarding and selects the
+        # recipes that run.
+        flow_id:,
+        # The identifier to score — a phone number or email address.
+        target:,
+        # 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.
+        attributes: nil,
+        # 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.
+        dispatch_id: nil,
+        # The signals used for anti-fraud. For more details, refer to
+        # [Signals](/verify/v2/documentation/prevent-fraud#signals).
+        signals: nil,
+        request_options: {}
+      )
+      end
+
       # At signup, score the user's phone number or email address (target) as legitimate
       # or suspicious. Scoring-only — does not update counters by itself. When using
       # Feedback, call predict before verification.started on the same target (and
@@ -12,10 +59,10 @@ module PreludeSDK
       # verification funnel outside Prelude Verify.
       sig do
         params(
-          target: PreludeSDK::WatchPredictParams::Target::OrHash,
+          target: PreludeSDK::Target::OrHash,
           dispatch_id: String,
           metadata: PreludeSDK::WatchPredictParams::Metadata::OrHash,
-          signals: PreludeSDK::WatchPredictParams::Signals::OrHash,
+          signals: PreludeSDK::Signals::OrHash,
           request_options: PreludeSDK::RequestOptions::OrHash
         ).returns(PreludeSDK::Models::WatchPredictResponse)
       end

data/sig/prelude_sdk/client.rbs

@@ -22,6 +22,8 @@ module PreludeSDK
 
     attr_reader watch: PreludeSDK::Resources::Watch
 
+    attr_reader intel: PreludeSDK::Resources::Intel
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/prelude_sdk/models/intel/kyc_match_params.rbs

@@ -0,0 +1,91 @@
+module PreludeSDK
+  module Models
+    module Intel
+      type kyc_match_params =
+        {
+          phone: String,
+          address: String,
+          birthdate: Date,
+          country: String,
+          email: String,
+          family_name: String,
+          given_name: String,
+          locality: String,
+          postal_code: String,
+          region: String
+        }
+        & PreludeSDK::Internal::Type::request_parameters
+
+      class KYCMatchParams < PreludeSDK::Internal::Type::BaseModel
+        extend PreludeSDK::Internal::Type::RequestParameters::Converter
+        include PreludeSDK::Internal::Type::RequestParameters
+
+        attr_accessor phone: String
+
+        attr_reader address: String?
+
+        def address=: (String) -> String
+
+        attr_reader birthdate: Date?
+
+        def birthdate=: (Date) -> Date
+
+        attr_reader country: String?
+
+        def country=: (String) -> String
+
+        attr_reader email: String?
+
+        def email=: (String) -> String
+
+        attr_reader family_name: String?
+
+        def family_name=: (String) -> String
+
+        attr_reader given_name: String?
+
+        def given_name=: (String) -> String
+
+        attr_reader locality: String?
+
+        def locality=: (String) -> String
+
+        attr_reader postal_code: String?
+
+        def postal_code=: (String) -> String
+
+        attr_reader region: String?
+
+        def region=: (String) -> String
+
+        def initialize: (
+          phone: String,
+          ?address: String,
+          ?birthdate: Date,
+          ?country: String,
+          ?email: String,
+          ?family_name: String,
+          ?given_name: String,
+          ?locality: String,
+          ?postal_code: String,
+          ?region: String,
+          ?request_options: PreludeSDK::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          phone: String,
+          address: String,
+          birthdate: Date,
+          country: String,
+          email: String,
+          family_name: String,
+          given_name: String,
+          locality: String,
+          postal_code: String,
+          region: String,
+          request_options: PreludeSDK::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/prelude_sdk/models/intel/kyc_match_response.rbs

@@ -0,0 +1,276 @@
+module PreludeSDK
+  module Models
+    module Intel
+      type kyc_match_response =
+        {
+          address_match: PreludeSDK::Models::Intel::KYCMatchResponse::address_match,
+          address_match_score: Integer,
+          birthdate_match: PreludeSDK::Models::Intel::KYCMatchResponse::birthdate_match,
+          country_code: String,
+          country_match: PreludeSDK::Models::Intel::KYCMatchResponse::country_match,
+          email_match: PreludeSDK::Models::Intel::KYCMatchResponse::email_match,
+          email_match_score: Integer,
+          family_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::family_name_match,
+          family_name_match_score: Integer,
+          given_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::given_name_match,
+          given_name_match_score: Integer,
+          locality_match: PreludeSDK::Models::Intel::KYCMatchResponse::locality_match,
+          locality_match_score: Integer,
+          operator: String,
+          phone_number: String,
+          postal_code_match: PreludeSDK::Models::Intel::KYCMatchResponse::postal_code_match,
+          region_match: PreludeSDK::Models::Intel::KYCMatchResponse::region_match,
+          region_match_score: Integer,
+          request_id: String
+        }
+
+      class KYCMatchResponse < PreludeSDK::Internal::Type::BaseModel
+        attr_reader address_match: PreludeSDK::Models::Intel::KYCMatchResponse::address_match?
+
+        def address_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::address_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::address_match
+
+        attr_reader address_match_score: Integer?
+
+        def address_match_score=: (Integer) -> Integer
+
+        attr_reader birthdate_match: PreludeSDK::Models::Intel::KYCMatchResponse::birthdate_match?
+
+        def birthdate_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::birthdate_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::birthdate_match
+
+        attr_reader country_code: String?
+
+        def country_code=: (String) -> String
+
+        attr_reader country_match: PreludeSDK::Models::Intel::KYCMatchResponse::country_match?
+
+        def country_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::country_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::country_match
+
+        attr_reader email_match: PreludeSDK::Models::Intel::KYCMatchResponse::email_match?
+
+        def email_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::email_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::email_match
+
+        attr_reader email_match_score: Integer?
+
+        def email_match_score=: (Integer) -> Integer
+
+        attr_reader family_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::family_name_match?
+
+        def family_name_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::family_name_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::family_name_match
+
+        attr_reader family_name_match_score: Integer?
+
+        def family_name_match_score=: (Integer) -> Integer
+
+        attr_reader given_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::given_name_match?
+
+        def given_name_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::given_name_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::given_name_match
+
+        attr_reader given_name_match_score: Integer?
+
+        def given_name_match_score=: (Integer) -> Integer
+
+        attr_reader locality_match: PreludeSDK::Models::Intel::KYCMatchResponse::locality_match?
+
+        def locality_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::locality_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::locality_match
+
+        attr_reader locality_match_score: Integer?
+
+        def locality_match_score=: (Integer) -> Integer
+
+        attr_reader operator: String?
+
+        def operator=: (String) -> String
+
+        attr_reader phone_number: String?
+
+        def phone_number=: (String) -> String
+
+        attr_reader postal_code_match: PreludeSDK::Models::Intel::KYCMatchResponse::postal_code_match?
+
+        def postal_code_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::postal_code_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::postal_code_match
+
+        attr_reader region_match: PreludeSDK::Models::Intel::KYCMatchResponse::region_match?
+
+        def region_match=: (
+          PreludeSDK::Models::Intel::KYCMatchResponse::region_match
+        ) -> PreludeSDK::Models::Intel::KYCMatchResponse::region_match
+
+        attr_reader region_match_score: Integer?
+
+        def region_match_score=: (Integer) -> Integer
+
+        attr_reader request_id: String?
+
+        def request_id=: (String) -> String
+
+        def initialize: (
+          ?address_match: PreludeSDK::Models::Intel::KYCMatchResponse::address_match,
+          ?address_match_score: Integer,
+          ?birthdate_match: PreludeSDK::Models::Intel::KYCMatchResponse::birthdate_match,
+          ?country_code: String,
+          ?country_match: PreludeSDK::Models::Intel::KYCMatchResponse::country_match,
+          ?email_match: PreludeSDK::Models::Intel::KYCMatchResponse::email_match,
+          ?email_match_score: Integer,
+          ?family_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::family_name_match,
+          ?family_name_match_score: Integer,
+          ?given_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::given_name_match,
+          ?given_name_match_score: Integer,
+          ?locality_match: PreludeSDK::Models::Intel::KYCMatchResponse::locality_match,
+          ?locality_match_score: Integer,
+          ?operator: String,
+          ?phone_number: String,
+          ?postal_code_match: PreludeSDK::Models::Intel::KYCMatchResponse::postal_code_match,
+          ?region_match: PreludeSDK::Models::Intel::KYCMatchResponse::region_match,
+          ?region_match_score: Integer,
+          ?request_id: String
+        ) -> void
+
+        def to_hash: -> {
+          address_match: PreludeSDK::Models::Intel::KYCMatchResponse::address_match,
+          address_match_score: Integer,
+          birthdate_match: PreludeSDK::Models::Intel::KYCMatchResponse::birthdate_match,
+          country_code: String,
+          country_match: PreludeSDK::Models::Intel::KYCMatchResponse::country_match,
+          email_match: PreludeSDK::Models::Intel::KYCMatchResponse::email_match,
+          email_match_score: Integer,
+          family_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::family_name_match,
+          family_name_match_score: Integer,
+          given_name_match: PreludeSDK::Models::Intel::KYCMatchResponse::given_name_match,
+          given_name_match_score: Integer,
+          locality_match: PreludeSDK::Models::Intel::KYCMatchResponse::locality_match,
+          locality_match_score: Integer,
+          operator: String,
+          phone_number: String,
+          postal_code_match: PreludeSDK::Models::Intel::KYCMatchResponse::postal_code_match,
+          region_match: PreludeSDK::Models::Intel::KYCMatchResponse::region_match,
+          region_match_score: Integer,
+          request_id: String
+        }
+
+        type address_match = :true | :false | :not_available
+
+        module AddressMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::address_match]
+        end
+
+        type birthdate_match = :true | :false | :not_available
+
+        module BirthdateMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::birthdate_match]
+        end
+
+        type country_match = :true | :false | :not_available
+
+        module CountryMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::country_match]
+        end
+
+        type email_match = :true | :false | :not_available
+
+        module EmailMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::email_match]
+        end
+
+        type family_name_match = :true | :false | :not_available
+
+        module FamilyNameMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::family_name_match]
+        end
+
+        type given_name_match = :true | :false | :not_available
+
+        module GivenNameMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::given_name_match]
+        end
+
+        type locality_match = :true | :false | :not_available
+
+        module LocalityMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::locality_match]
+        end
+
+        type postal_code_match = :true | :false | :not_available
+
+        module PostalCodeMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::postal_code_match]
+        end
+
+        type region_match = :true | :false | :not_available
+
+        module RegionMatch
+          extend PreludeSDK::Internal::Type::Enum
+
+          TRUE: :true
+          FALSE: :false
+          NOT_AVAILABLE: :not_available
+
+          def self?.values: -> ::Array[PreludeSDK::Models::Intel::KYCMatchResponse::region_match]
+        end
+      end
+    end
+  end
+end

data/sig/prelude_sdk/models/notify_reply_params.rbs

@@ -0,0 +1,50 @@
+module PreludeSDK
+  module Models
+    type notify_reply_params =
+      {
+        reply_to: String,
+        text: String,
+        to: String,
+        callback_url: String,
+        correlation_id: String
+      }
+      & PreludeSDK::Internal::Type::request_parameters
+
+    class NotifyReplyParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      attr_accessor reply_to: String
+
+      attr_accessor text: String
+
+      attr_accessor to: String
+
+      attr_reader callback_url: String?
+
+      def callback_url=: (String) -> String
+
+      attr_reader correlation_id: String?
+
+      def correlation_id=: (String) -> String
+
+      def initialize: (
+        reply_to: String,
+        text: String,
+        to: String,
+        ?callback_url: String,
+        ?correlation_id: String,
+        ?request_options: PreludeSDK::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        reply_to: String,
+        text: String,
+        to: String,
+        callback_url: String,
+        correlation_id: String,
+        request_options: PreludeSDK::RequestOptions
+      }
+    end
+  end
+end

data/sig/prelude_sdk/models/notify_reply_response.rbs

@@ -0,0 +1,54 @@
+module PreludeSDK
+  module Models
+    type notify_reply_response =
+      {
+        id: String,
+        created_at: Time,
+        reply_to: String,
+        text: String,
+        to: String,
+        callback_url: String,
+        correlation_id: String
+      }
+
+    class NotifyReplyResponse < PreludeSDK::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor reply_to: String
+
+      attr_accessor text: String
+
+      attr_accessor to: String
+
+      attr_reader callback_url: String?
+
+      def callback_url=: (String) -> String
+
+      attr_reader correlation_id: String?
+
+      def correlation_id=: (String) -> String
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        reply_to: String,
+        text: String,
+        to: String,
+        ?callback_url: String,
+        ?correlation_id: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        reply_to: String,
+        text: String,
+        to: String,
+        callback_url: String,
+        correlation_id: String
+      }
+    end
+  end
+end

data/sig/prelude_sdk/models/signals.rbs

@@ -0,0 +1,101 @@
+module PreludeSDK
+  module Models
+    type signals =
+      {
+        app_version: String,
+        device_id: String,
+        device_model: String,
+        device_platform: PreludeSDK::Models::Signals::device_platform,
+        existing_user: bool,
+        ip: String,
+        is_trusted_user: bool,
+        :ja4_fingerprint => String,
+        os_version: String,
+        user_agent: String
+      }
+
+    class Signals < PreludeSDK::Internal::Type::BaseModel
+      attr_reader app_version: String?
+
+      def app_version=: (String) -> String
+
+      attr_reader device_id: String?
+
+      def device_id=: (String) -> String
+
+      attr_reader device_model: String?
+
+      def device_model=: (String) -> String
+
+      attr_reader device_platform: PreludeSDK::Models::Signals::device_platform?
+
+      def device_platform=: (
+        PreludeSDK::Models::Signals::device_platform
+      ) -> PreludeSDK::Models::Signals::device_platform
+
+      attr_reader existing_user: bool?
+
+      def existing_user=: (bool) -> bool
+
+      attr_reader ip: String?
+
+      def ip=: (String) -> String
+
+      attr_reader is_trusted_user: bool?
+
+      def is_trusted_user=: (bool) -> bool
+
+      attr_reader ja4_fingerprint: String?
+
+      def ja4_fingerprint=: (String) -> String
+
+      attr_reader os_version: String?
+
+      def os_version=: (String) -> String
+
+      attr_reader user_agent: String?
+
+      def user_agent=: (String) -> String
+
+      def initialize: (
+        ?app_version: String,
+        ?device_id: String,
+        ?device_model: String,
+        ?device_platform: PreludeSDK::Models::Signals::device_platform,
+        ?existing_user: bool,
+        ?ip: String,
+        ?is_trusted_user: bool,
+        ?ja4_fingerprint: String,
+        ?os_version: String,
+        ?user_agent: String
+      ) -> void
+
+      def to_hash: -> {
+        app_version: String,
+        device_id: String,
+        device_model: String,
+        device_platform: PreludeSDK::Models::Signals::device_platform,
+        existing_user: bool,
+        ip: String,
+        is_trusted_user: bool,
+        :ja4_fingerprint => String,
+        os_version: String,
+        user_agent: String
+      }
+
+      type device_platform = :android | :ios | :ipados | :tvos | :web
+
+      module DevicePlatform
+        extend PreludeSDK::Internal::Type::Enum
+
+        ANDROID: :android
+        IOS: :ios
+        IPADOS: :ipados
+        TVOS: :tvos
+        WEB: :web
+
+        def self?.values: -> ::Array[PreludeSDK::Models::Signals::device_platform]
+      end
+    end
+  end
+end

data/sig/prelude_sdk/models/target.rbs

@@ -0,0 +1,29 @@
+module PreludeSDK
+  module Models
+    type target = { type: PreludeSDK::Models::Target::type_, value: String }
+
+    class Target < PreludeSDK::Internal::Type::BaseModel
+      attr_accessor type: PreludeSDK::Models::Target::type_
+
+      attr_accessor value: String
+
+      def initialize: (
+        type: PreludeSDK::Models::Target::type_,
+        value: String
+      ) -> void
+
+      def to_hash: -> { type: PreludeSDK::Models::Target::type_, value: String }
+
+      type type_ = :phone_number | :email_address
+
+      module Type
+        extend PreludeSDK::Internal::Type::Enum
+
+        PHONE_NUMBER: :phone_number
+        EMAIL_ADDRESS: :email_address
+
+        def self?.values: -> ::Array[PreludeSDK::Models::Target::type_]
+      end
+    end
+  end
+end