prelude-sdk 0.3.0 → 0.4.0

data/lib/prelude_sdk/resources/notify.rb

@@ -156,10 +156,10 @@ module PreludeSDK
       # Some parameter documentations has been truncated, see
       # {PreludeSDK::Models::NotifySendParams} for more details.
       #
-      # Send transactional and marketing messages to your users via SMS and WhatsApp
-      # with automatic compliance enforcement.
+      # Send transactional and marketing messages to your users via SMS, RCS and
+      # WhatsApp with automatic compliance enforcement.
       #
-      # @overload send_(template_id:, to:, callback_url: nil, correlation_id: nil, document: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, schedule_at: nil, variables: nil, request_options: {})
+      # @overload send_(template_id:, to:, callback_url: nil, context: nil, correlation_id: nil, document: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, schedule_at: nil, text: nil, variables: nil, request_options: {})
       #
       # @param template_id [String] The template identifier configured by your Customer Success team.
       #
@@ -167,9 +167,11 @@ module PreludeSDK
       #
       # @param callback_url [String] The URL where webhooks will be sent for message delivery events.
       #
+      # @param context [PreludeSDK::Models::NotifySendParams::Context] Context for replying to an inbound message. When provided, the message is sent a
+      #
       # @param correlation_id [String] A user-defined identifier to correlate this message with your internal systems.
       #
-      # @param document [PreludeSDK::Models::NotifySendParams::Document] A document to attach to the message. Only supported on WhatsApp templates that h
+      # @param document [PreludeSDK::Models::NotifySendParams::Document] A media attachment to include in the message header. Supported on
       #
       # @param expires_at [Time] The message expiration date in RFC3339 format. The message will not be sent if t
       #
@@ -181,6 +183,8 @@ module PreludeSDK
       #
       # @param schedule_at [Time] Schedule the message for future delivery in RFC3339 format. Marketing messages c
       #
+      # @param text [String] The reply message body. Required when `context.reply_to` is provided. Used for 2
+      #
       # @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.
       #
       # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -214,7 +218,7 @@ module PreludeSDK
       #
       # @param correlation_id [String] A user-defined identifier to correlate this request with your internal systems.
       #
-      # @param document [PreludeSDK::Models::NotifySendBatchParams::Document] A document to attach to the message. Only supported on WhatsApp templates that h
+      # @param document [PreludeSDK::Models::NotifySendBatchParams::Document] A media attachment to include in the message header. Supported on
       #
       # @param expires_at [Time] The message expiration date in RFC3339 format. Messages will not be sent after t
       #

data/lib/prelude_sdk/resources/transactional.rb

@@ -22,7 +22,7 @@ module PreludeSDK
       #
       # @param correlation_id [String] A user-defined identifier to correlate this transactional message with. It is re
       #
-      # @param document [PreludeSDK::Models::TransactionalSendParams::Document] A document to attach to the message. Only supported on WhatsApp templates that h
+      # @param document [PreludeSDK::Models::TransactionalSendParams::Document] A media attachment to include in the message header. Supported on
       #
       # @param expires_at [String] The message expiration date.
       #

data/lib/prelude_sdk/resources/watch.rb

@@ -35,12 +35,15 @@ module PreludeSDK
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {PreludeSDK::Models::WatchSendEventsParams} for more details.
+      #
       # Send real-time event data from end-user interactions within your application.
       # Events will be analyzed for proactive fraud prevention and risk scoring.
       #
       # @overload send_events(events:, request_options: {})
       #
-      # @param events [Array<PreludeSDK::Models::WatchSendEventsParams::Event>] A list of events to dispatch.
+      # @param events [Array<PreludeSDK::Models::WatchSendEventsParams::Event>] A list of events to dispatch. A maximum of 100 events can be sent in a single re
       #
       # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -58,12 +61,15 @@ module PreludeSDK
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {PreludeSDK::Models::WatchSendFeedbacksParams} for more details.
+      #
       # Send feedback regarding your end-users verification funnel. Events will be
       # analyzed for proactive fraud prevention and risk scoring.
       #
       # @overload send_feedbacks(feedbacks:, request_options: {})
       #
-      # @param feedbacks [Array<PreludeSDK::Models::WatchSendFeedbacksParams::Feedback>] A list of feedbacks to send.
+      # @param feedbacks [Array<PreludeSDK::Models::WatchSendFeedbacksParams::Feedback>] A list of feedbacks to send. A maximum of 100 feedbacks can be sent in a single
       #
       # @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/prelude_sdk/version.rb

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

data/rbi/prelude_sdk/internal/util.rbi

@@ -148,12 +148,20 @@ module PreludeSDK
         end
       end
 
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = T.let(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/, Regexp)
+
       class << self
         # @api private
         sig { params(uri: URI::Generic).returns(String) }
         def uri_origin(uri)
         end
 
+        # @api private
+        sig { params(path: T.any(String, Integer)).returns(String) }
+        def encode_path(path)
+        end
+
         # @api private
         sig { params(path: T.any(String, T::Array[String])).returns(String) }
         def interpolate_path(path)

data/rbi/prelude_sdk/models/notify_send_batch_params.rbi

