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

data/lib/finch_api/models/webhook_event.rb

@@ -24,22 +24,7 @@ module FinchAPI
       variant -> { FinchAPI::PayStatementEvent }
 
       # @!method self.variants
-      #   @return [Array(FinchAPI::AccountUpdateEvent, FinchAPI::CompanyEvent, FinchAPI::JobCompletionEvent, FinchAPI::DirectoryEvent, FinchAPI::EmploymentEvent, FinchAPI::IndividualEvent, FinchAPI::PaymentEvent, FinchAPI::PayStatementEvent)]
-
-      define_sorbet_constant!(:Variants) do
-        T.type_alias do
-          T.any(
-            FinchAPI::AccountUpdateEvent,
-            FinchAPI::CompanyEvent,
-            FinchAPI::JobCompletionEvent,
-            FinchAPI::DirectoryEvent,
-            FinchAPI::EmploymentEvent,
-            FinchAPI::IndividualEvent,
-            FinchAPI::PaymentEvent,
-            FinchAPI::PayStatementEvent
-          )
-        end
-      end
+      #   @return [Array(FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent)]
     end
   end
 end

data/lib/finch_api/models.rb

@@ -5,29 +5,40 @@ module FinchAPI
     cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, FinchAPI::Internal::AnyHash) } }
   end
 
-  [
-    *FinchAPI::Internal::Type::Enum.included_modules,
-    *FinchAPI::Internal::Type::Union.included_modules
-  ].each do |cls|
-    cls.constants.each do |name|
-      case cls.const_get(name)
-      in true | false
-        cls.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, cls) } }
-        cls.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
-      in Integer
-        cls.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, cls) } }
-        cls.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
-      in Float
-        cls.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, cls) } }
-        cls.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
-      in Symbol
-        cls.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, cls) } }
-        cls.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
-      else
+  FinchAPI::Internal::Util.walk_namespaces(FinchAPI::Models).each do |mod|
+    case mod
+    in FinchAPI::Internal::Type::Enum | FinchAPI::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
       end
+    else
     end
   end
 
+  FinchAPI::Internal::Util.walk_namespaces(FinchAPI::Models)
+                          .lazy
+                          .grep(FinchAPI::Internal::Type::Union)
+                          .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
   AccessTokenCreateParams = FinchAPI::Models::AccessTokenCreateParams
 
   AccountDisconnectParams = FinchAPI::Models::AccountDisconnectParams

data/lib/finch_api/resources/access_tokens.rb

@@ -13,7 +13,7 @@ module FinchAPI
       # @param redirect_uri [String]
       # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [FinchAPI::CreateAccessTokenResponse]
+      # @return [FinchAPI::Models::CreateAccessTokenResponse]
       #
       # @see FinchAPI::Models::AccessTokenCreateParams
       def create(params)

data/lib/finch_api/resources/account.rb

@@ -9,7 +9,7 @@ module FinchAPI
       #
       # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [FinchAPI::DisconnectResponse]
+      # @return [FinchAPI::Models::DisconnectResponse]
       #
       # @see FinchAPI::Models::AccountDisconnectParams
       def disconnect(params = {})
@@ -27,7 +27,7 @@ module FinchAPI
       #
       # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [FinchAPI::Introspection]
+      # @return [FinchAPI::Models::Introspection]
       #
       # @see FinchAPI::Models::AccountIntrospectParams
       def introspect(params = {})

data/lib/finch_api/resources/connect/sessions.rb

@@ -15,19 +15,19 @@ module FinchAPI
         #
         # @param customer_name [String]
         #
-        # @param products [Array<Symbol, FinchAPI::Connect::SessionNewParams::Product>]
+        # @param products [Array<Symbol, FinchAPI::Models::Connect::SessionNewParams::Product>]
         #
         # @param customer_email [String, nil]
         #
