finch-api 0.1.0.pre.alpha.19 → 0.1.0.pre.alpha.20

data/lib/finch_api.rb

@@ -20,7 +20,9 @@ require "uri"
 
 # We already ship the preferred sorbet manifests in the package itself.
 # `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
-if Object.const_defined?(:Tapioca) && caller.chain([$PROGRAM_NAME]).chain(ARGV).grep(/tapioca/)
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
   return
 end
 
@@ -74,7 +76,6 @@ require_relative "finch_api/models/hris/benefit_features_and_operations"
 require_relative "finch_api/models/hris/benefit_frequency"
 require_relative "finch_api/models/hris/benefit_list_params"
 require_relative "finch_api/models/hris/benefit_list_supported_benefits_params"
-require_relative "finch_api/models/hris/benefit_list_supported_benefits_response"
 require_relative "finch_api/models/hris/benefit_retrieve_params"
 require_relative "finch_api/models/hris/benefits/enrolled_individual_benefit_response"
 require_relative "finch_api/models/hris/benefits/individual_benefit"
@@ -119,6 +120,7 @@ require_relative "finch_api/models/hris/individual_retrieve_many_params"
 require_relative "finch_api/models/hris/payment"
 require_relative "finch_api/models/hris/payment_list_params"
 require_relative "finch_api/models/hris/pay_statement"
+require_relative "finch_api/models/hris/pay_statement_data_sync_in_progress"
 require_relative "finch_api/models/hris/pay_statement_response"
 require_relative "finch_api/models/hris/pay_statement_response_body"
 require_relative "finch_api/models/hris/pay_statement_retrieve_many_params"

data/rbi/finch_api/errors.rbi

@@ -8,6 +8,22 @@ module FinchAPI
     end
 
     class ConversionError < FinchAPI::Errors::Error
+      sig { returns(T.nilable(StandardError)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          on: T::Class[StandardError],
+          method: Symbol,
+          target: T.anything,
+          value: T.anything,
+          cause: T.nilable(StandardError)
+        ).returns(T.attached_class)
+      end
+      def self.new(on:, method:, target:, value:, cause: nil)
+      end
     end
 
     class APIError < FinchAPI::Errors::Error

data/rbi/finch_api/internal/type/array_of.rbi

@@ -8,6 +8,7 @@ module FinchAPI
       # Array of items of a given type.
       class ArrayOf
         include FinchAPI::Internal::Type::Converter
+        include FinchAPI::Internal::Util::SorbetRuntimeSupport
 
         abstract!
 
@@ -63,6 +64,11 @@ module FinchAPI
         def dump(value, state:)
         end
 
+        # @api private
+        sig { returns(T.anything) }
+        def to_sorbet_type
+        end
+
         # @api private
         sig { returns(Elem) }
         protected def item_type

data/rbi/finch_api/internal/type/base_model.rbi

@@ -197,6 +197,11 @@ module FinchAPI
           end
           def dump(value, state:)
           end
+
+          # @api private
+          sig { returns(T.anything) }
+          def to_sorbet_type
+          end
         end
 
         class << self

data/rbi/finch_api/internal/type/boolean.rbi

@@ -8,6 +8,7 @@ module FinchAPI
       # Ruby has no Boolean class; this is something for models to refer to.
       class Boolean
         extend FinchAPI::Internal::Type::Converter
+        extend FinchAPI::Internal::Util::SorbetRuntimeSupport
 
         abstract!
 
@@ -21,6 +22,8 @@ module FinchAPI
 
         class << self
           # @api private
+          #
+          # Coerce value to Boolean if possible, otherwise return the original value.
           sig do
             override
               .params(
@@ -43,6 +46,11 @@ module FinchAPI
           end
           def dump(value, state:)
           end
+
+          # @api private
+          sig { returns(T.anything) }
+          def to_sorbet_type
+          end
         end
       end
     end

data/rbi/finch_api/internal/type/converter.rbi

@@ -15,12 +15,14 @@ module FinchAPI
         CoerceState =
           T.type_alias do
             {
-              strictness: T.any(T::Boolean, Symbol),
+              translate_names: T::Boolean,
+              strictness: T::Boolean,
               exactness: {
                 yes: Integer,
                 no: Integer,
                 maybe: Integer
               },
+              error: T::Class[StandardError],
               branched: Integer
             }
           end
@@ -88,6 +90,15 @@ module FinchAPI
           def self.type_info(spec)
           end
 
+          # @api private
+          sig do
+            params(translate_names: T::Boolean).returns(
+              FinchAPI::Internal::Type::Converter::CoerceState
+            )
+          end
+          def self.new_coerce_state(translate_names: true)
+          end
+
           # @api private
           #
           # Based on `target`, transform `value` into `target`, to the extent possible:
@@ -109,14 +120,11 @@ module FinchAPI
           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:
+            # The `strictness` is one of `true`, `false`. 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
@@ -128,15 +136,7 @@ module FinchAPI
             # - `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
-            }
+            state: FinchAPI::Internal::Type::Converter.new_coerce_state
           )
           end
 

data/rbi/finch_api/internal/type/enum.rbi

@@ -67,6 +67,11 @@ module FinchAPI
         def dump(value, state:)
         end
 
