finch-api 0.1.0.pre.alpha.1

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

@@ -0,0 +1,112 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type payment =
+        {
+          id: String,
+          company_debit: FinchAPI::Models::Money?,
+          debit_date: String?,
+          employee_taxes: FinchAPI::Models::Money?,
+          employer_taxes: FinchAPI::Models::Money?,
+          gross_pay: FinchAPI::Models::Money?,
+          individual_ids: ::Array[String]?,
+          net_pay: FinchAPI::Models::Money?,
+          pay_date: String?,
+          pay_frequencies: ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency]?,
+          pay_group_ids: ::Array[String]?,
+          pay_period: FinchAPI::Models::HRIS::Payment::PayPeriod?
+        }
+
+      class Payment < FinchAPI::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_accessor company_debit: FinchAPI::Models::Money?
+
+        attr_accessor debit_date: String?
+
+        attr_accessor employee_taxes: FinchAPI::Models::Money?
+
+        attr_accessor employer_taxes: FinchAPI::Models::Money?
+
+        attr_accessor gross_pay: FinchAPI::Models::Money?
+
+        attr_accessor individual_ids: ::Array[String]?
+
+        attr_accessor net_pay: FinchAPI::Models::Money?
+
+        attr_accessor pay_date: String?
+
+        attr_accessor pay_frequencies: ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency]?
+
+        attr_accessor pay_group_ids: ::Array[String]?
+
+        attr_accessor pay_period: FinchAPI::Models::HRIS::Payment::PayPeriod?
+
+        def initialize:
+          (
+            id: String,
+            company_debit: FinchAPI::Models::Money?,
+            debit_date: String?,
+            employee_taxes: FinchAPI::Models::Money?,
+            employer_taxes: FinchAPI::Models::Money?,
+            gross_pay: FinchAPI::Models::Money?,
+            individual_ids: ::Array[String]?,
+            net_pay: FinchAPI::Models::Money?,
+            pay_date: String?,
+            pay_frequencies: ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency]?,
+            pay_group_ids: ::Array[String]?,
+            pay_period: FinchAPI::Models::HRIS::Payment::PayPeriod?
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::payment | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::payment
+
+        type pay_frequency =
+          :annually
+          | :semi_annually
+          | :quarterly
+          | :monthly
+          | :semi_monthly
+          | :bi_weekly
+          | :weekly
+          | :daily
+          | :other
+
+        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
+
+          def self.values: -> ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency]
+        end
+
+        type pay_period = { end_date: String?, start_date: String? }
+
+        class PayPeriod < FinchAPI::BaseModel
+          attr_accessor end_date: String?
+
+          attr_accessor start_date: String?
+
+          def initialize:
+            (end_date: String?, start_date: String?) -> void
+            | (
+              ?FinchAPI::Models::HRIS::Payment::pay_period
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::Payment::pay_period
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type payment_list_params =
+        { end_date: Date, start_date: Date } & FinchAPI::request_parameters
+
+      class PaymentListParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        attr_accessor end_date: Date
+
+        attr_accessor start_date: Date
+
+        def initialize:
+          (
+            end_date: Date,
+            start_date: Date,
+            request_options: FinchAPI::request_opts
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::payment_list_params
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::payment_list_params
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type support_per_benefit_type =
+        {
+          company_benefits: FinchAPI::Models::OperationSupportMatrix,
+          individual_benefits: FinchAPI::Models::OperationSupportMatrix
+        }
+
+      class SupportPerBenefitType < FinchAPI::BaseModel
+        attr_reader company_benefits: FinchAPI::Models::OperationSupportMatrix?
+
+        def company_benefits=: (
+          FinchAPI::Models::OperationSupportMatrix
+        ) -> FinchAPI::Models::OperationSupportMatrix
+
+        attr_reader individual_benefits: FinchAPI::Models::OperationSupportMatrix?
+
+        def individual_benefits=: (
+          FinchAPI::Models::OperationSupportMatrix
+        ) -> FinchAPI::Models::OperationSupportMatrix
+
+        def initialize:
+          (
+            company_benefits: FinchAPI::Models::OperationSupportMatrix,
+            individual_benefits: FinchAPI::Models::OperationSupportMatrix
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::support_per_benefit_type
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::support_per_benefit_type
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type supported_benefit =
+        {
+          annual_maximum: bool?,
+          catch_up: bool?,
+          company_contribution: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution?]?,
+          description: String?,
+          employee_deduction: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::employee_deduction?]?,
+          frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?],
+          hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit?]?,
+          type: FinchAPI::Models::HRIS::benefit_type?
+        }
+
+      class SupportedBenefit < FinchAPI::BaseModel
+        attr_accessor annual_maximum: bool?
+
+        attr_accessor catch_up: bool?
+
+        attr_accessor company_contribution: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution?]?
+
+        attr_accessor description: String?
+
+        attr_accessor employee_deduction: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::employee_deduction?]?
+
+        attr_reader frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?]?
+
+        def frequencies=: (
+          ::Array[FinchAPI::Models::HRIS::benefit_frequency?]
+        ) -> ::Array[FinchAPI::Models::HRIS::benefit_frequency?]
+
+        attr_accessor hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit?]?
+
+        attr_accessor type: FinchAPI::Models::HRIS::benefit_type?
+
+        def initialize:
+          (
+            annual_maximum: bool?,
+            catch_up: bool?,
+            company_contribution: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution?]?,
+            description: String?,
+            employee_deduction: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::employee_deduction?]?,
+            frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?],
+            hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit?]?,
+            type: FinchAPI::Models::HRIS::benefit_type?
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::supported_benefit
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::supported_benefit
+
+        type company_contribution = :fixed | :percent
+
+        class CompanyContribution < FinchAPI::Enum
+          FIXED: :fixed
+          PERCENT: :percent
+
+          def self.values: -> ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution]
+        end
+
+        type employee_deduction = :fixed | :percent
+
+        class EmployeeDeduction < FinchAPI::Enum
+          FIXED: :fixed
+          PERCENT: :percent
+
+          def self.values: -> ::Array[FinchAPI::Models::HRIS::SupportedBenefit::employee_deduction]
+        end
+
+        type hsa_contribution_limit = :individual | :family
+
+        class HsaContributionLimit < FinchAPI::Enum
+          INDIVIDUAL: :individual
+          FAMILY: :family
+
+          def self.values: -> ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type update_company_benefit_response = { benefit_id: String }
+
+      class UpdateCompanyBenefitResponse < FinchAPI::BaseModel
+        attr_accessor benefit_id: String
+
+        def initialize:
+          (benefit_id: String) -> void
+          | (
+            ?FinchAPI::Models::HRIS::update_company_benefit_response
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::update_company_benefit_response
+      end
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type w42005 =
+        {
+          data: FinchAPI::Models::HRIS::W42005::Data,
+          type: FinchAPI::Models::HRIS::W42005::type_,
+          year: Float?
+        }
+
+      class W42005 < FinchAPI::BaseModel
+        attr_reader data: FinchAPI::Models::HRIS::W42005::Data?
+
+        def data=: (
+          FinchAPI::Models::HRIS::W42005::Data
+        ) -> FinchAPI::Models::HRIS::W42005::Data
+
+        attr_reader type: FinchAPI::Models::HRIS::W42005::type_?
+
+        def type=: (
+          FinchAPI::Models::HRIS::W42005::type_
+        ) -> FinchAPI::Models::HRIS::W42005::type_
+
+        attr_accessor year: Float?
+
+        def initialize:
+          (
+            data: FinchAPI::Models::HRIS::W42005::Data,
+            type: FinchAPI::Models::HRIS::W42005::type_,
+            year: Float?
+          ) -> void
+          | (?FinchAPI::Models::HRIS::w42005 | FinchAPI::BaseModel data) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::w42005
+
+        type data =
+          {
+            additional_withholding: Integer?,
+            exemption: FinchAPI::Models::HRIS::W42005::Data::exemption,
+            filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status,
+            individual_id: String,
+            total_number_of_allowances: Integer?
+          }
+
+        class Data < FinchAPI::BaseModel
+          attr_accessor additional_withholding: Integer?
+
+          attr_reader exemption: FinchAPI::Models::HRIS::W42005::Data::exemption?
+
+          def exemption=: (
+            FinchAPI::Models::HRIS::W42005::Data::exemption
+          ) -> FinchAPI::Models::HRIS::W42005::Data::exemption
+
+          attr_reader filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?
+
+          def filing_status=: (
+            FinchAPI::Models::HRIS::W42005::Data::filing_status
+          ) -> FinchAPI::Models::HRIS::W42005::Data::filing_status
+
+          attr_reader individual_id: String?
+
+          def individual_id=: (String) -> String
+
+          attr_accessor total_number_of_allowances: Integer?
+
+          def initialize:
+            (
+              additional_withholding: Integer?,
+              exemption: FinchAPI::Models::HRIS::W42005::Data::exemption,
+              filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status,
+              individual_id: String,
+              total_number_of_allowances: Integer?
+            ) -> void
+            | (
+              ?FinchAPI::Models::HRIS::W42005::data | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::W42005::data
+
+          type exemption = :exempt | :non_exempt
+
+          class Exemption < FinchAPI::Enum
+            EXEMPT: :exempt
+            NON_EXEMPT: :non_exempt
+
+            def self.values: -> ::Array[FinchAPI::Models::HRIS::W42005::Data::exemption]
+          end
+
+          type filing_status =
+            :married | :married_but_withhold_at_higher_single_rate | :single
+
+          class FilingStatus < FinchAPI::Enum
+            MARRIED: :married
+            MARRIED_BUT_WITHHOLD_AT_HIGHER_SINGLE_RATE: :married_but_withhold_at_higher_single_rate
+            SINGLE: :single
+
+            def self.values: -> ::Array[FinchAPI::Models::HRIS::W42005::Data::filing_status]
+          end
+        end
+
+        type type_ = :w4_2005
+
+        class Type < FinchAPI::Enum
+          W4_2005: :w4_2005
+
+          def self.values: -> ::Array[FinchAPI::Models::HRIS::W42005::type_]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,108 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type w42020 =
+        {
+          data: FinchAPI::Models::HRIS::W42020::Data,
+          type: FinchAPI::Models::HRIS::W42020::type_,
+          year: Float?
+        }
+
+      class W42020 < FinchAPI::BaseModel
+        attr_reader data: FinchAPI::Models::HRIS::W42020::Data?
+
+        def data=: (
+          FinchAPI::Models::HRIS::W42020::Data
+        ) -> FinchAPI::Models::HRIS::W42020::Data
+
+        attr_reader type: FinchAPI::Models::HRIS::W42020::type_?
+
+        def type=: (
+          FinchAPI::Models::HRIS::W42020::type_
+        ) -> FinchAPI::Models::HRIS::W42020::type_
+
+        attr_accessor year: Float?
+
+        def initialize:
+          (
+            data: FinchAPI::Models::HRIS::W42020::Data,
+            type: FinchAPI::Models::HRIS::W42020::type_,
+            year: Float?
+          ) -> void
+          | (?FinchAPI::Models::HRIS::w42020 | FinchAPI::BaseModel data) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::w42020
+
+        type data =
+          {
+            amount_for_other_dependents: Integer?,
+            :amount_for_qualifying_children_under_17 => Integer?,
+            deductions: Integer?,
+            extra_withholding: Integer?,
+            filing_status: FinchAPI::Models::HRIS::W42020::Data::filing_status?,
+            individual_id: String,
+            other_income: Integer?,
+            total_claim_dependent_and_other_credits: Integer?
+          }
+
+        class Data < FinchAPI::BaseModel
+          attr_accessor amount_for_other_dependents: Integer?
+
+          attr_accessor amount_for_qualifying_children_under_17: Integer?
+
+          attr_accessor deductions: Integer?
+
+          attr_accessor extra_withholding: Integer?
+
+          attr_accessor filing_status: FinchAPI::Models::HRIS::W42020::Data::filing_status?
+
+          attr_reader individual_id: String?
+
+          def individual_id=: (String) -> String
+
+          attr_accessor other_income: Integer?
+
+          attr_accessor total_claim_dependent_and_other_credits: Integer?
+
+          def initialize:
+            (
+              amount_for_other_dependents: Integer?,
+              amount_for_qualifying_children_under_17: Integer?,
+              deductions: Integer?,
+              extra_withholding: Integer?,
+              filing_status: FinchAPI::Models::HRIS::W42020::Data::filing_status?,
+              individual_id: String,
+              other_income: Integer?,
+              total_claim_dependent_and_other_credits: Integer?
+            ) -> void
+            | (
+              ?FinchAPI::Models::HRIS::W42020::data | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::W42020::data
+
+          type filing_status =
+            :head_of_household
+            | :married_filing_jointly_or_qualifying_surviving_spouse
+            | :single_or_married_filing_separately
+
+          class FilingStatus < FinchAPI::Enum
+            HEAD_OF_HOUSEHOLD: :head_of_household
+            MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE: :married_filing_jointly_or_qualifying_surviving_spouse
+            SINGLE_OR_MARRIED_FILING_SEPARATELY: :single_or_married_filing_separately
+
+            def self.values: -> ::Array[FinchAPI::Models::HRIS::W42020::Data::filing_status]
+          end
+        end
+
+        type type_ = :w4_2020
+
+        class Type < FinchAPI::Enum
+          W4_2020: :w4_2020
+
+          def self.values: -> ::Array[FinchAPI::Models::HRIS::W42020::type_]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module FinchAPI
+  module Models
+    type income =
+      {
+        amount: Integer?,
+        currency: String?,
+        effective_date: String?,
+        unit: FinchAPI::Models::Income::unit?
+      }
+
+    class Income < FinchAPI::BaseModel
+      attr_accessor amount: Integer?
+
+      attr_accessor currency: String?
+
+      attr_accessor effective_date: String?
+
+      attr_accessor unit: FinchAPI::Models::Income::unit?
+
+      def initialize:
+        (
+          amount: Integer?,
+          currency: String?,
+          effective_date: String?,
+          unit: FinchAPI::Models::Income::unit?
+        ) -> void
+        | (?FinchAPI::Models::income | FinchAPI::BaseModel data) -> void
+
+      def to_hash: -> FinchAPI::Models::income
+
+      type unit =
+        :yearly
+        | :quarterly
+        | :monthly
+        | :semi_monthly
+        | :bi_weekly
+        | :weekly
+        | :daily
+        | :hourly
+        | :fixed
+
+      class Unit < FinchAPI::Enum
+        YEARLY: :yearly
+        QUARTERLY: :quarterly
+        MONTHLY: :monthly
+        SEMI_MONTHLY: :semi_monthly
+        BI_WEEKLY: :bi_weekly
+        WEEKLY: :weekly
+        DAILY: :daily
+        HOURLY: :hourly
+        FIXED: :fixed
+
+        def self.values: -> ::Array[FinchAPI::Models::Income::unit]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module FinchAPI
+  module Models
+    type individual_event =
+      {
+        data: FinchAPI::Models::IndividualEvent::Data,
+        event_type: FinchAPI::Models::IndividualEvent::event_type
+      }
+
+    class IndividualEvent < FinchAPI::Models::BaseWebhookEvent
+      attr_reader data: FinchAPI::Models::IndividualEvent::Data?
+
+      def data=: (
+        FinchAPI::Models::IndividualEvent::Data
+      ) -> FinchAPI::Models::IndividualEvent::Data
+
+      attr_reader event_type: FinchAPI::Models::IndividualEvent::event_type?
+
+      def event_type=: (
+        FinchAPI::Models::IndividualEvent::event_type
+      ) -> FinchAPI::Models::IndividualEvent::event_type
+
+      def initialize:
+        (
+          data: FinchAPI::Models::IndividualEvent::Data,
+          event_type: FinchAPI::Models::IndividualEvent::event_type
+        ) -> void
+        | (
+          ?FinchAPI::Models::individual_event | FinchAPI::BaseModel data
+        ) -> void
+
+      def to_hash: -> FinchAPI::Models::individual_event
+
+      type data = { individual_id: String }
+
+      class Data < FinchAPI::BaseModel
+        attr_reader individual_id: String?
+
+        def individual_id=: (String) -> String
+
+        def initialize:
+          (individual_id: String) -> void
+          | (
+            ?FinchAPI::Models::IndividualEvent::data | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::IndividualEvent::data
+      end
+
+      type event_type =
+        :"individual.created" | :"individual.updated" | :"individual.deleted"
+
+      class EventType < FinchAPI::Enum
+        INDIVIDUAL_CREATED: :"individual.created"
+        INDIVIDUAL_UPDATED: :"individual.updated"
+        INDIVIDUAL_DELETED: :"individual.deleted"
+
+        def self.values: -> ::Array[FinchAPI::Models::IndividualEvent::event_type]
+      end
+    end
+  end
+end