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

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Type
+    # @api private
+    #
+    # @abstract
+    #
+    # When we don't know what to expect for the value.
+    class Unknown
+      extend FinchAPI::Type::Converter
+
+      # rubocop:disable Lint/UnusedMethodArgument
+
+      # @param other [Object]
+      #
+      # @return [Boolean]
+      def self.===(other) = true
+
+      # @param other [Object]
+      #
+      # @return [Boolean]
+      def self.==(other) = other.is_a?(Class) && other <= FinchAPI::Unknown
+
+      class << self
+        # @api private
+        #
+        # @param value [Object]
+        #
+        # @param state [Hash{Symbol=>Object}] .
+        #
+        #   @option state [Boolean, :strong] :strictness
+        #
+        #   @option state [Hash{Symbol=>Object}] :exactness
+        #
+        #   @option state [Integer] :branched
+        #
+        # @return [Object]
+        def coerce(value, state:)
+          state.fetch(:exactness)[:yes] += 1
+          value
+        end
+
+        # @!parse
+        #   # @api private
+        #   #
+        #   # @param value [Object]
+        #   #
+        #   # @return [Object]
+        #   def dump(value) = super
+      end
+
+      # rubocop:enable Lint/UnusedMethodArgument
+    end
+  end
+end

data/lib/finch-api/type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+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/lib/finch-api/version.rb

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

data/lib/finch-api.rb

@@ -36,12 +36,21 @@ require "connection_pool"
 # Package files.
 require_relative "finch-api/version"
 require_relative "finch-api/util"
-require_relative "finch-api/base_model"
-require_relative "finch-api/base_page"
+require_relative "finch-api/type/converter"
+require_relative "finch-api/type/unknown"
+require_relative "finch-api/type/boolean_model"
+require_relative "finch-api/type/enum"
+require_relative "finch-api/type/union"
+require_relative "finch-api/type/array_of"
+require_relative "finch-api/type/hash_of"
+require_relative "finch-api/type/base_model"
+require_relative "finch-api/type/base_page"
+require_relative "finch-api/type/request_parameters"
+require_relative "finch-api/type"
 require_relative "finch-api/request_options"
 require_relative "finch-api/errors"
-require_relative "finch-api/base_client"
-require_relative "finch-api/pooled_net_requester"
+require_relative "finch-api/transport/base_client"
+require_relative "finch-api/transport/pooled_net_requester"
 require_relative "finch-api/client"
 require_relative "finch-api/individuals_page"
 require_relative "finch-api/page"

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

@@ -1,7 +1,7 @@
 # typed: strong
 
 module FinchAPI
-  class Client < FinchAPI::BaseClient
+  class Client < FinchAPI::Transport::BaseClient
     DEFAULT_MAX_RETRIES = 2
 
     DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)

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

@@ -2,7 +2,7 @@
 
 module FinchAPI
   class IndividualsPage
-    include FinchAPI::BasePage
+    include FinchAPI::Type::BasePage
 
     Elem = type_member
 

data/rbi/lib/finch-api/models/access_token_create_params.rbi

@@ -3,7 +3,7 @@
 module FinchAPI
   module Models
     class AccessTokenCreateParams < FinchAPI::BaseModel
-      extend FinchAPI::RequestParameters::Converter
+      extend FinchAPI::Type::RequestParameters::Converter
       include FinchAPI::RequestParameters
 
       sig { returns(String) }

data/rbi/lib/finch-api/models/account_disconnect_params.rbi

@@ -3,7 +3,7 @@
 module FinchAPI
   module Models
     class AccountDisconnectParams < FinchAPI::BaseModel
-      extend FinchAPI::RequestParameters::Converter
+      extend FinchAPI::Type::RequestParameters::Converter
       include FinchAPI::RequestParameters
 
       sig do

data/rbi/lib/finch-api/models/account_introspect_params.rbi

@@ -3,7 +3,7 @@
 module FinchAPI
   module Models
     class AccountIntrospectParams < FinchAPI::BaseModel
-      extend FinchAPI::RequestParameters::Converter
+      extend FinchAPI::Type::RequestParameters::Converter
       include FinchAPI::RequestParameters
 
       sig do

data/rbi/lib/finch-api/models/connect/session_new_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Connect
       class SessionNewParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         sig { returns(String) }

data/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Connect
       class SessionReauthenticateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # The ID of the existing connection to reauthenticate

data/rbi/lib/finch-api/models/hris/benefit_create_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       class BenefitCreateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # Name of the benefit as it appears in the provider and pay statements. Recommend

data/rbi/lib/finch-api/models/hris/benefit_list_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       class BenefitListParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         sig do

data/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       class BenefitListSupportedBenefitsParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         sig do

data/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       class BenefitRetrieveParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         sig do

data/rbi/lib/finch-api/models/hris/benefit_update_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       class BenefitUpdateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # Updated name or description.

data/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi

@@ -5,7 +5,7 @@ module FinchAPI
     module HRIS
       module Benefits
         class IndividualEnrollManyParams < FinchAPI::BaseModel
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           # Array of the individual_id to enroll and a configuration object.

data/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi

@@ -5,7 +5,7 @@ module FinchAPI
     module HRIS
       module Benefits
         class IndividualEnrolledIDsParams < FinchAPI::BaseModel
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           sig do

data/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi

@@ -5,7 +5,7 @@ module FinchAPI
     module HRIS
       module Benefits
         class IndividualRetrieveManyBenefitsParams < FinchAPI::BaseModel
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           # comma-delimited list of stable Finch uuids for each individual. If empty,

data/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi

@@ -5,7 +5,7 @@ module FinchAPI
     module HRIS
       module Benefits
         class IndividualUnenrollManyParams < FinchAPI::BaseModel
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           # Array of individual_ids to unenroll.

