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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12b02adb152b32c9bd2e7dd2587ddbd3c2cd0852b00af005c6227a938276e997
-  data.tar.gz: 4c62e71aa6241371ba0547bc643d51bb73c5193bac70725f073e3c8b5f3949c1
+  metadata.gz: 4f92fe6a16b20591bab5d7212829340cb90ece7b18a1c0ab76c90d5c2444ca7a
+  data.tar.gz: 83cb5e4ec4af8adc647af9a1e69ccfbed0b69d9cdabd407a3dd964542902eca8
 SHA512:
-  metadata.gz: eeb2a335540419f67629c0cfbf9d9dd0cc357cb174f0e5a4c309a6afc681cc1aa088cf3852c20b60b46bed5939a8b4d2af33de1b1e9d17af6f5c42e69911da0f
-  data.tar.gz: 7970fd85651bc993d6a8f9305118e5966c86558a79026a6279a9a9686b023a12dfcb962e12073a8ffc6cc4cd1fbd142398443b084a00bb40421f60df5e43ceed
+  metadata.gz: 00ab2023d3b9f12f43fefde4186d2214926e54f5efe6ecac2a22cbdeab3db9b5019c7ff1967d4ab596db4f4e8ba1cd847f597e712ade232967acf4cafe215bf0
+  data.tar.gz: ad64312be23a8b2200656143841ec8296f9454be8bc78368bb28a4618f4c8cdd09b333747cf9548c5ba5bf227187795da4f3c6ca395a092071d958ad31d7ae19

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** add Ruby-specific rename transformation ([42dadd3](https://github.com/prelude-so/ruby-sdk/commit/42dadd3bddbb321fc9cf76542b26651807050fc4))
+* **api:** api update ([036b7b2](https://github.com/prelude-so/ruby-sdk/commit/036b7b298dc4de946eeff885f8f2a0e9566e1de0))
+* **api:** update via SDK Studio ([791c53f](https://github.com/prelude-so/ruby-sdk/commit/791c53fdbb730ded753d2eb227f87ff6e86ee1bd))
+
+
+### Bug Fixes
+
+* bump sorbet version and fix new type errors from the breaking change ([18e0dd1](https://github.com/prelude-so/ruby-sdk/commit/18e0dd1e8f90e1e77c74b491490931309a9cdd4b))
+* **internal:** ensure sorbet test always runs serially ([73f6bb9](https://github.com/prelude-so/ruby-sdk/commit/73f6bb9d30db4eb38e746d74da4ff2eb81881080))
+
+
+### Chores
+
+* add json schema comment for rubocop.yml ([c6b0b40](https://github.com/prelude-so/ruby-sdk/commit/c6b0b40955adff0da669b9d6177ef37a4cbdbbcf))
+* collect metadata from type DSL ([7bf4d61](https://github.com/prelude-so/ruby-sdk/commit/7bf4d61d21cbd50bb83986e147a5c29793400ca5))
+* **internal:** allow streams to also be unwrapped on a per-row basis ([8572174](https://github.com/prelude-so/ruby-sdk/commit/8572174e262d9c6b7cc66a0894fd6d09184569f1))
+* **internal:** increase visibility of internal helper method ([f04772f](https://github.com/prelude-so/ruby-sdk/commit/f04772fd6d66ba49a3d2f73d21f4538c7957bd28))
+* **internal:** update comment in script ([a5fe28e](https://github.com/prelude-so/ruby-sdk/commit/a5fe28eacf22acdad6f621a1e6ee4e4dfb077d16))
+* **internal:** update test skipping reason ([55f2205](https://github.com/prelude-so/ruby-sdk/commit/55f220596e6310b2d89fe3b460c02fdfe57b9e78))
+* **internal:** version bump ([eb3405c](https://github.com/prelude-so/ruby-sdk/commit/eb3405ca5ae74eb673b5e0cbafde6943e83314fa))
+* update @stainless-api/prism-cli to v5.15.0 ([58f1de5](https://github.com/prelude-so/ruby-sdk/commit/58f1de5007b309c40d197031aeea1e5574213bbe))
+* update contribute.md ([65b7754](https://github.com/prelude-so/ruby-sdk/commit/65b7754e9bfac05f99efcc9a48200fada3940535))
+
 ## 0.1.0-alpha.2 (2025-06-27)
 
 Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/prelude-so/ruby-sdk/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)

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.2"
+gem "prelude-sdk", "~> 0.1.0.pre.alpha.3"
 ```
 
 <!-- x-release-please-end -->

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

@@ -365,7 +365,7 @@ module PreludeSDK
         #
         # @raise [PreludeSDK::Errors::APIError]
         # @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
-        private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
+        def send_request(request, redirect_count:, retry_count:, send_retry_header:)
           url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout)
           input = {**request.except(:timeout), deadline: PreludeSDK::Internal::Util.monotonic_secs + timeout}
 
@@ -471,6 +471,7 @@ module PreludeSDK
           self.class.validate!(req)
           model = req.fetch(:model) { PreludeSDK::Internal::Type::Unknown }
           opts = req[:options].to_h
+          unwrap = req[:unwrap]
           PreludeSDK::RequestOptions.validate!(opts)
           request = build_request(req.except(:options), opts)
           url = request.fetch(:url)
@@ -487,11 +488,18 @@ module PreludeSDK
           decoded = PreludeSDK::Internal::Util.decode_content(response, stream: stream)
           case req
           in {stream: Class => st}
-            st.new(model: model, url: url, status: status, response: response, stream: decoded)
+            st.new(
+              model: model,
+              url: url,
+              status: status,
+              response: response,
+              unwrap: unwrap,
+              stream: decoded
+            )
           in {page: Class => page}
             page.new(client: self, req: req, headers: response, page_data: decoded)
           else
-            unwrapped = PreludeSDK::Internal::Util.dig(decoded, req[:unwrap])
+            unwrapped = PreludeSDK::Internal::Util.dig(decoded, unwrap)
             PreludeSDK::Internal::Type::Converter.coerce(model, unwrapped)
           end
         end

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

@@ -193,15 +193,7 @@ module PreludeSDK
         end
 
         define_sorbet_constant!(:Request) do
-          T.type_alias do
-            {
-              method: Symbol,
-              url: URI::Generic,
-              headers: T::Hash[String, String],
-              body: T.anything,
-              deadline: Float
-            }
-          end
+          T.type_alias { {method: Symbol, url: URI::Generic, headers: T::Hash[String, String], body: T.anything, deadline: Float} }
         end
       end
     end

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

@@ -148,6 +148,7 @@ module PreludeSDK
         #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = PreludeSDK::Internal::Type::Converter.type_info(type_info || spec)
+          @meta = PreludeSDK::Internal::Type::Converter.meta_info(type_info, spec)
           @nilable = spec.fetch(:nil?, false)
         end
 

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

@@ -52,6 +52,7 @@ module PreludeSDK
           #
           #   @option spec [Boolean] :"nil?"
           private def add_field(name_sym, required:, type_info:, spec:)
+            meta = PreludeSDK::Internal::Type::Converter.meta_info(type_info, spec)
             type_fn, info =
               case type_info
               in Proc | PreludeSDK::Internal::Type::Converter | Class
@@ -63,14 +64,7 @@ module PreludeSDK
             setter = :"#{name_sym}="
             api_name = info.fetch(:api_name, name_sym)
             nilable = info.fetch(:nil?, false)
-            const = if required && !nilable
-              info.fetch(
-                :const,
-                PreludeSDK::Internal::OMIT
-              )
-            else
-              PreludeSDK::Internal::OMIT
-            end
+            const = required && !nilable ? info.fetch(:const, PreludeSDK::Internal::OMIT) : PreludeSDK::Internal::OMIT
 
             [name_sym, setter].each { undef_method(_1) } if known_fields.key?(name_sym)
 
@@ -81,7 +75,8 @@ module PreludeSDK
                 required: required,
                 nilable: nilable,
                 const: const,
-                type_fn: type_fn
+                type_fn: type_fn,
+                meta: meta
               }
 
             define_method(setter) do |value|

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

@@ -98,6 +98,33 @@ module PreludeSDK
             end
           end
 
+          # @api private
+          #
+          # @param type_info [Hash{Symbol=>Object}, Proc, PreludeSDK::Internal::Type::Converter, Class] .
+          #
+          #   @option type_info [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
+          #
+          #   @option type_info [Proc] :enum
+          #
+          #   @option type_info [Proc] :union
+          #
+          #   @option type_info [Boolean] :"nil?"
+          #
+          # @param spec [Hash{Symbol=>Object}, Proc, PreludeSDK::Internal::Type::Converter, Class] .
+          #
+          #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
+          #
+          #   @option spec [Proc] :enum
+          #
+          #   @option spec [Proc] :union
+          #
+          #   @option spec [Boolean] :"nil?"
+          #
+          # @return [Hash{Symbol=>Object}]
+          def meta_info(type_info, spec)
+            [spec, type_info].grep(Hash).first.to_h.except(:const, :enum, :union, :nil?)
+          end
+
           # @api private
           #
           # @param translate_names [Boolean]

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

@@ -168,6 +168,7 @@ module PreludeSDK
         #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = PreludeSDK::Internal::Type::Converter.type_info(type_info || spec)
+          @meta = PreludeSDK::Internal::Type::Converter.meta_info(type_info, spec)
           @nilable = spec.fetch(:nil?, false)
         end
 

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

@@ -12,20 +12,20 @@ module PreludeSDK
         #
         # All of the specified variant info for this union.
         #
-        # @return [Array<Array(Symbol, Proc)>]
+        # @return [Array<Array(Symbol, Proc, Hash{Symbol=>Object})>]
         private def known_variants = (@known_variants ||= [])
 
         # @api private
         #
-        # @return [Array<Array(Symbol, Object)>]
+        # @return [Array<Array(Symbol, Object, Hash{Symbol=>Object})>]
         protected def derefed_variants
-          known_variants.map { |key, variant_fn| [key, variant_fn.call] }
+          known_variants.map { |key, variant_fn, meta| [key, variant_fn.call, meta] }
         end
 
         # All of the specified variants for this union.
         #
         # @return [Array<Object>]
-        def variants = derefed_variants.map(&:last)
+        def variants = derefed_variants.map { _2 }
 
         # @api private
         #
@@ -51,12 +51,13 @@ module PreludeSDK
         #
         #   @option spec [Boolean] :"nil?"
         private def variant(key, spec = nil)
+          meta = PreludeSDK::Internal::Type::Converter.meta_info(nil, spec)
           variant_info =
             case key
             in Symbol
-              [key, PreludeSDK::Internal::Type::Converter.type_info(spec)]
+              [key, PreludeSDK::Internal::Type::Converter.type_info(spec), meta]
             in Proc | PreludeSDK::Internal::Type::Converter | Class | Hash
-              [nil, PreludeSDK::Internal::Type::Converter.type_info(key)]
+              [nil, PreludeSDK::Internal::Type::Converter.type_info(key), meta]
             end
 
           known_variants << variant_info
@@ -79,7 +80,8 @@ module PreludeSDK
             return nil if key == PreludeSDK::Internal::OMIT
 
             key = key.to_sym if key.is_a?(String)
-            known_variants.find { |k,| k == key }&.last&.call
+            _, found = known_variants.find { |k,| k == key }
+            found&.call
           else
             nil
           end

data/lib/prelude_sdk/internal/util.rb

@@ -244,7 +244,7 @@ module PreludeSDK
         #
         # @return [String]
         def uri_origin(uri)
-          "#{uri.scheme}://#{uri.host}#{uri.port == uri.default_port ? '' : ":#{uri.port}"}"
+          "#{uri.scheme}://#{uri.host}#{":#{uri.port}" unless uri.port == uri.default_port}"
         end
 
         # @api private

data/lib/prelude_sdk/models/transactional_send_params.rb

@@ -26,7 +26,9 @@ module PreludeSDK
       optional :callback_url, String
 
       # @!attribute correlation_id
-      #   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.
       #
       #   @return [String, nil]
       optional :correlation_id, String
@@ -68,7 +70,7 @@ module PreludeSDK
       #
       #   @param callback_url [String] The callback URL.
       #
-      #   @param correlation_id [String] A unique, user-defined identifier that will be included in webhook events.
+      #   @param correlation_id [String] A user-defined identifier to correlate this transactional message with. It is re
       #
       #   @param expires_at [String] The message expiration date.
       #

data/lib/prelude_sdk/models/transactional_send_response.rb

@@ -47,7 +47,9 @@ module PreludeSDK
       optional :callback_url, String
 
       # @!attribute correlation_id
-      #   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.
       #
       #   @return [String, nil]
       optional :correlation_id, String
@@ -59,6 +61,9 @@ module PreludeSDK
       optional :from, String
 
       # @!method initialize(id:, created_at:, expires_at:, template_id:, to:, variables:, callback_url: nil, correlation_id: nil, from: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::TransactionalSendResponse} for more details.
+      #
       #   @param id [String] The message identifier.
       #
       #   @param created_at [Time] The message creation date.
@@ -73,7 +78,7 @@ module PreludeSDK
       #
       #   @param callback_url [String] The callback URL.
       #
-      #   @param correlation_id [String] A unique, user-defined identifier that will be included in webhook events.
+      #   @param correlation_id [String] A user-defined identifier to correlate this transactional message with. It is re
       #
       #   @param from [String] The Sender ID.
     end

data/lib/prelude_sdk/models/verification_check_response.rb

@@ -53,14 +53,19 @@ module PreludeSDK
       # @see PreludeSDK::Models::VerificationCheckResponse#metadata
       class Metadata < PreludeSDK::Internal::Type::BaseModel
         # @!attribute correlation_id
+        #   A user-defined identifier to correlate this verification with. It is returned in
+        #   the response and any webhook events that refer to this verification.
         #
         #   @return [String, nil]
         optional :correlation_id, String
 
         # @!method initialize(correlation_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::VerificationCheckResponse::Metadata} for more details.
+        #
         #   The metadata for this verification.
         #
-        #   @param correlation_id [String]
+        #   @param correlation_id [String] A user-defined identifier to correlate this verification with. It is returned in
       end
     end
   end

data/lib/prelude_sdk/models/verification_create_params.rb

@@ -93,16 +93,20 @@ module PreludeSDK
 
       class Metadata < PreludeSDK::Internal::Type::BaseModel
         # @!attribute correlation_id
-        #   A user-defined identifier to correlate this verification with.
+        #   A user-defined identifier to correlate this verification with. It is returned in
+        #   the response and any webhook events that refer to this verification.
         #
         #   @return [String, nil]
         optional :correlation_id, String
 
         # @!method initialize(correlation_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::VerificationCreateParams::Metadata} for more details.
+        #
         #   The metadata for this verification. This object will be returned with every
         #   response or webhook sent that refers to this verification.
         #
-        #   @param correlation_id [String] A user-defined identifier to correlate this verification with.
+        #   @param correlation_id [String] A user-defined identifier to correlate this verification with. It is returned in
       end
 
       class Options < PreludeSDK::Internal::Type::BaseModel
@@ -145,27 +149,22 @@ module PreludeSDK
         #   @return [String, nil]
         optional :locale, String
 
-        # @!attribute method_
+        # @!attribute verification_method
         #   The method used for verifying this phone number. The 'voice' option provides an
         #   accessible alternative for visually impaired users by delivering the
         #   verification code through a phone call rather than a text message. It also
         #   allows verification of landline numbers that cannot receive SMS messages.
         #
         #   @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Method, nil]
-        optional :method_,
-                 enum: -> {
-                   PreludeSDK::VerificationCreateParams::Options::Method
-                 },
+        optional :verification_method,
+                 enum: -> { PreludeSDK::VerificationCreateParams::Options::Method },
                  api_name: :method
 
         # @!attribute preferred_channel
         #   The preferred channel to be used in priority for verification.
         #
         #   @return [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::PreferredChannel, nil]
-        optional :preferred_channel,
-                 enum: -> {
-                   PreludeSDK::VerificationCreateParams::Options::PreferredChannel
-                 }
+        optional :preferred_channel, enum: -> { PreludeSDK::VerificationCreateParams::Options::PreferredChannel }
 
         # @!attribute sender_id
         #   The Sender ID to use for this message. The Sender ID needs to be enabled by
@@ -187,7 +186,7 @@ module PreludeSDK
         #   @return [Hash{Symbol=>String}, nil]
         optional :variables, PreludeSDK::Internal::Type::HashOf[String]
 
-        # @!method initialize(app_realm: nil, callback_url: nil, code_size: nil, custom_code: nil, locale: nil, method_: nil, preferred_channel: nil, sender_id: nil, template_id: nil, variables: nil)
+        # @!method initialize(app_realm: nil, callback_url: nil, code_size: nil, custom_code: nil, locale: nil, verification_method: nil, preferred_channel: nil, sender_id: nil, template_id: nil, variables: nil)
         #   Some parameter documentations has been truncated, see
         #   {PreludeSDK::Models::VerificationCreateParams::Options} for more details.
         #
@@ -203,7 +202,7 @@ module PreludeSDK
         #
         #   @param locale [String] A BCP-47 formatted locale string with the language the text message will be sent
         #
-        #   @param method_ [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Method] The method used for verifying this phone number. The 'voice' option provides an
+        #   @param verification_method [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::Method] The method used for verifying this phone number. The 'voice' option provides an
         #
         #   @param preferred_channel [Symbol, PreludeSDK::Models::VerificationCreateParams::Options::PreferredChannel] The preferred channel to be used in priority for verification.
         #
@@ -259,7 +258,7 @@ module PreludeSDK
         # verification code through a phone call rather than a text message. It also
         # allows verification of landline numbers that cannot receive SMS messages.
         #
-        # @see PreludeSDK::Models::VerificationCreateParams::Options#method_
+        # @see PreludeSDK::Models::VerificationCreateParams::Options#verification_method
         module Method
           extend PreludeSDK::Internal::Type::Enum
 
@@ -282,8 +281,6 @@ module PreludeSDK
           VIBER = :viber
           ZALO = :zalo
           TELEGRAM = :telegram
-          SILENT = :silent
-          VOICE = :voice
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/prelude_sdk/models/verification_create_response.rb

@@ -10,11 +10,13 @@ module PreludeSDK
       #   @return [String]
       required :id, String
 
-      # @!attribute method_
+      # @!attribute verification_method
       #   The method used for verifying this phone number.
       #
       #   @return [Symbol, PreludeSDK::Models::VerificationCreateResponse::Method]
-      required :method_, enum: -> { PreludeSDK::Models::VerificationCreateResponse::Method }, api_name: :method
+      required :verification_method,
+               enum: -> { PreludeSDK::Models::VerificationCreateResponse::Method },
+               api_name: :method
 
       # @!attribute status
       #   The status of the verification.
@@ -25,8 +27,9 @@ module PreludeSDK
       # @!attribute channels
       #   The ordered sequence of channels to be used for verification
       #
-      #   @return [Array<String>, nil]
-      optional :channels, PreludeSDK::Internal::Type::ArrayOf[String]
+      #   @return [Array<Symbol, PreludeSDK::Models::VerificationCreateResponse::Channel>, nil]
+      optional :channels,
+               -> { PreludeSDK::Internal::Type::ArrayOf[enum: PreludeSDK::Models::VerificationCreateResponse::Channel] }
 
       # @!attribute metadata
       #   The metadata for this verification.
@@ -52,17 +55,17 @@ module PreludeSDK
       #   @return [PreludeSDK::Models::VerificationCreateResponse::Silent, nil]
       optional :silent, -> { PreludeSDK::Models::VerificationCreateResponse::Silent }
 
-      # @!method initialize(id:, method_:, status:, channels: nil, metadata: nil, reason: nil, request_id: nil, silent: nil)
+      # @!method initialize(id:, verification_method:, status:, channels: nil, metadata: nil, reason: nil, request_id: nil, silent: nil)
       #   Some parameter documentations has been truncated, see
       #   {PreludeSDK::Models::VerificationCreateResponse} for more details.
       #
       #   @param id [String] The verification identifier.
       #
-      #   @param method_ [Symbol, PreludeSDK::Models::VerificationCreateResponse::Method] The method used for verifying this phone number.
+      #   @param verification_method [Symbol, PreludeSDK::Models::VerificationCreateResponse::Method] The method used for verifying this phone number.
       #
       #   @param status [Symbol, PreludeSDK::Models::VerificationCreateResponse::Status] The status of the verification.
       #
-      #   @param channels [Array<String>] The ordered sequence of channels to be used for verification
+      #   @param channels [Array<Symbol, PreludeSDK::Models::VerificationCreateResponse::Channel>] The ordered sequence of channels to be used for verification
       #
       #   @param metadata [PreludeSDK::Models::VerificationCreateResponse::Metadata] The metadata for this verification.
       #
@@ -74,10 +77,11 @@ module PreludeSDK
 
       # The method used for verifying this phone number.
       #
-      # @see PreludeSDK::Models::VerificationCreateResponse#method_
+      # @see PreludeSDK::Models::VerificationCreateResponse#verification_method
       module Method
         extend PreludeSDK::Internal::Type::Enum
 
+        EMAIL = :email
         MESSAGE = :message
         SILENT = :silent
         VOICE = :voice
@@ -100,17 +104,38 @@ module PreludeSDK
         #   @return [Array<Symbol>]
       end
 
+      module Channel
+        extend PreludeSDK::Internal::Type::Enum
+
+        RCS = :rcs
+        SILENT = :silent
+        SMS = :sms
+        TELEGRAM = :telegram
+        VIBER = :viber
+        VOICE = :voice
+        WHATSAPP = :whatsapp
+        ZALO = :zalo
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see PreludeSDK::Models::VerificationCreateResponse#metadata
       class Metadata < PreludeSDK::Internal::Type::BaseModel
         # @!attribute correlation_id
+        #   A user-defined identifier to correlate this verification with. It is returned in
+        #   the response and any webhook events that refer to this verification.
         #
         #   @return [String, nil]
         optional :correlation_id, String
 
         # @!method initialize(correlation_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::VerificationCreateResponse::Metadata} for more details.
+        #
         #   The metadata for this verification.
         #
-        #   @param correlation_id [String]
+        #   @param correlation_id [String] A user-defined identifier to correlate this verification with. It is returned in
       end
 
       # The reason why the verification was blocked. Only present when status is
@@ -120,11 +145,13 @@ module PreludeSDK
       module Reason
         extend PreludeSDK::Internal::Type::Enum
 
-        SUSPICIOUS = :suspicious
-        REPEATED_ATTEMPTS = :repeated_attempts
+        EXPIRED_SIGNATURE = :expired_signature
+        IN_BLOCK_LIST = :in_block_list
         INVALID_PHONE_LINE = :invalid_phone_line
         INVALID_PHONE_NUMBER = :invalid_phone_number
-        IN_BLOCK_LIST = :in_block_list
+        INVALID_SIGNATURE = :invalid_signature
+        REPEATED_ATTEMPTS = :repeated_attempts
+        SUSPICIOUS = :suspicious
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/prelude_sdk/models/watch_predict_params.rb

@@ -82,15 +82,19 @@ module PreludeSDK
 
       class Metadata < PreludeSDK::Internal::Type::BaseModel
         # @!attribute correlation_id
-        #   A user-defined identifier to correlate this prediction with.
+        #   A user-defined identifier to correlate this prediction with. It is returned in
+        #   the response and any webhook events that refer to this prediction.
         #
         #   @return [String, nil]
         optional :correlation_id, String
 
         # @!method initialize(correlation_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::WatchPredictParams::Metadata} for more details.
+        #
         #   The metadata for this prediction.
         #
-        #   @param correlation_id [String] A user-defined identifier to correlate this prediction with.
+        #   @param correlation_id [String] A user-defined identifier to correlate this prediction with. It is returned in t
       end
 
       class Signals < PreludeSDK::Internal::Type::BaseModel

data/lib/prelude_sdk/models/watch_send_feedbacks_params.rb

@@ -116,15 +116,20 @@ module PreludeSDK
         # @see PreludeSDK::Models::WatchSendFeedbacksParams::Feedback#metadata
         class Metadata < PreludeSDK::Internal::Type::BaseModel
           # @!attribute correlation_id
-          #   A user-defined identifier to correlate this feedback with.
+          #   A user-defined identifier to correlate this feedback with. It is returned in the
+          #   response and any webhook events that refer to this feedback.
           #
           #   @return [String, nil]
           optional :correlation_id, String
 
           # @!method initialize(correlation_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {PreludeSDK::Models::WatchSendFeedbacksParams::Feedback::Metadata} for more
+          #   details.
+          #
           #   The metadata for this feedback.
           #
-          #   @param correlation_id [String] A user-defined identifier to correlate this feedback with.
+          #   @param correlation_id [String] A user-defined identifier to correlate this feedback with. It is returned in the
         end
 
         # @see PreludeSDK::Models::WatchSendFeedbacksParams::Feedback#signals

data/lib/prelude_sdk/resources/transactional.rb

@@ -16,7 +16,7 @@ module PreludeSDK
       #
       # @param callback_url [String] The callback URL.
       #
-      # @param correlation_id [String] A unique, user-defined identifier that will be included in webhook events.
+      # @param correlation_id [String] A user-defined identifier to correlate this transactional message with. It is re
       #
       # @param expires_at [String] The message expiration date.
       #

data/lib/prelude_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PreludeSDK
-  VERSION = "0.1.0.pre.alpha.2"
+  VERSION = "0.1.0.pre.alpha.3"
 end

data/rbi/prelude_sdk/errors.rbi

@@ -59,10 +59,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

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

@@ -216,7 +216,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:,