prelude-sdk 0.2.0 → 0.3.0

data/lib/prelude_sdk/resources/notify.rb

@@ -2,6 +2,7 @@
 
 module PreludeSDK
   module Resources
+    # Send transactional and marketing messages with compliance enforcement.
     class Notify
       # Retrieve a specific subscription management configuration by its ID.
       #
@@ -70,10 +71,11 @@ module PreludeSDK
       # @see PreludeSDK::Models::NotifyListSubscriptionConfigsParams
       def list_subscription_configs(params = {})
         parsed, options = PreludeSDK::NotifyListSubscriptionConfigsParams.dump_request(params)
+        query = PreludeSDK::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "v2/notify/management/subscriptions",
-          query: parsed,
+          query: query,
           model: PreludeSDK::Models::NotifyListSubscriptionConfigsResponse,
           options: options
         )
@@ -101,6 +103,7 @@ module PreludeSDK
       # @see PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsParams
       def list_subscription_phone_number_events(phone_number, params)
         parsed, options = PreludeSDK::NotifyListSubscriptionPhoneNumberEventsParams.dump_request(params)
+        query = PreludeSDK::Internal::Util.encode_query_params(parsed)
         config_id =
           parsed.delete(:config_id) do
             raise ArgumentError.new("missing required path argument #{_1}")
@@ -112,7 +115,7 @@ module PreludeSDK
             config_id,
             phone_number
           ],
-          query: parsed,
+          query: query,
           model: PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse,
           options: options
         )
@@ -140,10 +143,11 @@ module PreludeSDK
       # @see PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams
       def list_subscription_phone_numbers(config_id, params = {})
         parsed, options = PreludeSDK::NotifyListSubscriptionPhoneNumbersParams.dump_request(params)
+        query = PreludeSDK::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v2/notify/management/subscriptions/%1$s/phone_numbers", config_id],
-          query: parsed,
+          query: query,
           model: PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse,
           options: options
         )
@@ -155,7 +159,7 @@ module PreludeSDK
       # Send transactional and marketing messages to your users via SMS and WhatsApp
       # with automatic compliance enforcement.
       #
-      # @overload send_(template_id:, to:, callback_url: nil, correlation_id: 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, correlation_id: nil, document: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, schedule_at: nil, variables: nil, request_options: {})
       #
       # @param template_id [String] The template identifier configured by your Customer Success team.
       #
@@ -165,6 +169,8 @@ module PreludeSDK
       #
       # @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 expires_at [Time] The message expiration date in RFC3339 format. The message will not be sent if t
       #
       # @param from [String] The Sender ID. Must be approved for your account.
@@ -198,7 +204,7 @@ module PreludeSDK
       #
       # Send the same message to multiple recipients in a single request.
       #
-      # @overload send_batch(template_id:, to:, callback_url: nil, correlation_id: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, schedule_at: nil, variables: nil, request_options: {})
+      # @overload send_batch(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: {})
       #
       # @param template_id [String] The template identifier configured by your Customer Success team.
       #
@@ -208,6 +214,8 @@ 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 expires_at [Time] The message expiration date in RFC3339 format. Messages will not be sent after t
       #
       # @param from [String] The Sender ID. Must be approved for your account.

data/lib/prelude_sdk/resources/transactional.rb

@@ -2,6 +2,7 @@
 
 module PreludeSDK
   module Resources
+    # Send transactional messages (deprecated - use Notify API instead).
     class Transactional
       # @deprecated
       #
@@ -11,7 +12,7 @@ module PreludeSDK
       # Legacy route maintained for backward compatibility. Migrate to `/v2/notify`
       # instead.
       #
-      # @overload send_(template_id:, to:, callback_url: nil, correlation_id: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, variables: nil, request_options: {})
+      # @overload send_(template_id:, to:, callback_url: nil, correlation_id: nil, document: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, variables: nil, request_options: {})
       #
       # @param template_id [String] The template identifier.
       #
@@ -21,6 +22,8 @@ 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 expires_at [String] The message expiration date.
       #
       # @param from [String] The Sender ID.

