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

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/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
 
@@ -87,7 +89,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,

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 }) }

data/rbi/prelude_sdk/models/verification_create_params.rbi

@@ -200,7 +200,8 @@ module PreludeSDK
             )
           end
 
-        # 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.
         sig { returns(T.nilable(String)) }
         attr_reader :correlation_id
 
@@ -211,7 +212,8 @@ module PreludeSDK
         # response or webhook sent that refers to this verification.
         sig { params(correlation_id: String).returns(T.attached_class) }
         def self.new(
-          # 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.
           correlation_id: nil
         )
         end
@@ -294,15 +296,15 @@ module PreludeSDK
             )
           )
         end
-        attr_reader :method_
+        attr_reader :verification_method
 
         sig do
           params(
-            method_:
+            verification_method:
               PreludeSDK::VerificationCreateParams::Options::Method::OrSymbol
           ).void
         end
-        attr_writer :method_
+        attr_writer :verification_method
 
         # The preferred channel to be used in priority for verification.
         sig do
@@ -354,7 +356,7 @@ module PreludeSDK
             code_size: Integer,
             custom_code: String,
             locale: String,
-            method_:
+            verification_method:
               PreludeSDK::VerificationCreateParams::Options::Method::OrSymbol,
             preferred_channel:
               PreludeSDK::VerificationCreateParams::Options::PreferredChannel::OrSymbol,
@@ -387,7 +389,7 @@ module PreludeSDK
           # 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.
-          method_: nil,
+          verification_method: nil,
           # The preferred channel to be used in priority for verification.
           preferred_channel: nil,
           # The Sender ID to use for this message. The Sender ID needs to be enabled by
@@ -410,7 +412,7 @@ module PreludeSDK
               code_size: Integer,
               custom_code: String,
               locale: String,
-              method_:
+              verification_method:
                 PreludeSDK::VerificationCreateParams::Options::Method::OrSymbol,
               preferred_channel:
                 PreludeSDK::VerificationCreateParams::Options::PreferredChannel::OrSymbol,
@@ -588,16 +590,6 @@ module PreludeSDK
               :telegram,
               PreludeSDK::VerificationCreateParams::Options::PreferredChannel::TaggedSymbol
             )
-          SILENT =
-            T.let(
-              :silent,
-              PreludeSDK::VerificationCreateParams::Options::PreferredChannel::TaggedSymbol
-            )
-          VOICE =
-            T.let(
-              :voice,
-              PreludeSDK::VerificationCreateParams::Options::PreferredChannel::TaggedSymbol
-            )
 
           sig do
             override.returns(

data/rbi/prelude_sdk/models/verification_create_response.rbi

@@ -21,7 +21,7 @@ module PreludeSDK
           PreludeSDK::Models::VerificationCreateResponse::Method::TaggedSymbol
         )
       end
-      attr_accessor :method_
+      attr_accessor :verification_method
 
       # The status of the verification.
       sig do
@@ -32,10 +32,25 @@ module PreludeSDK
       attr_accessor :status
 
       # The ordered sequence of channels to be used for verification
-      sig { returns(T.nilable(T::Array[String])) }
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+            ]
+          )
+        )
+      end
       attr_reader :channels
 
-      sig { params(channels: T::Array[String]).void }
+      sig do
+        params(
+          channels:
+            T::Array[
+              PreludeSDK::Models::VerificationCreateResponse::Channel::OrSymbol
+            ]
+        ).void
+      end
       attr_writer :channels
 
       # The metadata for this verification.
