prelude-sdk 0.2.0 → 0.4.0

data/rbi/prelude_sdk/models/notify_send_response.rbi

@@ -49,6 +49,34 @@ module PreludeSDK
       sig { params(correlation_id: String).void }
       attr_writer :correlation_id
 
+      # The SMS encoding type based on message content. GSM-7 supports standard
+      # characters (up to 160 chars per segment), while UCS-2 supports Unicode including
+      # emoji (up to 70 chars per segment). Only present for SMS messages.
+      sig do
+        returns(
+          T.nilable(
+            PreludeSDK::Models::NotifySendResponse::Encoding::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :encoding
+
+      sig do
+        params(
+          encoding: PreludeSDK::Models::NotifySendResponse::Encoding::OrSymbol
+        ).void
+      end
+      attr_writer :encoding
+
+      # The estimated number of SMS segments for this message. This value is not
+      # contractual; the actual segment count will be determined after the SMS is sent
+      # by the provider. Only present for SMS messages.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :estimated_segment_count
+
+      sig { params(estimated_segment_count: Integer).void }
+      attr_writer :estimated_segment_count
+
       # The Sender ID used for this message.
       sig { returns(T.nilable(String)) }
       attr_reader :from
@@ -75,6 +103,8 @@ module PreludeSDK
           variables: T::Hash[Symbol, String],
           callback_url: String,
           correlation_id: String,
+          encoding: PreludeSDK::Models::NotifySendResponse::Encoding::OrSymbol,
+          estimated_segment_count: Integer,
           from: String,
           schedule_at: Time
         ).returns(T.attached_class)
@@ -96,6 +126,14 @@ module PreludeSDK
         callback_url: nil,
         # A user-defined identifier to correlate this message with your internal systems.
         correlation_id: nil,
+        # The SMS encoding type based on message content. GSM-7 supports standard
+        # characters (up to 160 chars per segment), while UCS-2 supports Unicode including
+        # emoji (up to 70 chars per segment). Only present for SMS messages.
+        encoding: nil,
+        # The estimated number of SMS segments for this message. This value is not
+        # contractual; the actual segment count will be determined after the SMS is sent
+        # by the provider. Only present for SMS messages.
+        estimated_segment_count: nil,
         # The Sender ID used for this message.
         from: nil,
         # When the message will actually be sent in RFC3339 format with timezone offset.
@@ -116,6 +154,9 @@ module PreludeSDK
             variables: T::Hash[Symbol, String],
             callback_url: String,
             correlation_id: String,
+            encoding:
+              PreludeSDK::Models::NotifySendResponse::Encoding::TaggedSymbol,
+            estimated_segment_count: Integer,
             from: String,
             schedule_at: Time
           }
@@ -123,6 +164,40 @@ module PreludeSDK
       end
       def to_hash
       end