+        # @api private
+        sig { returns(T.anything) }
+        def to_sorbet_type
+        end
+
         # @api private
         sig { params(depth: Integer).returns(String) }
         def inspect(depth: 0)

data/rbi/finch_api/internal/type/file_input.rbi

@@ -47,6 +47,11 @@ module FinchAPI
           end
           def dump(value, state:)
           end
+
+          # @api private
+          sig { returns(T.anything) }
+          def to_sorbet_type
+          end
         end
       end
     end

data/rbi/finch_api/internal/type/hash_of.rbi

@@ -8,6 +8,7 @@ module FinchAPI
       # Hash of items of a given type.
       class HashOf
         include FinchAPI::Internal::Type::Converter
+        include FinchAPI::Internal::Util::SorbetRuntimeSupport
 
         abstract!
 
@@ -63,6 +64,11 @@ module FinchAPI
         def dump(value, state:)
         end
 
+        # @api private
+        sig { returns(T.anything) }
+        def to_sorbet_type
+        end
+
         # @api private
         sig { returns(Elem) }
         protected def item_type

data/rbi/finch_api/internal/type/union.rbi

@@ -78,6 +78,11 @@ module FinchAPI
         end
 
         # @api private
+        #
+        # Tries to efficiently coerce the given value to one of the known variants.
+        #
+        # If the value cannot match any of the known variants, the coercion is considered
+        # non-viable and returns the original value.
         sig do
           override
             .params(
@@ -101,6 +106,11 @@ module FinchAPI
         def dump(value, state:)
         end
 
+        # @api private
+        sig { returns(T.anything) }
+        def to_sorbet_type
+        end
+
         # @api private
         sig { params(depth: Integer).returns(String) }
         def inspect(depth: 0)

data/rbi/finch_api/internal/type/unknown.rbi

@@ -8,6 +8,7 @@ module FinchAPI
       # When we don't know what to expect for the value.
       class Unknown
         extend FinchAPI::Internal::Type::Converter
+        extend FinchAPI::Internal::Util::SorbetRuntimeSupport
 
         abstract!
 
@@ -21,6 +22,8 @@ module FinchAPI
 
         class << self
           # @api private
+          #
+          # No coercion needed for Unknown type.
           sig do
             override
               .params(
@@ -43,6 +46,11 @@ module FinchAPI
           end
           def dump(value, state:)
           end
+
+          # @api private
+          sig { returns(T.anything) }
+          def to_sorbet_type
+          end
         end
       end
     end

data/rbi/finch_api/internal/util.rbi

@@ -11,6 +11,15 @@ module FinchAPI
       def self.monotonic_secs
       end
 
+      # @api private
+      sig do
+        params(ns: T.any(Module, T::Class[T.anything])).returns(
+          T::Enumerable[T.any(Module, T::Class[T.anything])]
+        )
+      end
+      def self.walk_namespaces(ns)
+      end
+
       class << self
         # @api private
         sig { returns(String) }
@@ -323,6 +332,8 @@ module FinchAPI
         end
 
         # @api private
+        #
+        # https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#special-considerations-for-multipart-content
         sig do
           params(body: T.anything).returns([String, T::Enumerable[String]])
         end
@@ -441,10 +452,35 @@ module FinchAPI
         def const_missing(name)
         end
 
+        # @api private
+        sig { params(name: Symbol).returns(T::Boolean) }
+        def sorbet_constant_defined?(name)
+        end
+
         # @api private
         sig { params(name: Symbol, blk: T.proc.returns(T.anything)).void }
         def define_sorbet_constant!(name, &blk)
         end
+
+        # @api private
+        sig { returns(T.anything) }
+        def to_sorbet_type
+        end
+
+        class << self
+          # @api private
+          sig do
+            params(
+              type:
+                T.any(
+                  FinchAPI::Internal::Util::SorbetRuntimeSupport,
+                  T.anything
+                )
+            ).returns(T.anything)
+          end
+          def to_sorbet_type(type)
+          end
+        end
       end
     end
   end

data/rbi/finch_api/internal.rbi

@@ -8,6 +8,9 @@ module FinchAPI
     # this alias might be refined in the future.
     AnyHash = T.type_alias { T::Hash[Symbol, T.anything] }
 
+    FileInput =
+      T.type_alias { T.any(Pathname, StringIO, IO, String, FinchAPI::FilePart) }
+
     OMIT = T.let(Object.new.freeze, T.anything)
   end
 end

data/rbi/finch_api/models/connect/session_new_params.rbi

@@ -49,8 +49,8 @@ module FinchAPI
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :manual
 
-        # The number of minutes until the session expires (defaults to 43,200, which is 30
-        # days)
+        # The number of minutes until the session expires (defaults to 129,600, which is
+        # 90 days)
         sig { returns(T.nilable(Float)) }
         attr_accessor :minutes_to_expire
 
@@ -90,8 +90,8 @@ module FinchAPI
           customer_email: nil,
           integration: nil,
           manual: nil,
-          # The number of minutes until the session expires (defaults to 43,200, which is 30
-          # days)
+          # The number of minutes until the session expires (defaults to 129,600, which is
+          # 90 days)
           minutes_to_expire: nil,
           redirect_uri: nil,
           sandbox: nil,