data/lib/prelude_sdk/resources/verification.rb

@@ -2,6 +2,7 @@
 
 module PreludeSDK
   module Resources
+    # Verify phone numbers.
     class Verification
       # Some parameter documentations has been truncated, see
       # {PreludeSDK::Models::VerificationCreateParams} for more details.

data/lib/prelude_sdk/resources/verification_management.rb

@@ -2,6 +2,7 @@
 
 module PreludeSDK
   module Resources
+    # Verify phone numbers.
     class VerificationManagement
       # Remove a phone number from the allow or block list.
       #

data/lib/prelude_sdk/resources/watch.rb

@@ -2,6 +2,7 @@
 
 module PreludeSDK
   module Resources
+    # Evaluate email addresses and phone numbers for trustworthiness.
     class Watch
       # Some parameter documentations has been truncated, see
       # {PreludeSDK::Models::WatchPredictParams} for more details.

data/lib/prelude_sdk/version.rb

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

data/rbi/prelude_sdk/client.rbi

@@ -14,21 +14,28 @@ module PreludeSDK
     sig { returns(String) }
     attr_reader :api_token
 
+    # Retrieve detailed information about a phone number including carrier data, line
+    # type, and portability status.
     sig { returns(PreludeSDK::Resources::Lookup) }
     attr_reader :lookup
 
+    # Send transactional and marketing messages with compliance enforcement.
     sig { returns(PreludeSDK::Resources::Notify) }
     attr_reader :notify
 
+    # Send transactional messages (deprecated - use Notify API instead).
     sig { returns(PreludeSDK::Resources::Transactional) }
     attr_reader :transactional
 
+    # Verify phone numbers.
     sig { returns(PreludeSDK::Resources::Verification) }
     attr_reader :verification
 
+    # Verify phone numbers.
     sig { returns(PreludeSDK::Resources::VerificationManagement) }
     attr_reader :verification_management
 
+    # Evaluate email addresses and phone numbers for trustworthiness.
     sig { returns(PreludeSDK::Resources::Watch) }
     attr_reader :watch
 

data/rbi/prelude_sdk/internal/util.rbi

@@ -296,11 +296,31 @@ module PreludeSDK
       end
 
       JSON_CONTENT =
-        T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
+        T.let(%r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}, Regexp)
       JSONL_CONTENT =
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: PreludeSDK::Internal::AnyHash).returns(
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: PreludeSDK::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(

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,18 @@ 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.
+      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 +109,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 +129,9 @@ 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.
+        document: nil,
         # The message expiration date in RFC3339 format. Messages will not be sent after
         # this time.
         expires_at: nil,
@@ -141,6 +157,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 +172,39 @@ 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
+
+        # 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.
+        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) }
+        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:
+        )
+        end
+
+        sig { override.returns({ filename: String, url: String }) }
+        def to_hash
+        end
+      end
+
       # Preferred channel for delivery. If unavailable, automatic fallback applies.
       module PreferredChannel
         extend PreludeSDK::Internal::Type::Enum

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

@@ -35,6 +35,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.
+      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)) }
@@ -99,6 +109,7 @@ module PreludeSDK
           to: String,
           callback_url: String,
           correlation_id: String,
+          document: PreludeSDK::NotifySendParams::Document::OrHash,
           expires_at: Time,
           from: String,
           locale: String,
@@ -120,6 +131,9 @@ module PreludeSDK
         # 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.
+        document: nil,
         # The message expiration date in RFC3339 format. The message will not be sent if
         # this time is reached.
         expires_at: nil,
@@ -150,6 +164,7 @@ module PreludeSDK
             to: String,
             callback_url: String,
             correlation_id: String,
+            document: PreludeSDK::NotifySendParams::Document,
             expires_at: Time,
             from: String,
             locale: String,
@@ -164,6 +179,39 @@ module PreludeSDK
       def to_hash
       end
 
+      class Document < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::NotifySendParams::Document,
+              PreludeSDK::Internal::AnyHash
+            )
+          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.
+        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) }
+        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:
+        )
+        end
+
+        sig { override.returns({ filename: String, url: 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