+
+      # The SMS encoding type based on message content. GSM-7 supports standard
+      # characters (up to 160 chars per segment), while UCS-2 supports Unicode including
+      # emoji (up to 70 chars per segment). Only present for SMS messages.
+      module Encoding
+        extend PreludeSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, PreludeSDK::Models::NotifySendResponse::Encoding)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        GSM_7 =
+          T.let(
+            :"GSM-7",
+            PreludeSDK::Models::NotifySendResponse::Encoding::TaggedSymbol
+          )
+        UCS_2 =
+          T.let(
+            :"UCS-2",
+            PreludeSDK::Models::NotifySendResponse::Encoding::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::Models::NotifySendResponse::Encoding::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/prelude_sdk/models/transactional_send_params.rbi

@@ -38,6 +38,26 @@ module PreludeSDK
       sig { params(correlation_id: String).void }
       attr_writer :correlation_id
 
+      # A media attachment to include in the message header. Supported on WhatsApp
+      # templates registered with a `DOCUMENT`, `IMAGE`, or `VIDEO` header. The media
+      # type is determined by the template's registered header format; send the matching
+      # file type for each.
+      #
+      # - `DOCUMENT` headers accept PDF and other document formats; `filename` is
+      #   required and displayed to the recipient.
+      # - `IMAGE` headers accept `.png`, `.jpg`, `.jpeg`, and `.webp` URLs; `filename`
+      #   is ignored.
+      # - `VIDEO` headers accept `.mp4` and `.3gp` URLs; `filename` is ignored.
+      sig { returns(T.nilable(PreludeSDK::TransactionalSendParams::Document)) }
+      attr_reader :document
+
+      sig do
+        params(
+          document: PreludeSDK::TransactionalSendParams::Document::OrHash
+        ).void
+      end
+      attr_writer :document
+
       # The message expiration date.
       sig { returns(T.nilable(String)) }
       attr_reader :expires_at
@@ -101,6 +121,7 @@ module PreludeSDK
           to: String,
           callback_url: String,
           correlation_id: String,
+          document: PreludeSDK::TransactionalSendParams::Document::OrHash,
           expires_at: String,
           from: String,
           locale: String,
@@ -121,6 +142,17 @@ module PreludeSDK
         # returned in the response and any webhook events that refer to this
         # transactionalmessage.
         correlation_id: nil,
+        # A media attachment to include in the message header. Supported on WhatsApp
+        # templates registered with a `DOCUMENT`, `IMAGE`, or `VIDEO` header. The media
+        # type is determined by the template's registered header format; send the matching
+        # file type for each.
+        #
+        # - `DOCUMENT` headers accept PDF and other document formats; `filename` is
+        #   required and displayed to the recipient.
+        # - `IMAGE` headers accept `.png`, `.jpg`, `.jpeg`, and `.webp` URLs; `filename`
+        #   is ignored.
+        # - `VIDEO` headers accept `.mp4` and `.3gp` URLs; `filename` is ignored.
+        document: nil,
         # The message expiration date.
         expires_at: nil,
         # The Sender ID.
@@ -153,6 +185,7 @@ module PreludeSDK
             to: String,
             callback_url: String,
             correlation_id: String,
+            document: PreludeSDK::TransactionalSendParams::Document,
             expires_at: String,
             from: String,
             locale: String,
@@ -166,6 +199,56 @@ module PreludeSDK
       def to_hash
       end
 
+      class Document < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::TransactionalSendParams::Document,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # HTTPS URL of the media file. The file extension must match the template's
+        # registered header format (PDF for DOCUMENT; PNG/JPG/JPEG/WEBP for IMAGE; MP4/3GP
+        # for VIDEO).
+        sig { returns(String) }
+        attr_accessor :url
+
+        # Filename displayed to the recipient. Required for templates with a `DOCUMENT`
+        # header; ignored for `IMAGE` and `VIDEO` headers.
+        sig { returns(T.nilable(String)) }
+        attr_reader :filename
+
+        sig { params(filename: String).void }
+        attr_writer :filename
+
+        # A media attachment to include in the message header. Supported on WhatsApp
+        # templates registered with a `DOCUMENT`, `IMAGE`, or `VIDEO` header. The media
+        # type is determined by the template's registered header format; send the matching
+        # file type for each.
+        #
+        # - `DOCUMENT` headers accept PDF and other document formats; `filename` is
+        #   required and displayed to the recipient.
+        # - `IMAGE` headers accept `.png`, `.jpg`, `.jpeg`, and `.webp` URLs; `filename`
+        #   is ignored.
+        # - `VIDEO` headers accept `.mp4` and `.3gp` URLs; `filename` is ignored.
+        sig { params(url: String, filename: String).returns(T.attached_class) }
+        def self.new(
+          # HTTPS URL of the media file. The file extension must match the template's
+          # registered header format (PDF for DOCUMENT; PNG/JPG/JPEG/WEBP for IMAGE; MP4/3GP
+          # for VIDEO).
+          url:,
+          # Filename displayed to the recipient. Required for templates with a `DOCUMENT`
+          # header; ignored for `IMAGE` and `VIDEO` headers.
+          filename: nil
+        )
+        end
+
+        sig { override.returns({ url: String, filename: String }) }
+        def to_hash
+        end
+      end
+
       # The preferred delivery channel for the message. When specified, the system will
       # prioritize sending via the requested channel if the template is configured for
       # it.

data/rbi/prelude_sdk/models/verification_create_params.rbi

@@ -232,8 +232,8 @@ module PreludeSDK
             )
           end
 
