prelude-sdk 0.2.0 → 0.4.0

data/rbi/prelude_sdk/models/lookup_lookup_params.rbi

@@ -11,6 +11,10 @@ module PreludeSDK
           T.any(PreludeSDK::LookupLookupParams, PreludeSDK::Internal::AnyHash)
         end
 
+      # An E.164 formatted phone number to look up.
+      sig { returns(String) }
+      attr_accessor :phone_number
+
       # Optional features. Possible values are:
       #
       # - `cnam` - Retrieve CNAM (Caller ID Name) along with other information. Contact
@@ -31,11 +35,14 @@ module PreludeSDK
 
       sig do
         params(
+          phone_number: String,
           type: T::Array[PreludeSDK::LookupLookupParams::Type::OrSymbol],
           request_options: PreludeSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # An E.164 formatted phone number to look up.
+        phone_number:,
         # Optional features. Possible values are:
         #
         # - `cnam` - Retrieve CNAM (Caller ID Name) along with other information. Contact
@@ -48,6 +55,7 @@ module PreludeSDK
       sig do
         override.returns(
           {
+            phone_number: String,
             type: T::Array[PreludeSDK::LookupLookupParams::Type::OrSymbol],
             request_options: PreludeSDK::RequestOptions
           }

data/rbi/prelude_sdk/models/notify_get_subscription_config_params.rbi

@@ -14,15 +14,23 @@ module PreludeSDK
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :config_id
+
       sig do
-        params(request_options: PreludeSDK::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          config_id: String,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(config_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: PreludeSDK::RequestOptions }) }
+      sig do
+        override.returns(
+          { config_id: String, request_options: PreludeSDK::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/prelude_sdk/models/notify_get_subscription_phone_number_params.rbi

@@ -17,18 +17,26 @@ module PreludeSDK
       sig { returns(String) }
       attr_accessor :config_id
 
+      sig { returns(String) }
+      attr_accessor :phone_number
+
       sig do
         params(
           config_id: String,
+          phone_number: String,
           request_options: PreludeSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(config_id:, request_options: {})
+      def self.new(config_id:, phone_number:, request_options: {})
       end
 
       sig do
         override.returns(
-          { config_id: String, request_options: PreludeSDK::RequestOptions }
+          {
+            config_id: String,
+            phone_number: String,
+            request_options: PreludeSDK::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/prelude_sdk/models/notify_list_subscription_phone_number_events_params.rbi

@@ -17,6 +17,9 @@ module PreludeSDK
       sig { returns(String) }
       attr_accessor :config_id
 
+      sig { returns(String) }
+      attr_accessor :phone_number
+
       # Pagination cursor from the previous response
       sig { returns(T.nilable(String)) }
       attr_reader :cursor
@@ -34,6 +37,7 @@ module PreludeSDK
       sig do
         params(
           config_id: String,
+          phone_number: String,
           cursor: String,
           limit: Integer,
           request_options: PreludeSDK::RequestOptions::OrHash
@@ -41,6 +45,7 @@ module PreludeSDK
       end
       def self.new(
         config_id:,
+        phone_number:,
         # Pagination cursor from the previous response
         cursor: nil,
         # Maximum number of events to return per page
@@ -53,6 +58,7 @@ module PreludeSDK
         override.returns(
           {
             config_id: String,
+            phone_number: String,
             cursor: String,
             limit: Integer,
             request_options: PreludeSDK::RequestOptions

data/rbi/prelude_sdk/models/notify_list_subscription_phone_numbers_params.rbi

@@ -14,6 +14,9 @@ module PreludeSDK
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :config_id
+
       # Pagination cursor from the previous response
       sig { returns(T.nilable(String)) }
       attr_reader :cursor
@@ -48,6 +51,7 @@ module PreludeSDK
 
       sig do
         params(
+          config_id: String,
           cursor: String,
           limit: Integer,
           state:
@@ -56,6 +60,7 @@ module PreludeSDK
         ).returns(T.attached_class)
       end
       def self.new(
+        config_id:,
         # Pagination cursor from the previous response
         cursor: nil,
         # Maximum number of phone numbers to return per page
@@ -69,6 +74,7 @@ module PreludeSDK
       sig do
         override.returns(
           {
+            config_id: String,
             cursor: String,
             limit: Integer,
             state:

data/rbi/prelude_sdk/models/notify_send_batch_params.rbi

@@ -36,6 +36,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::NotifySendBatchParams::Document)) }
+      attr_reader :document
+
+      sig do
+        params(
+          document: PreludeSDK::NotifySendBatchParams::Document::OrHash
+        ).void
+      end
+      attr_writer :document
+
       # The message expiration date in RFC3339 format. Messages will not be sent after
       # this time.
       sig { returns(T.nilable(Time)) }
@@ -97,6 +117,7 @@ module PreludeSDK
           to: T::Array[String],
           callback_url: String,
           correlation_id: String,
+          document: PreludeSDK::NotifySendBatchParams::Document::OrHash,
           expires_at: Time,
           from: String,
           locale: String,
@@ -116,6 +137,17 @@ module PreludeSDK
         callback_url: nil,
         # A user-defined identifier to correlate this request with your internal systems.
         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 in RFC3339 format. Messages will not be sent after
         # this time.
         expires_at: nil,
@@ -141,6 +173,7 @@ module PreludeSDK
             to: T::Array[String],
             callback_url: String,
             correlation_id: String,
+            document: PreludeSDK::NotifySendBatchParams::Document,
             expires_at: Time,
             from: String,
             locale: String,
@@ -155,6 +188,56 @@ module PreludeSDK
       def to_hash
       end
 
+      class Document < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::NotifySendBatchParams::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
+
       # Preferred channel for delivery. If unavailable, automatic fallback applies.
       module PreferredChannel
         extend PreludeSDK::Internal::Type::Enum
@@ -170,6 +253,11 @@ module PreludeSDK
             :sms,
             PreludeSDK::NotifySendBatchParams::PreferredChannel::TaggedSymbol
           )
+        RCS =
+          T.let(
+            :rcs,
+            PreludeSDK::NotifySendBatchParams::PreferredChannel::TaggedSymbol
+          )
         WHATSAPP =
           T.let(
             :whatsapp,

data/rbi/prelude_sdk/models/notify_send_batch_response.rbi

@@ -269,6 +269,35 @@ module PreludeSDK
           sig { params(created_at: Time).void }
           attr_writer :created_at
 
+          # 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::NotifySendBatchResponse::Result::Message::Encoding::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :encoding
+
+          sig do
+            params(
+              encoding:
+                PreludeSDK::Models::NotifySendBatchResponse::Result::Message::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 message expiration date in RFC3339 format.
           sig { returns(T.nilable(Time)) }
           attr_reader :expires_at
@@ -310,6 +339,9 @@ module PreludeSDK
               id: String,
               correlation_id: String,
               created_at: Time,
+              encoding:
+                PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding::OrSymbol,
+              estimated_segment_count: Integer,
               expires_at: Time,
               from: String,
               locale: String,
@@ -324,6 +356,14 @@ module PreludeSDK
             correlation_id: nil,
             # The message creation date in RFC3339 format.
             created_at: 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 message expiration date in RFC3339 format.
             expires_at: nil,
             # The Sender ID used for this message.
@@ -343,6 +383,9 @@ module PreludeSDK
                 id: String,
                 correlation_id: String,
                 created_at: Time,
+                encoding:
+                  PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding::TaggedSymbol,
+                estimated_segment_count: Integer,
                 expires_at: Time,
                 from: String,
                 locale: String,
@@ -353,6 +396,43 @@ 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::NotifySendBatchResponse::Result::Message::Encoding
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            GSM_7 =
+              T.let(
+                :"GSM-7",
+                PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding::TaggedSymbol
+              )
+            UCS_2 =
+              T.let(
+                :"UCS-2",
+                PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
       end
     end

data/rbi/prelude_sdk/models/notify_send_params.rbi

@@ -26,6 +26,16 @@ module PreludeSDK
       sig { params(callback_url: String).void }
       attr_writer :callback_url
 
+      # Context for replying to an inbound message. When provided, the message is sent
+      # as a WhatsApp reply within the 24-hour conversation window.
+      sig { returns(T.nilable(PreludeSDK::NotifySendParams::Context)) }
+      attr_reader :context
+
+      sig do
+        params(context: PreludeSDK::NotifySendParams::Context::OrHash).void
+      end
+      attr_writer :context
+
       # A user-defined identifier to correlate this message with your internal systems.
       # It is returned in the response and any webhook events that refer to this
       # message.
@@ -35,6 +45,24 @@ 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::NotifySendParams::Document)) }
+      attr_reader :document
+
+      sig do
+        params(document: PreludeSDK::NotifySendParams::Document::OrHash).void
+      end
+      attr_writer :document
+
       # The message expiration date in RFC3339 format. The message will not be sent if
       # this time is reached.
       sig { returns(T.nilable(Time)) }
@@ -86,6 +114,15 @@ module PreludeSDK
       sig { params(schedule_at: Time).void }
       attr_writer :schedule_at
 
+      # The reply message body. Required when `context.reply_to` is provided. Used for
+      # 2-way WhatsApp messaging to send free-form text replies within a conversation
+      # window.
+      sig { returns(T.nilable(String)) }
+      attr_reader :text
+
+      sig { params(text: String).void }
+      attr_writer :text
+
       # The variables to be replaced in the template.
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
       attr_reader :variables
@@ -98,13 +135,16 @@ module PreludeSDK
           template_id: String,
           to: String,
           callback_url: String,
+          context: PreludeSDK::NotifySendParams::Context::OrHash,
           correlation_id: String,
+          document: PreludeSDK::NotifySendParams::Document::OrHash,
           expires_at: Time,
           from: String,
           locale: String,
           preferred_channel:
             PreludeSDK::NotifySendParams::PreferredChannel::OrSymbol,
           schedule_at: Time,
+          text: String,
           variables: T::Hash[Symbol, String],
           request_options: PreludeSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -116,10 +156,24 @@ module PreludeSDK
         to:,
         # The URL where webhooks will be sent for message delivery events.
         callback_url: nil,
+        # Context for replying to an inbound message. When provided, the message is sent
+        # as a WhatsApp reply within the 24-hour conversation window.
+        context: nil,
         # A user-defined identifier to correlate this message with your internal systems.
         # It is returned in the response and any webhook events that refer to this
         # message.
         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 in RFC3339 format. The message will not be sent if
         # this time is reached.
         expires_at: nil,
@@ -137,6 +191,10 @@ module PreludeSDK
         # can be scheduled up to 90 days in advance and will be automatically adjusted for
         # compliance with local time window restrictions.
         schedule_at: nil,
+        # The reply message body. Required when `context.reply_to` is provided. Used for
+        # 2-way WhatsApp messaging to send free-form text replies within a conversation
+        # window.
+        text: nil,
         # The variables to be replaced in the template.
         variables: nil,
         request_options: {}
@@ -149,13 +207,16 @@ module PreludeSDK
             template_id: String,
             to: String,
             callback_url: String,
+            context: PreludeSDK::NotifySendParams::Context,
             correlation_id: String,
+            document: PreludeSDK::NotifySendParams::Document,
             expires_at: Time,
             from: String,
             locale: String,
             preferred_channel:
               PreludeSDK::NotifySendParams::PreferredChannel::OrSymbol,
             schedule_at: Time,
+            text: String,
             variables: T::Hash[Symbol, String],
             request_options: PreludeSDK::RequestOptions
           }
@@ -164,6 +225,85 @@ module PreludeSDK
       def to_hash
       end
 
+      class Context < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::NotifySendParams::Context,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # The inbound message ID (prefixed with `im_`) to reply to. This ID is provided in
+        # the `inbound.message.received` webhook event.
+        sig { returns(String) }
+        attr_accessor :reply_to
+
+        # Context for replying to an inbound message. When provided, the message is sent
+        # as a WhatsApp reply within the 24-hour conversation window.
+        sig { params(reply_to: String).returns(T.attached_class) }
+        def self.new(
+          # The inbound message ID (prefixed with `im_`) to reply to. This ID is provided in
+          # the `inbound.message.received` webhook event.
+          reply_to:
+        )
+        end
+
+        sig { override.returns({ reply_to: String }) }
+        def to_hash
+        end
+      end
+
+      class Document < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::NotifySendParams::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 channel to be used in priority for message delivery. If the
       # channel is unavailable, the system will fallback to other available channels.
       module PreferredChannel
@@ -180,6 +320,11 @@ module PreludeSDK
             :sms,
             PreludeSDK::NotifySendParams::PreferredChannel::TaggedSymbol
           )
+        RCS =
+          T.let(
+            :rcs,
+            PreludeSDK::NotifySendParams::PreferredChannel::TaggedSymbol
+          )
         WHATSAPP =
           T.let(
             :whatsapp,