-        # @param integration [FinchAPI::Connect::SessionNewParams::Integration, nil]
+        # @param integration [FinchAPI::Models::Connect::SessionNewParams::Integration, nil]
         #
         # @param manual [Boolean, nil]
         #
-        # @param minutes_to_expire [Float, nil] The number of minutes until the session expires (defaults to 43,200, which is 30
+        # @param minutes_to_expire [Float, nil] The number of minutes until the session expires (defaults to 129,600, which is 9
         #
         # @param redirect_uri [String, nil]
         #
-        # @param sandbox [Symbol, FinchAPI::Connect::SessionNewParams::Sandbox, nil]
+        # @param sandbox [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil]
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -56,7 +56,7 @@ module FinchAPI
         #
         # @param minutes_to_expire [Integer, nil] The number of minutes until the session expires (defaults to 43,200, which is 30
         #
-        # @param products [Array<Symbol, FinchAPI::Connect::SessionReauthenticateParams::Product>, nil] The products to request access to (optional for reauthentication)
+        # @param products [Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil] The products to request access to (optional for reauthentication)
         #
         # @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
         #

data/lib/finch_api/resources/hris/benefits/individuals.rb

@@ -14,11 +14,11 @@ module FinchAPI
           #
           # @param benefit_id [String]
           #
-          # @param individuals [Array<FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual>] Array of the individual_id to enroll and a configuration object.
+          # @param individuals [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual>] Array of the individual_id to enroll and a configuration object.
           #
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [FinchAPI::HRIS::Benefits::EnrolledIndividualBenefitResponse]
+          # @return [FinchAPI::Models::HRIS::Benefits::EnrolledIndividualBenefitResponse]
           #
           # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams
           def enroll_many(benefit_id, params = {})
@@ -65,7 +65,7 @@ module FinchAPI
           #
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [FinchAPI::Internal::SinglePage<FinchAPI::HRIS::Benefits::IndividualBenefit>]
+          # @return [FinchAPI::Internal::SinglePage<FinchAPI::Models::HRIS::Benefits::IndividualBenefit>]
           #
           # @see FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams
           def retrieve_many_benefits(benefit_id, params = {})
@@ -90,7 +90,7 @@ module FinchAPI
           #
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [FinchAPI::HRIS::Benefits::UnenrolledIndividualBenefitResponse]
+          # @return [FinchAPI::Models::HRIS::Benefits::UnenrolledIndividualBenefitResponse]
           #
           # @see FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyParams
           def unenroll_many(benefit_id, params = {})

data/lib/finch_api/resources/hris/benefits.rb

@@ -15,17 +15,17 @@ module FinchAPI
         #
         # @overload create(company_contribution: nil, description: nil, frequency: nil, type: nil, request_options: {})
         #
-        # @param company_contribution [FinchAPI::HRIS::BenefitCreateParams::CompanyContribution, nil] The company match for this benefit.
+        # @param company_contribution [FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, nil] The company match for this benefit.
         #
         # @param description [String] Name of the benefit as it appears in the provider and pay statements. Recommend
         #
-        # @param frequency [Symbol, FinchAPI::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
+        # @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
         #
-        # @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit.
+        # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit.
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [FinchAPI::HRIS::CreateCompanyBenefitsResponse]
+        # @return [FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse]
         #
         # @see FinchAPI::Models::HRIS::BenefitCreateParams
         def create(params = {})
@@ -46,7 +46,7 @@ module FinchAPI
         # @param benefit_id [String]
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [FinchAPI::HRIS::CompanyBenefit]
+        # @return [FinchAPI::Models::HRIS::CompanyBenefit]
         #
         # @see FinchAPI::Models::HRIS::BenefitRetrieveParams
         def retrieve(benefit_id, params = {})
@@ -68,7 +68,7 @@ module FinchAPI
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [FinchAPI::HRIS::UpdateCompanyBenefitResponse]
+        # @return [FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse]
         #
         # @see FinchAPI::Models::HRIS::BenefitUpdateParams
         def update(benefit_id, params = {})
