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

data/rbi/lib/finch-api/type/converter.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module FinchAPI
+  module Type
+    # @api private
+    module Converter
+      Input = T.type_alias { T.any(FinchAPI::Type::Converter, T::Class[T.anything]) }
+
+      State =
+        T.type_alias do
+          {
+            strictness: T.any(T::Boolean, Symbol),
+            exactness: {yes: Integer, no: Integer, maybe: Integer},
+            branched: Integer
+          }
+        end
+
+      # @api private
+      sig do
+        overridable.params(value: T.anything, state: FinchAPI::Type::Converter::State).returns(T.anything)
+      end
+      def coerce(value, state:)
+      end
+
+      # @api private
+      sig { overridable.params(value: T.anything).returns(T.anything) }
+      def dump(value)
+      end
+
+      class << self
+        # @api private
+        sig do
+          params(
+            spec: T.any(
+              {
+                const: T.nilable(T.any(NilClass, T::Boolean, Integer, Float, Symbol)),
+                enum: T.nilable(T.proc.returns(FinchAPI::Type::Converter::Input)),
+                union: T.nilable(T.proc.returns(FinchAPI::Type::Converter::Input))
+              },
+              T.proc.returns(FinchAPI::Type::Converter::Input),
+              FinchAPI::Type::Converter::Input
+            )
+          )
+            .returns(T.proc.returns(T.anything))
+        end
+        def self.type_info(spec)
+        end
+
+        # @api private
+        #
+        # Based on `target`, transform `value` into `target`, to the extent possible:
+        #
+        #   1. if the given `value` conforms to `target` already, return the given `value`
+        #   2. if it's possible and safe to convert the given `value` to `target`, then the
+        #      converted value
+        #   3. otherwise, the given `value` unaltered
+        #
+        #   The coercion process is subject to improvement between minor release versions.
+        #   See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode
+        sig do
+          params(
+            target: FinchAPI::Type::Converter::Input,
+            value: T.anything,
+            state: FinchAPI::Type::Converter::State
+          )
+            .returns(T.anything)
+        end
+        def self.coerce(
+          target,
+          value,
+          # The `strictness` is one of `true`, `false`, or `:strong`. This informs the
+          #   coercion strategy when we have to decide between multiple possible conversion
+          #   targets:
+          #
+          #   - `true`: the conversion must be exact, with minimum coercion.
+          #   - `false`: the conversion can be approximate, with some coercion.
+          #   - `:strong`: the conversion must be exact, with no coercion, and raise an error
+          #     if not possible.
+          #
+          #   The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
+          #   any given conversion attempt, the exactness will be updated based on how closely
+          #   the value recursively matches the target type:
+          #
+          #   - `yes`: the value can be converted to the target type with minimum coercion.
+          #   - `maybe`: the value can be converted to the target type with some reasonable
+          #     coercion.
+          #   - `no`: the value cannot be converted to the target type.
+          #
+          #   See implementation below for more details.
+          state: {strictness: true, exactness: {yes: 0, no: 0, maybe: 0}, branched: 0}
+        )
+        end
+
+        # @api private
+        sig { params(target: FinchAPI::Type::Converter::Input, value: T.anything).returns(T.anything) }
+        def self.dump(target, value)
+        end
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/type/enum.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module FinchAPI
+  module Type
+    # @api private
+    #
+    # A value from among a specified list of options. OpenAPI enum values map to Ruby
+    #   values in the SDK as follows:
+    #
+    #   1. boolean => true | false
+    #   2. integer => Integer
+    #   3. float => Float
+    #   4. string => Symbol
+    #
+    #   We can therefore convert string values to Symbols, but can't convert other
+    #   values safely.
+    module Enum
+      include FinchAPI::Type::Converter
+
+      # All of the valid Symbol values for this enum.
+      sig { overridable.returns(T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)]) }
+      def values
+      end
+
+      # @api private
+      #
+      # Guard against thread safety issues by instantiating `@values`.
+      sig { void }
+      private def finalize!
+      end
+
+      sig { params(other: T.anything).returns(T::Boolean) }
+      def ===(other)
+      end
+
+      sig { params(other: T.anything).returns(T::Boolean) }
+      def ==(other)
+      end
+
+      # @api private
+      #
+      # Unlike with primitives, `Enum` additionally validates that the value is a member
+      #   of the enum.
+      sig do
+        override
+          .params(value: T.any(String, Symbol, T.anything), state: FinchAPI::Type::Converter::State)
+          .returns(T.any(Symbol, T.anything))
+      end
+      def coerce(value, state:)
+      end
+
+      # @api private
+      sig { override.params(value: T.any(Symbol, T.anything)).returns(T.any(Symbol, T.anything)) }
+      def dump(value)
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/type/hash_of.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module FinchAPI
+  module Type
+    # @api private
+    #
+    # Hash of items of a given type.
+    class HashOf
+      include FinchAPI::Type::Converter
+
+      abstract!
+      final!
+
+      Elem = type_member(:out)
+
+      sig(:final) do
+        params(
+          type_info: T.any(
+            FinchAPI::Util::AnyHash,
+            T.proc.returns(FinchAPI::Type::Converter::Input),
+            FinchAPI::Type::Converter::Input
+          ),
+          spec: FinchAPI::Util::AnyHash
+        )
+          .returns(T.attached_class)
+      end
+      def self.[](type_info, spec = {})
+      end
+
+      sig(:final) { params(other: T.anything).returns(T::Boolean) }
+      def ===(other)
+      end
+
+      sig(:final) { params(other: T.anything).returns(T::Boolean) }
+      def ==(other)
+      end
+
+      # @api private
+      sig(:final) do
+        override
+          .params(value: T.any(
+            T::Hash[T.anything, T.anything],
+            T.anything
+          ),
+                  state: FinchAPI::Type::Converter::State)
+          .returns(T.any(FinchAPI::Util::AnyHash, T.anything))
+      end
+      def coerce(value, state:)
+      end
+
+      # @api private
+      sig(:final) do
+        override
+          .params(value: T.any(T::Hash[T.anything, T.anything], T.anything))
+          .returns(T.any(FinchAPI::Util::AnyHash, T.anything))
+      end
+      def dump(value)
+      end
+
+      # @api private
+      sig(:final) { returns(Elem) }
+      protected def item_type
+      end
+
+      # @api private
+      sig(:final) { returns(T::Boolean) }
+      protected def nilable?
+      end
+
+      # @api private
+      sig(:final) do
+        params(
+          type_info: T.any(
+            FinchAPI::Util::AnyHash,
+            T.proc.returns(FinchAPI::Type::Converter::Input),
+            FinchAPI::Type::Converter::Input
+          ),
+          spec: FinchAPI::Util::AnyHash
+        )
+          .void
+      end
+      def initialize(type_info, spec = {})
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/type/request_parameters.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module FinchAPI
+  module Type
+    # @api private
+    module RequestParameters
+      # Options to specify HTTP behaviour for this request.
+      sig { returns(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) }
+      attr_accessor :request_options
+
+      # @api private
+      module Converter
+        # @api private
+        sig { params(params: T.anything).returns([T.anything, FinchAPI::Util::AnyHash]) }
+        def dump_request(params)
+        end
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/type/union.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module FinchAPI
+  module Type
+    # @api private
+    module Union
+      include FinchAPI::Type::Converter
+
+      # @api private
+      #
+      # All of the specified variant info for this union.
+      sig { returns(T::Array[[T.nilable(Symbol), T.proc.returns(FinchAPI::Type::Converter::Input)]]) }
+      private def known_variants
+      end
+
+      # @api private
+      sig { returns(T::Array[[T.nilable(Symbol), T.anything]]) }
+      protected def derefed_variants
+      end
+
+      # All of the specified variants for this union.
+      sig { overridable.returns(T::Array[T.anything]) }
+      def variants
+      end
+
+      # @api private
+      sig { params(property: Symbol).void }
+      private def discriminator(property)
+      end
+
+      # @api private
+      sig do
+        params(
+          key: T.any(Symbol, FinchAPI::Util::AnyHash, T.proc.returns(T.anything), T.anything),
+          spec: T.any(FinchAPI::Util::AnyHash, T.proc.returns(T.anything), T.anything)
+        )
+          .void
+      end
+      private def variant(key, spec = nil)
+      end
+
+      # @api private
+      sig { params(value: T.anything).returns(T.nilable(T.anything)) }
+      private def resolve_variant(value)
+      end
+
+      sig { params(other: T.anything).returns(T::Boolean) }
+      def ===(other)
+      end
+
+      sig { params(other: T.anything).returns(T::Boolean) }
+      def ==(other)
+      end
+
+      # @api private
+      sig { override.params(value: T.anything, state: FinchAPI::Type::Converter::State).returns(T.anything) }
+      def coerce(value, state:)
+      end
+
+      # @api private
+      sig { override.params(value: T.anything).returns(T.anything) }
+      def dump(value)
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/type/unknown.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module FinchAPI
+  module Type
+    # @api private
+    #
+    # When we don't know what to expect for the value.
+    class Unknown
+      extend FinchAPI::Type::Converter
+
+      abstract!
+      final!
+
+      sig(:final) { params(other: T.anything).returns(T::Boolean) }
+      def self.===(other)
+      end
+
+      sig(:final) { params(other: T.anything).returns(T::Boolean) }
+      def self.==(other)
+      end
+
+      class << self
+        # @api private
+        sig(:final) do
+          override.params(value: T.anything, state: FinchAPI::Type::Converter::State).returns(T.anything)
+        end
+        def coerce(value, state:)
+        end
+
+        # @api private
+        sig(:final) { override.params(value: T.anything).returns(T.anything) }
+        def dump(value)
+        end
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/type.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module FinchAPI
+  Unknown = FinchAPI::Type::Unknown
+
+  BooleanModel = FinchAPI::Type::BooleanModel
+
+  Enum = FinchAPI::Type::Enum
+
+  Union = FinchAPI::Type::Union
+
+  ArrayOf = FinchAPI::Type::ArrayOf
+
+  HashOf = FinchAPI::Type::HashOf
+
+  BaseModel = FinchAPI::Type::BaseModel
+
+  RequestParameters = FinchAPI::Type::RequestParameters
+
+  # This module contains various type declarations.
+  module Type
+  end
+end

