prelude-sdk 0.6.0 → 0.8.0

data/rbi/prelude_sdk/resources/intel/kyc.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module PreludeSDK
+  module Resources
+    class Intel
+      # Retrieve detailed information about a phone number including carrier data, line
+      # type, and portability status.
+      class KYC
+        # Verify identity attributes against the subscriber record held by the end-user's
+        # mobile operator. Send a phone number along with the attributes to check; Prelude
+        # resolves the operator internally and returns a per-attribute match. Currently
+        # available for France only (Orange, SFR, Bouygues) and must be enabled for your
+        # account.
+        sig do
+          params(
+            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::OrHash
+          ).returns(PreludeSDK::Models::Intel::KYCMatchResponse)
+        end
+        def match(
+          # An E.164 formatted phone number whose subscriber identity to match against.
+          phone,
+          # The street address.
+          address: nil,
+          # The date of birth in ISO 8601 (`YYYY-MM-DD`) format. Compared exactly.
+          birthdate: nil,
+          # The ISO 3166-1 alpha-2 country code. Compared exactly.
+          country: nil,
+          # The email address.
+          email: nil,
+          # The end-user's family (last) name.
+          family_name: nil,
+          # The end-user's given (first) name.
+          given_name: nil,
+          # The locality (city).
+          locality: nil,
+          # The postal code. Compared exactly.
+          postal_code: nil,
+          # The region, state, or province.
+          region: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: PreludeSDK::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/resources/intel.rbi

@@ -0,0 +1,17 @@
+# typed: strong
+
+module PreludeSDK
+  module Resources
+    class Intel
+      # Retrieve detailed information about a phone number including carrier data, line
+      # type, and portability status.
+      sig { returns(PreludeSDK::Resources::Intel::KYC) }
+      attr_reader :kyc
+
+      # @api private
+      sig { params(client: PreludeSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/resources/notify.rbi

@@ -5,6 +5,8 @@ module PreludeSDK
     # Send transactional and marketing messages with compliance enforcement.
     class Notify
       # Retrieve a specific subscription management configuration by its ID.
+      #
+      # In order to get access to this endpoint, contact our support team.
       sig do
         params(
           config_id: String,
@@ -20,6 +22,8 @@ module PreludeSDK
 
       # Retrieve the current subscription status for a specific phone number within a
       # subscription configuration.
+      #
+      # In order to get access to this endpoint, contact our support team.
       sig do
         params(
           phone_number: String,
@@ -41,6 +45,8 @@ module PreludeSDK
       #
       # Each configuration represents a subscription management setup with phone numbers
       # for receiving opt-out/opt-in requests and a callback URL for webhook events.
+      #
+      # In order to get access to this endpoint, contact our support team.
       sig do
         params(
           cursor: String,
@@ -61,6 +67,8 @@ module PreludeSDK
       # phone number within a subscription configuration.
       #
       # Events are ordered by timestamp in descending order (most recent first).
+      #
+      # In order to get access to this endpoint, contact our support team.
       sig do
         params(
           phone_number: String,
@@ -89,6 +97,8 @@ module PreludeSDK
       # specific subscription configuration.
       #
       # You can optionally filter by subscription state (SUB or UNSUB).
+      #
+      # In order to get access to this endpoint, contact our support team.
       sig do
         params(
           config_id: String,
@@ -114,6 +124,37 @@ module PreludeSDK
       )
       end
 
+      # Send a free-form text reply to an inbound WhatsApp message within the 24-hour
+      # conversation window. See
+      # [WhatsApp 2-Way Messaging](/notify/v2/documentation/whatsapp) for details.
+      sig do
+        params(
+          reply_to: String,
+          text: String,
+          to: String,
+          callback_url: String,
+          correlation_id: String,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(PreludeSDK::Models::NotifyReplyResponse)
+      end
+      def reply(
+        # The inbound message ID (prefixed with `im_`) to reply to. This ID is provided in
+        # the `inbound.message.received` webhook event.
+        reply_to:,
+        # The reply message body sent as a free-form WhatsApp text.
+        text:,
+        # The recipient's phone number in E.164 format. Must match the phone number that
+        # sent the original inbound message.
+        to:,
+        # The URL where webhooks will be sent for delivery events of this reply.
+        callback_url: nil,
+        # A user-defined identifier to correlate this reply with your internal systems. It
+        # is returned in the response and any webhook events that refer to this message.
+        correlation_id: nil,
+        request_options: {}
+      )
+      end
+
       # Send transactional and marketing messages to your users via SMS, RCS and
       # WhatsApp with automatic compliance enforcement.
       sig do

data/rbi/prelude_sdk/resources/verification/phone/history.rbi

@@ -0,0 +1,112 @@
+# typed: strong
+
+module PreludeSDK
+  module Resources
+    class Verification
+      class Phone
+        # Verify phone numbers.
+        class History
+          # Retrieve everything Prelude recorded for one phone verification: its outcome and
+          # the device, network and anti-fraud context it was created in, the chronological
+          # timeline of every message attempt and code check, and the anti-fraud signals you
+          # forwarded.
+          #
+          # The identifier is the `id` returned by
+          # [Create or retry a verification](/verify/v2/api-reference/create-or-retry-a-verification)
+          # or the `verification_id` of the verification webhooks. Both `lifecycle` and
+          # `signals` are optional: a verification can resolve with its top-level fields
+          # alone.
+          sig do
+            params(
+              id: String,
+              request_options: PreludeSDK::RequestOptions::OrHash
+            ).returns(
+              PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse
+            )
+          end
+          def retrieve(
+            # The verification identifier.
+            id,
+            request_options: {}
+          )
+          end
+
+          # List your phone verifications, most recent first, one entry per verification
+          # with its outcome, channels, attempts and cost. Every filter is optional and they
+          # combine with AND.
+          #
+          # Use it to find every verification a phone number went through from your support
+          # tooling, then
+          # [Get a phone verification](/verify/v2/api-reference/history/get-a-phone-verification)
+          # for the full timeline of one of them. A cursor is bound to the filters that
+          # produced it: pass `next_cursor` back with the exact same query parameters.
+          sig do
+            params(
+              channels:
+                T::Array[
+                  PreludeSDK::Verification::Phone::HistoryListParams::Channel::OrSymbol
+                ],
+              cursor: String,
+              device_platform:
+                PreludeSDK::Verification::Phone::HistoryListParams::DevicePlatform::OrSymbol,
+              from: Time,
+              limit: Integer,
+              max_attempts: Integer,
+              min_attempts: Integer,
+              phone_number: String,
+              region: String,
+              status:
+                PreludeSDK::Verification::Phone::HistoryListParams::Status::OrSymbol,
+              template_id: String,
+              to: Time,
+              request_options: PreludeSDK::RequestOptions::OrHash
+            ).returns(
+              PreludeSDK::Models::Verification::Phone::HistoryListResponse
+            )
+          end
+          def list(
+            # Only verifications that could use one of these channels. Repeat the parameter
+            # for several values.
+            channels: nil,
+            # Pagination cursor from the previous response.
+            cursor: nil,
+            # Only verifications created from this device platform.
+            device_platform: nil,
+            # Only verifications created at or after this RFC 3339 timestamp. Goes with `to`,
+            # at most 6 months apart. Without them the whole history is searched.
+            from: nil,
+            # Maximum number of verifications to return per page.
+            limit: nil,
+            # Only verifications that sent at most this many messages. `0` keeps the
+            # verifications that never sent one.
+            max_attempts: nil,
+            # Only verifications that sent at least this many messages.
+            min_attempts: nil,
+            # Only verifications targeting this E.164 phone number. The leading `+` may be
+            # omitted.
+            phone_number: nil,
+            # Only verifications of phone numbers from this region, as an ISO 3166-1 alpha-2
+            # code.
+            region: nil,
+            # Only verifications in this status. `pending_check` cannot be filtered on.
+            status: nil,
+            # Only verifications sent with this template, as returned in `template_id` by
+            # [Get a phone verification](/verify/v2/api-reference/history/get-a-phone-verification).
+            # Built-in templates (`prelude:*`) cannot be filtered on.
+            template_id: nil,
+            # Only verifications created at or before this RFC 3339 timestamp. Goes with
+            # `from`.
+            to: nil,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: PreludeSDK::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/resources/verification/phone.rbi

@@ -0,0 +1,18 @@
+# typed: strong
+
+module PreludeSDK
+  module Resources
+    class Verification
+      class Phone
+        # Verify phone numbers.
+        sig { returns(PreludeSDK::Resources::Verification::Phone::History) }
+        attr_reader :history
+
+        # @api private
+        sig { params(client: PreludeSDK::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/resources/verification.rbi

@@ -4,16 +4,19 @@ module PreludeSDK
   module Resources
     # Verify phone numbers.
     class Verification
+      sig { returns(PreludeSDK::Resources::Verification::Phone) }
+      attr_reader :phone
+
       # Create a new verification for a specific phone number. If another non-expired
       # verification exists (the request is performed within the verification window),
       # this endpoint will perform a retry instead.
       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(PreludeSDK::Models::VerificationCreateResponse)
       end
@@ -39,7 +42,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(PreludeSDK::Models::VerificationCheckResponse)

data/rbi/prelude_sdk/resources/verification_management/sandbox.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module PreludeSDK
+  module Resources
+    class VerificationManagement
+      # Verify phone numbers.
+      class Sandbox
+        # Register a phone number as a sandbox number and associate it with a fixed
+        # attempt code. Subsequent verification attempts against this number will not
+        # trigger a real SMS/call and will validate against the configured attempt code.
+        #
+        # This operation is idempotent - re-adding the same phone number will overwrite
+        # the existing attempt code.
+        #
+        # In order to get access to this endpoint, contact our support team.
+        sig do
+          params(
+            attempt_code: String,
+            phone_number: String,
+            request_options: PreludeSDK::RequestOptions::OrHash
+          ).returns(
+            PreludeSDK::Models::VerificationManagement::SandboxAddPhoneNumberResponse
+          )
+        end
+        def add_phone_number(
+          # 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
+
+        # Remove a phone number from the sandbox list.
+        #
+        # This operation is idempotent - deleting a phone number that is not in the
+        # sandbox list will succeed without making any changes.
+        #
+        # In order to get access to this endpoint, contact our support team.
+        sig do
+          params(
+            phone_number: String,
+            request_options: PreludeSDK::RequestOptions::OrHash
+          ).returns(
+            PreludeSDK::Models::VerificationManagement::SandboxDeletePhoneNumberResponse
+          )
+        end
+        def delete_phone_number(
+          # The E.164 formatted phone number to remove from the sandbox list.
+          phone_number,
+          request_options: {}
+        )
+        end
+
+        # Retrieve the list of sandbox phone numbers for the account. Sandbox numbers are
+        # test numbers that bypass the real verification flow and return a fixed attempt
+        # code.
+        #
+        # In order to get access to this endpoint, contact our support team.
+        sig do
+          params(request_options: PreludeSDK::RequestOptions::OrHash).returns(
+            PreludeSDK::Models::VerificationManagement::SandboxListPhoneNumbersResponse
+          )
+        end
+        def list_phone_numbers(request_options: {})
+        end
+
+        # @api private
+        sig { params(client: PreludeSDK::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/resources/verification_management.rbi

@@ -4,6 +4,10 @@ module PreludeSDK
   module Resources
     # Verify phone numbers.
     class VerificationManagement
+      # Verify phone numbers.
+      sig { returns(PreludeSDK::Resources::VerificationManagement::Sandbox) }
+      attr_reader :sandbox
+
       # Remove a phone number from the allow or block list.
       #
       # This operation is idempotent - re-deleting the same phone number will not result

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, and flows and
+      # recipes are configured by Prelude on your behalf for now. Talk to us before you
+      # build against it.
+      #
+      # 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