prelude-sdk 0.1.0.pre.alpha.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f92fe6a16b20591bab5d7212829340cb90ece7b18a1c0ab76c90d5c2444ca7a
-  data.tar.gz: 83cb5e4ec4af8adc647af9a1e69ccfbed0b69d9cdabd407a3dd964542902eca8
+  metadata.gz: bdd2764aef5a2905ae9ff686383745a878831c2402b1858f60025c4185f9fce1
+  data.tar.gz: be34c995e5c189bd7bfc38a03f30d0e399376ffdbb70f42c3776f64df56de7e4
 SHA512:
-  metadata.gz: 00ab2023d3b9f12f43fefde4186d2214926e54f5efe6ecac2a22cbdeab3db9b5019c7ff1967d4ab596db4f4e8ba1cd847f597e712ade232967acf4cafe215bf0
-  data.tar.gz: ad64312be23a8b2200656143841ec8296f9454be8bc78368bb28a4618f4c8cdd09b333747cf9548c5ba5bf227187795da4f3c6ca395a092071d958ad31d7ae19
+  metadata.gz: 953de3f45bdc0854d720388783118e6daff94fcfda5fa3de09bace85598b61e7165f87ac2439f1c275822e80f6811d711c055d2d8b5399824aec74f2dd715208
+  data.tar.gz: c7b590b961d3bcdb03aafbcc97fa3d4c80e0ac59a70a2dd79451000fe300b702c90a1cb30f7a6fa8c0604c73365f4e5fbb0da7a05e0df2aa77a1ee672ce5e008

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 # Changelog
 