data/rbi/lib/finch-api/version.rbi

@@ -1,5 +1,5 @@
 # typed: strong
 
 module FinchAPI
-  VERSION = "0.1.0-alpha.4"
+  VERSION = "0.1.0-alpha.5"
 end

data/sig/finch-api/client.rbs

@@ -1,5 +1,5 @@
 module FinchAPI
-  class Client < FinchAPI::BaseClient
+  class Client < FinchAPI::Transport::BaseClient
     DEFAULT_MAX_RETRIES: 2
 
     DEFAULT_TIMEOUT_IN_SECONDS: Float

data/sig/finch-api/individuals_page.rbs

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

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

@@ -10,7 +10,7 @@ module FinchAPI
       & FinchAPI::request_parameters
 
     class AccessTokenCreateParams < FinchAPI::BaseModel
-      extend FinchAPI::RequestParameters::Converter
+      extend FinchAPI::Type::RequestParameters::Converter
       include FinchAPI::RequestParameters
 
       attr_accessor code: String

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

@@ -3,7 +3,7 @@ module FinchAPI
     type account_disconnect_params = {  } & FinchAPI::request_parameters
 
     class AccountDisconnectParams < 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/account_introspect_params.rbs

@@ -3,7 +3,7 @@ module FinchAPI
     type account_introspect_params = {  } & FinchAPI::request_parameters
 
     class AccountIntrospectParams < 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/connect/session_new_params.rbs