-        # This allows you to automatically retrieve and fill the OTP code on mobile apps.
-        # Currently only Android devices are supported.
+        # This allows automatic OTP retrieval on mobile apps and web browsers. Supported
+        # platforms are Android (SMS Retriever API) and Web (WebOTP API).
         sig do
           returns(
             T.nilable(PreludeSDK::VerificationCreateParams::Options::AppRealm)
@@ -275,24 +275,6 @@ module PreludeSDK
         sig { params(custom_code: String).void }
         attr_writer :custom_code
 
-        # The integration that triggered the verification.
-        sig do
-          returns(
-            T.nilable(
-              PreludeSDK::VerificationCreateParams::Options::Integration::OrSymbol
-            )
-          )
-        end
-        attr_reader :integration
-
-        sig do
-          params(
-            integration:
-              PreludeSDK::VerificationCreateParams::Options::Integration::OrSymbol
-          ).void
-        end
-        attr_writer :integration
-
         # A BCP-47 formatted locale string with the language the text message will be sent
         # to. If there's no locale set, the language will be determined by the country
         # code of the phone number. If the language specified doesn't exist, it defaults
@@ -376,8 +358,6 @@ module PreludeSDK
             callback_url: String,
             code_size: Integer,
             custom_code: String,
-            integration:
-              PreludeSDK::VerificationCreateParams::Options::Integration::OrSymbol,
             locale: String,
             verification_method:
               PreludeSDK::VerificationCreateParams::Options::Method::OrSymbol,
@@ -389,8 +369,8 @@ module PreludeSDK
           ).returns(T.attached_class)
         end
         def self.new(
-          # This allows you to automatically retrieve and fill the OTP code on mobile apps.
-          # Currently only Android devices are supported.
+          # This allows automatic OTP retrieval on mobile apps and web browsers. Supported
+          # platforms are Android (SMS Retriever API) and Web (WebOTP API).
           app_realm: nil,
           # The URL where webhooks will be sent when verification events occur, including
           # verification creation, attempt creation, and delivery status changes. For more
@@ -403,8 +383,6 @@ module PreludeSDK
           # contact us to enable it for your account. For more details, refer to
           # [Custom Code](/verify/v2/documentation/custom-codes).
           custom_code: nil,
-          # The integration that triggered the verification.
-          integration: nil,
           # A BCP-47 formatted locale string with the language the text message will be sent
           # to. If there's no locale set, the language will be determined by the country
           # code of the phone number. If the language specified doesn't exist, it defaults
@@ -439,8 +417,6 @@ module PreludeSDK
               callback_url: String,
               code_size: Integer,
               custom_code: String,
-              integration:
-                PreludeSDK::VerificationCreateParams::Options::Integration::OrSymbol,
               locale: String,
               verification_method:
                 PreludeSDK::VerificationCreateParams::Options::Method::OrSymbol,
@@ -464,8 +440,8 @@ module PreludeSDK
               )
             end
 
-          # The platform the SMS will be sent to. We are currently only supporting
-          # "android".
+          # The platform for automatic OTP retrieval. Use "android" for the SMS Retriever
+          # API or "web" for the WebOTP API.
           sig do
             returns(
               PreludeSDK::VerificationCreateParams::Options::AppRealm::Platform::OrSymbol
@@ -473,14 +449,17 @@ module PreludeSDK
           end
           attr_accessor :platform
 
-          # The Android SMS Retriever API hash code that identifies your app. For more
-          # information, see
-          # [Google documentation](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string).
+          # The value depends on the platform:
+          #
+          # - For Android: The SMS Retriever API hash code (11 characters). See
+          #   [Google documentation](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string).
+          # - For Web: The origin domain (e.g., "example.com" or "www.example.com"). See
+          #   [WebOTP API documentation](https://developer.mozilla.org/en-US/docs/Web/API/WebOTP_API).
           sig { returns(String) }
           attr_accessor :value
 
-          # This allows you to automatically retrieve and fill the OTP code on mobile apps.
-          # Currently only Android devices are supported.
+          # This allows automatic OTP retrieval on mobile apps and web browsers. Supported
+          # platforms are Android (SMS Retriever API) and Web (WebOTP API).
           sig do
             params(
               platform:
@@ -489,12 +468,15 @@ module PreludeSDK
             ).returns(T.attached_class)
           end
           def self.new(
-            # The platform the SMS will be sent to. We are currently only supporting
-            # "android".
+            # The platform for automatic OTP retrieval. Use "android" for the SMS Retriever
+            # API or "web" for the WebOTP API.
             platform:,
-            # The Android SMS Retriever API hash code that identifies your app. For more
-            # information, see
-            # [Google documentation](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string).
+            # The value depends on the platform:
+            #
+            # - For Android: The SMS Retriever API hash code (11 characters). See
+            #   [Google documentation](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string).
+            # - For Web: The origin domain (e.g., "example.com" or "www.example.com"). See
+            #   [WebOTP API documentation](https://developer.mozilla.org/en-US/docs/Web/API/WebOTP_API).
             value:
           )
           end
@@ -511,8 +493,8 @@ module PreludeSDK
           def to_hash
           end
 
-          # The platform the SMS will be sent to. We are currently only supporting
-          # "android".
+          # The platform for automatic OTP retrieval. Use "android" for the SMS Retriever
+          # API or "web" for the WebOTP API.
           module Platform
             extend PreludeSDK::Internal::Type::Enum
 
@@ -530,6 +512,11 @@ module PreludeSDK
                 :android,
                 PreludeSDK::VerificationCreateParams::Options::AppRealm::Platform::TaggedSymbol
               )
