prelude-sdk 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc907faf5181de68a78b810ea7e8f112b9487a1509787ade20ee24a89ebb1e47
-  data.tar.gz: 72ee64f891262d8b42dbf743563acf09d649090ac5b0e5b4a651ab3250228952
+  metadata.gz: 5c0ab52c77ef4b4adef294278608b900e799d87addb9838aa9d0f1b670cba4e3
+  data.tar.gz: 44b544a684b17f92a020198981d31f6013a43cc7d73b47c475f680529e332adb
 SHA512:
-  metadata.gz: 92d9f3a4bc299dc75db670d6be40eeeadd34e2ee1d19c82197ea7217f05e3fed75f279a3e13f209dbfd129d190794d9a53f6cef584e32fa90e97fd30abfe06ee
-  data.tar.gz: 360197b7fafbed000c76dc07e8b21dc81c8f46e869c193298da0ad51b71930ad6bb1ea5585f1d0570a1c3d2fd88c0a68984f54cacf6630a1c78a656465b632d5
+  metadata.gz: 73d77009ae1589ec192685756e1ab08475f561447e281ff9ce16104be9c64bd16dc8658a9563d10c8fff0d8bf1ebf48756c2545125ba6e7f2c65ba59f020514d
+  data.tar.gz: 97b509de3dbc882b0ba62e84e19d7aaf4a17219a9d689d6e3fa309d07685969e92ce049326640c9f06f2038e1f8e5d90433955e5e9f5e3dd0d75cc779253e381

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.7.0 (2026-09-15)
+
+Full Changelog: [v0.6.0...v0.7.0](https://github.com/prelude-so/ruby-sdk/compare/v0.6.0...v0.7.0)
+
+### Features
+
+* **api:** api update ([ed39fec](https://github.com/prelude-so/ruby-sdk/commit/ed39fece4f1d8838d68d7596ab587b4aba76a14a))
+* **api:** api update ([00dcf41](https://github.com/prelude-so/ruby-sdk/commit/00dcf41dcc28fe76ec0a112169c6d01da9937a53))
+* **api:** api update ([ebb1d68](https://github.com/prelude-so/ruby-sdk/commit/ebb1d682d35d4fc0f6a403aa06b903481ccae8fe))
+
+
+### Chores
+
+* **internal:** allow the mock server port to be set with STAINLESS_MOCK_PORT ([2c5f32b](https://github.com/prelude-so/ruby-sdk/commit/2c5f32b48b0859861875e96aceb3530daf400015))
+
 ## 0.6.0 (2026-08-07)
 
 Full Changelog: [v0.5.0...v0.6.0](https://github.com/prelude-so/ruby-sdk/compare/v0.5.0...v0.6.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "prelude-sdk", "~> 0.6.0"
+gem "prelude-sdk", "~> 0.7.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/prelude_sdk/models/verification_create_params.rb

@@ -405,6 +405,16 @@ module PreludeSDK
         #   @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Signals::DevicePlatform, nil]
         optional :device_platform, enum: -> { PreludeSDK::VerificationCreateParams::Signals::DevicePlatform }
 
+        # @!attribute existing_user
+        #   Whether the end-user already exists in your system, for example an existing
+        #   account signing in again rather than a first-time signup. Unlike
+        #   `is_trusted_user`, this signal does not bypass fraud checks; it is taken into
+        #   account as one additional anti-fraud signal. For more details, refer to
+        #   [Signals](/verify/v2/documentation/prevent-fraud#signals).
+        #
+        #   @return [Boolean, nil]
+        optional :existing_user, PreludeSDK::Internal::Type::Boolean
+
         # @!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`,
@@ -444,7 +454,7 @@ module PreludeSDK
         #   @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)
+        # @!method initialize(app_version: nil, device_id: nil, device_model: nil, device_platform: nil, existing_user: nil, ip: nil, is_trusted_user: nil, ja4_fingerprint: nil, os_version: nil, user_agent: nil)
         #   Some parameter documentations has been truncated, see
         #   {PreludeSDK::Models::VerificationCreateParams::Signals} for more details.
         #
@@ -459,6 +469,8 @@ module PreludeSDK
         #
         #   @param device_platform [Symbol, PreludeSDK::Models::VerificationCreateParams::Signals::DevicePlatform] The type of the user's device.
         #
+        #   @param existing_user [Boolean] Whether the end-user already exists in your system, for example an existing acco
+        #
         #   @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

data/lib/prelude_sdk/models/watch_predict_params.rb

@@ -124,6 +124,16 @@ module PreludeSDK
         #   @return [Symbol, PreludeSDK::Models::WatchPredictParams::Signals::DevicePlatform, nil]
         optional :device_platform, enum: -> { PreludeSDK::WatchPredictParams::Signals::DevicePlatform }
 
+        # @!attribute existing_user
+        #   Whether the end-user already exists in your system, for example an existing
+        #   account signing in again rather than a first-time signup. Unlike
+        #   `is_trusted_user`, this signal does not bypass fraud checks; it is taken into
+        #   account as one additional anti-fraud signal. For more details, refer to
+        #   [Signals](/verify/v2/documentation/prevent-fraud#signals).
+        #
+        #   @return [Boolean, nil]
+        optional :existing_user, PreludeSDK::Internal::Type::Boolean
+
         # @!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`,
@@ -163,7 +173,7 @@ module PreludeSDK
         #   @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)
+        # @!method initialize(app_version: nil, device_id: nil, device_model: nil, device_platform: nil, existing_user: nil, ip: nil, is_trusted_user: nil, ja4_fingerprint: nil, os_version: nil, user_agent: nil)
         #   Some parameter documentations has been truncated, see
         #   {PreludeSDK::Models::WatchPredictParams::Signals} for more details.
         #
@@ -178,6 +188,8 @@ module PreludeSDK
         #
         #   @param device_platform [Symbol, PreludeSDK::Models::WatchPredictParams::Signals::DevicePlatform] The type of the user's device.
         #
+        #   @param existing_user [Boolean] Whether the end-user already exists in your system, for example an existing acco
+        #
         #   @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

data/lib/prelude_sdk/models/watch_predict_response.rb

@@ -28,6 +28,9 @@ module PreludeSDK
       #   when prediction is "suspicious" and the anti-fraud system detected specific risk
       #   signals.
       #
+      #   - `account_risk_profile` - The target matches a risk profile derived from the
+      #     outcomes reported on your own account, rather than from a signal shared across
+      #     accounts.
       #   - `behavioral_pattern` - The phone number past behavior during verification
       #     flows exhibits suspicious patterns.
       #   - `device_attribute` - The device exhibits characteristics associated with
@@ -81,6 +84,7 @@ module PreludeSDK
       module RiskFactor
         extend PreludeSDK::Internal::Type::Enum
 
+        ACCOUNT_RISK_PROFILE = :account_risk_profile
         BEHAVIORAL_PATTERN = :behavioral_pattern
         DEVICE_ATTRIBUTE = :device_attribute
         FRAUD_DATABASE = :fraud_database

data/lib/prelude_sdk/resources/notify.rb

@@ -6,6 +6,8 @@ module PreludeSDK
     class Notify
       # Retrieve a specific subscription management configuration by its ID.
       #
+      # In order to get access to this endpoint, contact our support team.
+      #
       # @overload get_subscription_config(config_id, request_options: {})
       #
       # @param config_id [String] The subscription configuration ID
@@ -27,6 +29,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.
+      #
       # @overload get_subscription_phone_number(phone_number, config_id:, request_options: {})
       #
       # @param phone_number [String] The phone number in E.164 format (e.g., +33612345678)
@@ -58,6 +62,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.
+      #
       # @overload list_subscription_configs(cursor: nil, limit: nil, request_options: {})
       #
       # @param cursor [String] Pagination cursor from the previous response
@@ -86,6 +92,8 @@ module PreludeSDK
       #
       # Events are ordered by timestamp in descending order (most recent first).
       #
+      # In order to get access to this endpoint, contact our support team.
+      #
       # @overload list_subscription_phone_number_events(phone_number, config_id:, cursor: nil, limit: nil, request_options: {})
       #
       # @param phone_number [String] Path param: The phone number in E.164 format (e.g., +33612345678)
@@ -126,6 +134,8 @@ module PreludeSDK
       #
       # You can optionally filter by subscription state (SUB or UNSUB).
       #
+      # In order to get access to this endpoint, contact our support team.
+      #
       # @overload list_subscription_phone_numbers(config_id, cursor: nil, limit: nil, state: nil, request_options: {})
       #
       # @param config_id [String] The subscription configuration ID

data/lib/prelude_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PreludeSDK
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/rbi/prelude_sdk/models/verification_create_params.rbi

@@ -863,6 +863,17 @@ module PreludeSDK
         end
         attr_writer :device_platform
 
+        # Whether the end-user already exists in your system, for example an existing
+        # account signing in again rather than a first-time signup. Unlike
+        # `is_trusted_user`, this signal does not bypass fraud checks; it is taken into
+        # account as one additional anti-fraud signal. For more details, refer to
+        # [Signals](/verify/v2/documentation/prevent-fraud#signals).
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :existing_user
+
+        sig { params(existing_user: T::Boolean).void }
+        attr_writer :existing_user
+
         # 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
@@ -916,6 +927,7 @@ module PreludeSDK
             device_model: String,
             device_platform:
               PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::OrSymbol,
+            existing_user: T::Boolean,
             ip: String,
             is_trusted_user: T::Boolean,
             ja4_fingerprint: String,
@@ -934,6 +946,12 @@ module PreludeSDK
           device_model: nil,
           # The type of the user's device.
           device_platform: nil,
+          # Whether the end-user already exists in your system, for example an existing
+          # account signing in again rather than a first-time signup. Unlike
+          # `is_trusted_user`, this signal does not bypass fraud checks; it is taken into
+          # account as one additional anti-fraud signal. For more details, refer to
+          # [Signals](/verify/v2/documentation/prevent-fraud#signals).
+          existing_user: 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
@@ -964,6 +982,7 @@ module PreludeSDK
               device_model: String,
               device_platform:
                 PreludeSDK::VerificationCreateParams::Signals::DevicePlatform::OrSymbol,
+              existing_user: T::Boolean,
               ip: String,
               is_trusted_user: T::Boolean,
               ja4_fingerprint: String,

data/rbi/prelude_sdk/models/watch_predict_params.rbi

@@ -240,6 +240,17 @@ module PreludeSDK
         end
         attr_writer :device_platform
 
+        # Whether the end-user already exists in your system, for example an existing
+        # account signing in again rather than a first-time signup. Unlike
+        # `is_trusted_user`, this signal does not bypass fraud checks; it is taken into
+        # account as one additional anti-fraud signal. For more details, refer to
+        # [Signals](/verify/v2/documentation/prevent-fraud#signals).
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :existing_user
+
+        sig { params(existing_user: T::Boolean).void }
+        attr_writer :existing_user
+
         # 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
@@ -293,6 +304,7 @@ module PreludeSDK
             device_model: String,
             device_platform:
               PreludeSDK::WatchPredictParams::Signals::DevicePlatform::OrSymbol,
+            existing_user: T::Boolean,
             ip: String,
             is_trusted_user: T::Boolean,
             ja4_fingerprint: String,
@@ -311,6 +323,12 @@ module PreludeSDK
           device_model: nil,
           # The type of the user's device.
           device_platform: nil,
+          # Whether the end-user already exists in your system, for example an existing
+          # account signing in again rather than a first-time signup. Unlike
+          # `is_trusted_user`, this signal does not bypass fraud checks; it is taken into
+          # account as one additional anti-fraud signal. For more details, refer to
+          # [Signals](/verify/v2/documentation/prevent-fraud#signals).
+          existing_user: 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
@@ -341,6 +359,7 @@ module PreludeSDK
               device_model: String,
               device_platform:
                 PreludeSDK::WatchPredictParams::Signals::DevicePlatform::OrSymbol,
+              existing_user: T::Boolean,
               ip: String,
               is_trusted_user: T::Boolean,
               ja4_fingerprint: String,

data/rbi/prelude_sdk/models/watch_predict_response.rbi

@@ -32,6 +32,9 @@ module PreludeSDK
       # when prediction is "suspicious" and the anti-fraud system detected specific risk
       # signals.
       #
+      # - `account_risk_profile` - The target matches a risk profile derived from the
+      #   outcomes reported on your own account, rather than from a signal shared across
+      #   accounts.
       # - `behavioral_pattern` - The phone number past behavior during verification
       #   flows exhibits suspicious patterns.
       # - `device_attribute` - The device exhibits characteristics associated with
@@ -97,6 +100,9 @@ module PreludeSDK
         # when prediction is "suspicious" and the anti-fraud system detected specific risk
         # signals.
         #
+        # - `account_risk_profile` - The target matches a risk profile derived from the
+        #   outcomes reported on your own account, rather than from a signal shared across
+        #   accounts.
         # - `behavioral_pattern` - The phone number past behavior during verification
         #   flows exhibits suspicious patterns.
         # - `device_attribute` - The device exhibits characteristics associated with
@@ -179,6 +185,11 @@ module PreludeSDK
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        ACCOUNT_RISK_PROFILE =
+          T.let(
+            :account_risk_profile,
+            PreludeSDK::Models::WatchPredictResponse::RiskFactor::TaggedSymbol
+          )
         BEHAVIORAL_PATTERN =
           T.let(
             :behavioral_pattern,

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,

data/sig/prelude_sdk/models/verification_create_params.rbs

@@ -294,6 +294,7 @@ module PreludeSDK
           device_id: String,
           device_model: String,
           device_platform: PreludeSDK::Models::VerificationCreateParams::Signals::device_platform,
+          existing_user: bool,
           ip: String,
           is_trusted_user: bool,
           :ja4_fingerprint => String,
@@ -320,6 +321,10 @@ module PreludeSDK
           PreludeSDK::Models::VerificationCreateParams::Signals::device_platform
         ) -> PreludeSDK::Models::VerificationCreateParams::Signals::device_platform
 
+        attr_reader existing_user: bool?
+
+        def existing_user=: (bool) -> bool
+
         attr_reader ip: String?
 
         def ip=: (String) -> String
@@ -345,6 +350,7 @@ module PreludeSDK
           ?device_id: String,
           ?device_model: String,
           ?device_platform: PreludeSDK::Models::VerificationCreateParams::Signals::device_platform,
+          ?existing_user: bool,
           ?ip: String,
           ?is_trusted_user: bool,
           ?ja4_fingerprint: String,
@@ -357,6 +363,7 @@ module PreludeSDK
           device_id: String,
           device_model: String,
           device_platform: PreludeSDK::Models::VerificationCreateParams::Signals::device_platform,
+          existing_user: bool,
           ip: String,
           is_trusted_user: bool,
           :ja4_fingerprint => String,

data/sig/prelude_sdk/models/watch_predict_params.rbs

@@ -98,6 +98,7 @@ module PreludeSDK
           device_id: String,
           device_model: String,
           device_platform: PreludeSDK::Models::WatchPredictParams::Signals::device_platform,
+          existing_user: bool,
           ip: String,
           is_trusted_user: bool,
           :ja4_fingerprint => String,
@@ -124,6 +125,10 @@ module PreludeSDK
           PreludeSDK::Models::WatchPredictParams::Signals::device_platform
         ) -> PreludeSDK::Models::WatchPredictParams::Signals::device_platform
 
+        attr_reader existing_user: bool?
+
+        def existing_user=: (bool) -> bool
+
         attr_reader ip: String?
 
         def ip=: (String) -> String
@@ -149,6 +154,7 @@ module PreludeSDK
           ?device_id: String,
           ?device_model: String,
           ?device_platform: PreludeSDK::Models::WatchPredictParams::Signals::device_platform,
+          ?existing_user: bool,
           ?ip: String,
           ?is_trusted_user: bool,
           ?ja4_fingerprint: String,
@@ -161,6 +167,7 @@ module PreludeSDK
           device_id: String,
           device_model: String,
           device_platform: PreludeSDK::Models::WatchPredictParams::Signals::device_platform,
+          existing_user: bool,
           ip: String,
           is_trusted_user: bool,
           :ja4_fingerprint => String,

data/sig/prelude_sdk/models/watch_predict_response.rbs

@@ -47,7 +47,8 @@ module PreludeSDK
       end
 
       type risk_factor =
-        :behavioral_pattern
+        :account_risk_profile
+        | :behavioral_pattern
         | :device_attribute
         | :fraud_database
         | :location_discrepancy
@@ -61,6 +62,7 @@ module PreludeSDK
       module RiskFactor
         extend PreludeSDK::Internal::Type::Enum
 
+        ACCOUNT_RISK_PROFILE: :account_risk_profile
         BEHAVIORAL_PATTERN: :behavioral_pattern
         DEVICE_ATTRIBUTE: :device_attribute
         FRAUD_DATABASE: :fraud_database

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prelude-sdk
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Prelude
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-12 00:00:00.000000000 Z
+date: 2026-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi