scalar_api_ruby 0.2.0

data/sig/scalar_api_ruby/file_part.rbs

@@ -0,0 +1,21 @@
+module Scalar
+  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: (Pathname | String)?,
+      ?content_type: String?
+    ) -> void
+  end
+end

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

@@ -0,0 +1,133 @@
+module Scalar
+  module Internal
+    module Transport
+      class BaseClient
+        extend Scalar::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: Scalar::Internal::Type::Converter::input?,
+            options: Scalar::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!: (
+          Scalar::Internal::Transport::BaseClient::request_components req
+        ) -> void
+
+        def self.should_retry?: (
+          Integer status,
+          headers: ::Hash[String, String]
+        ) -> bool
+
+        def self.follow_redirect: (
+          Scalar::Internal::Transport::BaseClient::request_input request,
+          status: Integer,
+          response_headers: ::Hash[String, String]
+        ) -> Scalar::Internal::Transport::BaseClient::request_input
+
+        def self.reap_connection!: (
+          Integer | Scalar::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: Scalar::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 user_agent: -> String
+
+        private def generate_idempotency_key: -> String
+
+        private def build_request: (
+          Scalar::Internal::Transport::BaseClient::request_components req,
+          Scalar::request_options opts
+        ) -> Scalar::Internal::Transport::BaseClient::request_input
+
+        private def retry_delay: (
+          ::Hash[String, String] headers,
+          retry_count: Integer
+        ) -> Float
+
+        def send_request: (
+          Scalar::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: Scalar::Internal::Type::Converter::input?,
+          ?options: Scalar::request_opts?
+        ) -> top
+
+        def inspect: -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module Scalar
+  module Internal
+    module Transport
+      class PooledNetRequester
+        extend Scalar::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: (
+          cert_store: OpenSSL::X509::Store,
+          url: URI::Generic
+        ) -> top
+
+        def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
+
+        def self.build_request: (
+          Scalar::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: (
+          Scalar::Internal::Transport::PooledNetRequester::request request
+        ) -> [Integer, top, Enumerable[String]]
+
+        def initialize: (?size: Integer) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module Scalar
+  module Internal
+    module Type
+      class ArrayOf[Elem]
+        include Scalar::Internal::Type::Converter
+        include Scalar::Internal::Util::SorbetRuntimeSupport
+
+        def self.[]: (
+          ::Hash[Symbol, top]
+          | ^-> Scalar::Internal::Type::Converter::input
+          | Scalar::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: Scalar::Internal::Type::Converter::coerce_state
+        ) -> (::Array[top] | top)
+
+        def dump: (
+          ::Array[top] | top value,
+          state: Scalar::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]
+          | ^-> Scalar::Internal::Type::Converter::input
+          | Scalar::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        def inspect: (?depth: Integer) -> String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+module Scalar
+  module Internal
+    module Type
+      class BaseModel
+        extend Scalar::Internal::Type::Converter
+        extend Scalar::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, (Scalar::Internal::Type::BaseModel::known_field
+        & { type_fn: (^-> Scalar::Internal::Type::Converter::input) })]
+
+        def self.fields: -> ::Hash[Symbol, (Scalar::Internal::Type::BaseModel::known_field
+        & { type: Scalar::Internal::Type::Converter::input })]
+
+        private def self.add_field: (
+          Symbol name_sym,
+          required: bool,
+          type_info: {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> Scalar::Internal::Type::Converter::input?,
+            union: ^-> Scalar::Internal::Type::Converter::input?,
+            api_name: Symbol
+          }
+          | ^-> Scalar::Internal::Type::Converter::input
+          | Scalar::Internal::Type::Converter::input,
+          spec: ::Hash[Symbol, top]
+        ) -> void
+
+        def self.required: (
+          Symbol name_sym,
+          ::Hash[Symbol, top]
+          | ^-> Scalar::Internal::Type::Converter::input
+          | Scalar::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        def self.optional: (
+          Symbol name_sym,
+          ::Hash[Symbol, top]
+          | ^-> Scalar::Internal::Type::Converter::input
+          | Scalar::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: (
+          Scalar::Internal::Type::BaseModel | ::Hash[top, top] | top value,
+          state: Scalar::Internal::Type::Converter::coerce_state
+        ) -> (instance | top)
+
+        def self.dump: (
+          instance | top value,
+          state: Scalar::Internal::Type::Converter::dump_state
+        ) -> (::Hash[top, top] | top)
+
+        def self.to_sorbet_type: -> top
+
+        def self.recursively_to_h: (
+          Scalar::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/scalar_api_ruby/internal/type/base_page.rbs

@@ -0,0 +1,24 @@
+module Scalar
+  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: Scalar::Internal::Transport::BaseClient,
+          req: Scalar::Internal::Transport::BaseClient::request_components,
+          headers: ::Hash[String, String],
+          page_data: top
+        ) -> void
+      end
+    end
+  end
+end

data/sig/scalar_api_ruby/internal/type/boolean.rbs

@@ -0,0 +1,26 @@
+module Scalar
+  module Internal
+    module Type
+      class Boolean
+        extend Scalar::Internal::Type::Converter
+        extend Scalar::Internal::Util::SorbetRuntimeSupport
+
+        def self.===: (top other) -> bool
+
+        def self.==: (top other) -> bool
+
+        def self.coerce: (
+          bool | top value,
+          state: Scalar::Internal::Type::Converter::coerce_state
+        ) -> (bool | top)
+
+        def self.dump: (
+          bool | top value,
+          state: Scalar::Internal::Type::Converter::dump_state
+        ) -> (bool | top)
+
+        def self.to_sorbet_type: -> top
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+module Scalar
+  module Internal
+    module Type
+      module Converter
+        extend Scalar::Internal::Util::SorbetRuntimeSupport
+
+        type input = Scalar::Internal::Type::Converter | Class
+
+        type coerce_state =
+          {
+            translate_names: bool,
+            strictness: bool,
+            exactness: { yes: Integer, no: Integer, maybe: Integer },
+            error: Class,
+            branched: Integer
+          }
+
+        type dump_state = { can_retry: bool }
+
+        def coerce: (
+          top value,
+          state: Scalar::Internal::Type::Converter::coerce_state
+        ) -> top
+
+        def dump: (
+          top value,
+          state: Scalar::Internal::Type::Converter::dump_state
+        ) -> top
+
+        def inspect: (?depth: Integer) -> String
+
+        def self.type_info: (
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> Scalar::Internal::Type::Converter::input?,
+            union: ^-> Scalar::Internal::Type::Converter::input?
+          }
+          | ^-> Scalar::Internal::Type::Converter::input
+          | Scalar::Internal::Type::Converter::input spec
+        ) -> (^-> top)
+
+        def self.meta_info: (
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> Scalar::Internal::Type::Converter::input?,
+            union: ^-> Scalar::Internal::Type::Converter::input?
+          }
+          | ^-> Scalar::Internal::Type::Converter::input
+          | Scalar::Internal::Type::Converter::input type_info,
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> Scalar::Internal::Type::Converter::input?,
+            union: ^-> Scalar::Internal::Type::Converter::input?
+          }
+          | ^-> Scalar::Internal::Type::Converter::input
+          | Scalar::Internal::Type::Converter::input spec
+        ) -> ::Hash[Symbol, top]
+
+        def self.new_coerce_state: (
+          ?translate_names: bool
+        ) -> Scalar::Internal::Type::Converter::coerce_state
+
+        def self.coerce: (
+          Scalar::Internal::Type::Converter::input target,
+          top value,
+          ?state: Scalar::Internal::Type::Converter::coerce_state
+        ) -> top
+
+        def self.dump: (
+          Scalar::Internal::Type::Converter::input target,
+          top value,
+          ?state: Scalar::Internal::Type::Converter::dump_state
+        ) -> top
+
+        def self.inspect: (top target, depth: Integer) -> String
+      end
+    end
+  end
+end

