prelude-sdk 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20bf770b210bf23b3214f6dc77fd7e2f74a96869d52c7f96788a548a87c8afb0
-  data.tar.gz: fcb6a885d033659e8a2d8f7c91b97e04cf9df00ac8da6ad1392961f77f52c525
+  metadata.gz: c30d57028d9ebcfd36fa8b9eec44cb27060d610dea0ad043a84d5d3ba03e63dd
+  data.tar.gz: 3704104bbb4293a7bef28aaa073376d8bd873f0b90ae8102c5e73194cd0259eb
 SHA512:
-  metadata.gz: 2797a1a23e09c4a7038ac2f06a86d491c1505c734d7fecaea592b7d0fc125818a1517cab2d1431229c3cf1634b8847c754e58b511c7d7968517f2095a3aa1536
-  data.tar.gz: 5bdad09b05d0f22ceba1f75fd9b3fbf7f045331729c288ae938b78de419a378382469347e1ea50ab7f6fcf044f3ffe120ff27136c995ea163bad08987991840c
+  metadata.gz: 56012d0287c7baa14666bc5a009ed125c3a40f442e2cdbf4a6c1e2fd65671212ec0cf947bffd9dfd90b5a64197d3525a1f79969f01d4f063e7f860f907b0b729
+  data.tar.gz: 497e10803825d58f550569fae77d4e02a20ff1a3a75480c31710513b41c58e19d8ce4d7979b497066f22385ca3c5cab537edd6a10d7b7d9e79ad619cf36d0a64

data/CHANGELOG.md

@@ -1,5 +1,86 @@
 # Changelog
 