+## 0.1.0 (2025-11-17)
+
+Full Changelog: [v0.1.0-alpha.3...v0.1.0](https://github.com/prelude-so/ruby-sdk/compare/v0.1.0-alpha.3...v0.1.0)
+
+### Features
+
+* **api:** api update ([c9e65c1](https://github.com/prelude-so/ruby-sdk/commit/c9e65c116529da3a8e5aa86a562b7fed5cf4a97a))
+* **api:** api update ([bf8dee6](https://github.com/prelude-so/ruby-sdk/commit/bf8dee60be19b83b817ece1f9004cfaec2e85e4f))
+* **api:** api update ([9d565ad](https://github.com/prelude-so/ruby-sdk/commit/9d565ad99b6b46c7d17934bd68273f3d82fe9d85))
+* **api:** api update ([4fd18f8](https://github.com/prelude-so/ruby-sdk/commit/4fd18f8a058510eb8d930d819d31cb6f6173f83a))
+* **api:** api update ([69a221a](https://github.com/prelude-so/ruby-sdk/commit/69a221a42fcaec93f98d63caf9d17766be47fbc6))
+* **api:** api update ([4af700e](https://github.com/prelude-so/ruby-sdk/commit/4af700e93bc5cf28d97ff79885834e81b57da1a4))
+* **api:** api update ([0c33db9](https://github.com/prelude-so/ruby-sdk/commit/0c33db9825b569f3a89e225b154340c4c310479f))
+* **api:** api update ([445cbad](https://github.com/prelude-so/ruby-sdk/commit/445cbadbafa387f8650e669062177e7224105de7))
+* **api:** api update ([595d9ef](https://github.com/prelude-so/ruby-sdk/commit/595d9ef60705cb032562fd76150bb9aacf9626d6))
+* **api:** expose phone numbers management methods ([f941fe5](https://github.com/prelude-so/ruby-sdk/commit/f941fe55ce85520986895f042146e59f192ed48d))
+* **api:** expose verification management methods ([b9b9495](https://github.com/prelude-so/ruby-sdk/commit/b9b94955da54d2d44b0a1592abe73337e4087ec3))
+* expose response headers for both streams and errors ([fc2ae79](https://github.com/prelude-so/ruby-sdk/commit/fc2ae79a34a537cda6aa82b63a0c26b83a393cd2))
+* handle thread interrupts in the core HTTP client ([866b344](https://github.com/prelude-so/ruby-sdk/commit/866b344df136a37851b378b07f228c815ca79636))
+
+
+### Bug Fixes
+
+* absolutely qualified uris should always override the default ([68aaf0e](https://github.com/prelude-so/ruby-sdk/commit/68aaf0eb2327e02d5b031ec0a89e7b732ad420f7))
+* always send `filename=...` for multipart requests where a file is expected ([da05b08](https://github.com/prelude-so/ruby-sdk/commit/da05b084037001a449e416128ccd45467e3c364b))
+* better thread safety via early initializing SSL store during HTTP client creation ([5e8ee30](https://github.com/prelude-so/ruby-sdk/commit/5e8ee30cb5783924438c63e8235ae2b4c58eafcc))
+* coroutine leaks from connection pool ([ed37e6b](https://github.com/prelude-so/ruby-sdk/commit/ed37e6b16456986d82b11232f097721ef8a40638))
+* **internal:** use null byte as file separator in the fast formatting script ([d665d3a](https://github.com/prelude-so/ruby-sdk/commit/d665d3a0675b0b96be78135d06e683f1ec170321))
+* shorten multipart boundary sep to less than RFC specificed max length ([bd7c735](https://github.com/prelude-so/ruby-sdk/commit/bd7c7352f57c8f18669454fe537e0e6a747333c4))
+* should not reuse buffers for `IO.copy_stream` interop ([a81068b](https://github.com/prelude-so/ruby-sdk/commit/a81068b77b064aec1a6dcffa475259b664f6beb9))
+
+
+### Performance Improvements
+
+* faster code formatting ([0b96741](https://github.com/prelude-so/ruby-sdk/commit/0b9674139c6ec176f9778f4fd6ef0c21b260fd10))
+
+
+### Chores
+
+* allow fast-format to use bsd sed as well ([5e8c0c0](https://github.com/prelude-so/ruby-sdk/commit/5e8c0c0a63e8e20622e79102d7e17a59591a9b87))
+* **client:** send user-agent header ([0da478a](https://github.com/prelude-so/ruby-sdk/commit/0da478a2be5493927b58d9f162626ca900d400d8))
+* do not install brew dependencies in ./scripts/bootstrap by default ([4604e34](https://github.com/prelude-so/ruby-sdk/commit/4604e34fa43c84c180974e36ce957ff5e4afe515))
+* ignore linter error for tests having large collections ([b76b678](https://github.com/prelude-so/ruby-sdk/commit/b76b678af0a7bf7de20974c5d6e87ab1cc5ca816))
+* **internal:** codegen related update ([b5d6135](https://github.com/prelude-so/ruby-sdk/commit/b5d61356ba2806cb9d24ee7aeb982dd20485da3a))
+
 ## 0.1.0-alpha.3 (2025-09-02)
 
 Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/prelude-so/ruby-sdk/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)

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.1.0.pre.alpha.3"
+gem "prelude-sdk", "~> 0.1.0"
 ```
 
 <!-- x-release-please-end -->
@@ -202,6 +202,34 @@ params = PreludeSDK::VerificationCreateParams.new(
 prelude.verification.create(**params)
 ```
 
+### Enums
+
+Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
+
+```ruby
+# :allow
+puts(PreludeSDK::VerificationManagementDeletePhoneNumberParams::Action::ALLOW)
+
+# Revealed type: `T.all(PreludeSDK::VerificationManagementDeletePhoneNumberParams::Action, Symbol)`
+T.reveal_type(PreludeSDK::VerificationManagementDeletePhoneNumberParams::Action::ALLOW)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+# Using the enum constants preserves the tagged type information:
+prelude.verification_management.delete_phone_number(
+  action: PreludeSDK::VerificationManagementDeletePhoneNumberParams::Action::ALLOW,
+  # …
+)
+
+# Literal values are also permissible:
+prelude.verification_management.delete_phone_number(
+  action: :allow,
+  # …
+)
+```
+
 ## Versioning
 
 This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.

data/lib/prelude_sdk/client.rb

@@ -28,6 +28,9 @@ module PreludeSDK
     # @return [PreludeSDK::Resources::Verification]
     attr_reader :verification
 
+    # @return [PreludeSDK::Resources::VerificationManagement]
+    attr_reader :verification_management
+
     # @return [PreludeSDK::Resources::Watch]
     attr_reader :watch
 
@@ -81,6 +84,7 @@ module PreludeSDK
       @lookup = PreludeSDK::Resources::Lookup.new(client: self)
       @transactional = PreludeSDK::Resources::Transactional.new(client: self)
       @verification = PreludeSDK::Resources::Verification.new(client: self)
+      @verification_management = PreludeSDK::Resources::VerificationManagement.new(client: self)
       @watch = PreludeSDK::Resources::Watch.new(client: self)
     end
   end

data/lib/prelude_sdk/errors.rb

@@ -40,6 +40,9 @@ module PreludeSDK
       # @return [Integer, nil]
       attr_accessor :status
 
+      # @return [Hash{String=>String}, nil]
+      attr_accessor :headers
+
       # @return [Object, nil]
       attr_accessor :body
 
@@ -47,13 +50,15 @@ module PreludeSDK
       #
       # @param url [URI::Generic]
       # @param status [Integer, nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+      def initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: nil)
         @url = url
         @status = status
+        @headers = headers
         @body = body
         @request = request
         @response = response
@@ -74,6 +79,7 @@ module PreludeSDK
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -81,6 +87,7 @@ module PreludeSDK
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -95,6 +102,7 @@ module PreludeSDK
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -102,6 +110,7 @@ module PreludeSDK
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -116,21 +125,24 @@ module PreludeSDK
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
       #
       # @return [self]
-      def self.for(url:, status:, body:, request:, response:, message: nil)
-        kwargs = {
-          url: url,
-          status: status,
-          body: body,
-          request: request,
-          response: response,
-          message: message
-        }
+      def self.for(url:, status:, headers:, body:, request:, response:, message: nil)
+        kwargs =
+          {
+            url: url,
+            status: status,
+            headers: headers,
+            body: body,
+            request: request,
+            response: response,
+            message: message
+          }
 
         case status
         in 400
@@ -162,15 +174,17 @@ module PreludeSDK
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status:, body:, request:, response:, message: nil)
+      def initialize(url:, status:, headers:, body:, request:, response:, message: nil)
         message ||= {url: url.to_s, status: status, body: body}
         super(
           url: url,
           status: status,
+          headers: headers,
           body: body,
           request: request,
           response: response,

data/lib/prelude_sdk/file_part.rb

@@ -38,18 +38,21 @@ module PreludeSDK
     def to_yaml(*a) = read.to_yaml(*a)
 
     # @param content [Pathname, StringIO, IO, String]
-    # @param filename [String, nil]
+    # @param filename [Pathname, String, nil]
     # @param content_type [String, nil]
     def initialize(content, filename: nil, content_type: nil)
-      @content = content
+      @content_type = content_type
       @filename =
-        case content
-        in Pathname
-          filename.nil? ? content.basename.to_path : ::File.basename(filename)
+        case [filename, (@content = content)]
+        in [String | Pathname, _]
+          ::File.basename(filename)
+        in [nil, Pathname]
+          content.basename.to_path
+        in [nil, IO]
+          content.to_path
         else
-          filename.nil? ? nil : ::File.basename(filename)
+          filename
         end
-      @content_type = content_type
     end
   end
 end

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

@@ -47,7 +47,7 @@ module PreludeSDK
           # @api private
           #
           # @param status [Integer]
-          # @param headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param headers [Hash{String=>String}]
           #
           # @return [Boolean]
           def should_retry?(status, headers:)
@@ -85,7 +85,7 @@ module PreludeSDK
           #
           # @param status [Integer]
           #
-          # @param response_headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param response_headers [Hash{String=>String}]
           #
           # @return [Hash{Symbol=>Object}]
           def follow_redirect(request, status:, response_headers:)
@@ -201,7 +201,8 @@ module PreludeSDK
             self.class::PLATFORM_HEADERS,
             {
               "accept" => "application/json",
-              "content-type" => "application/json"
+              "content-type" => "application/json",
+              "user-agent" => user_agent
             },
             headers
           )
@@ -219,6 +220,11 @@ module PreludeSDK
         # @return [Hash{String=>String}]
         private def auth_headers = {}
 
+        # @api private
+        #
+        # @return [String]
+        private def user_agent = "#{self.class.name}/Ruby #{PreludeSDK::VERSION}"
+
         # @api private
         #
         # @return [String]
@@ -378,6 +384,7 @@ module PreludeSDK
           rescue PreludeSDK::Errors::APIConnectionError => e
             status = e
           end
+          headers = PreludeSDK::Internal::Util.normalized_headers(response&.each_header&.to_h)
 
           case status
           in ..299
@@ -390,7 +397,7 @@ module PreludeSDK
           in 300..399
             self.class.reap_connection!(status, stream: stream)
 
-            request = self.class.follow_redirect(request, status: status, response_headers: response)
+            request = self.class.follow_redirect(request, status: status, response_headers: headers)
             send_request(
               request,
               redirect_count: redirect_count + 1,
@@ -399,9 +406,9 @@ module PreludeSDK
             )
           in PreludeSDK::Errors::APIConnectionError if retry_count >= max_retries
             raise status
-          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: response)
+          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: headers)
             decoded = Kernel.then do
-              PreludeSDK::Internal::Util.decode_content(response, stream: stream, suppress_error: true)
+              PreludeSDK::Internal::Util.decode_content(headers, stream: stream, suppress_error: true)
             ensure
               self.class.reap_connection!(status, stream: stream)
             end
@@ -409,6 +416,7 @@ module PreludeSDK
             raise PreludeSDK::Errors::APIStatusError.for(
               url: url,
               status: status,
+              headers: headers,
               body: decoded,
               request: nil,
               response: response
@@ -485,19 +493,21 @@ module PreludeSDK
             send_retry_header: send_retry_header
           )
 
-          decoded = PreludeSDK::Internal::Util.decode_content(response, stream: stream)
+          headers = PreludeSDK::Internal::Util.normalized_headers(response.each_header.to_h)
+          decoded = PreludeSDK::Internal::Util.decode_content(headers, stream: stream)
           case req
           in {stream: Class => st}
             st.new(
               model: model,
               url: url,
               status: status,
+              headers: headers,
               response: response,
               unwrap: unwrap,
               stream: decoded
             )
           in {page: Class => page}
-            page.new(client: self, req: req, headers: response, page_data: decoded)
+            page.new(client: self, req: req, headers: headers, page_data: decoded)
           else
             unwrapped = PreludeSDK::Internal::Util.dig(decoded, unwrap)
             PreludeSDK::Internal::Type::Converter.coerce(model, unwrapped)

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

@@ -16,10 +16,11 @@ module PreludeSDK
         class << self
           # @api private
           #
+          # @param cert_store [OpenSSL::X509::Store]
           # @param url [URI::Generic]
           #
           # @return [Net::HTTP]
-          def connect(url)
+          def connect(cert_store:, url:)
             port =
               case [url.port, url.scheme]
               in [Integer, _]
@@ -33,6 +34,8 @@ module PreludeSDK
             Net::HTTP.new(url.host, port).tap do
               _1.use_ssl = %w[https wss].include?(url.scheme)
               _1.max_retries = 0
+
+              (_1.cert_store = cert_store) if _1.use_ssl?
             end
           end
 
@@ -102,7 +105,7 @@ module PreludeSDK
           pool =
             @mutex.synchronize do
               @pools[origin] ||= ConnectionPool.new(size: @size) do
-                self.class.connect(url)
+                self.class.connect(cert_store: @cert_store, url: url)
               end
             end
 
@@ -128,37 +131,47 @@ module PreludeSDK
           url, deadline = request.fetch_values(:url, :deadline)
 
           req = nil
-          eof = false
           finished = false
-          closing = nil
 
           # rubocop:disable Metrics/BlockLength
           enum = Enumerator.new do |y|
-            with_pool(url, deadline: deadline) do |conn|
-              next if finished
-
-              req, closing = self.class.build_request(request) do
-                self.class.calibrate_socket_timeout(conn, deadline)
-              end
-
-              self.class.calibrate_socket_timeout(conn, deadline)
-              unless conn.started?
-                conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
-                conn.start
-              end
+            next if finished
 
-              self.class.calibrate_socket_timeout(conn, deadline)
-              conn.request(req) do |rsp|
-                y << [conn, req, rsp]
-                break if finished
+            with_pool(url, deadline: deadline) do |conn|
+              eof = false
+              closing = nil
+              ::Thread.handle_interrupt(Object => :never) do
+                ::Thread.handle_interrupt(Object => :immediate) do
+                  req, closing = self.class.build_request(request) do
+                    self.class.calibrate_socket_timeout(conn, deadline)
+                  end
 
-                rsp.read_body do |bytes|
-                  y << bytes.force_encoding(Encoding::BINARY)
-                  break if finished
+                  self.class.calibrate_socket_timeout(conn, deadline)
+                  unless conn.started?
+                    conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
+                    conn.start
+                  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)
+                    end
+                    eof = true
+                  end
+                end
+              ensure
+                begin
+                  conn.finish if !eof && conn&.started?
+                ensure
+                  closing&.call
                 end
-                eof = true
               end
             end
           rescue Timeout::Error
@@ -168,17 +181,10 @@ module PreludeSDK
           end
           # rubocop:enable Metrics/BlockLength
 
-          conn, _, response = enum.next
+          _, response = enum.next
           body = PreludeSDK::Internal::Util.fused_enum(enum, external: true) do
             finished = true
-            tap do
-              enum.next
-            rescue StopIteration
-              nil
-            end
-          ensure
-            conn.finish if !eof && conn&.started?
-            closing&.call
+            loop { enum.next }
           end
           [Integer(response.code), response, body]
         end
@@ -189,6 +195,7 @@ module PreludeSDK
         def initialize(size: self.class::DEFAULT_MAX_CONNECTIONS)
           @mutex = Mutex.new
           @size = size
+          @cert_store = OpenSSL::X509::Store.new.tap(&:set_default_paths)
           @pools = {}
         end
 

data/lib/prelude_sdk/internal/type/base_page.rb

@@ -39,7 +39,7 @@ module PreludeSDK
         #
         # @param client [PreludeSDK::Internal::Transport::BaseClient]
         # @param req [Hash{Symbol=>Object}]
-        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param headers [Hash{String=>String}]
         # @param page_data [Object]
         def initialize(client:, req:, headers:, page_data:)
           @client = client

data/lib/prelude_sdk/internal/type/file_input.rb

@@ -82,17 +82,20 @@ module PreludeSDK
           #
           # @return [Pathname, StringIO, IO, String, Object]
           def dump(value, state:)
-            # rubocop:disable Lint/DuplicateBranch
             case value
+            in StringIO | String
+              # https://datatracker.ietf.org/doc/html/rfc7578#section-4.2
+              # while not required, a filename is recommended, and in practice many servers do expect this
+              PreludeSDK::FilePart.new(value, filename: "upload")
             in IO
               state[:can_retry] = false
+              value.to_path.nil? ? PreludeSDK::FilePart.new(value, filename: "upload") : value
             in PreludeSDK::FilePart if value.content.is_a?(IO)
               state[:can_retry] = false
+              value
             else
+              value
             end
-            # rubocop:enable Lint/DuplicateBranch
-
-            value
           end
 
           # @api private

data/lib/prelude_sdk/internal/util.rb

@@ -346,8 +346,9 @@ module PreludeSDK
           base_path, base_query = lhs.fetch_values(:path, :query)
           slashed = base_path.end_with?("/") ? base_path : "#{base_path}/"
 
-          parsed_path, parsed_query = parse_uri(rhs.fetch(:path)).fetch_values(:path, :query)
-          override = URI::Generic.build(**rhs.slice(:scheme, :host, :port), path: parsed_path)
+          merged = {**parse_uri(rhs.fetch(:path)), **rhs.except(:path, :query)}
+          parsed_path, parsed_query = merged.fetch_values(:path, :query)
+          override = URI::Generic.build(**merged.slice(:scheme, :host, :port), path: parsed_path)
 
           joined = URI.join(URI::Generic.build(lhs.except(:path, :query)), slashed, override)
           query = deep_merge(
@@ -473,10 +474,9 @@ module PreludeSDK
         # @return [Enumerable<String>]
         def writable_enum(&blk)
           Enumerator.new do |y|
-            buf = String.new
             y.define_singleton_method(:write) do
-              self << buf.replace(_1)
-              buf.bytesize
+              self << _1.dup
+              _1.bytesize
             end
 
             blk.call(y)
@@ -566,7 +566,8 @@ module PreludeSDK
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
-          boundary = SecureRandom.urlsafe_base64(60)
+          # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
+          boundary = SecureRandom.urlsafe_base64(46)
 
           closing = []
           strio = writable_enum do |y|
@@ -647,7 +648,7 @@ module PreludeSDK
         #
         # Assumes each chunk in stream has `Encoding::BINARY`.
         #
-        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param headers [Hash{String=>String}]
         # @param stream [Enumerable<String>]
         # @param suppress_error [Boolean]
         #

data/lib/prelude_sdk/models/transactional_send_params.rb

@@ -54,13 +54,27 @@ module PreludeSDK
       #   @return [String, nil]
       optional :locale, String
 
+      # @!attribute preferred_channel
+      #   The preferred delivery channel for the message. When specified, the system will
+      #   prioritize sending via the requested channel if the template is configured for
+      #   it.
+      #
+      #   If not specified and the template is configured for WhatsApp, the message will
+      #   be sent via WhatsApp first, with automatic fallback to SMS if WhatsApp delivery
+      #   is unavailable.
+      #
+      #   Supported channels: `sms`, `rcs`, `whatsapp`.
+      #
+      #   @return [Symbol, PreludeSDK::Models::TransactionalSendParams::PreferredChannel, nil]
+      optional :preferred_channel, enum: -> { PreludeSDK::TransactionalSendParams::PreferredChannel }
+
       # @!attribute variables
       #   The variables to be replaced in the template.
       #
       #   @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, variables: nil, request_options: {})
+      # @!method initialize(template_id:, to:, callback_url: nil, correlation_id: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, variables: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::TransactionalSendParams} for more details.
       #
@@ -78,9 +92,31 @@ module PreludeSDK
       #
       #   @param locale [String] A BCP-47 formatted locale string with the language the text message will be sent
       #
+      #   @param preferred_channel [Symbol, PreludeSDK::Models::TransactionalSendParams::PreferredChannel] The preferred delivery channel for the message. When specified, the system will
+      #
       #   @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.
       #
       #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # The preferred delivery channel for the message. When specified, the system will
+      # prioritize sending via the requested channel if the template is configured for
+      # it.
+      #
+      # If not specified and the template is configured for WhatsApp, the message will
+      # be sent via WhatsApp first, with automatic fallback to SMS if WhatsApp delivery
+      # is unavailable.
+      #
+      # Supported channels: `sms`, `rcs`, `whatsapp`.
+      module PreferredChannel
+        extend PreludeSDK::Internal::Type::Enum
+
+        SMS = :sms
+        RCS = :rcs
+        WHATSAPP = :whatsapp
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end