finch-api 0.1.0.pre.alpha.4 → 0.1.0.pre.alpha.5

data/sig/finch-api/models/jobs/automated_list_params.rbs

@@ -5,7 +5,7 @@ module FinchAPI
         { limit: Integer, offset: Integer } & FinchAPI::request_parameters
 
       class AutomatedListParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_reader limit: Integer?

data/sig/finch-api/models/jobs/automated_retrieve_params.rbs

@@ -4,7 +4,7 @@ module FinchAPI
       type automated_retrieve_params = {  } & FinchAPI::request_parameters
 
       class AutomatedRetrieveParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         def initialize: (?request_options: FinchAPI::request_opts) -> void

data/sig/finch-api/models/jobs/manual_retrieve_params.rbs

@@ -4,7 +4,7 @@ module FinchAPI
       type manual_retrieve_params = {  } & FinchAPI::request_parameters
 
       class ManualRetrieveParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         def initialize: (?request_options: FinchAPI::request_opts) -> void

data/sig/finch-api/models/payroll/pay_group_list_params.rbs

@@ -6,7 +6,7 @@ module FinchAPI
         & FinchAPI::request_parameters
 
       class PayGroupListParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_reader individual_id: String?

data/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs

@@ -4,7 +4,7 @@ module FinchAPI
       type pay_group_retrieve_params = {  } & FinchAPI::request_parameters
 
       class PayGroupRetrieveParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         def initialize: (?request_options: FinchAPI::request_opts) -> void

data/sig/finch-api/models/provider_list_params.rbs

@@ -3,7 +3,7 @@ module FinchAPI
     type provider_list_params = {  } & FinchAPI::request_parameters
 
     class ProviderListParams < FinchAPI::BaseModel
-      extend FinchAPI::RequestParameters::Converter
+      extend FinchAPI::Type::RequestParameters::Converter
       include FinchAPI::RequestParameters
 
       def initialize: (?request_options: FinchAPI::request_opts) -> void

data/sig/finch-api/models/request_forwarding_forward_params.rbs

@@ -11,7 +11,7 @@ module FinchAPI
       & FinchAPI::request_parameters
 
     class RequestForwardingForwardParams < FinchAPI::BaseModel
-      extend FinchAPI::RequestParameters::Converter
+      extend FinchAPI::Type::RequestParameters::Converter
       include FinchAPI::RequestParameters
 
       attr_accessor method_: String

data/sig/finch-api/models/sandbox/company_update_params.rbs

@@ -15,7 +15,7 @@ module FinchAPI
         & FinchAPI::request_parameters
 
       class CompanyUpdateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_accessor accounts: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]?

data/sig/finch-api/models/sandbox/connection_create_params.rbs

@@ -11,7 +11,7 @@ module FinchAPI
         & FinchAPI::request_parameters
 
       class ConnectionCreateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_accessor provider_id: String

data/sig/finch-api/models/sandbox/connections/account_create_params.rbs

@@ -12,7 +12,7 @@ module FinchAPI
           & FinchAPI::request_parameters
 
         class AccountCreateParams < FinchAPI::BaseModel
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           attr_accessor company_id: String

data/sig/finch-api/models/sandbox/connections/account_update_params.rbs

@@ -7,7 +7,7 @@ module FinchAPI
           & FinchAPI::request_parameters
 
         class AccountUpdateParams < FinchAPI::BaseModel
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           attr_reader connection_status: FinchAPI::Models::connection_status_type?

data/sig/finch-api/models/sandbox/directory_create_params.rbs

@@ -8,7 +8,7 @@ module FinchAPI
         & FinchAPI::request_parameters
 
       class DirectoryCreateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_reader body: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body]?

data/sig/finch-api/models/sandbox/employment_update_params.rbs

@@ -25,7 +25,7 @@ module FinchAPI
         & FinchAPI::request_parameters
 
       class EmploymentUpdateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_accessor class_code: String?