@@ -88,7 +88,7 @@ module FinchAPI
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [FinchAPI::Internal::SinglePage<FinchAPI::HRIS::CompanyBenefit>]
+        # @return [FinchAPI::Internal::SinglePage<FinchAPI::Models::HRIS::CompanyBenefit>]
         #
         # @see FinchAPI::Models::HRIS::BenefitListParams
         def list(params = {})
@@ -107,7 +107,7 @@ module FinchAPI
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [FinchAPI::Internal::SinglePage<FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse>]
+        # @return [FinchAPI::Internal::SinglePage<FinchAPI::Models::HRIS::SupportedBenefit>]
         #
         # @see FinchAPI::Models::HRIS::BenefitListSupportedBenefitsParams
         def list_supported_benefits(params = {})
@@ -115,7 +115,7 @@ module FinchAPI
             method: :get,
             path: "employer/benefits/meta",
             page: FinchAPI::Internal::SinglePage,
-            model: FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse,
+            model: FinchAPI::HRIS::SupportedBenefit,
             options: params[:request_options]
           )
         end

data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb

@@ -15,15 +15,15 @@ module FinchAPI
             #
             # @overload create(attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {})
             #
-            # @param attributes [FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met.
+            # @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met.
             #
-            # @param conditions [Array<FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>]
+            # @param conditions [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>]
             #
             # @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date.
             #
             # @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date.
             #
-            # @param entity_type [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType] The entity type to which the rule is applied.
+            # @param entity_type [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType] The entity type to which the rule is applied.
             #
             # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
             #

data/lib/finch_api/resources/hris/company/pay_statement_item.rb

@@ -17,7 +17,7 @@ module FinchAPI
           #
           # @overload list(categories: nil, end_date: nil, name: nil, start_date: nil, type: nil, request_options: {})
           #
-          # @param categories [Array<Symbol, FinchAPI::HRIS::Company::PayStatementItemListParams::Category>] Comma-delimited list of pay statement item categories to filter on. If empty, de
+          # @param categories [Array<Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category>] Comma-delimited list of pay statement item categories to filter on. If empty, de
           #
           # @param end_date [Date] The end date to retrieve pay statement items by via their last seen pay date in
           #

data/lib/finch_api/resources/hris/company.rb

@@ -13,7 +13,7 @@ module FinchAPI
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [FinchAPI::HRIS::HRISCompany]
+        # @return [FinchAPI::Models::HRIS::HRISCompany]
         #
         # @see FinchAPI::Models::HRIS::CompanyRetrieveParams
         def retrieve(params = {})

data/lib/finch_api/resources/hris/directory.rb

@@ -14,7 +14,7 @@ module FinchAPI
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [FinchAPI::Internal::IndividualsPage<FinchAPI::HRIS::IndividualInDirectory>]
+        # @return [FinchAPI::Internal::IndividualsPage<FinchAPI::Models::HRIS::IndividualInDirectory>]
         #
         # @see FinchAPI::Models::HRIS::DirectoryListParams
         def list(params = {})

data/lib/finch_api/resources/hris/documents.rb

@@ -18,7 +18,7 @@ module FinchAPI
         #
         # @param offset [Integer] Index to start from (defaults to 0)
         #
-        # @param types [Array<Symbol, FinchAPI::HRIS::DocumentListParams::Type>] Comma-delimited list of document types to filter on. If empty, defaults to all t
+        # @param types [Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>] Comma-delimited list of document types to filter on. If empty, defaults to all t
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -45,7 +45,7 @@ module FinchAPI
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [FinchAPI::HRIS::W42020, FinchAPI::HRIS::W42005]
+        # @return [FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005]
         #
         # @see FinchAPI::Models::HRIS::DocumentRetreiveParams
         def retreive(document_id, params = {})