data/sig/scalar_api_ruby/internal/type/enum.rbs

@@ -0,0 +1,32 @@
+module Scalar
+  module Internal
+    module Type
+      module Enum
+        include Scalar::Internal::Type::Converter
+        include Scalar::Internal::Util::SorbetRuntimeSupport
+
+        def self.values: -> ::Array[(nil | bool | Integer | Float | Symbol)]
+
+        def ===: (top other) -> bool
+
+        def ==: (top other) -> bool
+
+        def hash: -> Integer
+
+        def coerce: (
+          String | Symbol | top value,
+          state: Scalar::Internal::Type::Converter::coerce_state
+        ) -> (Symbol | top)
+
+        def dump: (
+          Symbol | top value,
+          state: Scalar::Internal::Type::Converter::dump_state
+        ) -> (Symbol | top)
+
+        def to_sorbet_type: -> top
+
+        def inspect: (?depth: Integer) -> String
+      end
+    end
+  end
+end

data/sig/scalar_api_ruby/internal/type/file_input.rbs

@@ -0,0 +1,25 @@
+module Scalar
+  module Internal
+    module Type
+      class FileInput
+        extend Scalar::Internal::Type::Converter
+
+        def self.===: (top other) -> bool
+
+        def self.==: (top other) -> bool
+
+        def self.coerce: (
+          StringIO | String | top value,
+          state: Scalar::Internal::Type::Converter::coerce_state
+        ) -> (StringIO | top)
+
+        def self.dump: (
+          Pathname | StringIO | IO | String | top value,
+          state: Scalar::Internal::Type::Converter::dump_state
+        ) -> (Pathname | StringIO | IO | String | top)
+
+        def self.to_sorbet_type: -> top
+      end
+    end
+  end
+end