data/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       class CompanyRetrieveParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         sig do

data/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       class DirectoryListIndividualsParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # Number of employees to return (defaults to all)

data/rbi/lib/finch-api/models/hris/directory_list_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       class DirectoryListParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # Number of employees to return (defaults to all)

data/rbi/lib/finch-api/models/hris/document_list_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       class DocumentListParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # Comma-delimited list of stable Finch uuids for each individual. If empty,

data/rbi/lib/finch-api/models/hris/document_retreive_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       class DocumentRetreiveParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         sig do

data/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       class EmploymentRetrieveManyParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # The array of batch requests.

data/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       class IndividualRetrieveManyParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         sig { returns(T.nilable(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options)) }

data/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       class PayStatementRetrieveManyParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # The array of batch requests.

data/rbi/lib/finch-api/models/hris/payment_list_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       class PaymentListParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`

data/rbi/lib/finch-api/models/jobs/automated_create_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Jobs
       class AutomatedCreateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # The type of job to start.

data/rbi/lib/finch-api/models/jobs/automated_list_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Jobs
       class AutomatedListParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # Number of items to return

data/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Jobs
       class AutomatedRetrieveParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         sig do

data/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Jobs
       class ManualRetrieveParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         sig do

data/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Payroll
       class PayGroupListParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         sig { returns(T.nilable(String)) }

data/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Payroll
       class PayGroupRetrieveParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         sig do

data/rbi/lib/finch-api/models/provider_list_params.rbi

@@ -3,7 +3,7 @@
 module FinchAPI
   module Models
     class ProviderListParams < FinchAPI::BaseModel
-      extend FinchAPI::RequestParameters::Converter
+      extend FinchAPI::Type::RequestParameters::Converter
       include FinchAPI::RequestParameters
 
       sig do

data/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi

@@ -3,7 +3,7 @@
 module FinchAPI
   module Models
     class RequestForwardingForwardParams < FinchAPI::BaseModel
-      extend FinchAPI::RequestParameters::Converter
+      extend FinchAPI::Type::RequestParameters::Converter
       include FinchAPI::RequestParameters
 
       # The HTTP method for the forwarded request. Valid values include: `GET` , `POST`

data/rbi/lib/finch-api/models/sandbox/company_update_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Sandbox
       class CompanyUpdateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # An array of bank account objects associated with the payroll/HRIS system.

data/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Sandbox
       class ConnectionCreateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # The provider associated with the connection

data/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi

@@ -5,7 +5,7 @@ module FinchAPI
     module Sandbox
       module Connections
         class AccountCreateParams < FinchAPI::BaseModel
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           sig { returns(String) }

data/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi

@@ -5,7 +5,7 @@ module FinchAPI
     module Sandbox
       module Connections
         class AccountUpdateParams < FinchAPI::BaseModel
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           sig { returns(T.nilable(FinchAPI::Models::ConnectionStatusType::OrSymbol)) }

data/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Sandbox
       class DirectoryCreateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # Array of individuals to create. Takes all combined fields from `/individual` and

data/rbi/lib/finch-api/models/sandbox/directory_create_response.rbi

@@ -3,7 +3,7 @@
 module FinchAPI
   module Models
     module Sandbox
-      DirectoryCreateResponse = T.let(FinchAPI::ArrayOf[FinchAPI::Unknown], FinchAPI::Converter)
+      DirectoryCreateResponse = T.let(FinchAPI::ArrayOf[FinchAPI::Unknown], FinchAPI::Type::Converter)
     end
   end
 end

data/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Sandbox
       class EmploymentUpdateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # Worker's compensation classification code for this employee

data/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Sandbox
       class IndividualUpdateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         sig { returns(T.nilable(String)) }

data/rbi/lib/finch-api/models/sandbox/job_create_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Sandbox
       class JobCreateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         # The type of job to start. Currently the only supported type is `data_sync_all`

data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi

@@ -5,7 +5,7 @@ module FinchAPI
     module Sandbox
       module Jobs
         class ConfigurationRetrieveParams < FinchAPI::BaseModel
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           sig do

data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi

@@ -5,7 +5,10 @@ module FinchAPI
     module Sandbox
       module Jobs
         ConfigurationRetrieveResponse =
-          T.let(FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration], FinchAPI::Converter)
+          T.let(
+            FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration],
+            FinchAPI::Type::Converter
+          )
       end
     end
   end

data/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi

@@ -5,7 +5,7 @@ module FinchAPI
     module Sandbox
       module Jobs
         class ConfigurationUpdateParams < FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration
-          extend FinchAPI::RequestParameters::Converter
+          extend FinchAPI::Type::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
           sig do

data/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Sandbox
       class PaymentCreateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         sig { returns(T.nilable(String)) }

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

@@ -2,7 +2,7 @@
 
 module FinchAPI
   class Page
-    include FinchAPI::BasePage
+    include FinchAPI::Type::BasePage
 
     Elem = type_member
 

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

@@ -1,21 +1,6 @@
 # typed: strong
 
 module FinchAPI
-  # @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
-
   # Specify HTTP behaviour to use for a specific request. These options supplement
   #   or override those provided at the client level.
   #

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

@@ -2,7 +2,7 @@
 
 module FinchAPI
   class ResponsesPage
-    include FinchAPI::BasePage
+    include FinchAPI::Type::BasePage
 
     Elem = type_member
 

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

@@ -2,7 +2,7 @@
 
 module FinchAPI
   class SinglePage < ::Array
-    include FinchAPI::BasePage
+    include FinchAPI::Type::BasePage
 
     Elem = type_member