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

data/rbi/prelude_sdk/errors.rbi

@@ -33,6 +33,9 @@ module PreludeSDK
       sig { returns(T.nilable(Integer)) }
       attr_accessor :status
 
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :headers
+
       sig { returns(T.nilable(T.anything)) }
       attr_accessor :body
 
@@ -41,6 +44,7 @@ module PreludeSDK
         params(
           url: URI::Generic,
           status: T.nilable(Integer),
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
@@ -50,6 +54,7 @@ module PreludeSDK
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -59,10 +64,10 @@ module PreludeSDK
     end
 
     class APIConnectionError < PreludeSDK::Errors::APIError
-      sig { void }
+      sig { returns(NilClass) }
       attr_accessor :status
 
-      sig { void }
+      sig { returns(NilClass) }
       attr_accessor :body
 
       # @api private
@@ -70,6 +75,7 @@ module PreludeSDK
         params(
           url: URI::Generic,
           status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
           body: NilClass,
           request: NilClass,
           response: NilClass,
@@ -79,6 +85,7 @@ module PreludeSDK
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -93,6 +100,7 @@ module PreludeSDK
         params(
           url: URI::Generic,
           status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
           body: NilClass,
           request: NilClass,
           response: NilClass,
@@ -102,6 +110,7 @@ module PreludeSDK
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -116,13 +125,22 @@ module PreludeSDK
         params(
           url: URI::Generic,
           status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
         ).returns(T.attached_class)
       end
-      def self.for(url:, status:, body:, request:, response:, message: nil)
+      def self.for(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
       end
 
       sig { returns(Integer) }
@@ -133,13 +151,22 @@ module PreludeSDK
         params(
           url: URI::Generic,
           status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
         ).returns(T.attached_class)
       end
-      def self.new(url:, status:, body:, request:, response:, message: nil)
+      def self.new(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
       end
     end
 

data/rbi/prelude_sdk/file_part.rbi

@@ -27,7 +27,7 @@ module PreludeSDK
     sig do
       params(
         content: T.any(Pathname, StringIO, IO, String),
-        filename: T.nilable(String),
+        filename: T.nilable(T.any(Pathname, String)),
         content_type: T.nilable(String)
       ).returns(T.attached_class)
     end

data/rbi/prelude_sdk/internal/transport/base_client.rbi

@@ -85,10 +85,9 @@ module PreludeSDK
 
           # @api private
           sig do
-            params(
-              status: Integer,
-              headers: T.any(T::Hash[String, String], Net::HTTPHeader)
-            ).returns(T::Boolean)
+            params(status: Integer, headers: T::Hash[String, String]).returns(
+              T::Boolean
+            )
           end
           def should_retry?(status, headers:)
           end
@@ -99,7 +98,7 @@ module PreludeSDK
               request:
                 PreludeSDK::Internal::Transport::BaseClient::RequestInput,
               status: Integer,
-              response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
+              response_headers: T::Hash[String, String]
             ).returns(PreludeSDK::Internal::Transport::BaseClient::RequestInput)
           end
           def follow_redirect(request, status:, response_headers:)
@@ -179,6 +178,11 @@ module PreludeSDK
         private def auth_headers
         end
 
+        # @api private
+        sig { returns(String) }
+        private def user_agent
+        end
+
         # @api private
         sig { returns(String) }
         private def generate_idempotency_key
@@ -216,7 +220,7 @@ module PreludeSDK
             send_retry_header: T::Boolean
           ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
         end
-        private def send_request(
+        def send_request(
           request,
           redirect_count:,
           retry_count:,

data/rbi/prelude_sdk/internal/transport/pooled_net_requester.rbi

@@ -26,8 +26,12 @@ module PreludeSDK
 
         class << self
           # @api private
-          sig { params(url: URI::Generic).returns(Net::HTTP) }
-          def connect(url)
+          sig do
+            params(cert_store: OpenSSL::X509::Store, url: URI::Generic).returns(
+              Net::HTTP
+            )
+          end
+          def connect(cert_store:, url:)
           end
 
           # @api private

data/rbi/prelude_sdk/internal/type/base_model.rbi

@@ -31,7 +31,7 @@ module PreludeSDK
           #
           # Assumes superclass fields are totally defined before fields are accessed /
           # defined on subclasses.
-          sig { params(child: T.self_type).void }
+          sig { params(child: PreludeSDK::Internal::Type::BaseModel).void }
           def inherited(child)
           end
 
@@ -276,9 +276,13 @@ module PreludeSDK
 
         # Create a new instance of a model.
         sig do
-          params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(
-            T.attached_class
-          )
+          params(
+            data:
+              T.any(
+                T::Hash[Symbol, T.anything],
+                PreludeSDK::Internal::Type::BaseModel
+              )
+          ).returns(T.attached_class)
         end
         def self.new(data = {})
         end

data/rbi/prelude_sdk/internal/type/base_page.rbi

@@ -30,7 +30,7 @@ module PreludeSDK
           params(
             client: PreludeSDK::Internal::Transport::BaseClient,
             req: PreludeSDK::Internal::Transport::BaseClient::RequestComponents,
-            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            headers: T::Hash[String, String],
             page_data: T.anything
           ).void
         end

data/rbi/prelude_sdk/internal/type/converter.rbi

@@ -90,6 +90,60 @@ module PreludeSDK
           def self.type_info(spec)
           end
 
+          # @api private
+          sig do
+            params(
+              type_info:
+                T.any(
+                  {
+                    const:
+                      T.nilable(
+                        T.any(NilClass, T::Boolean, Integer, Float, Symbol)
+                      ),
+                    enum:
+                      T.nilable(
+                        T.proc.returns(
+                          PreludeSDK::Internal::Type::Converter::Input
+                        )
+                      ),
+                    union:
+                      T.nilable(
+                        T.proc.returns(
+                          PreludeSDK::Internal::Type::Converter::Input
+                        )
+                      )
+                  },
+                  T.proc.returns(PreludeSDK::Internal::Type::Converter::Input),
+                  PreludeSDK::Internal::Type::Converter::Input
+                ),
+              spec:
+                T.any(
+                  {
+                    const:
+                      T.nilable(
+                        T.any(NilClass, T::Boolean, Integer, Float, Symbol)
+                      ),
+                    enum:
+                      T.nilable(
+                        T.proc.returns(
+                          PreludeSDK::Internal::Type::Converter::Input
+                        )
+                      ),
+                    union:
+                      T.nilable(
+                        T.proc.returns(
+                          PreludeSDK::Internal::Type::Converter::Input
+                        )
+                      )
+                  },
+                  T.proc.returns(PreludeSDK::Internal::Type::Converter::Input),
+                  PreludeSDK::Internal::Type::Converter::Input
+                )
+            ).returns(PreludeSDK::Internal::AnyHash)
+          end
+          def self.meta_info(type_info, spec)
+          end
+
           # @api private
           sig do
             params(translate_names: T::Boolean).returns(

data/rbi/prelude_sdk/internal/type/union.rbi

@@ -16,7 +16,8 @@ module PreludeSDK
             T::Array[
               [
                 T.nilable(Symbol),
-                T.proc.returns(PreludeSDK::Internal::Type::Converter::Input)
+                T.proc.returns(PreludeSDK::Internal::Type::Converter::Input),
+                PreludeSDK::Internal::AnyHash
               ]
             ]
           )
@@ -25,7 +26,13 @@ module PreludeSDK
         end
 
         # @api private
-        sig { returns(T::Array[[T.nilable(Symbol), T.anything]]) }
+        sig do
+          returns(
+            T::Array[
+              [T.nilable(Symbol), T.anything, PreludeSDK::Internal::AnyHash]
+            ]
+          )
+        end
         protected def derefed_variants
         end
 

data/rbi/prelude_sdk/internal/util.rbi

@@ -361,7 +361,7 @@ module PreludeSDK
         # Assumes each chunk in stream has `Encoding::BINARY`.
         sig do
           params(
-            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            headers: T::Hash[String, String],
             stream: T::Enumerable[String],
             suppress_error: T::Boolean
           ).returns(T.anything)

data/rbi/prelude_sdk/models/transactional_send_params.rbi

@@ -29,7 +29,9 @@ module PreludeSDK
       sig { params(callback_url: String).void }
       attr_writer :callback_url
 
-      # A unique, user-defined identifier that will be included in webhook events.
+      # A user-defined identifier to correlate this transactional message with. It is
+      # returned in the response and any webhook events that refer to this
+      # transactionalmessage.
       sig { returns(T.nilable(String)) }
       attr_reader :correlation_id
 
@@ -60,6 +62,32 @@ module PreludeSDK
       sig { params(locale: String).void }
       attr_writer :locale
 
+      # 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`.
+      sig do
+        returns(
+          T.nilable(
+            PreludeSDK::TransactionalSendParams::PreferredChannel::OrSymbol
+          )
+        )
+      end
+      attr_reader :preferred_channel
+
+      sig do
+        params(
+          preferred_channel:
+            PreludeSDK::TransactionalSendParams::PreferredChannel::OrSymbol
+        ).void
+      end
+      attr_writer :preferred_channel
+
       # The variables to be replaced in the template.
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
       attr_reader :variables
@@ -76,6 +104,8 @@ module PreludeSDK
           expires_at: String,
           from: String,
           locale: String,
+          preferred_channel:
+            PreludeSDK::TransactionalSendParams::PreferredChannel::OrSymbol,
           variables: T::Hash[Symbol, String],
           request_options: PreludeSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -87,7 +117,9 @@ module PreludeSDK
         to:,
         # The callback URL.
         callback_url: nil,
-        # A unique, user-defined identifier that will be included in webhook events.
+        # A user-defined identifier to correlate this transactional message with. It is
+        # returned in the response and any webhook events that refer to this
+        # transactionalmessage.
         correlation_id: nil,
         # The message expiration date.
         expires_at: nil,
@@ -98,6 +130,16 @@ module PreludeSDK
         # code of the phone number. If the language specified doesn't exist, the default
         # set on the template will be used.
         locale: nil,
+        # 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`.
+        preferred_channel: nil,
         # The variables to be replaced in the template.
         variables: nil,
         request_options: {}
@@ -114,6 +156,8 @@ module PreludeSDK
             expires_at: String,
             from: String,
             locale: String,
+            preferred_channel:
+              PreludeSDK::TransactionalSendParams::PreferredChannel::OrSymbol,
             variables: T::Hash[Symbol, String],
             request_options: PreludeSDK::RequestOptions
           }
@@ -121,6 +165,51 @@ module PreludeSDK
       end
       def to_hash
       end
+
+      # 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
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, PreludeSDK::TransactionalSendParams::PreferredChannel)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SMS =
+          T.let(
+            :sms,
+            PreludeSDK::TransactionalSendParams::PreferredChannel::TaggedSymbol
+          )
+        RCS =
+          T.let(
+            :rcs,
+            PreludeSDK::TransactionalSendParams::PreferredChannel::TaggedSymbol
+          )
+        WHATSAPP =
+          T.let(
+            :whatsapp,
+            PreludeSDK::TransactionalSendParams::PreferredChannel::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::TransactionalSendParams::PreferredChannel::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/prelude_sdk/models/transactional_send_response.rbi

@@ -42,7 +42,9 @@ module PreludeSDK
       sig { params(callback_url: String).void }
       attr_writer :callback_url
 
-      # A unique, user-defined identifier that will be included in webhook events.
+      # A user-defined identifier to correlate this transactional message with. It is
+      # returned in the response and any webhook events that refer to this transactional
+      # message.
       sig { returns(T.nilable(String)) }
       attr_reader :correlation_id
 
@@ -84,7 +86,9 @@ module PreludeSDK
         variables:,
         # The callback URL.
         callback_url: nil,
-        # A unique, user-defined identifier that will be included in webhook events.
+        # A user-defined identifier to correlate this transactional message with. It is
+        # returned in the response and any webhook events that refer to this transactional
+        # message.
         correlation_id: nil,
         # The Sender ID.
         from: nil

data/rbi/prelude_sdk/models/verification_check_response.rbi

@@ -129,6 +129,8 @@ module PreludeSDK
             )
           end
 
+        # A user-defined identifier to correlate this verification with. It is returned in
+        # the response and any webhook events that refer to this verification.
         sig { returns(T.nilable(String)) }
         attr_reader :correlation_id
 
@@ -137,7 +139,11 @@ module PreludeSDK
 
         # The metadata for this verification.
         sig { params(correlation_id: String).returns(T.attached_class) }
-        def self.new(correlation_id: nil)
+        def self.new(
+          # A user-defined identifier to correlate this verification with. It is returned in
+          # the response and any webhook events that refer to this verification.
+          correlation_id: nil
+        )
         end
 
         sig { override.returns({ correlation_id: String }) }