data/sig/finch-api/models/sandbox/individual_update_params.rbs

@@ -19,7 +19,7 @@ module FinchAPI
         & FinchAPI::request_parameters
 
       class IndividualUpdateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_accessor dob: String?

data/sig/finch-api/models/sandbox/job_create_params.rbs

@@ -6,7 +6,7 @@ module FinchAPI
         & FinchAPI::request_parameters
 
       class JobCreateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_accessor type: FinchAPI::Models::Sandbox::JobCreateParams::type_

data/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs

@@ -5,7 +5,7 @@ module FinchAPI
         type configuration_retrieve_params = {  } & FinchAPI::request_parameters
 
         class ConfigurationRetrieveParams < FinchAPI::BaseModel
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           def initialize: (?request_options: FinchAPI::request_opts) -> void

data/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs

@@ -5,7 +5,7 @@ module FinchAPI
         type configuration_update_params = {  } & FinchAPI::request_parameters
 
         class ConfigurationUpdateParams < FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           def initialize: (?request_options: FinchAPI::request_opts) -> void

data/sig/finch-api/models/sandbox/payment_create_params.rbs

@@ -10,7 +10,7 @@ module FinchAPI
         & FinchAPI::request_parameters
 
       class PaymentCreateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_reader end_date: String?

data/sig/finch-api/page.rbs

@@ -1,6 +1,6 @@
 module FinchAPI
   class Page[Elem]
-    include FinchAPI::BasePage[Elem]
+    include FinchAPI::Type::BasePage[Elem]
 
     attr_accessor data: ::Array[Elem]?
 

data/sig/finch-api/request_options.rbs

@@ -2,16 +2,6 @@ module FinchAPI
   type request_opts =
     FinchAPI::RequestOptions | FinchAPI::request_options | ::Hash[Symbol, top]
 
