finch-api 0.1.0.pre.alpha.1

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class PayStatementRetrieveManyParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        # @!attribute requests
+        #   The array of batch requests.
+        #
+        #   @return [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>]
+        required :requests,
+                 -> { FinchAPI::ArrayOf[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request] }
+
+        # @!parse
+        #   # @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>]
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(requests:, request_options: {}, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        class Request < FinchAPI::BaseModel
+          # @!attribute payment_id
+          #   A stable Finch `id` (UUID v4) for a payment.
+          #
+          #   @return [String]
+          required :payment_id, String
+
+          # @!attribute [r] limit
+          #   Number of pay statements to return (defaults to all).
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!parse
+          #   # @return [Integer]
+          #   attr_writer :limit
+
+          # @!attribute [r] offset
+          #   Index to start from.
+          #
+          #   @return [Integer, nil]
+          optional :offset, Integer
+
+          # @!parse
+          #   # @return [Integer]
+          #   attr_writer :offset
+
+          # @!parse
+          #   # @param payment_id [String]
+          #   # @param limit [Integer]
+          #   # @param offset [Integer]
+          #   #
+          #   def initialize(payment_id:, limit: nil, offset: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/hris/payment.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class Payment < FinchAPI::BaseModel
+        # @!attribute [r] id
+        #   The unique id for the payment.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :id
+
+        # @!attribute company_debit
+        #
+        #   @return [FinchAPI::Models::Money, nil]
+        optional :company_debit, -> { FinchAPI::Models::Money }, nil?: true
+
+        # @!attribute debit_date
+        #
+        #   @return [String, nil]
+        optional :debit_date, String, nil?: true
+
+        # @!attribute employee_taxes
+        #
+        #   @return [FinchAPI::Models::Money, nil]
+        optional :employee_taxes, -> { FinchAPI::Models::Money }, nil?: true
+
+        # @!attribute employer_taxes
+        #
+        #   @return [FinchAPI::Models::Money, nil]
+        optional :employer_taxes, -> { FinchAPI::Models::Money }, nil?: true
+
+        # @!attribute gross_pay
+        #
+        #   @return [FinchAPI::Models::Money, nil]
+        optional :gross_pay, -> { FinchAPI::Models::Money }, nil?: true
+
+        # @!attribute individual_ids
+        #   Array of every individual on this payment.
+        #
+        #   @return [Array<String>, nil]
+        optional :individual_ids, FinchAPI::ArrayOf[String], nil?: true
+
+        # @!attribute net_pay
+        #
+        #   @return [FinchAPI::Models::Money, nil]
+        optional :net_pay, -> { FinchAPI::Models::Money }, nil?: true
+
+        # @!attribute pay_date
+        #
+        #   @return [String, nil]
+        optional :pay_date, String, nil?: true
+
+        # @!attribute pay_frequencies
+        #   List of pay frequencies associated with this payment.
+        #
+        #   @return [Array<Symbol, FinchAPI::Models::HRIS::Payment::PayFrequency>, nil]
+        optional :pay_frequencies,
+                 -> { FinchAPI::ArrayOf[enum: FinchAPI::Models::HRIS::Payment::PayFrequency] },
+                 nil?: true
+
+        # @!attribute pay_group_ids
+        #   Array of the Finch id (uuidv4) of every pay group associated with this payment.
+        #
+        #   @return [Array<String>, nil]
+        optional :pay_group_ids, FinchAPI::ArrayOf[String], nil?: true
+
+        # @!attribute pay_period
+        #   The pay period object.
+        #
+        #   @return [FinchAPI::Models::HRIS::Payment::PayPeriod, nil]
+        optional :pay_period, -> { FinchAPI::Models::HRIS::Payment::PayPeriod }, nil?: true
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param company_debit [FinchAPI::Models::Money, nil]
+        #   # @param debit_date [String, nil]
+        #   # @param employee_taxes [FinchAPI::Models::Money, nil]
+        #   # @param employer_taxes [FinchAPI::Models::Money, nil]
+        #   # @param gross_pay [FinchAPI::Models::Money, nil]
+        #   # @param individual_ids [Array<String>, nil]
+        #   # @param net_pay [FinchAPI::Models::Money, nil]
+        #   # @param pay_date [String, nil]
+        #   # @param pay_frequencies [Array<Symbol, FinchAPI::Models::HRIS::Payment::PayFrequency>, nil]
+        #   # @param pay_group_ids [Array<String>, nil]
+        #   # @param pay_period [FinchAPI::Models::HRIS::Payment::PayPeriod, nil]
+        #   #
+        #   def initialize(
+        #     id: nil,
+        #     company_debit: nil,
+        #     debit_date: nil,
+        #     employee_taxes: nil,
+        #     employer_taxes: nil,
+        #     gross_pay: nil,
+        #     individual_ids: nil,
+        #     net_pay: nil,
+        #     pay_date: nil,
+        #     pay_frequencies: nil,
+        #     pay_group_ids: nil,
+        #     pay_period: nil,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        # @abstract
+        #
+        # @example
+        # ```ruby
+        # case pay_frequency
+        # in :annually
+        #   # ...
+        # in :semi_annually
+        #   # ...
+        # in :quarterly
+        #   # ...
+        # in :monthly
+        #   # ...
+        # in :semi_monthly
+        #   # ...
+        # in ...
+        #   #...
+        # end
+        # ```
+        class PayFrequency < FinchAPI::Enum
+          ANNUALLY = :annually
+          SEMI_ANNUALLY = :semi_annually
+          QUARTERLY = :quarterly
+          MONTHLY = :monthly
+          SEMI_MONTHLY = :semi_monthly
+          BI_WEEKLY = :bi_weekly
+          WEEKLY = :weekly
+          DAILY = :daily
+          OTHER = :other
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+
+        class PayPeriod < FinchAPI::BaseModel
+          # @!attribute end_date
+          #
+          #   @return [String, nil]
+          optional :end_date, String, nil?: true
+
+          # @!attribute start_date
+          #
+          #   @return [String, nil]
+          optional :start_date, String, nil?: true
+
+          # @!parse
+          #   # The pay period object.
+          #   #
+          #   # @param end_date [String, nil]
+          #   # @param start_date [String, nil]
+          #   #
+          #   def initialize(end_date: nil, start_date: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class PaymentListParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        # @!attribute end_date
+        #   The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
+        #     format.
+        #
+        #   @return [Date]
+        required :end_date, Date
+
+        # @!attribute start_date
+        #   The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
+        #     format.
+        #
+        #   @return [Date]
+        required :start_date, Date
+
+        # @!parse
+        #   # @param end_date [Date]
+        #   # @param start_date [Date]
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(end_date:, start_date:, request_options: {}, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/finch-api/models/hris/support_per_benefit_type.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class SupportPerBenefitType < FinchAPI::BaseModel
+        # @!attribute [r] company_benefits
+        #
+        #   @return [FinchAPI::Models::OperationSupportMatrix, nil]
+        optional :company_benefits, -> { FinchAPI::Models::OperationSupportMatrix }
+
+        # @!parse
+        #   # @return [FinchAPI::Models::OperationSupportMatrix]
+        #   attr_writer :company_benefits
+
+        # @!attribute [r] individual_benefits
+        #
+        #   @return [FinchAPI::Models::OperationSupportMatrix, nil]
+        optional :individual_benefits, -> { FinchAPI::Models::OperationSupportMatrix }
+
+        # @!parse
+        #   # @return [FinchAPI::Models::OperationSupportMatrix]
+        #   attr_writer :individual_benefits
+
+        # @!parse
+        #   # @param company_benefits [FinchAPI::Models::OperationSupportMatrix]
+        #   # @param individual_benefits [FinchAPI::Models::OperationSupportMatrix]
+        #   #
+        #   def initialize(company_benefits: nil, individual_benefits: nil, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/finch-api/models/hris/supported_benefit.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class SupportedBenefit < FinchAPI::BaseModel
+        # @!attribute annual_maximum
+        #   Whether the provider supports an annual maximum for this benefit.
+        #
+        #   @return [Boolean, nil]
+        optional :annual_maximum, FinchAPI::BooleanModel, nil?: true
+
+        # @!attribute catch_up
+        #   Whether the provider supports catch up for this benefit. This field will only be
+        #     true for retirement benefits.
+        #
+        #   @return [Boolean, nil]
+        optional :catch_up, FinchAPI::BooleanModel, nil?: true
+
+        # @!attribute company_contribution
+        #   Supported contribution types. An empty array indicates contributions are not
+        #     supported.
+        #
+        #   @return [Array<Symbol, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution, nil>, nil]
+        optional :company_contribution,
+                 -> { FinchAPI::ArrayOf[enum: FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution, nil?: true] },
+                 nil?: true
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute employee_deduction
+        #   Supported deduction types. An empty array indicates deductions are not
+        #     supported.
+        #
+        #   @return [Array<Symbol, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction, nil>, nil]
+        optional :employee_deduction,
+                 -> { FinchAPI::ArrayOf[enum: FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction, nil?: true] },
+                 nil?: true
+
+        # @!attribute [r] frequencies
+        #   The list of frequencies supported by the provider for this benefit
+        #
+        #   @return [Array<Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil>, nil]
+        optional :frequencies,
+                 -> { FinchAPI::ArrayOf[enum: FinchAPI::Models::HRIS::BenefitFrequency, nil?: true] }
+
+        # @!parse
+        #   # @return [Array<Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil>]
+        #   attr_writer :frequencies
+
+        # @!attribute hsa_contribution_limit
+        #   Whether the provider supports HSA contribution limits. Empty if this feature is
+        #     not supported for the benefit. This array only has values for HSA benefits.
+        #
+        #   @return [Array<Symbol, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit, nil>, nil]
+        optional :hsa_contribution_limit,
+                 -> { FinchAPI::ArrayOf[enum: FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit, nil?: true] },
+                 nil?: true
+
+        # @!attribute type
+        #   Type of benefit.
+        #
+        #   @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
+        optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true
+
+        # @!parse
+        #   # @param annual_maximum [Boolean, nil]
+        #   # @param catch_up [Boolean, nil]
+        #   # @param company_contribution [Array<Symbol, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution, nil>, nil]
+        #   # @param description [String, nil]
+        #   # @param employee_deduction [Array<Symbol, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction, nil>, nil]
+        #   # @param frequencies [Array<Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil>]
+        #   # @param hsa_contribution_limit [Array<Symbol, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit, nil>, nil]
+        #   # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
+        #   #
+        #   def initialize(
+        #     annual_maximum: nil,
+        #     catch_up: nil,
+        #     company_contribution: nil,
+        #     description: nil,
+        #     employee_deduction: nil,
+        #     frequencies: nil,
+        #     hsa_contribution_limit: nil,
+        #     type: nil,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        # @abstract
+        #
+        # @example
+        # ```ruby
+        # case company_contribution
+        # in :fixed
+        #   # ...
+        # in :percent
+        #   # ...
+        # end
+        # ```
+        class CompanyContribution < FinchAPI::Enum
+          FIXED = :fixed
+          PERCENT = :percent
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+
+        # @abstract
+        #
+        # @example
+        # ```ruby
+        # case employee_deduction
+        # in :fixed
+        #   # ...
+        # in :percent
+        #   # ...
+        # end
+        # ```
+        class EmployeeDeduction < FinchAPI::Enum
+          FIXED = :fixed
+          PERCENT = :percent
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+
+        # @abstract
+        #
+        # @example
+        # ```ruby
+        # case hsa_contribution_limit
+        # in :individual
+        #   # ...
+        # in :family
+        #   # ...
+        # end
+        # ```
+        class HsaContributionLimit < FinchAPI::Enum
+          INDIVIDUAL = :individual
+          FAMILY = :family
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/hris/update_company_benefit_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class UpdateCompanyBenefitResponse < FinchAPI::BaseModel
+        # @!attribute benefit_id
+        #
+        #   @return [String]
+        required :benefit_id, String
+
+        # @!parse
+        #   # @param benefit_id [String]
+        #   #
+        #   def initialize(benefit_id:, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/finch-api/models/hris/w42005.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class W42005 < FinchAPI::BaseModel
+        # @!attribute [r] data
+        #   Detailed information specific to the 2005 W4 form.
+        #
+        #   @return [FinchAPI::Models::HRIS::W42005::Data, nil]
+        optional :data, -> { FinchAPI::Models::HRIS::W42005::Data }
+
+        # @!parse
+        #   # @return [FinchAPI::Models::HRIS::W42005::Data]
+        #   attr_writer :data
+
+        # @!attribute [r] type
+        #   Specifies the form type, indicating that this document is a 2005 W4 form.
+        #
+        #   @return [Symbol, FinchAPI::Models::HRIS::W42005::Type, nil]
+        optional :type, enum: -> { FinchAPI::Models::HRIS::W42005::Type }
+
+        # @!parse
+        #   # @return [Symbol, FinchAPI::Models::HRIS::W42005::Type]
+        #   attr_writer :type
+
+        # @!attribute year
+        #   The tax year this W4 document applies to.
+        #
+        #   @return [Float, nil]
+        optional :year, Float, nil?: true
+
+        # @!parse
+        #   # A 2005 version of the W-4 tax form containing information on an individual's
+        #   #   filing status, dependents, and withholding details.
+        #   #
+        #   # @param data [FinchAPI::Models::HRIS::W42005::Data]
+        #   # @param type [Symbol, FinchAPI::Models::HRIS::W42005::Type]
+        #   # @param year [Float, nil]
+        #   #
+        #   def initialize(data: nil, type: nil, year: nil, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        class Data < FinchAPI::BaseModel
+          # @!attribute additional_withholding
+          #   Additional withholding amount (in cents).
+          #
+          #   @return [Integer, nil]
+          optional :additional_withholding, Integer, nil?: true
+
+          # @!attribute [r] exemption
+          #   Indicates exemption status from federal tax withholding.
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption, nil]
+          optional :exemption, enum: -> { FinchAPI::Models::HRIS::W42005::Data::Exemption }
+
+          # @!parse
+          #   # @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption]
+          #   attr_writer :exemption
+
+          # @!attribute [r] filing_status
+          #   The individual's filing status for tax purposes.
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus, nil]
+          optional :filing_status, enum: -> { FinchAPI::Models::HRIS::W42005::Data::FilingStatus }
+
+          # @!parse
+          #   # @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus]
+          #   attr_writer :filing_status
+
+          # @!attribute [r] individual_id
+          #   The unique identifier for the individual associated with this 2005 W4 form.
+          #
+          #   @return [String, nil]
+          optional :individual_id, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :individual_id
+
+          # @!attribute total_number_of_allowances
+          #   Total number of allowances claimed (in cents).
+          #
+          #   @return [Integer, nil]
+          optional :total_number_of_allowances, Integer, nil?: true
+
+          # @!parse
+          #   # Detailed information specific to the 2005 W4 form.
+          #   #
+          #   # @param additional_withholding [Integer, nil]
+          #   # @param exemption [Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption]
+          #   # @param filing_status [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus]
+          #   # @param individual_id [String]
+          #   # @param total_number_of_allowances [Integer, nil]
+          #   #
+          #   def initialize(
+          #     additional_withholding: nil,
+          #     exemption: nil,
+          #     filing_status: nil,
+          #     individual_id: nil,
+          #     total_number_of_allowances: nil,
+          #     **
+          #   )
+          #     super
+          #   end
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+          # @abstract
+          #
+          # Indicates exemption status from federal tax withholding.
+          #
+          # @example
+          # ```ruby
+          # case exemption
+          # in :exempt
+          #   # ...
+          # in :non_exempt
+          #   # ...
+          # end
+          # ```
+          class Exemption < FinchAPI::Enum
+            EXEMPT = :exempt
+            NON_EXEMPT = :non_exempt
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+
+          # @abstract
+          #
+          # The individual's filing status for tax purposes.
+          #
+          # @example
+          # ```ruby
+          # case filing_status
+          # in :married
+          #   # ...
+          # in :married_but_withhold_at_higher_single_rate
+          #   # ...
+          # in :single
+          #   # ...
+          # end
+          # ```
+          class FilingStatus < FinchAPI::Enum
+            MARRIED = :married
+            MARRIED_BUT_WITHHOLD_AT_HIGHER_SINGLE_RATE = :married_but_withhold_at_higher_single_rate
+            SINGLE = :single
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+        end
+
+        # @abstract
+        #
+        # Specifies the form type, indicating that this document is a 2005 W4 form.
+        #
+        # @example
+        # ```ruby
+        # case type
+        # in :w4_2005
+        #   # ...
+        # end
+        # ```
+        class Type < FinchAPI::Enum
+          W4_2005 = :w4_2005
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end