finch-api 0.1.0.pre.alpha.1

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

@@ -0,0 +1,47 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class PayStatementResponse < FinchAPI::BaseModel
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatementResponseBody)) }
+        def body
+        end
+
+        sig do
+          params(_: FinchAPI::Models::HRIS::PayStatementResponseBody)
+            .returns(FinchAPI::Models::HRIS::PayStatementResponseBody)
+        end
+        def body=(_)
+        end
+
+        sig { returns(T.nilable(Integer)) }
+        def code
+        end
+
+        sig { params(_: Integer).returns(Integer) }
+        def code=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def payment_id
+        end
+
+        sig { params(_: String).returns(String) }
+        def payment_id=(_)
+        end
+
+        sig { params(body: FinchAPI::Models::HRIS::PayStatementResponseBody, code: Integer, payment_id: String).void }
+        def initialize(body: nil, code: nil, payment_id: nil)
+        end
+
+        sig do
+          override
+            .returns({body: FinchAPI::Models::HRIS::PayStatementResponseBody, code: Integer, payment_id: String})
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class PayStatementResponseBody < FinchAPI::BaseModel
+        sig { returns(T.nilable(FinchAPI::Models::Paging)) }
+        def paging
+        end
+
+        sig { params(_: FinchAPI::Models::Paging).returns(FinchAPI::Models::Paging) }
+        def paging=(_)
+        end
+
+        sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::PayStatement])) }
+        def pay_statements
+        end
+
+        sig do
+          params(_: T::Array[FinchAPI::Models::HRIS::PayStatement])
+            .returns(T::Array[FinchAPI::Models::HRIS::PayStatement])
+        end
+        def pay_statements=(_)
+        end
+
+        sig do
+          params(paging: FinchAPI::Models::Paging, pay_statements: T::Array[FinchAPI::Models::HRIS::PayStatement])
+            .void
+        end
+        def initialize(paging: nil, pay_statements: nil)
+        end
+
+        sig do
+          override
+            .returns(
+              {paging: FinchAPI::Models::Paging, pay_statements: T::Array[FinchAPI::Models::HRIS::PayStatement]}
+            )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class PayStatementRetrieveManyParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        sig { returns(T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request]) }
+        def requests
+        end
+
+        sig do
+          params(_: T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request])
+            .returns(T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request])
+        end
+        def requests=(_)
+        end
+
+        sig do
+          params(
+            requests: T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request],
+            request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])
+          )
+            .void
+        end
+        def initialize(requests:, request_options: {})
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                requests: T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request],
+                request_options: FinchAPI::RequestOptions
+              }
+            )
+        end
+        def to_hash
+        end
+
+        class Request < FinchAPI::BaseModel
+          sig { returns(String) }
+          def payment_id
+          end
+
+          sig { params(_: String).returns(String) }
+          def payment_id=(_)
+          end
+
+          sig { returns(T.nilable(Integer)) }
+          def limit
+          end
+
+          sig { params(_: Integer).returns(Integer) }
+          def limit=(_)
+          end
+
+          sig { returns(T.nilable(Integer)) }
+          def offset
+          end
+
+          sig { params(_: Integer).returns(Integer) }
+          def offset=(_)
+          end
+
+          sig { params(payment_id: String, limit: Integer, offset: Integer).void }
+          def initialize(payment_id:, limit: nil, offset: nil)
+          end
+
+          sig { override.returns({payment_id: String, limit: Integer, offset: Integer}) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,207 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class Payment < FinchAPI::BaseModel
+        sig { returns(T.nilable(String)) }
+        def id
+        end
+
+        sig { params(_: String).returns(String) }
+        def id=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::Money)) }
+        def company_debit
+        end
+
+        sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) }
+        def company_debit=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def debit_date
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def debit_date=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::Money)) }
+        def employee_taxes
+        end
+
+        sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) }
+        def employee_taxes=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::Money)) }
+        def employer_taxes
+        end
+
+        sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) }
+        def employer_taxes=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::Money)) }
+        def gross_pay
+        end
+
+        sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) }
+        def gross_pay=(_)
+        end
+
+        sig { returns(T.nilable(T::Array[String])) }
+        def individual_ids
+        end
+
+        sig { params(_: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
+        def individual_ids=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::Money)) }
+        def net_pay
+        end
+
+        sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) }
+        def net_pay=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def pay_date
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def pay_date=(_)
+        end
+
+        sig { returns(T.nilable(T::Array[Symbol])) }
+        def pay_frequencies
+        end
+
+        sig { params(_: T.nilable(T::Array[Symbol])).returns(T.nilable(T::Array[Symbol])) }
+        def pay_frequencies=(_)
+        end
+
+        sig { returns(T.nilable(T::Array[String])) }
+        def pay_group_ids
+        end
+
+        sig { params(_: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
+        def pay_group_ids=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod)) }
+        def pay_period
+        end
+
+        sig do
+          params(_: T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod))
+            .returns(T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod))
+        end
+        def pay_period=(_)
+        end
+
+        sig do
+          params(
+            id: String,
+            company_debit: T.nilable(FinchAPI::Models::Money),
+            debit_date: T.nilable(String),
+            employee_taxes: T.nilable(FinchAPI::Models::Money),
+            employer_taxes: T.nilable(FinchAPI::Models::Money),
+            gross_pay: T.nilable(FinchAPI::Models::Money),
+            individual_ids: T.nilable(T::Array[String]),
+            net_pay: T.nilable(FinchAPI::Models::Money),
+            pay_date: T.nilable(String),
+            pay_frequencies: T.nilable(T::Array[Symbol]),
+            pay_group_ids: T.nilable(T::Array[String]),
+            pay_period: T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod)
+          )
+            .void
+        end
+        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
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                id: String,
+                company_debit: T.nilable(FinchAPI::Models::Money),
+                debit_date: T.nilable(String),
+                employee_taxes: T.nilable(FinchAPI::Models::Money),
+                employer_taxes: T.nilable(FinchAPI::Models::Money),
+                gross_pay: T.nilable(FinchAPI::Models::Money),
+                individual_ids: T.nilable(T::Array[String]),
+                net_pay: T.nilable(FinchAPI::Models::Money),
+                pay_date: T.nilable(String),
+                pay_frequencies: T.nilable(T::Array[Symbol]),
+                pay_group_ids: T.nilable(T::Array[String]),
+                pay_period: T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod)
+              }
+            )
+        end
+        def to_hash
+        end
+
+        class PayFrequency < FinchAPI::Enum
+          abstract!
+
+          ANNUALLY = :annually
+          SEMI_ANNUALLY = :semi_annually
+          QUARTERLY = :quarterly
+          MONTHLY = :monthly
+          SEMI_MONTHLY = :semi_monthly
+          BI_WEEKLY = :bi_weekly
+          WEEKLY = :weekly
+          DAILY = :daily
+          OTHER = :other
+
+          sig { override.returns(T::Array[Symbol]) }
+          def self.values
+          end
+        end
+
+        class PayPeriod < FinchAPI::BaseModel
+          sig { returns(T.nilable(String)) }
+          def end_date
+          end
+
+          sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+          def end_date=(_)
+          end
+
+          sig { returns(T.nilable(String)) }
+          def start_date
+          end
+
+          sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+          def start_date=(_)
+          end
+
+          sig { params(end_date: T.nilable(String), start_date: T.nilable(String)).void }
+          def initialize(end_date: nil, start_date: nil)
+          end
+
+          sig { override.returns({end_date: T.nilable(String), start_date: T.nilable(String)}) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class PaymentListParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        sig { returns(Date) }
+        def end_date
+        end
+
+        sig { params(_: Date).returns(Date) }
+        def end_date=(_)
+        end
+
+        sig { returns(Date) }
+        def start_date
+        end
+
+        sig { params(_: Date).returns(Date) }
+        def start_date=(_)
+        end
+
+        sig do
+          params(
+            end_date: Date,
+            start_date: Date,
+            request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])
+          )
+            .void
+        end
+        def initialize(end_date:, start_date:, request_options: {})
+        end
+
+        sig do
+          override.returns({end_date: Date, start_date: Date, request_options: FinchAPI::RequestOptions})
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class SupportPerBenefitType < FinchAPI::BaseModel
+        sig { returns(T.nilable(FinchAPI::Models::OperationSupportMatrix)) }
+        def company_benefits
+        end
+
+        sig { params(_: FinchAPI::Models::OperationSupportMatrix).returns(FinchAPI::Models::OperationSupportMatrix) }
+        def company_benefits=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::OperationSupportMatrix)) }
+        def individual_benefits
+        end
+
+        sig { params(_: FinchAPI::Models::OperationSupportMatrix).returns(FinchAPI::Models::OperationSupportMatrix) }
+        def individual_benefits=(_)
+        end
+
+        sig do
+          params(
+            company_benefits: FinchAPI::Models::OperationSupportMatrix,
+            individual_benefits: FinchAPI::Models::OperationSupportMatrix
+          )
+            .void
+        end
+        def initialize(company_benefits: nil, individual_benefits: nil)
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                company_benefits: FinchAPI::Models::OperationSupportMatrix,
+                individual_benefits: FinchAPI::Models::OperationSupportMatrix
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,155 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class SupportedBenefit < FinchAPI::BaseModel
+        sig { returns(T.nilable(T::Boolean)) }
+        def annual_maximum
+        end
+
+        sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
+        def annual_maximum=(_)
+        end
+
+        sig { returns(T.nilable(T::Boolean)) }
+        def catch_up
+        end
+
+        sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
+        def catch_up=(_)
+        end
+
+        sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) }
+        def company_contribution
+        end
+
+        sig do
+          params(_: T.nilable(T::Array[T.nilable(Symbol)])).returns(T.nilable(T::Array[T.nilable(Symbol)]))
+        end
+        def company_contribution=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def description
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def description=(_)
+        end
+
+        sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) }
+        def employee_deduction
+        end
+
+        sig do
+          params(_: T.nilable(T::Array[T.nilable(Symbol)])).returns(T.nilable(T::Array[T.nilable(Symbol)]))
+        end
+        def employee_deduction=(_)
+        end
+
+        sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) }
+        def frequencies
+        end
+
+        sig { params(_: T::Array[T.nilable(Symbol)]).returns(T::Array[T.nilable(Symbol)]) }
+        def frequencies=(_)
+        end
+
+        sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) }
+        def hsa_contribution_limit
+        end
+
+        sig do
+          params(_: T.nilable(T::Array[T.nilable(Symbol)])).returns(T.nilable(T::Array[T.nilable(Symbol)]))
+        end
+        def hsa_contribution_limit=(_)
+        end
+
+        sig { returns(T.nilable(Symbol)) }
+        def type
+        end
+
+        sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
+        def type=(_)
+        end
+
+        sig do
+          params(
+            annual_maximum: T.nilable(T::Boolean),
+            catch_up: T.nilable(T::Boolean),
+            company_contribution: T.nilable(T::Array[T.nilable(Symbol)]),
+            description: T.nilable(String),
+            employee_deduction: T.nilable(T::Array[T.nilable(Symbol)]),
+            frequencies: T::Array[T.nilable(Symbol)],
+            hsa_contribution_limit: T.nilable(T::Array[T.nilable(Symbol)]),
+            type: T.nilable(Symbol)
+          )
+            .void
+        end
+        def initialize(
+          annual_maximum: nil,
+          catch_up: nil,
+          company_contribution: nil,
+          description: nil,
+          employee_deduction: nil,
+          frequencies: nil,
+          hsa_contribution_limit: nil,
+          type: nil
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                annual_maximum: T.nilable(T::Boolean),
+                catch_up: T.nilable(T::Boolean),
+                company_contribution: T.nilable(T::Array[T.nilable(Symbol)]),
+                description: T.nilable(String),
+                employee_deduction: T.nilable(T::Array[T.nilable(Symbol)]),
+                frequencies: T::Array[T.nilable(Symbol)],
+                hsa_contribution_limit: T.nilable(T::Array[T.nilable(Symbol)]),
+                type: T.nilable(Symbol)
+              }
+            )
+        end
+        def to_hash
+        end
+
+        class CompanyContribution < FinchAPI::Enum
+          abstract!
+
+          FIXED = T.let(:fixed, T.nilable(Symbol))
+          PERCENT = T.let(:percent, T.nilable(Symbol))
+
+          sig { override.returns(T::Array[Symbol]) }
+          def self.values
+          end
+        end
+
+        class EmployeeDeduction < FinchAPI::Enum
+          abstract!
+
+          FIXED = T.let(:fixed, T.nilable(Symbol))
+          PERCENT = T.let(:percent, T.nilable(Symbol))
+
+          sig { override.returns(T::Array[Symbol]) }
+          def self.values
+          end
+        end
+
+        class HsaContributionLimit < FinchAPI::Enum
+          abstract!
+
+          INDIVIDUAL = T.let(:individual, T.nilable(Symbol))
+          FAMILY = T.let(:family, T.nilable(Symbol))
+
+          sig { override.returns(T::Array[Symbol]) }
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class UpdateCompanyBenefitResponse < FinchAPI::BaseModel
+        sig { returns(String) }
+        def benefit_id
+        end
+
+        sig { params(_: String).returns(String) }
+        def benefit_id=(_)
+        end
+
+        sig { params(benefit_id: String).void }
+        def initialize(benefit_id:)
+        end
+
+        sig { override.returns({benefit_id: String}) }
+        def to_hash
+        end
+      end
+    end
+  end
+end