@@ -16,7 +16,7 @@ module FinchAPI
         & FinchAPI::request_parameters
 
       class SessionNewParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_accessor customer_id: String

data/sig/finch-api/models/connect/session_reauthenticate_params.rbs

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

data/sig/finch-api/models/hris/benefit_create_params.rbs

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

data/sig/finch-api/models/hris/benefit_list_params.rbs

@@ -4,7 +4,7 @@ module FinchAPI
       type benefit_list_params = {  } & FinchAPI::request_parameters
 
       class BenefitListParams < 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/hris/benefit_list_supported_benefits_params.rbs

@@ -5,7 +5,7 @@ module FinchAPI
         {  } & FinchAPI::request_parameters
 
       class BenefitListSupportedBenefitsParams < 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/hris/benefit_retrieve_params.rbs

@@ -4,7 +4,7 @@ module FinchAPI
       type benefit_retrieve_params = {  } & FinchAPI::request_parameters
 
       class BenefitRetrieveParams < 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/hris/benefit_update_params.rbs

@@ -5,7 +5,7 @@ module FinchAPI
         { description: String } & FinchAPI::request_parameters
 
       class BenefitUpdateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_reader description: String?

data/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs

@@ -9,7 +9,7 @@ module FinchAPI
           & FinchAPI::request_parameters
 
         class IndividualEnrollManyParams < FinchAPI::BaseModel
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           attr_reader individuals: ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual]?