+            WEB =
+              T.let(
+                :web,
+                PreludeSDK::VerificationCreateParams::Options::AppRealm::Platform::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -543,41 +530,6 @@ module PreludeSDK
           end
         end
 
-        # The integration that triggered the verification.
-        module Integration
-          extend PreludeSDK::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                PreludeSDK::VerificationCreateParams::Options::Integration
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          AUTH0 =
-            T.let(
-              :auth0,
-              PreludeSDK::VerificationCreateParams::Options::Integration::TaggedSymbol
-            )
-          SUPABASE =
-            T.let(
-              :supabase,
-              PreludeSDK::VerificationCreateParams::Options::Integration::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                PreludeSDK::VerificationCreateParams::Options::Integration::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
         # The method used for verifying this phone number. The 'voice' option provides an
         # accessible alternative for visually impaired users by delivering the
         # verification code through a phone call rather than a text message. It also
@@ -696,8 +648,9 @@ module PreludeSDK
         sig { params(app_version: String).void }
         attr_writer :app_version
 
-        # The unique identifier for the user's device. For Android, this corresponds to
-        # the `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
+        # A unique ID for the user's device. You should ensure that each user device has a
+        # unique `device_id` value. Ideally, for Android, this corresponds to the
+        # `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
         sig { returns(T.nilable(String)) }
         attr_reader :device_id
 
@@ -729,15 +682,18 @@ module PreludeSDK
         end
         attr_writer :device_platform
 
-        # The IP address of the user's device.
+        # The public IP v4 or v6 address of the end-user's device. You should collect this
+        # from your backend. If your backend is behind a proxy, use the `X-Forwarded-For`,
+        # `Forwarded`, `True-Client-IP`, `CF-Connecting-IP` or an equivalent header to get
+        # the actual public IP of the end-user's device.
         sig { returns(T.nilable(String)) }
         attr_reader :ip
 
         sig { params(ip: String).void }
         attr_writer :ip
 
-        # This signal should provide a higher level of trust, indicating that the user is
-        # genuine. Contact us to discuss your use case. For more details, refer to
+        # This signal should indicate a higher level of trust, explicitly stating that the
+        # user is genuine. Contact us to discuss your use case. For more details, refer to
         # [Signals](/verify/v2/documentation/prevent-fraud#signals).
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :is_trusted_user
@@ -745,9 +701,9 @@ module PreludeSDK
         sig { params(is_trusted_user: T::Boolean).void }
         attr_writer :is_trusted_user
 
-        # The JA4 fingerprint observed for the connection. Prelude will infer it
-        # automatically when requests go through our client SDK (which uses Prelude's
-        # edge), but you can also provide it explicitly if you terminate TLS yourself.
+        # The JA4 fingerprint observed for the end-user's connection. Prelude will infer
+        # it automatically when you use our Frontend SDKs (which use Prelude's edge
+        # network), but you can also forward the value if you terminate TLS yourself.
         sig { returns(T.nilable(String)) }
         attr_reader :ja4_fingerprint
 
@@ -789,22 +745,26 @@ module PreludeSDK
         def self.new(
           # The version of your application.
           app_version: nil,
-          # The unique identifier for the user's device. For Android, this corresponds to
-          # the `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
+          # A unique ID for the user's device. You should ensure that each user device has a
+          # unique `device_id` value. Ideally, for Android, this corresponds to the
+          # `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
           device_id: nil,
           # The model of the user's device.
           device_model: nil,
           # The type of the user's device.
           device_platform: nil,
-          # The IP address of the user's device.
+          # The public IP v4 or v6 address of the end-user's device. You should collect this
+          # from your backend. If your backend is behind a proxy, use the `X-Forwarded-For`,
+          # `Forwarded`, `True-Client-IP`, `CF-Connecting-IP` or an equivalent header to get
+          # the actual public IP of the end-user's device.
           ip: nil,
-          # This signal should provide a higher level of trust, indicating that the user is
-          # genuine. Contact us to discuss your use case. For more details, refer to
+          # This signal should indicate a higher level of trust, explicitly stating that the
+          # user is genuine. Contact us to discuss your use case. For more details, refer to
           # [Signals](/verify/v2/documentation/prevent-fraud#signals).
           is_trusted_user: nil,
-          # The JA4 fingerprint observed for the connection. Prelude will infer it
-          # automatically when requests go through our client SDK (which uses Prelude's
-          # edge), but you can also provide it explicitly if you terminate TLS yourself.
+          # The JA4 fingerprint observed for the end-user's connection. Prelude will infer
+          # it automatically when you use our Frontend SDKs (which use Prelude's edge
+          # network), but you can also forward the value if you terminate TLS yourself.
           ja4_fingerprint: nil,
           # The version of the user's device operating system.
           os_version: nil,