data/sig/scalar_api_ruby/internal/type/hash_of.rbs

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

data/sig/scalar_api_ruby/internal/type/request_parameters.rbs

@@ -0,0 +1,17 @@
+module Scalar
+  module Internal
+    module Type
+      type request_parameters = { request_options: Scalar::request_opts }
+
+      module RequestParameters
+        attr_reader request_options: Scalar::request_opts
+
+        def request_options=: (Scalar::request_opts) -> Scalar::request_opts
+
+        module Converter
+          def dump_request: (top params) -> [top, ::Hash[Symbol, top]]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module Scalar
+  module Internal
+    module Type
+      module Union
+        include Scalar::Internal::Type::Converter
+        include Scalar::Internal::Util::SorbetRuntimeSupport
+
+        private def self.known_variants: -> ::Array[[Symbol?, (^-> Scalar::Internal::Type::Converter::input), ::Hash[Symbol, top]]]
+
+        def self.derefed_variants: -> ::Array[[Symbol?, top, ::Hash[Symbol, top]]]
+
+        def self.variants: -> ::Array[top]
+
+        private def self.discriminator: (Symbol property) -> void
+
+        private def self.variant: (
+          Symbol
+          | ::Hash[Symbol, top]
+          | ^-> Scalar::Internal::Type::Converter::input
+          | Scalar::Internal::Type::Converter::input key,
+          ?::Hash[Symbol, top]
+          | ^-> Scalar::Internal::Type::Converter::input
+          | Scalar::Internal::Type::Converter::input spec
+        ) -> void
+
+        private def self.resolve_variant: (
+          top value
+        ) -> Scalar::Internal::Type::Converter::input?
+
+        def ===: (top other) -> bool
+
+        def ==: (top other) -> bool
+
+        def hash: -> Integer
+
+        def coerce: (
+          top value,
+          state: Scalar::Internal::Type::Converter::coerce_state
+        ) -> top
+
+        def dump: (
+          top value,
+          state: Scalar::Internal::Type::Converter::dump_state
+        ) -> top
+
+        def to_sorbet_type: -> top
+
+        def inspect: (?depth: Integer) -> String
+      end
+    end
+  end
+end

data/sig/scalar_api_ruby/internal/type/unknown.rbs

@@ -0,0 +1,26 @@
+module Scalar
+  module Internal
+    module Type
+      class Unknown
+        extend Scalar::Internal::Type::Converter
+        extend Scalar::Internal::Util::SorbetRuntimeSupport
+
+        def self.===: (top other) -> bool
+
+        def self.==: (top other) -> bool
+
+        def self.coerce: (
+          top value,
+          state: Scalar::Internal::Type::Converter::coerce_state
+        ) -> top
+
+        def self.dump: (
+          top value,
+          state: Scalar::Internal::Type::Converter::dump_state
+        ) -> top
+
+        def self.to_sorbet_type: -> top
+      end
+    end
+  end
+end