@@ -97,11 +112,14 @@ module PreludeSDK
       sig do
         params(
           id: String,
-          method_:
+          verification_method:
             PreludeSDK::Models::VerificationCreateResponse::Method::OrSymbol,
           status:
             PreludeSDK::Models::VerificationCreateResponse::Status::OrSymbol,
-          channels: T::Array[String],
+          channels:
+            T::Array[
+              PreludeSDK::Models::VerificationCreateResponse::Channel::OrSymbol
+            ],
           metadata:
             PreludeSDK::Models::VerificationCreateResponse::Metadata::OrHash,
           reason:
@@ -114,7 +132,7 @@ module PreludeSDK
         # The verification identifier.
         id:,
         # The method used for verifying this phone number.
-        method_:,
+        verification_method:,
         # The status of the verification.
         status:,
         # The ordered sequence of channels to be used for verification
@@ -134,11 +152,14 @@ module PreludeSDK
         override.returns(
           {
             id: String,
-            method_:
+            verification_method:
               PreludeSDK::Models::VerificationCreateResponse::Method::TaggedSymbol,
             status:
               PreludeSDK::Models::VerificationCreateResponse::Status::TaggedSymbol,
-            channels: T::Array[String],
+            channels:
+              T::Array[
+                PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+              ],
             metadata: PreludeSDK::Models::VerificationCreateResponse::Metadata,
             reason:
               PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol,
@@ -163,6 +184,11 @@ module PreludeSDK
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        EMAIL =
+          T.let(
+            :email,
+            PreludeSDK::Models::VerificationCreateResponse::Method::TaggedSymbol
+          )
         MESSAGE =
           T.let(
             :message,
@@ -230,6 +256,70 @@ module PreludeSDK
         end
       end
 
+      module Channel
+        extend PreludeSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              PreludeSDK::Models::VerificationCreateResponse::Channel
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        RCS =
+          T.let(
+            :rcs,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+        SILENT =
+          T.let(
+            :silent,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+        SMS =
+          T.let(
+            :sms,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+        TELEGRAM =
+          T.let(
+            :telegram,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+        VIBER =
+          T.let(
+            :viber,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+        VOICE =
+          T.let(
+            :voice,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+        WHATSAPP =
+          T.let(
+            :whatsapp,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+        ZALO =
+          T.let(
+            :zalo,
+            PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::Models::VerificationCreateResponse::Channel::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Metadata < PreludeSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -239,6 +329,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
 
@@ -247,7 +339,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 }) }
@@ -269,14 +365,14 @@ module PreludeSDK
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        SUSPICIOUS =
+        EXPIRED_SIGNATURE =
           T.let(
-            :suspicious,
+            :expired_signature,
             PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol
           )
-        REPEATED_ATTEMPTS =
+        IN_BLOCK_LIST =
           T.let(
-            :repeated_attempts,
+            :in_block_list,
             PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol
           )
         INVALID_PHONE_LINE =
@@ -289,9 +385,19 @@ module PreludeSDK
             :invalid_phone_number,
             PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol
           )
-        IN_BLOCK_LIST =
+        INVALID_SIGNATURE =
           T.let(
-            :in_block_list,
+            :invalid_signature,
+            PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol
+          )
+        REPEATED_ATTEMPTS =
+          T.let(
+            :repeated_attempts,
+            PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol
+          )
+        SUSPICIOUS =
+          T.let(
+            :suspicious,
             PreludeSDK::Models::VerificationCreateResponse::Reason::TaggedSymbol
           )
 

data/rbi/prelude_sdk/models/watch_predict_params.rbi

@@ -168,7 +168,8 @@ module PreludeSDK
             )
           end
 
-        # 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.
         sig { returns(T.nilable(String)) }
         attr_reader :correlation_id
 
@@ -178,7 +179,8 @@ module PreludeSDK
         # The metadata for this prediction.
         sig { params(correlation_id: String).returns(T.attached_class) }
         def self.new(
-          # 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.
           correlation_id: nil
         )
         end

data/rbi/prelude_sdk/models/watch_send_feedbacks_params.rbi

@@ -285,7 +285,8 @@ module PreludeSDK
               )
             end
 
-          # 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.
           sig { returns(T.nilable(String)) }
           attr_reader :correlation_id
 
@@ -295,7 +296,8 @@ module PreludeSDK
           # The metadata for this feedback.
           sig { params(correlation_id: String).returns(T.attached_class) }
           def self.new(
-            # 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.
             correlation_id: nil
           )
           end

data/rbi/prelude_sdk/resources/transactional.rbi

@@ -24,7 +24,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,

data/sig/prelude_sdk/internal/transport/base_client.rbs

@@ -99,7 +99,7 @@ module PreludeSDK
           retry_count: Integer
         ) -> Float
 
-        private def send_request: (
+        def send_request: (
           PreludeSDK::Internal::Transport::BaseClient::request_input request,
           redirect_count: Integer,
           retry_count: Integer,

data/sig/prelude_sdk/internal/type/converter.rbs

@@ -39,6 +39,23 @@ module PreludeSDK
           | PreludeSDK::Internal::Type::Converter::input spec
         ) -> (^-> top)
 
+        def self.meta_info: (
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> PreludeSDK::Internal::Type::Converter::input?,
+            union: ^-> PreludeSDK::Internal::Type::Converter::input?
+          }
+          | ^-> PreludeSDK::Internal::Type::Converter::input
+          | PreludeSDK::Internal::Type::Converter::input type_info,
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> PreludeSDK::Internal::Type::Converter::input?,
+            union: ^-> PreludeSDK::Internal::Type::Converter::input?
+          }
+          | ^-> PreludeSDK::Internal::Type::Converter::input
+          | PreludeSDK::Internal::Type::Converter::input spec
+        ) -> ::Hash[Symbol, top]
+
         def self.new_coerce_state: (
           ?translate_names: bool
         ) -> PreludeSDK::Internal::Type::Converter::coerce_state

data/sig/prelude_sdk/internal/type/union.rbs

@@ -5,9 +5,9 @@ module PreludeSDK
         include PreludeSDK::Internal::Type::Converter
         include PreludeSDK::Internal::Util::SorbetRuntimeSupport
 
-        private def self.known_variants: -> ::Array[[Symbol?, (^-> PreludeSDK::Internal::Type::Converter::input)]]
+        private def self.known_variants: -> ::Array[[Symbol?, (^-> PreludeSDK::Internal::Type::Converter::input), ::Hash[Symbol, top]]]
 
-        def self.derefed_variants: -> ::Array[[Symbol?, top]]
+        def self.derefed_variants: -> ::Array[[Symbol?, top, ::Hash[Symbol, top]]]
 
         def self.variants: -> ::Array[top]
 

data/sig/prelude_sdk/models/verification_create_params.rbs

@@ -108,7 +108,7 @@ module PreludeSDK
           code_size: Integer,
           custom_code: String,
           locale: String,
-          method_: PreludeSDK::Models::VerificationCreateParams::Options::method_,
+          verification_method: PreludeSDK::Models::VerificationCreateParams::Options::method_,
           preferred_channel: PreludeSDK::Models::VerificationCreateParams::Options::preferred_channel,
           sender_id: String,
           template_id: String,
@@ -138,9 +138,9 @@ module PreludeSDK
 
         def locale=: (String) -> String
 
-        attr_reader method_: PreludeSDK::Models::VerificationCreateParams::Options::method_?
+        attr_reader verification_method: PreludeSDK::Models::VerificationCreateParams::Options::method_?
 
-        def method_=: (
+        def verification_method=: (
           PreludeSDK::Models::VerificationCreateParams::Options::method_
         ) -> PreludeSDK::Models::VerificationCreateParams::Options::method_
 
@@ -168,7 +168,7 @@ module PreludeSDK
           ?code_size: Integer,
           ?custom_code: String,
           ?locale: String,
-          ?method_: PreludeSDK::Models::VerificationCreateParams::Options::method_,
+          ?verification_method: PreludeSDK::Models::VerificationCreateParams::Options::method_,
           ?preferred_channel: PreludeSDK::Models::VerificationCreateParams::Options::preferred_channel,
           ?sender_id: String,
           ?template_id: String,
@@ -181,7 +181,7 @@ module PreludeSDK
           code_size: Integer,
           custom_code: String,
           locale: String,
-          method_: PreludeSDK::Models::VerificationCreateParams::Options::method_,
+          verification_method: PreludeSDK::Models::VerificationCreateParams::Options::method_,
           preferred_channel: PreludeSDK::Models::VerificationCreateParams::Options::preferred_channel,
           sender_id: String,
           template_id: String,
@@ -232,14 +232,7 @@ module PreludeSDK
         end
 
         type preferred_channel =
-          :sms
-          | :rcs
-          | :whatsapp
-          | :viber
-          | :zalo
-          | :telegram
-          | :silent
-          | :voice
+          :sms | :rcs | :whatsapp | :viber | :zalo | :telegram
 
         module PreferredChannel
           extend PreludeSDK::Internal::Type::Enum
@@ -250,8 +243,6 @@ module PreludeSDK
           VIBER: :viber
           ZALO: :zalo
           TELEGRAM: :telegram
-          SILENT: :silent
-          VOICE: :voice
 
           def self?.values: -> ::Array[PreludeSDK::Models::VerificationCreateParams::Options::preferred_channel]
         end