data/lib/finch_api/resources/hris/employments.rb

@@ -8,11 +8,11 @@ module FinchAPI
         #
         # @overload retrieve_many(requests:, request_options: {})
         #
-        # @param requests [Array<FinchAPI::HRIS::EmploymentRetrieveManyParams::Request>] The array of batch requests.
+        # @param requests [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] The array of batch requests.
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [FinchAPI::Internal::ResponsesPage<FinchAPI::HRIS::EmploymentDataResponse>]
+        # @return [FinchAPI::Internal::ResponsesPage<FinchAPI::Models::HRIS::EmploymentDataResponse>]
         #
         # @see FinchAPI::Models::HRIS::EmploymentRetrieveManyParams
         def retrieve_many(params)

data/lib/finch_api/resources/hris/individuals.rb

@@ -8,11 +8,11 @@ module FinchAPI
         #
         # @overload retrieve_many(options: nil, requests: nil, request_options: {})
         #
-        # @param options [FinchAPI::HRIS::IndividualRetrieveManyParams::Options, nil]
-        # @param requests [Array<FinchAPI::HRIS::IndividualRetrieveManyParams::Request>]
+        # @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil]
+        # @param requests [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>]
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [FinchAPI::Internal::ResponsesPage<FinchAPI::HRIS::IndividualResponse>]
+        # @return [FinchAPI::Internal::ResponsesPage<FinchAPI::Models::HRIS::IndividualResponse>]
         #
         # @see FinchAPI::Models::HRIS::IndividualRetrieveManyParams
         def retrieve_many(params = {})

data/lib/finch_api/resources/hris/pay_statements.rb

@@ -11,11 +11,11 @@ module FinchAPI
         #
         # @overload retrieve_many(requests:, request_options: {})
         #
-        # @param requests [Array<FinchAPI::HRIS::PayStatementRetrieveManyParams::Request>] The array of batch requests.
+        # @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] The array of batch requests.
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [FinchAPI::Internal::ResponsesPage<FinchAPI::HRIS::PayStatementResponse>]
+        # @return [FinchAPI::Internal::ResponsesPage<FinchAPI::Models::HRIS::PayStatementResponse>]
         #
         # @see FinchAPI::Models::HRIS::PayStatementRetrieveManyParams
         def retrieve_many(params)

data/lib/finch_api/resources/hris/payments.rb

@@ -17,7 +17,7 @@ module FinchAPI
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [FinchAPI::Internal::SinglePage<FinchAPI::HRIS::Payment>]
+        # @return [FinchAPI::Internal::SinglePage<FinchAPI::Models::HRIS::Payment>]
         #
         # @see FinchAPI::Models::HRIS::PaymentListParams
         def list(params)

data/lib/finch_api/resources/jobs/automated.rb

@@ -21,9 +21,9 @@ module FinchAPI
         #
         # @overload create(type:, params:, request_options: {})
         #
-        # @param type [Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type] The type of job to start.
+        # @param type [Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type] The type of job to start.
         #
-        # @param params [FinchAPI::Jobs::AutomatedCreateParams::Params]
+        # @param params [FinchAPI::Models::Jobs::AutomatedCreateParams::Params]
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -48,7 +48,7 @@ module FinchAPI
         # @param job_id [String]
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [FinchAPI::Jobs::AutomatedAsyncJob]
+        # @return [FinchAPI::Models::Jobs::AutomatedAsyncJob]
         #
         # @see FinchAPI::Models::Jobs::AutomatedRetrieveParams
         def retrieve(job_id, params = {})

data/lib/finch_api/resources/jobs/manual.rb

@@ -12,7 +12,7 @@ module FinchAPI
         # @param job_id [String]
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [FinchAPI::Jobs::ManualAsyncJob]
+        # @return [FinchAPI::Models::Jobs::ManualAsyncJob]
         #
         # @see FinchAPI::Models::Jobs::ManualRetrieveParams
         def retrieve(job_id, params = {})

