prelude-sdk 0.1.0.pre.alpha.2

data/rbi/prelude_sdk/models/transactional_send_response.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class TransactionalSendResponse < PreludeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::Models::TransactionalSendResponse,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # The message identifier.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The message creation date.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The message expiration date.
+      sig { returns(Time) }
+      attr_accessor :expires_at
+
+      # The template identifier.
+      sig { returns(String) }
+      attr_accessor :template_id
+
+      # The recipient's phone number.
+      sig { returns(String) }
+      attr_accessor :to
+
+      # The variables to be replaced in the template.
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :variables
+
+      # The callback URL.
+      sig { returns(T.nilable(String)) }
+      attr_reader :callback_url
+
+      sig { params(callback_url: String).void }
+      attr_writer :callback_url
+
+      # A unique, user-defined identifier that will be included in webhook events.
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      # The Sender ID.
+      sig { returns(T.nilable(String)) }
+      attr_reader :from
+
+      sig { params(from: String).void }
+      attr_writer :from
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          expires_at: Time,
+          template_id: String,
+          to: String,
+          variables: T::Hash[Symbol, String],
+          callback_url: String,
+          correlation_id: String,
+          from: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The message identifier.
+        id:,
+        # The message creation date.
+        created_at:,
+        # The message expiration date.
+        expires_at:,
+        # The template identifier.
+        template_id:,
+        # The recipient's phone number.
+        to:,
+        # The variables to be replaced in the template.
+        variables:,
+        # The callback URL.
+        callback_url: nil,
+        # A unique, user-defined identifier that will be included in webhook events.
+        correlation_id: nil,
+        # The Sender ID.
+        from: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            expires_at: Time,
+            template_id: String,
+            to: String,
+            variables: T::Hash[Symbol, String],
+            callback_url: String,
+            correlation_id: String,
+            from: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_check_params.rbi

@@ -0,0 +1,140 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class VerificationCheckParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::VerificationCheckParams,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # The OTP code to validate.
+      sig { returns(String) }
+      attr_accessor :code
+
+      # The verification target. Either a phone number or an email address. To use the
+      # email verification feature contact us to discuss your use case.
+      sig { returns(PreludeSDK::VerificationCheckParams::Target) }
+      attr_reader :target
+
+      sig do
+        params(target: PreludeSDK::VerificationCheckParams::Target::OrHash).void
+      end
+      attr_writer :target
+
+      sig do
+        params(
+          code: String,
+          target: PreludeSDK::VerificationCheckParams::Target::OrHash,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The OTP code to validate.
+        code:,
+        # The verification target. Either a phone number or an email address. To use the
+        # email verification feature contact us to discuss your use case.
+        target:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            code: String,
+            target: PreludeSDK::VerificationCheckParams::Target,
+            request_options: PreludeSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Target < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::VerificationCheckParams::Target,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        # The type of the target. Either "phone_number" or "email_address".
+        sig do
+          returns(PreludeSDK::VerificationCheckParams::Target::Type::OrSymbol)
+        end
+        attr_accessor :type
+
+        # An E.164 formatted phone number or an email address.
+        sig { returns(String) }
+        attr_accessor :value
+
+        # The verification target. Either a phone number or an email address. To use the
+        # email verification feature contact us to discuss your use case.
+        sig do
+          params(
+            type: PreludeSDK::VerificationCheckParams::Target::Type::OrSymbol,
+            value: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The type of the target. Either "phone_number" or "email_address".
+          type:,
+          # An E.164 formatted phone number or an email address.
+          value:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              type: PreludeSDK::VerificationCheckParams::Target::Type::OrSymbol,
+              value: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The type of the target. Either "phone_number" or "email_address".
+        module Type
+          extend PreludeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, PreludeSDK::VerificationCheckParams::Target::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PHONE_NUMBER =
+            T.let(
+              :phone_number,
+              PreludeSDK::VerificationCheckParams::Target::Type::TaggedSymbol
+            )
+          EMAIL_ADDRESS =
+            T.let(
+              :email_address,
+              PreludeSDK::VerificationCheckParams::Target::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                PreludeSDK::VerificationCheckParams::Target::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/models/verification_check_response.rbi

@@ -0,0 +1,149 @@
+# typed: strong
+
+module PreludeSDK
+  module Models
+    class VerificationCheckResponse < PreludeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            PreludeSDK::Models::VerificationCheckResponse,
+            PreludeSDK::Internal::AnyHash
+          )
+        end
+
+      # The status of the check.
+      sig do
+        returns(
+          PreludeSDK::Models::VerificationCheckResponse::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      # The verification identifier.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # The metadata for this verification.
+      sig do
+        returns(
+          T.nilable(PreludeSDK::Models::VerificationCheckResponse::Metadata)
+        )
+      end
+      attr_reader :metadata
+
+      sig do
+        params(
+          metadata:
+            PreludeSDK::Models::VerificationCheckResponse::Metadata::OrHash
+        ).void
+      end
+      attr_writer :metadata
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      sig do
+        params(
+          status:
+            PreludeSDK::Models::VerificationCheckResponse::Status::OrSymbol,
+          id: String,
+          metadata:
+            PreludeSDK::Models::VerificationCheckResponse::Metadata::OrHash,
+          request_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The status of the check.
+        status:,
+        # The verification identifier.
+        id: nil,
+        # The metadata for this verification.
+        metadata: nil,
+        request_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            status:
+              PreludeSDK::Models::VerificationCheckResponse::Status::TaggedSymbol,
+            id: String,
+            metadata: PreludeSDK::Models::VerificationCheckResponse::Metadata,
+            request_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The status of the check.
+      module Status
+        extend PreludeSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, PreludeSDK::Models::VerificationCheckResponse::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SUCCESS =
+          T.let(
+            :success,
+            PreludeSDK::Models::VerificationCheckResponse::Status::TaggedSymbol
+          )
+        FAILURE =
+          T.let(
+            :failure,
+            PreludeSDK::Models::VerificationCheckResponse::Status::TaggedSymbol
+          )
+        EXPIRED_OR_NOT_FOUND =
+          T.let(
+            :expired_or_not_found,
+            PreludeSDK::Models::VerificationCheckResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PreludeSDK::Models::VerificationCheckResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Metadata < PreludeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PreludeSDK::Models::VerificationCheckResponse::Metadata,
+              PreludeSDK::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :correlation_id
+
+        sig { params(correlation_id: String).void }
+        attr_writer :correlation_id
+
+        # The metadata for this verification.
+        sig { params(correlation_id: String).returns(T.attached_class) }
+        def self.new(correlation_id: nil)
+        end
+
+        sig { override.returns({ correlation_id: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end