data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs

@@ -6,7 +6,7 @@ module FinchAPI
           {  } & FinchAPI::request_parameters
 
         class IndividualEnrolledIDsParams < 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/hris/benefits/individual_retrieve_many_benefits_params.rbs

@@ -6,7 +6,7 @@ module FinchAPI
           { individual_ids: String } & FinchAPI::request_parameters
 
         class IndividualRetrieveManyBenefitsParams < FinchAPI::BaseModel
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           attr_reader individual_ids: String?

data/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs

@@ -6,7 +6,7 @@ module FinchAPI
           { individual_ids: ::Array[String] } & FinchAPI::request_parameters
 
         class IndividualUnenrollManyParams < FinchAPI::BaseModel
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           attr_reader individual_ids: ::Array[String]?

data/sig/finch-api/models/hris/company_retrieve_params.rbs

@@ -4,7 +4,7 @@ module FinchAPI
       type company_retrieve_params = {  } & FinchAPI::request_parameters
 
       class CompanyRetrieveParams < 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/hris/directory_list_individuals_params.rbs

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

data/sig/finch-api/models/hris/directory_list_params.rbs

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

data/sig/finch-api/models/hris/document_list_params.rbs

@@ -11,7 +11,7 @@ module FinchAPI
         & FinchAPI::request_parameters
 
       class DocumentListParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_reader individual_ids: ::Array[String]?

data/sig/finch-api/models/hris/document_retreive_params.rbs

@@ -4,7 +4,7 @@ module FinchAPI
       type document_retreive_params = {  } & FinchAPI::request_parameters
 
       class DocumentRetreiveParams < 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/hris/employment_retrieve_many_params.rbs

@@ -8,7 +8,7 @@ module FinchAPI
         & FinchAPI::request_parameters
 
       class EmploymentRetrieveManyParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_accessor requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request]

data/sig/finch-api/models/hris/individual_retrieve_many_params.rbs

@@ -9,7 +9,7 @@ module FinchAPI
         & FinchAPI::request_parameters
 
       class IndividualRetrieveManyParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_accessor options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?

data/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs

@@ -8,7 +8,7 @@ module FinchAPI
         & FinchAPI::request_parameters
 
       class PayStatementRetrieveManyParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_accessor requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request]

data/sig/finch-api/models/hris/payment_list_params.rbs

@@ -5,7 +5,7 @@ module FinchAPI
         { end_date: Date, start_date: Date } & FinchAPI::request_parameters
 
       class PaymentListParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_accessor end_date: Date

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

@@ -9,7 +9,7 @@ module FinchAPI
         & FinchAPI::request_parameters
 
       class AutomatedCreateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         attr_accessor type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_