data/lib/finch_api/resources/providers.rb

@@ -9,7 +9,7 @@ module FinchAPI
       #
       # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [FinchAPI::Internal::SinglePage<FinchAPI::Provider>]
+      # @return [FinchAPI::Internal::SinglePage<FinchAPI::Models::Provider>]
       #
       # @see FinchAPI::Models::ProviderListParams
       def list(params = {})

data/lib/finch_api/resources/sandbox/company.rb

@@ -11,17 +11,17 @@ module FinchAPI
         #
         # @overload update(accounts:, departments:, ein:, entity:, legal_name:, locations:, primary_email:, primary_phone_number:, request_options: {})
         #
-        # @param accounts [Array<FinchAPI::Sandbox::CompanyUpdateParams::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
+        # @param accounts [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
         #
-        # @param departments [Array<FinchAPI::Sandbox::CompanyUpdateParams::Department, nil>, nil] The array of company departments.
+        # @param departments [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, nil>, nil] The array of company departments.
         #
         # @param ein [String, nil] The employer identification number.
         #
-        # @param entity [FinchAPI::Sandbox::CompanyUpdateParams::Entity, nil] The entity type object.
+        # @param entity [FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, nil] The entity type object.
         #
         # @param legal_name [String, nil] The legal name of the company.
         #
-        # @param locations [Array<FinchAPI::Location, nil>, nil]
+        # @param locations [Array<FinchAPI::Models::Location, nil>, nil]
         #
         # @param primary_email [String, nil] The email of the main administrator on the account.
         #

data/lib/finch_api/resources/sandbox/connections/accounts.rb

@@ -16,7 +16,7 @@ module FinchAPI
           #
           # @param provider_id [String] The provider associated with the `access_token`
           #
-          # @param authentication_type [Symbol, FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType]
+          # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType]
           #
           # @param products [Array<String>] Optional, defaults to Organization products (`company`, `directory`, `employment
           #
@@ -41,7 +41,7 @@ module FinchAPI
           #
           # @overload update(connection_status: nil, request_options: {})
           #
-          # @param connection_status [Symbol, FinchAPI::ConnectionStatusType]
+          # @param connection_status [Symbol, FinchAPI::Models::ConnectionStatusType]
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse]

data/lib/finch_api/resources/sandbox/connections.rb

@@ -16,7 +16,7 @@ module FinchAPI
         #
         # @param provider_id [String] The provider associated with the connection
         #
-        # @param authentication_type [Symbol, FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType]
+        # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType]
         #
         # @param employee_size [Integer] Optional: the size of the employer to be created with this connection. Defaults
         #

data/lib/finch_api/resources/sandbox/directory.rb

@@ -11,7 +11,7 @@ module FinchAPI
         #
         # @overload create(body: nil, request_options: {})
         #
-        # @param body [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body>] Array of individuals to create. Takes all combined fields from `/individual` and
+        # @param body [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body>] Array of individuals to create. Takes all combined fields from `/individual` and
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/finch_api/resources/sandbox/employment.rb

@@ -15,21 +15,21 @@ module FinchAPI
         #
         # @param class_code [String, nil] Worker's compensation classification code for this employee
         #
-        # @param custom_fields [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
+        # @param custom_fields [Array<FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
         #
-        # @param department [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
+        # @param department [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
         #
-        # @param employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
+        # @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
         #
-        # @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual.
+        # @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
         #
         # @param end_date [String, nil]
         #
         # @param first_name [String, nil] The legal first name of the individual.
         #
-        # @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual
+        # @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual
         #
-        # @param income_history [Array<FinchAPI::Income, nil>, nil] The array of income history.
+        # @param income_history [Array<FinchAPI::Models::Income, nil>, nil] The array of income history.
         #
         # @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company.
         #