-  type request_parameters = { request_options: FinchAPI::request_opts }
-
-  module RequestParameters
-    attr_accessor request_options: FinchAPI::request_opts
-
-    module Converter
-      def dump_request: (top params) -> [top, ::Hash[Symbol, top]]
-    end
-  end
-
   type request_options =
     {
       idempotency_key: String?,

data/sig/finch-api/responses_page.rbs

@@ -1,6 +1,6 @@
 module FinchAPI
   class ResponsesPage[Elem]
-    include FinchAPI::BasePage[Elem]
+    include FinchAPI::Type::BasePage[Elem]
 
     attr_accessor responses: ::Array[Elem]?
 

data/sig/finch-api/single_page.rbs

@@ -1,6 +1,6 @@
 module FinchAPI
   class SinglePage[Elem] < ::Array[Elem]
-    include FinchAPI::BasePage[Elem]
+    include FinchAPI::Type::BasePage[Elem]
 
     def next_page?: -> bool
 

data/sig/finch-api/transport/base_client.rbs

@@ -0,0 +1,110 @@
+module FinchAPI
+  module Transport
+    class BaseClient
+      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?,
+          page: Class?,
+          stream: Class?,
+          model: FinchAPI::Type::Converter::input?,
+          options: FinchAPI::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!: (
+        FinchAPI::Transport::BaseClient::request_components req
+      ) -> void
+
+      def self.should_retry?: (
+        Integer status,
+        headers: ::Hash[String, String]
+      ) -> bool
+
+      def self.follow_redirect: (
+        FinchAPI::Transport::BaseClient::request_input request,
+        status: Integer,
+        response_headers: ::Hash[String, String]
+      ) -> FinchAPI::Transport::BaseClient::request_input
+
+      def self.reap_connection!: (
+        Integer | FinchAPI::APIConnectionError status,
+        stream: Enumerable[String]?
+      ) -> void
+
+      # @api private
+      attr_accessor requester: FinchAPI::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: (
+        FinchAPI::Transport::BaseClient::request_components req,
+        FinchAPI::request_options opts
+      ) -> FinchAPI::Transport::BaseClient::request_input
+
+      private def retry_delay: (
+        ::Hash[String, String] headers,
+        retry_count: Integer
+      ) -> Float
+
+      private def send_request: (
+        FinchAPI::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?,
+          ?page: Class?,
+          ?stream: Class?,
+          ?model: FinchAPI::Type::Converter::input?,
+          ?options: FinchAPI::request_opts?
+        ) -> top
+        | (FinchAPI::Transport::BaseClient::request_components req) -> top
+
+      def inspect: -> String
+    end
+  end
+end

data/sig/finch-api/transport/pooled_net_requester.rbs

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

data/sig/finch-api/type/array_of.rbs

@@ -0,0 +1,36 @@
+module FinchAPI
+  module Type
+    class ArrayOf[Elem]
+      include FinchAPI::Type::Converter
+
+      def self.[]: (
+        ::Hash[Symbol, top]
+        | ^-> FinchAPI::Type::Converter::input
+        | FinchAPI::Type::Converter::input type_info,
+        ?::Hash[Symbol, top] spec
+      ) -> instance
+
+      def ===: (top other) -> bool
+
+      def ==: (top other) -> bool
+
+      def coerce: (
+        Enumerable[Elem] | top value,
+        state: FinchAPI::Type::Converter::state
+      ) -> (::Array[top] | top)
+
+      def dump: (Enumerable[Elem] | top value) -> (::Array[top] | top)
+
+      def item_type: -> Elem
+
+      def nilable?: -> bool
+
+      def initialize: (
+        ::Hash[Symbol, top]
+        | ^-> FinchAPI::Type::Converter::input
+        | FinchAPI::Type::Converter::input type_info,
+        ?::Hash[Symbol, top] spec
+      ) -> void
+    end
+  end
+end

data/sig/finch-api/type/base_model.rbs

@@ -0,0 +1,73 @@
+module FinchAPI
+  module Type
+    class BaseModel
+      extend FinchAPI::Type::Converter
+
+      type known_field =
+        { mode: (:coerce | :dump)?, required: bool, nilable: bool }
+
+      def self.known_fields: -> ::Hash[Symbol, (FinchAPI::BaseModel::known_field
+      & { type_fn: (^-> FinchAPI::Type::Converter::input) })]
+
+      def self.fields: -> ::Hash[Symbol, (FinchAPI::BaseModel::known_field
+      & { type: FinchAPI::Type::Converter::input })]
+
+      private def self.add_field: (
+        Symbol name_sym,
+        required: bool,
+        type_info: {
+          const: (nil | bool | Integer | Float | Symbol)?,
+          enum: ^-> FinchAPI::Type::Converter::input?,
+          union: ^-> FinchAPI::Type::Converter::input?,
+          api_name: Symbol
+        }
+        | ^-> FinchAPI::Type::Converter::input
+        | FinchAPI::Type::Converter::input,
+        spec: ::Hash[Symbol, top]
+      ) -> void
+
+      def self.required: (
+        Symbol name_sym,
+        ::Hash[Symbol, top]
+        | ^-> FinchAPI::Type::Converter::input
+        | FinchAPI::Type::Converter::input type_info,
+        ?::Hash[Symbol, top] spec
+      ) -> void
+
+      def self.optional: (
+        Symbol name_sym,
+        ::Hash[Symbol, top]
+        | ^-> FinchAPI::Type::Converter::input
+        | FinchAPI::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 ==: (top other) -> bool
+
+      def self.coerce: (
+        FinchAPI::BaseModel | ::Hash[top, top] | top value,
+        state: FinchAPI::Type::Converter::state
+      ) -> (instance | top)
+
+      def self.dump: (instance | top value) -> (::Hash[top, top] | top)
+
+      def []: (Symbol key) -> top?
+
+      def to_h: -> ::Hash[Symbol, top]
+
+      alias to_hash to_h
+
+      def deconstruct_keys: (::Array[Symbol]? keys) -> ::Hash[Symbol, top]
+
+      def initialize: (?::Hash[Symbol, top] | self data) -> void
+
+      def inspect: -> String
+    end
+  end
+end

data/sig/finch-api/type/base_page.rbs

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

data/sig/finch-api/type/boolean_model.rbs

@@ -0,0 +1,18 @@
+module FinchAPI
+  module Type
+    class BooleanModel
+      extend FinchAPI::Type::Converter
+
+      def self.===: (top other) -> bool
+
+      def self.==: (top other) -> bool
+
+      def self.coerce: (
+        bool | top value,
+        state: FinchAPI::Type::Converter::state
+      ) -> (bool | top)
+
+      def self.dump: (bool | top value) -> (bool | top)
+    end
+  end
+end

data/sig/finch-api/type/converter.rbs

@@ -0,0 +1,36 @@
+module FinchAPI
+  module Type
+    module Converter
+      type input = FinchAPI::Type::Converter | Class
+
+      type state =
+        {
+          strictness: bool | :strong,
+          exactness: { yes: Integer, no: Integer, maybe: Integer },
+          branched: Integer
+        }
+
+      def coerce: (top value, state: FinchAPI::Type::Converter::state) -> top
+
+      def dump: (top value) -> top
+
+      def self.type_info: (
+        {
+          const: (nil | bool | Integer | Float | Symbol)?,
+          enum: ^-> FinchAPI::Type::Converter::input?,
+          union: ^-> FinchAPI::Type::Converter::input?
+        }
+        | ^-> FinchAPI::Type::Converter::input
+        | FinchAPI::Type::Converter::input spec
+      ) -> (^-> top)
+
+      def self.coerce: (
+        FinchAPI::Type::Converter::input target,
+        top value,
+        ?state: FinchAPI::Type::Converter::state
+      ) -> top
+
+      def self.dump: (FinchAPI::Type::Converter::input target, top value) -> top
+    end
+  end
+end

data/sig/finch-api/type/enum.rbs

@@ -0,0 +1,22 @@
+module FinchAPI
+  module Type
+    module Enum
+      include FinchAPI::Type::Converter
+
+      def self.values: -> ::Array[(nil | bool | Integer | Float | Symbol)]
+
+      private def self.finalize!: -> void
+
+      def ===: (top other) -> bool
+
+      def ==: (top other) -> bool
+
+      def coerce: (
+        String | Symbol | top value,
+        state: FinchAPI::Type::Converter::state
+      ) -> (Symbol | top)
+
+      def dump: (Symbol | top value) -> (Symbol | top)
+    end
+  end
+end

data/sig/finch-api/type/hash_of.rbs

@@ -0,0 +1,36 @@
+module FinchAPI
+  module Type
+    class HashOf[Elem]
+      include FinchAPI::Type::Converter
+
+      def self.[]: (
+        ::Hash[Symbol, top]
+        | ^-> FinchAPI::Type::Converter::input
+        | FinchAPI::Type::Converter::input type_info,
+        ?::Hash[Symbol, top] spec
+      ) -> instance
+
+      def ===: (top other) -> bool
+
+      def ==: (top other) -> bool
+
+      def coerce: (
+        ::Hash[top, top] | top value,
+        state: FinchAPI::Type::Converter::state
+      ) -> (::Hash[Symbol, top] | top)
+
+      def dump: (::Hash[top, top] | top value) -> (::Hash[Symbol, top] | top)
+
+      def item_type: -> Elem
+
+      def nilable?: -> bool
+
+      def initialize: (
+        ::Hash[Symbol, top]
+        | ^-> FinchAPI::Type::Converter::input
+        | FinchAPI::Type::Converter::input type_info,
+        ?::Hash[Symbol, top] spec
+      ) -> void
+    end
+  end
+end

data/sig/finch-api/type/request_parameters.rbs

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