@@ -36,8 +36,16 @@ module PreludeSDK
       sig { params(correlation_id: String).void }
       attr_writer :correlation_id
 
-      # A document to attach to the message. Only supported on WhatsApp templates that
-      # have a document header.
+      # 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
 
@@ -129,8 +137,16 @@ module PreludeSDK
         callback_url: nil,
         # A user-defined identifier to correlate this request with your internal systems.
         correlation_id: nil,
-        # A document to attach to the message. Only supported on WhatsApp templates that
-        # have a document header.
+        # 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.
@@ -181,26 +197,43 @@ module PreludeSDK
             )
           end
 
-        # The filename to display for the document.
-        sig { returns(String) }
-        attr_accessor :filename
-
-        # The URL of the document to attach. Must be a valid HTTP or HTTPS URL.
+        # 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
 
-        # A document to attach to the message. Only supported on WhatsApp templates that
-        # have a document header.
-        sig { params(filename: String, url: String).returns(T.attached_class) }
+        # 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(
-          # The filename to display for the document.
-          filename:,
-          # The URL of the document to attach. Must be a valid HTTP or HTTPS URL.
-          url:
+          # 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({ filename: String, url: String }) }
+        sig { override.returns({ url: String, filename: String }) }
         def to_hash
         end
       end
@@ -220,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_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,8 +45,16 @@ module PreludeSDK
       sig { params(correlation_id: String).void }
       attr_writer :correlation_id
 
-      # A document to attach to the message. Only supported on WhatsApp templates that
-      # have a document header.
+      # 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
 
@@ -96,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
@@ -108,6 +135,7 @@ 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,
@@ -116,6 +144,7 @@ module PreludeSDK
           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)
@@ -127,12 +156,23 @@ 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 document to attach to the message. Only supported on WhatsApp templates that
-        # have a document header.
+        # 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.
@@ -151,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: {}
@@ -163,6 +207,7 @@ module PreludeSDK
             template_id: String,
             to: String,
             callback_url: String,
+            context: PreludeSDK::NotifySendParams::Context,
             correlation_id: String,
             document: PreludeSDK::NotifySendParams::Document,
             expires_at: Time,
@@ -171,6 +216,7 @@ module PreludeSDK
             preferred_channel:
               PreludeSDK::NotifySendParams::PreferredChannel::OrSymbol,
             schedule_at: Time,
+            text: String,
             variables: T::Hash[Symbol, String],
             request_options: PreludeSDK::RequestOptions
           }
@@ -179,35 +225,81 @@ module PreludeSDK
       def to_hash
       end
 
-      class Document < PreludeSDK::Internal::Type::BaseModel
+      class Context < PreludeSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              PreludeSDK::NotifySendParams::Document,
+              PreludeSDK::NotifySendParams::Context,
               PreludeSDK::Internal::AnyHash
             )
           end
 
-        # The filename to display for the document.
+        # 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 :filename
+        attr_accessor :reply_to
 
-        # The URL of the document to attach. Must be a valid HTTP or HTTPS 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 { 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
 
-        # A document to attach to the message. Only supported on WhatsApp templates that
-        # have a document header.
-        sig { params(filename: String, url: String).returns(T.attached_class) }
+        # 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(
-          # The filename to display for the document.
-          filename:,
-          # The URL of the document to attach. Must be a valid HTTP or HTTPS URL.
-          url:
+          # 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({ filename: String, url: String }) }
+        sig { override.returns({ url: String, filename: String }) }
         def to_hash
         end
       end
@@ -228,6 +320,11 @@ module PreludeSDK
             :sms,
             PreludeSDK::NotifySendParams::PreferredChannel::TaggedSymbol
           )
+        RCS =
+          T.let(
+            :rcs,
+            PreludeSDK::NotifySendParams::PreferredChannel::TaggedSymbol
+          )
         WHATSAPP =
           T.let(
             :whatsapp,

data/rbi/prelude_sdk/models/transactional_send_params.rbi

@@ -38,8 +38,16 @@ module PreludeSDK
       sig { params(correlation_id: String).void }
       attr_writer :correlation_id
 
-      # A document to attach to the message. Only supported on WhatsApp templates that
-      # have a document header.
+      # 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
 
@@ -134,8 +142,16 @@ module PreludeSDK
         # returned in the response and any webhook events that refer to this
         # transactionalmessage.
         correlation_id: nil,
-        # A document to attach to the message. Only supported on WhatsApp templates that
-        # have a document header.
+        # 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,
@@ -192,26 +208,43 @@ module PreludeSDK
             )
           end
 
-        # The filename to display for the document.
-        sig { returns(String) }
-        attr_accessor :filename
-
-        # The URL of the document to attach. Must be a valid HTTP or HTTPS URL.
+        # 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
 
-        # A document to attach to the message. Only supported on WhatsApp templates that
-        # have a document header.
-        sig { params(filename: String, url: String).returns(T.attached_class) }
+        # 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(
-          # The filename to display for the document.
-          filename:,
-          # The URL of the document to attach. Must be a valid HTTP or HTTPS URL.
-          url:
+          # 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({ filename: String, url: String }) }
+        sig { override.returns({ url: String, filename: String }) }
         def to_hash
         end
       end