+## 0.4.0 (2026-04-30)
+
+Full Changelog: [v0.3.0...v0.4.0](https://github.com/prelude-so/ruby-sdk/compare/v0.3.0...v0.4.0)
+
+### Features
+
+* **api:** api update ([6ef917b](https://github.com/prelude-so/ruby-sdk/commit/6ef917bcd3a32e40139d32528e20ad17ea3b8278))
+* **api:** api update ([f0ec5a8](https://github.com/prelude-so/ruby-sdk/commit/f0ec5a8d5121f7f8d541a3f9fbf5a2176380bdb2))
+* **api:** api update ([3041c86](https://github.com/prelude-so/ruby-sdk/commit/3041c8644933cc9a849dc02bdf2717c4405bf812))
+* **api:** api update ([3d94aa1](https://github.com/prelude-so/ruby-sdk/commit/3d94aa1539b0ee491fb1b852976aee745c72f08b))
+* **api:** api update ([3f9e6ce](https://github.com/prelude-so/ruby-sdk/commit/3f9e6ce6f97d66c574611befa9c1620b93eeeb76))
+* support setting headers via env ([755c4ac](https://github.com/prelude-so/ruby-sdk/commit/755c4acad1a339802b824f6f719a9084db6742fc))
+
+
+### Bug Fixes
+
+* align path encoding with RFC 3986 section 3.3 ([20f9b5e](https://github.com/prelude-so/ruby-sdk/commit/20f9b5e3571676a09e4b2aa5a1f554257d67c07d))
+* **internal:** correct multipart form field name encoding ([ba42aef](https://github.com/prelude-so/ruby-sdk/commit/ba42aeff39e77c2911fddb776676bf5ec3b6480d))
+* multipart encoding for file arrays ([00c8720](https://github.com/prelude-so/ruby-sdk/commit/00c87208d38c26848af8a20f0f2ab916d908ca95))
+* variable name typo ([2a83f6e](https://github.com/prelude-so/ruby-sdk/commit/2a83f6eff281991ab4736f6ce752cef42c7e4b60))
+
+
+### Chores
+
+* **ci:** skip lint on metadata-only changes ([ecdcd0b](https://github.com/prelude-so/ruby-sdk/commit/ecdcd0b15967ac9ab50887e24c9884804a72c2c7))
+* **ci:** support opting out of skipping builds on metadata-only commits ([86d205e](https://github.com/prelude-so/ruby-sdk/commit/86d205e651fbb5002655857a287ec09b0b2b4370))
+* **internal:** more robust bootstrap script ([1163c75](https://github.com/prelude-so/ruby-sdk/commit/1163c758b68ed31eb3ae60117d8850ba3417c829))
+* **tests:** bump steady to v0.19.6 ([9be6206](https://github.com/prelude-so/ruby-sdk/commit/9be6206e357ce0ab47da60230a356ed5d2e33bc3))
+* **tests:** bump steady to v0.19.7 ([e96d496](https://github.com/prelude-so/ruby-sdk/commit/e96d496b589f7a404288d92b8519ae25fc1f4c96))
+* **tests:** bump steady to v0.20.1 ([f9c136f](https://github.com/prelude-so/ruby-sdk/commit/f9c136fad7a342404cc80b6e5d10a0c5cce19d88))
+* **tests:** bump steady to v0.20.2 ([cf8ca21](https://github.com/prelude-so/ruby-sdk/commit/cf8ca215bacfb6606bfe3ca08db55bacef5c3d18))
+* **tests:** bump steady to v0.22.1 ([4223d7b](https://github.com/prelude-so/ruby-sdk/commit/4223d7b15d68b27d1029eb93e135a96e25244548))
+
+## 0.3.0 (2026-03-23)
+
+Full Changelog: [v0.2.0...v0.3.0](https://github.com/prelude-so/ruby-sdk/compare/v0.2.0...v0.3.0)
+
+### Features
+
+* **api:** api update ([24553b3](https://github.com/prelude-so/ruby-sdk/commit/24553b346bf3e424aa565b58dfc0a5ff339d0ffd))
+* **api:** api update ([c8e488b](https://github.com/prelude-so/ruby-sdk/commit/c8e488bc5106f22fd3c3e1e996aa865bf51ff3a1))
+* **api:** api update ([bc9d8d4](https://github.com/prelude-so/ruby-sdk/commit/bc9d8d41c941879192c531c1b5f07d619d4bfc7b))
+* **api:** api update ([1e8ea21](https://github.com/prelude-so/ruby-sdk/commit/1e8ea213c96c039d76722d6bc522e84e0ff0278f))
+* **api:** api update ([c339306](https://github.com/prelude-so/ruby-sdk/commit/c3393069dc67ed5ecaecb276b26c2308a00356d1))
+* **api:** api update ([ec6ca20](https://github.com/prelude-so/ruby-sdk/commit/ec6ca2085c7628b495b9486bd46c27656432e9eb))
+* **api:** api update ([64ca50e](https://github.com/prelude-so/ruby-sdk/commit/64ca50eae743d655d253c2ab6564eade851b60be))
+* **api:** api update ([240811f](https://github.com/prelude-so/ruby-sdk/commit/240811ffbc8caabaad46ce164bdb9ac3c6cbf9b0))
+
+
+### Bug Fixes
+
+* calling `break` out of streams should be instantaneous ([a880e79](https://github.com/prelude-so/ruby-sdk/commit/a880e79694d57969c34395666edbd365d5a65483))
+* **client:** add types for path params, and update structure of unions nested in params ([dff25fc](https://github.com/prelude-so/ruby-sdk/commit/dff25fc4134005a9e8a7f84d8fc6fbd5f9ac8098))
+* **client:** always add content-length to post body, even when empty ([73b8b98](https://github.com/prelude-so/ruby-sdk/commit/73b8b98d2f14602fb5b297a697d3894699659b84))
+* **client:** loosen json header parsing ([144e10b](https://github.com/prelude-so/ruby-sdk/commit/144e10bb50679a7748df724edf574a86fc8fbc9e))
+* **client:** serialize query parameters properly ([e59d46e](https://github.com/prelude-so/ruby-sdk/commit/e59d46eaa39b1033807c4c000cfb4220b1c8d0ff))
+* issue where json.parse errors when receiving HTTP 204 with nobody ([5960180](https://github.com/prelude-so/ruby-sdk/commit/59601805484363ad564d640ae2dec6a2eff08f26))
+* properly mock time in ruby ci tests ([19a7259](https://github.com/prelude-so/ruby-sdk/commit/19a7259d6c21e24e6773487981154c17215846f0))
+
+
+### Chores
+
+* **ci:** add build step ([9517e54](https://github.com/prelude-so/ruby-sdk/commit/9517e54b4ad0cf6bfeefdb9c227217f5f732cf27))
+* **ci:** skip uploading artifacts on stainless-internal branches ([b239f23](https://github.com/prelude-so/ruby-sdk/commit/b239f237e3b67cc6a01f992028fc5885336f6538))
+* **docs:** add missing descriptions ([874587d](https://github.com/prelude-so/ruby-sdk/commit/874587d45083a9a5e0fc188b378a9b8d58dd39a5))
+* **docs:** remove www prefix ([9c41466](https://github.com/prelude-so/ruby-sdk/commit/9c41466d86710318107d52692f8efb93515e9738))
+* **internal:** codegen related update ([4721c32](https://github.com/prelude-so/ruby-sdk/commit/4721c32fbc82220da55e561f4ad10ac22223108b))
+* **internal:** codegen related update ([d227583](https://github.com/prelude-so/ruby-sdk/commit/d227583e5a4a92a1cbc4bd75ed70b18df8a2f0ff))
+* **internal:** tweak CI branches ([1a3bb89](https://github.com/prelude-so/ruby-sdk/commit/1a3bb8905066138aec8da0bba42d3f699da7144f))
+* **internal:** update `actions/checkout` version ([dd49de2](https://github.com/prelude-so/ruby-sdk/commit/dd49de2c037b0f622d7cdead21ab464a1455363f))
+* **internal:** update gitignore ([603a4c6](https://github.com/prelude-so/ruby-sdk/commit/603a4c69350448463dae3f8d99d6aa09d0c48b1b))
+* **test:** do not count install time for mock server timeout ([77b5e70](https://github.com/prelude-so/ruby-sdk/commit/77b5e70ec2a773c70e55ca4cb3e527e8d2446459))
+* **tests:** bump steady to v0.19.4 ([001f050](https://github.com/prelude-so/ruby-sdk/commit/001f050d338b3015dba4527bc278795fadb04ac2))
+* **tests:** bump steady to v0.19.5 ([e824cb0](https://github.com/prelude-so/ruby-sdk/commit/e824cb0c8e2f3f601a4e07f7c36afeafcfff9b28))
+* update mock server docs ([6fa353c](https://github.com/prelude-so/ruby-sdk/commit/6fa353cd9d0112786119b6a50d96fc48c77253c3))
+
+
+### Refactors
+
+* **tests:** switch from prism to steady ([4f1499f](https://github.com/prelude-so/ruby-sdk/commit/4f1499f85472caac00731960ba4a9623131c57f6))
+
 ## 0.2.0 (2025-12-05)
 
 Full Changelog: [v0.1.0...v0.2.0](https://github.com/prelude-so/ruby-sdk/compare/v0.1.0...v0.2.0)

data/README.md

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

data/lib/prelude_sdk/client.rb

@@ -19,21 +19,28 @@ module PreludeSDK
     # @return [String]
     attr_reader :api_token
 
+    # Retrieve detailed information about a phone number including carrier data, line
+    # type, and portability status.
     # @return [PreludeSDK::Resources::Lookup]
     attr_reader :lookup
 
+    # Send transactional and marketing messages with compliance enforcement.
     # @return [PreludeSDK::Resources::Notify]
     attr_reader :notify
 
+    # Send transactional messages (deprecated - use Notify API instead).
     # @return [PreludeSDK::Resources::Transactional]
     attr_reader :transactional
 
+    # Verify phone numbers.
     # @return [PreludeSDK::Resources::Verification]
     attr_reader :verification
 
+    # Verify phone numbers.
     # @return [PreludeSDK::Resources::VerificationManagement]
     attr_reader :verification_management
 
+    # Evaluate email addresses and phone numbers for trustworthiness.
     # @return [PreludeSDK::Resources::Watch]
     attr_reader :watch
 
@@ -74,6 +81,19 @@ module PreludeSDK
         raise ArgumentError.new("api_token is required, and can be set via environ: \"API_TOKEN\"")
       end
 
+      headers = {}
+      custom_headers_env = ENV["PRELUDE_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env.split("\n").each do |line|
+          colon = line.index(":")
+          unless colon.nil?
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip
+          end
+        end
+        headers = parsed.merge(headers)
+      end
+
       @api_token = api_token.to_s
 
       super(
@@ -81,7 +101,8 @@ module PreludeSDK
         timeout: timeout,
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
-        max_retry_delay: max_retry_delay
+        max_retry_delay: max_retry_delay,
+        headers: headers
       )
 
       @lookup = PreludeSDK::Resources::Lookup.new(client: self)

data/lib/prelude_sdk/internal/transport/pooled_net_requester.rb

@@ -75,7 +75,7 @@ module PreludeSDK
 
             case body
             in nil
-              nil
+              req["content-length"] ||= 0 unless req["transfer-encoding"]
             in String
               req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"]
               req.body_stream = PreludeSDK::Internal::Util::ReadIOAdapter.new(body, &blk)
@@ -153,17 +153,19 @@ module PreludeSDK
                   end
 
                   self.class.calibrate_socket_timeout(conn, deadline)
-                  conn.request(req) do |rsp|
-                    y << [req, rsp]
-                    break if finished
-
-                    rsp.read_body do |bytes|
-                      y << bytes.force_encoding(Encoding::BINARY)
-                      break if finished
-
-                      self.class.calibrate_socket_timeout(conn, deadline)
+                  ::Kernel.catch(:jump) do
+                    conn.request(req) do |rsp|
+                      y << [req, rsp]
+                      ::Kernel.throw(:jump) if finished
+
+                      rsp.read_body do |bytes|
+                        y << bytes.force_encoding(Encoding::BINARY)
+                        ::Kernel.throw(:jump) if finished
+
+                        self.class.calibrate_socket_timeout(conn, deadline)
+                      end
+                      eof = true
                     end
-                    eof = true
                   end
                 end
               ensure

data/lib/prelude_sdk/internal/util.rb

@@ -157,7 +157,7 @@ module PreludeSDK
           in Hash | nil => coerced
             coerced
           else
-            message = "Expected a #{Hash} or #{PreludeSDK::Internal::Type::BaseModel}, got #{data.inspect}"
+            message = "Expected a #{Hash} or #{PreludeSDK::Internal::Type::BaseModel}, got #{input.inspect}"
             raise ArgumentError.new(message)
           end
         end
@@ -237,6 +237,11 @@ module PreludeSDK
         end
       end
 
+      # @type [Regexp]
+      #
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = /[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/
+
       class << self
         # @api private
         #
@@ -247,6 +252,15 @@ module PreludeSDK
           "#{uri.scheme}://#{uri.host}#{":#{uri.port}" unless uri.port == uri.default_port}"
         end
 
+        # @api private
+        #
+        # @param path [String, Integer]
+        #
+        # @return [String]
+        def encode_path(path)
+          path.to_s.gsub(PreludeSDK::Internal::Util::RFC_3986_NOT_PCHARS) { ERB::Util.url_encode(_1) }
+        end
+
         # @api private
         #
         # @param path [String, Array<String>]
@@ -259,7 +273,7 @@ module PreludeSDK
           in []
             ""
           in [String => p, *interpolations]
-            encoded = interpolations.map { ERB::Util.url_encode(_1) }
+            encoded = interpolations.map { encode_path(_1) }
             format(p, *encoded)
           end
         end
@@ -485,11 +499,42 @@ module PreludeSDK
       end
 
       # @type [Regexp]
-      JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}
+      JSON_CONTENT = %r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}
       # @type [Regexp]
       JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 
       class << self
+        # @api private
+        #
+        # @param query [Hash{Symbol=>Object}]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def encode_query_params(query)
+          out = {}
+          query.each { write_query_param_element!(out, _1, _2) }
+          out
+        end
+
+        # @api private
+        #
+        # @param collection [Hash{Symbol=>Object}]
+        # @param key [String]
+        # @param element [Object]
+        #
+        # @return [nil]
+        private def write_query_param_element!(collection, key, element)
+          case element
+          in Hash
+            element.each do |name, value|
+              write_query_param_element!(collection, "#{key}[#{name}]", value)
+            end
+          in Array
+            collection[key] = element.map(&:to_s).join(",")
+          else
+            collection[key] = element.to_s
+          end
+        end
+
         # @api private
         #
         # @param y [Enumerator::Yielder]
@@ -540,16 +585,15 @@ module PreludeSDK
           y << "Content-Disposition: form-data"
 
           unless key.nil?
-            name = ERB::Util.url_encode(key.to_s)
-            y << "; name=\"#{name}\""
+            y << "; name=\"#{key}\""
           end
 
           case val
           in PreludeSDK::FilePart unless val.filename.nil?
-            filename = ERB::Util.url_encode(val.filename)
+            filename = encode_path(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(::File.basename(val.to_path))
+            filename = encode_path(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end
@@ -566,6 +610,7 @@ module PreludeSDK
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
+          # rubocop:disable Style/CaseEquality
           # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
           boundary = SecureRandom.urlsafe_base64(46)
 
@@ -575,7 +620,7 @@ module PreludeSDK
             in Hash
               body.each do |key, val|
                 case val
-                in Array if val.all? { primitive?(_1) }
+                in Array if val.all? { primitive?(_1) || PreludeSDK::Internal::Type::FileInput === _1 }
                   val.each do |v|
                     write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
                   end
@@ -591,6 +636,7 @@ module PreludeSDK
 
           fused_io = fused_enum(strio) { closing.each(&:call) }
           [boundary, fused_io]
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private
@@ -657,7 +703,8 @@ module PreludeSDK
         def decode_content(headers, stream:, suppress_error: false)
           case (content_type = headers["content-type"])
           in PreludeSDK::Internal::Util::JSON_CONTENT
-            json = stream.to_a.join
+            return nil if (json = stream.to_a.join).empty?
+
             begin
               JSON.parse(json, symbolize_names: true)
             rescue JSON::ParserError => e
@@ -667,7 +714,11 @@ module PreludeSDK
           in PreludeSDK::Internal::Util::JSONL_CONTENT
             lines = decode_lines(stream)
             chain_fused(lines) do |y|
-              lines.each { y << JSON.parse(_1, symbolize_names: true) }
+              lines.each do
+                next if _1.empty?
+
+                y << JSON.parse(_1, symbolize_names: true)
+              end
             end
           in %r{^text/event-stream}
             lines = decode_lines(stream)

data/lib/prelude_sdk/models/lookup_lookup_params.rb

@@ -7,6 +7,12 @@ module PreludeSDK
       extend PreludeSDK::Internal::Type::RequestParameters::Converter
       include PreludeSDK::Internal::Type::RequestParameters
 
+      # @!attribute phone_number
+      #   An E.164 formatted phone number to look up.
+      #
+      #   @return [String]
+      required :phone_number, String
+
       # @!attribute type
       #   Optional features. Possible values are:
       #
@@ -16,10 +22,12 @@ module PreludeSDK
       #   @return [Array<Symbol, PreludeSDK::Models::LookupLookupParams::Type>, nil]
       optional :type, -> { PreludeSDK::Internal::Type::ArrayOf[enum: PreludeSDK::LookupLookupParams::Type] }
 
-      # @!method initialize(type: nil, request_options: {})
+      # @!method initialize(phone_number:, type: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::LookupLookupParams} for more details.
       #
+      #   @param phone_number [String] An E.164 formatted phone number to look up.
+      #
       #   @param type [Array<Symbol, PreludeSDK::Models::LookupLookupParams::Type>] Optional features. Possible values are:
       #
       #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]

data/lib/prelude_sdk/models/notify_get_subscription_config_params.rb

@@ -7,7 +7,13 @@ module PreludeSDK
       extend PreludeSDK::Internal::Type::RequestParameters::Converter
       include PreludeSDK::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute config_id
+      #
+      #   @return [String]
+      required :config_id, String
+
+      # @!method initialize(config_id:, request_options: {})
+      #   @param config_id [String]
       #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/prelude_sdk/models/notify_get_subscription_phone_number_params.rb

@@ -12,8 +12,14 @@ module PreludeSDK
       #   @return [String]
       required :config_id, String
 
-      # @!method initialize(config_id:, request_options: {})
+      # @!attribute phone_number
+      #
+      #   @return [String]
+      required :phone_number, String
+
+      # @!method initialize(config_id:, phone_number:, request_options: {})
       #   @param config_id [String]
+      #   @param phone_number [String]
       #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/prelude_sdk/models/notify_list_subscription_phone_number_events_params.rb

@@ -12,6 +12,11 @@ module PreludeSDK
       #   @return [String]
       required :config_id, String
 
+      # @!attribute phone_number
+      #
+      #   @return [String]
+      required :phone_number, String
+
       # @!attribute cursor
       #   Pagination cursor from the previous response
       #
@@ -24,9 +29,11 @@ module PreludeSDK
       #   @return [Integer, nil]
       optional :limit, Integer
 
-      # @!method initialize(config_id:, cursor: nil, limit: nil, request_options: {})
+      # @!method initialize(config_id:, phone_number:, cursor: nil, limit: nil, request_options: {})
       #   @param config_id [String]
       #
+      #   @param phone_number [String]
+      #
       #   @param cursor [String] Pagination cursor from the previous response
       #
       #   @param limit [Integer] Maximum number of events to return per page

data/lib/prelude_sdk/models/notify_list_subscription_phone_numbers_params.rb

@@ -7,6 +7,11 @@ module PreludeSDK
       extend PreludeSDK::Internal::Type::RequestParameters::Converter
       include PreludeSDK::Internal::Type::RequestParameters
 
+      # @!attribute config_id
+      #
+      #   @return [String]
+      required :config_id, String
+
       # @!attribute cursor
       #   Pagination cursor from the previous response
       #
@@ -25,7 +30,9 @@ module PreludeSDK
       #   @return [Symbol, PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams::State, nil]
       optional :state, enum: -> { PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State }
 
-      # @!method initialize(cursor: nil, limit: nil, state: nil, request_options: {})
+      # @!method initialize(config_id:, cursor: nil, limit: nil, state: nil, request_options: {})
+      #   @param config_id [String]
+      #
       #   @param cursor [String] Pagination cursor from the previous response
       #
       #   @param limit [Integer] Maximum number of phone numbers to return per page

data/lib/prelude_sdk/models/notify_send_batch_params.rb

@@ -31,6 +31,21 @@ module PreludeSDK
       #   @return [String, nil]
       optional :correlation_id, String
 
+      # @!attribute document
+      #   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.
+      #
+      #   @return [PreludeSDK::Models::NotifySendBatchParams::Document, nil]
+      optional :document, -> { PreludeSDK::NotifySendBatchParams::Document }
+
       # @!attribute expires_at
       #   The message expiration date in RFC3339 format. Messages will not be sent after
       #   this time.
@@ -69,7 +84,7 @@ module PreludeSDK
       #   @return [Hash{Symbol=>String}, nil]
       optional :variables, PreludeSDK::Internal::Type::HashOf[String]
 
-      # @!method initialize(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: {})
+      # @!method initialize(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: {})
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::NotifySendBatchParams} for more details.
       #
@@ -81,6 +96,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 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
       #
       #   @param from [String] The Sender ID. Must be approved for your account.
@@ -95,11 +112,48 @@ module PreludeSDK
       #
       #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
 
+      class Document < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute 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).
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute filename
+        #   Filename displayed to the recipient. Required for templates with a `DOCUMENT`
+        #   header; ignored for `IMAGE` and `VIDEO` headers.
+        #
+        #   @return [String, nil]
+        optional :filename, String
+
+        # @!method initialize(url:, filename: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::NotifySendBatchParams::Document} for more details.
+        #
+        #   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.
+        #
+        #   @param url [String] HTTPS URL of the media file. The file extension must match the template's regist
+        #
+        #   @param filename [String] Filename displayed to the recipient. Required for templates with a `DOCUMENT` he
+      end
+
       # Preferred channel for delivery. If unavailable, automatic fallback applies.
       module PreferredChannel
         extend PreludeSDK::Internal::Type::Enum
 
         SMS = :sms
+        RCS = :rcs
         WHATSAPP = :whatsapp
 
         # @!method self.values

data/lib/prelude_sdk/models/notify_send_batch_response.rb

@@ -146,6 +146,22 @@ module PreludeSDK
           #   @return [Time, nil]
           optional :created_at, Time
 
+          # @!attribute encoding
+          #   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.
+          #
+          #   @return [Symbol, PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding, nil]
+          optional :encoding, enum: -> { PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding }
+
+          # @!attribute estimated_segment_count
+          #   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.
+          #
+          #   @return [Integer, nil]
+          optional :estimated_segment_count, Integer
+
           # @!attribute expires_at
           #   The message expiration date in RFC3339 format.
           #
@@ -176,7 +192,10 @@ module PreludeSDK
           #   @return [String, nil]
           optional :to, String
 
-          # @!method initialize(id: nil, correlation_id: nil, created_at: nil, expires_at: nil, from: nil, locale: nil, schedule_at: nil, to: nil)
+          # @!method initialize(id: nil, correlation_id: nil, created_at: nil, encoding: nil, estimated_segment_count: nil, expires_at: nil, from: nil, locale: nil, schedule_at: nil, to: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {PreludeSDK::Models::NotifySendBatchResponse::Result::Message} for more details.
+          #
           #   Present only if success is true.
           #
           #   @param id [String] The message identifier.
@@ -185,6 +204,10 @@ module PreludeSDK
           #
           #   @param created_at [Time] The message creation date in RFC3339 format.
           #
+          #   @param encoding [Symbol, PreludeSDK::Models::NotifySendBatchResponse::Result::Message::Encoding] The SMS encoding type based on message content. GSM-7 supports standard characte
+          #
+          #   @param estimated_segment_count [Integer] The estimated number of SMS segments for this message. This value is not contrac
+          #
           #   @param expires_at [Time] The message expiration date in RFC3339 format.
           #
           #   @param from [String] The Sender ID used for this message.
@@ -194,6 +217,21 @@ module PreludeSDK
           #   @param schedule_at [Time] When the message will actually be sent in RFC3339 format with timezone offset.
           #
           #   @param to [String] The recipient's phone number in E.164 format.
+
+          # 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.
+          #
+          # @see PreludeSDK::Models::NotifySendBatchResponse::Result::Message#encoding
+          module Encoding
+            extend PreludeSDK::Internal::Type::Enum
+
+            GSM_7 = :"GSM-7"
+            UCS_2 = :"UCS-2"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
       end
     end