prelude-sdk 0.1.0.pre.alpha.2

data/rbi/prelude_sdk/resources/transactional.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module PreludeSDK
+  module Resources
+    class Transactional
+      # Send a transactional message to your user.
+      sig do
+        params(
+          template_id: String,
+          to: String,
+          callback_url: String,
+          correlation_id: String,
+          expires_at: String,
+          from: String,
+          locale: String,
+          variables: T::Hash[Symbol, String],
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(PreludeSDK::Models::TransactionalSendResponse)
+      end
+      def send_(
+        # The template identifier.
+        template_id:,
+        # The recipient's phone number.
+        to:,
+        # The callback URL.
+        callback_url: nil,
+        # A unique, user-defined identifier that will be included in webhook events.
+        correlation_id: nil,
+        # The message expiration date.
+        expires_at: nil,
+        # The Sender ID.
+        from: nil,
+        # A BCP-47 formatted locale string with the language the text message will be sent
+        # to. If there's no locale set, the language will be determined by the country
+        # code of the phone number. If the language specified doesn't exist, the default
+        # set on the template will be used.
+        locale: nil,
+        # The variables to be replaced in the template.
+        variables: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: PreludeSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/resources/verification.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module PreludeSDK
+  module Resources
+    class Verification
+      # Create a new verification for a specific phone number. If another non-expired
+      # verification exists (the request is performed within the verification window),
+      # this endpoint will perform a retry instead.
+      sig do
+        params(
+          target: PreludeSDK::VerificationCreateParams::Target::OrHash,
+          dispatch_id: String,
+          metadata: PreludeSDK::VerificationCreateParams::Metadata::OrHash,
+          options: PreludeSDK::VerificationCreateParams::Options::OrHash,
+          signals: PreludeSDK::VerificationCreateParams::Signals::OrHash,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(PreludeSDK::Models::VerificationCreateResponse)
+      end
+      def create(
+        # 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:,
+        # The identifier of the dispatch that came from the front-end SDK.
+        dispatch_id: nil,
+        # The metadata for this verification. This object will be returned with every
+        # response or webhook sent that refers to this verification.
+        metadata: nil,
+        # Verification options
+        options: nil,
+        # The signals used for anti-fraud. For more details, refer to
+        # [Signals](/verify/v2/documentation/prevent-fraud#signals).
+        signals: nil,
+        request_options: {}
+      )
+      end
+
+      # Check the validity of a verification code.
+      sig do
+        params(
+          code: String,
+          target: PreludeSDK::VerificationCheckParams::Target::OrHash,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(PreludeSDK::Models::VerificationCheckResponse)
+      end
+      def check(
+        # 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
+
+      # @api private
+      sig { params(client: PreludeSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/resources/watch.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module PreludeSDK
+  module Resources
+    class Watch
+      # Predict the outcome of a verification based on Prelude’s anti-fraud system.
+      sig do
+        params(
+          target: PreludeSDK::WatchPredictParams::Target::OrHash,
+          dispatch_id: String,
+          metadata: PreludeSDK::WatchPredictParams::Metadata::OrHash,
+          signals: PreludeSDK::WatchPredictParams::Signals::OrHash,
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(PreludeSDK::Models::WatchPredictResponse)
+      end
+      def predict(
+        # The prediction target. Only supports phone numbers for now.
+        target:,
+        # The identifier of the dispatch that came from the front-end SDK.
+        dispatch_id: nil,
+        # The metadata for this prediction.
+        metadata: nil,
+        # The signals used for anti-fraud. For more details, refer to
+        # [Signals](/verify/v2/documentation/prevent-fraud#signals).
+        signals: nil,
+        request_options: {}
+      )
+      end
+
+      # Send real-time event data from end-user interactions within your application.
+      # Events will be analyzed for proactive fraud prevention and risk scoring.
+      sig do
+        params(
+          events: T::Array[PreludeSDK::WatchSendEventsParams::Event::OrHash],
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(PreludeSDK::Models::WatchSendEventsResponse)
+      end
+      def send_events(
+        # A list of events to dispatch.
+        events:,
+        request_options: {}
+      )
+      end
+
+      # Send feedback regarding your end-users verification funnel. Events will be
+      # analyzed for proactive fraud prevention and risk scoring.
+      sig do
+        params(
+          feedbacks:
+            T::Array[PreludeSDK::WatchSendFeedbacksParams::Feedback::OrHash],
+          request_options: PreludeSDK::RequestOptions::OrHash
+        ).returns(PreludeSDK::Models::WatchSendFeedbacksResponse)
+      end
+      def send_feedbacks(
+        # A list of feedbacks to send.
+        feedbacks:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: PreludeSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/prelude_sdk/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module PreludeSDK
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/prelude_sdk/client.rbs

@@ -0,0 +1,32 @@
+module PreludeSDK
+  class Client < PreludeSDK::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader api_token: String
+
+    attr_reader lookup: PreludeSDK::Resources::Lookup
+
+    attr_reader transactional: PreludeSDK::Resources::Transactional
+
+    attr_reader verification: PreludeSDK::Resources::Verification
+
+    attr_reader watch: PreludeSDK::Resources::Watch
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?api_token: String?,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end

data/sig/prelude_sdk/errors.rbs

@@ -0,0 +1,110 @@
+module PreludeSDK
+  module Errors
+    class Error < StandardError
+      attr_accessor cause: StandardError?
+    end
+
+    class ConversionError < PreludeSDK::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
+    end
+
+    class APIError < PreludeSDK::Errors::Error
+      attr_accessor url: URI::Generic
+
+      attr_accessor status: Integer?
+
+      attr_accessor body: top?
+
+      def initialize: (
+        url: URI::Generic,
+        ?status: Integer?,
+        ?body: Object?,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIConnectionError < PreludeSDK::Errors::APIError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APITimeoutError < PreludeSDK::Errors::APIConnectionError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIStatusError < PreludeSDK::Errors::APIError
+      def self.for: (
+        url: URI::Generic,
+        status: Integer,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> instance
+
+      def initialize: (
+        url: URI::Generic,
+        status: Integer,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class BadRequestError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS: 400
+    end
+
+    class AuthenticationError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS: 401
+    end
+
+    class PermissionDeniedError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS: 403
+    end
+
+    class NotFoundError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS: 404
+    end
+
+    class ConflictError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS: 409
+    end
+
+    class UnprocessableEntityError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS: 422
+    end
+
+    class RateLimitError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS: 429
+    end
+
+    class InternalServerError < PreludeSDK::Errors::APIStatusError
+      HTTP_STATUS: Range[Integer]
+    end
+  end
+end

data/sig/prelude_sdk/file_part.rbs

@@ -0,0 +1,21 @@
+module PreludeSDK
+  class FilePart
+    attr_reader content: Pathname | StringIO | IO | String
+
+    attr_reader content_type: String?
+
+    attr_reader filename: String?
+
+    private def read: -> String
+
+    def to_json: (*top a) -> String
+
+    def to_yaml: (*top a) -> String
+
+    def initialize: (
+      Pathname | StringIO | IO | String content,
+      ?filename: String?,
+      ?content_type: String?
+    ) -> void
+  end
+end

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

@@ -0,0 +1,131 @@
+module PreludeSDK
+  module Internal
+    module Transport
+      class BaseClient
+        extend PreludeSDK::Internal::Util::SorbetRuntimeSupport
+
+        type request_components =
+          {
+            method: Symbol,
+            path: String | ::Array[String],
+            query: ::Hash[String, (::Array[String] | String)?]?,
+            headers: ::Hash[String, (String
+            | Integer
+            | ::Array[(String | Integer)?])?]?,
+            body: top?,
+            unwrap: (Symbol
+            | Integer
+            | ::Array[(Symbol | Integer)]
+            | (^(top arg0) -> top))?,
+            page: Class?,
+            stream: Class?,
+            model: PreludeSDK::Internal::Type::Converter::input?,
+            options: PreludeSDK::request_opts?
+          }
+        type request_input =
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: ::Hash[String, String],
+            body: top,
+            max_retries: Integer,
+            timeout: Float
+          }
+
+        MAX_REDIRECTS: 20
+
+        PLATFORM_HEADERS: ::Hash[String, String]
+
+        def self.validate!: (
+          PreludeSDK::Internal::Transport::BaseClient::request_components req
+        ) -> void
+
+        def self.should_retry?: (
+          Integer status,
+          headers: ::Hash[String, String]
+        ) -> bool
+
+        def self.follow_redirect: (
+          PreludeSDK::Internal::Transport::BaseClient::request_input request,
+          status: Integer,
+          response_headers: ::Hash[String, String]
+        ) -> PreludeSDK::Internal::Transport::BaseClient::request_input
+
+        def self.reap_connection!: (
+          Integer | PreludeSDK::Errors::APIConnectionError status,
+          stream: Enumerable[String]?
+        ) -> void
+
+        attr_reader base_url: URI::Generic
+
+        attr_reader timeout: Float
+
+        attr_reader max_retries: Integer
+
+        attr_reader initial_retry_delay: Float
+
+        attr_reader max_retry_delay: Float
+
+        attr_reader headers: ::Hash[String, String]
+
+        attr_reader idempotency_header: String?
+
+        # @api private
+        attr_reader requester: PreludeSDK::Internal::Transport::PooledNetRequester
+
+        def initialize: (
+          base_url: String,
+          ?timeout: Float,
+          ?max_retries: Integer,
+          ?initial_retry_delay: Float,
+          ?max_retry_delay: Float,
+          ?headers: ::Hash[String, (String
+          | Integer
+          | ::Array[(String | Integer)?])?],
+          ?idempotency_header: String?
+        ) -> void
+
+        private def auth_headers: -> ::Hash[String, String]
+
+        private def generate_idempotency_key: -> String
+
+        private def build_request: (
+          PreludeSDK::Internal::Transport::BaseClient::request_components req,
+          PreludeSDK::request_options opts
+        ) -> PreludeSDK::Internal::Transport::BaseClient::request_input
+
+        private def retry_delay: (
+          ::Hash[String, String] headers,
+          retry_count: Integer
+        ) -> Float
+
+        private def send_request: (
+          PreludeSDK::Internal::Transport::BaseClient::request_input request,
+          redirect_count: Integer,
+          retry_count: Integer,
+          send_retry_header: bool
+        ) -> [Integer, top, Enumerable[String]]
+
+        def request: (
+          Symbol method,
+          String | ::Array[String] path,
+          ?query: ::Hash[String, (::Array[String] | String)?]?,
+          ?headers: ::Hash[String, (String
+          | Integer
+          | ::Array[(String | Integer)?])?]?,
+          ?body: top?,
+          ?unwrap: (Symbol
+          | Integer
+          | ::Array[(Symbol | Integer)]
+          | (^(top arg0) -> top))?,
+          ?page: Class?,
+          ?stream: Class?,
+          ?model: PreludeSDK::Internal::Type::Converter::input?,
+          ?options: PreludeSDK::request_opts?
+        ) -> top
+
+        def inspect: -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module PreludeSDK
+  module Internal
+    module Transport
+      class PooledNetRequester
+        extend PreludeSDK::Internal::Util::SorbetRuntimeSupport
+
+        type request =
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: ::Hash[String, String],
+            body: top,
+            deadline: Float
+          }
+
+        KEEP_ALIVE_TIMEOUT: 30
+
+        DEFAULT_MAX_CONNECTIONS: Integer
+
+        def self.connect: (URI::Generic url) -> top
+
+        def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
+
+        def self.build_request: (
+          PreludeSDK::Internal::Transport::PooledNetRequester::request request
+        ) {
+          (String arg0) -> void
+        } -> [top, (^-> void)]
+
+        private def with_pool: (
+          URI::Generic url,
+          deadline: Float
+        ) {
+          (top arg0) -> void
+        } -> void
+
+        def execute: (
+          PreludeSDK::Internal::Transport::PooledNetRequester::request request
+        ) -> [Integer, top, Enumerable[String]]
+
+        def initialize: (?size: Integer) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module PreludeSDK
+  module Internal
+    module Type
+      class ArrayOf[Elem]
+        include PreludeSDK::Internal::Type::Converter
+        include PreludeSDK::Internal::Util::SorbetRuntimeSupport
+
+        def self.[]: (
+          ::Hash[Symbol, top]
+          | ^-> PreludeSDK::Internal::Type::Converter::input
+          | PreludeSDK::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> instance
+
+        def ===: (top other) -> bool
+
+        def ==: (top other) -> bool
+
+        def hash: -> Integer
+
+        def coerce: (
+          ::Array[top] | top value,
+          state: PreludeSDK::Internal::Type::Converter::coerce_state
+        ) -> (::Array[top] | top)
+
+        def dump: (
+          ::Array[top] | top value,
+          state: PreludeSDK::Internal::Type::Converter::dump_state
+        ) -> (::Array[top] | top)
+
+        def to_sorbet_type: -> top
+
+        def item_type: -> Elem
+
+        def nilable?: -> bool
+
+        def initialize: (
+          ::Hash[Symbol, top]
+          | ^-> PreludeSDK::Internal::Type::Converter::input
+          | PreludeSDK::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        def inspect: (?depth: Integer) -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+module PreludeSDK
+  module Internal
+    module Type
+      class BaseModel
+        extend PreludeSDK::Internal::Type::Converter
+        extend PreludeSDK::Internal::Util::SorbetRuntimeSupport
+
+        type known_field =
+          { mode: (:coerce | :dump)?, required: bool, nilable: bool }
+
+        def self.inherited: (self child) -> void
+
+        def self.known_fields: -> ::Hash[Symbol, (PreludeSDK::Internal::Type::BaseModel::known_field
+        & { type_fn: (^-> PreludeSDK::Internal::Type::Converter::input) })]
+
+        def self.fields: -> ::Hash[Symbol, (PreludeSDK::Internal::Type::BaseModel::known_field
+        & { type: PreludeSDK::Internal::Type::Converter::input })]
+
+        private def self.add_field: (
+          Symbol name_sym,
+          required: bool,
+          type_info: {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> PreludeSDK::Internal::Type::Converter::input?,
+            union: ^-> PreludeSDK::Internal::Type::Converter::input?,
+            api_name: Symbol
+          }
+          | ^-> PreludeSDK::Internal::Type::Converter::input
+          | PreludeSDK::Internal::Type::Converter::input,
+          spec: ::Hash[Symbol, top]
+        ) -> void
+
+        def self.required: (
+          Symbol name_sym,
+          ::Hash[Symbol, top]
+          | ^-> PreludeSDK::Internal::Type::Converter::input
+          | PreludeSDK::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        def self.optional: (
+          Symbol name_sym,
+          ::Hash[Symbol, top]
+          | ^-> PreludeSDK::Internal::Type::Converter::input
+          | PreludeSDK::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        private def self.request_only: { -> void } -> void
+
+        private def self.response_only: { -> void } -> void
+
+        def self.==: (top other) -> bool
+
+        def self.hash: -> Integer
+
+        def ==: (top other) -> bool
+
+        def hash: -> Integer
+
+        def self.coerce: (
+          PreludeSDK::Internal::Type::BaseModel | ::Hash[top, top] | top value,
+          state: PreludeSDK::Internal::Type::Converter::coerce_state
+        ) -> (instance | top)
+
+        def self.dump: (
+          instance | top value,
+          state: PreludeSDK::Internal::Type::Converter::dump_state
+        ) -> (::Hash[top, top] | top)
+
+        def self.to_sorbet_type: -> top
+
+        def self.recursively_to_h: (
+          PreludeSDK::Internal::Type::BaseModel model,
+          convert: bool
+        ) -> ::Hash[Symbol, top]
+
+        def []: (Symbol key) -> top?
+
+        def to_h: -> ::Hash[Symbol, top]
+
+        alias to_hash to_h
+
+        def deep_to_h: -> ::Hash[Symbol, top]
+
+        def deconstruct_keys: (::Array[Symbol]? keys) -> ::Hash[Symbol, top]
+
+        def to_json: (*top a) -> String
+
+        def to_yaml: (*top a) -> String
+
+        def initialize: (?::Hash[Symbol, top] | instance data) -> void
+
+        def self.inspect: (?depth: Integer) -> String
+
+        def to_s: -> String
+
+        def inspect: -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module PreludeSDK
+  module Internal
+    module Type
+      module BasePage[Elem]
+        def next_page?: -> bool
+
+        def next_page: -> instance
+
+        def auto_paging_each: { (Elem arg0) -> void } -> void
+
+        def to_enum: -> Enumerable[Elem]
+
+        alias enum_for to_enum
+
+        def initialize: (
+          client: PreludeSDK::Internal::Transport::BaseClient,
+          req: PreludeSDK::Internal::Transport::BaseClient::request_components,
+          headers: ::Hash[String, String],
+          page_data: top
+        ) -> void
+      end
+    end
+  end
+end