@@ -37,13 +37,13 @@ module FinchAPI
         #
         # @param latest_rehire_date [String, nil]
         #
-        # @param location [FinchAPI::Location, nil]
+        # @param location [FinchAPI::Models::Location, nil]
         #
-        # @param manager [FinchAPI::Sandbox::EmploymentUpdateParams::Manager, nil] The manager object representing the manager of the individual within the org.
+        # @param manager [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, nil] The manager object representing the manager of the individual within the org.
         #
         # @param middle_name [String, nil] The legal middle name of the individual.
         #
-        # @param source_id [String] The source system's unique employment identifier for this individual
+        # @param source_id [String, nil] The source system's unique employment identifier for this individual
         #
         # @param start_date [String, nil]
         #

data/lib/finch_api/resources/sandbox/individual.rb

@@ -15,25 +15,25 @@ module FinchAPI
         #
         # @param dob [String, nil]
         #
-        # @param emails [Array<FinchAPI::Sandbox::IndividualUpdateParams::Email>, nil]
+        # @param emails [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::Email>, nil]
         #
         # @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
         #
-        # @param ethnicity [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
+        # @param ethnicity [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
         #
         # @param first_name [String, nil] The legal first name of the individual.
         #
-        # @param gender [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Gender, nil] The gender of the individual.
+        # @param gender [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender, nil] The gender of the individual.
         #
         # @param last_name [String, nil] The legal last name of the individual.
         #
         # @param middle_name [String, nil] The legal middle name of the individual.
         #
-        # @param phone_numbers [Array<FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber, nil>, nil]
+        # @param phone_numbers [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber, nil>, nil]
         #
         # @param preferred_name [String, nil] The preferred name of the individual.
         #
-        # @param residence [FinchAPI::Location, nil]
+        # @param residence [FinchAPI::Models::Location, nil]
         #
         # @param ssn [String, nil] Social Security Number of the individual. This field is only available with the
         #

data/lib/finch_api/resources/sandbox/jobs/configuration.rb

@@ -11,7 +11,7 @@ module FinchAPI
           #
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [Array<FinchAPI::Sandbox::Jobs::SandboxJobConfiguration>]
+          # @return [Array<FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration>]
           #
           # @see FinchAPI::Models::Sandbox::Jobs::ConfigurationRetrieveParams
           def retrieve(params = {})
@@ -27,11 +27,11 @@ module FinchAPI
           #
           # @overload update(completion_status:, type:, request_options: {})
           #
-          # @param completion_status [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
-          # @param type [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type]
+          # @param completion_status [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
+          # @param type [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type]
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [FinchAPI::Sandbox::Jobs::SandboxJobConfiguration]
+          # @return [FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration]
           #
           # @see FinchAPI::Models::Sandbox::Jobs::ConfigurationUpdateParams
           def update(params)

data/lib/finch_api/resources/sandbox/jobs.rb

@@ -11,7 +11,7 @@ module FinchAPI
         #
         # @overload create(type:, request_options: {})
         #
-        # @param type [Symbol, FinchAPI::Sandbox::JobCreateParams::Type] The type of job to start. Currently the only supported type is `data_sync_all`
+        # @param type [Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type] The type of job to start. Currently the only supported type is `data_sync_all`
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/finch_api/resources/sandbox/payment.rb

@@ -8,9 +8,12 @@ module FinchAPI
         #
         # @overload create(end_date: nil, pay_statements: nil, start_date: nil, request_options: {})
         #
-        # @param end_date [String]
-        # @param pay_statements [Array<FinchAPI::Sandbox::PaymentCreateParams::PayStatement>]
-        # @param start_date [String]
+        # @param end_date [Date]
+        #
+        # @param pay_statements [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement>] Array of pay statements to include in the payment.
+        #
+        # @param start_date [Date]
+        #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [FinchAPI::Models::Sandbox::PaymentCreateResponse]

data/lib/finch_api/version.rb

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