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

data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi

@@ -0,0 +1,468 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        class IndividualEnrollManyParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
+          # Array of the individual_id to enroll and a configuration object.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual
+                ]
+              )
+            )
+          end
+          attr_reader :individuals
+
+          sig do
+            params(
+              individuals:
+                T::Array[
+                  FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::OrHash
+                ]
+            ).void
+          end
+          attr_writer :individuals
+
+          sig do
+            params(
+              individuals:
+                T::Array[
+                  FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::OrHash
+                ],
+              request_options: FinchAPI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Array of the individual_id to enroll and a configuration object.
+            individuals: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                individuals:
+                  T::Array[
+                    FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual
+                  ],
+                request_options: FinchAPI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Individual < FinchAPI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
+            sig do
+              returns(
+                T.nilable(
+                  FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration
+                )
+              )
+            end
+            attr_reader :configuration
+
+            sig do
+              params(
+                configuration:
+                  FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::OrHash
+              ).void
+            end
+            attr_writer :configuration
+
+            # Finch id (uuidv4) for the individual to enroll
+            sig { returns(T.nilable(String)) }
+            attr_reader :individual_id
+
+            sig { params(individual_id: String).void }
+            attr_writer :individual_id
+
+            sig do
+              params(
+                configuration:
+                  FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::OrHash,
+                individual_id: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              configuration: nil,
+              # Finch id (uuidv4) for the individual to enroll
+              individual_id: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  configuration:
+                    FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration,
+                  individual_id: String
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Configuration < FinchAPI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
+              # For HSA benefits only - whether the contribution limit is for an individual or
+              # family
+              sig do
+                returns(
+                  T.nilable(
+                    FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol
+                  )
+                )
+              end
+              attr_reader :annual_contribution_limit
+
+              sig do
+                params(
+                  annual_contribution_limit:
+                    FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol
+                ).void
+              end
+              attr_writer :annual_contribution_limit
+
+              # Maximum annual amount in cents
+              sig { returns(T.nilable(Integer)) }
+              attr_accessor :annual_maximum
+
+              # For retirement benefits only - whether catch up contributions are enabled
+              sig { returns(T.nilable(T::Boolean)) }
+              attr_reader :catch_up
+
+              sig { params(catch_up: T::Boolean).void }
+              attr_writer :catch_up
+
+              sig do
+                returns(
+                  T.nilable(
+                    FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution
+                  )
+                )
+              end
+              attr_reader :company_contribution
+
+              sig do
+                params(
+                  company_contribution:
+                    FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::OrHash
+                ).void
+              end
+              attr_writer :company_contribution
+
+              # The date the enrollment will take effect
+              sig { returns(T.nilable(Date)) }
+              attr_reader :effective_date
+
+              sig { params(effective_date: Date).void }
+              attr_writer :effective_date
+
+              sig do
+                returns(
+                  T.nilable(
+                    FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction
+                  )
+                )
+              end
+              attr_reader :employee_deduction
+
+              sig do
+                params(
+                  employee_deduction:
+                    FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::OrHash
+                ).void
+              end
+              attr_writer :employee_deduction
+
+              sig do
+                params(
+                  annual_contribution_limit:
+                    FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol,
+                  annual_maximum: T.nilable(Integer),
+                  catch_up: T::Boolean,
+                  company_contribution:
+                    FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::OrHash,
+                  effective_date: Date,
+                  employee_deduction:
+                    FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::OrHash
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # For HSA benefits only - whether the contribution limit is for an individual or
+                # family
+                annual_contribution_limit: nil,
+                # Maximum annual amount in cents
+                annual_maximum: nil,
+                # For retirement benefits only - whether catch up contributions are enabled
+                catch_up: nil,
+                company_contribution: nil,
+                # The date the enrollment will take effect
+                effective_date: nil,
+                employee_deduction: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    annual_contribution_limit:
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol,
+                    annual_maximum: T.nilable(Integer),
+                    catch_up: T::Boolean,
+                    company_contribution:
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution,
+                    effective_date: Date,
+                    employee_deduction:
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # For HSA benefits only - whether the contribution limit is for an individual or
+              # family
+              module AnnualContributionLimit
+                extend FinchAPI::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                INDIVIDUAL =
+                  T.let(
+                    :individual,
+                    FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol
+                  )
+                FAMILY =
+                  T.let(
+                    :family,
+                    FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+
+              class CompanyContribution < FinchAPI::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(T.self_type, FinchAPI::Internal::AnyHash)
+                  end
+
+                # Amount in cents for fixed type or basis points (1/100th of a percent) for
+                # percent type
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :amount
+
+                sig { params(amount: Integer).void }
+                attr_writer :amount
+
+                sig do
+                  returns(
+                    T.nilable(
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol
+                    )
+                  )
+                end
+                attr_reader :type
+
+                sig do
+                  params(
+                    type:
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol
+                  ).void
+                end
+                attr_writer :type
+
+                sig do
+                  params(
+                    amount: Integer,
+                    type:
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # Amount in cents for fixed type or basis points (1/100th of a percent) for
+                  # percent type
+                  amount: nil,
+                  type: nil
+                )
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      amount: Integer,
+                      type:
+                        FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol
+                    }
+                  )
+                end
+                def to_hash
+                end
+
+                module Type
+                  extend FinchAPI::Internal::Type::Enum
+
+                  TaggedSymbol =
+                    T.type_alias do
+                      T.all(
+                        Symbol,
+                        FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type
+                      )
+                    end
+                  OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                  FIXED =
+                    T.let(
+                      :fixed,
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol
+                    )
+                  PERCENT =
+                    T.let(
+                      :percent,
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol
+                    )
+
+                  sig do
+                    override.returns(
+                      T::Array[
+                        FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol
+                      ]
+                    )
+                  end
+                  def self.values
+                  end
+                end
+              end
+
+              class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(T.self_type, FinchAPI::Internal::AnyHash)
+                  end
+
+                # Amount in cents for fixed type or basis points (1/100th of a percent) for
+                # percent type
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :amount
+
+                sig { params(amount: Integer).void }
+                attr_writer :amount
+
+                sig do
+                  returns(
+                    T.nilable(
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol
+                    )
+                  )
+                end
+                attr_reader :type
+
+                sig do
+                  params(
+                    type:
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol
+                  ).void
+                end
+                attr_writer :type
+
+                sig do
+                  params(
+                    amount: Integer,
+                    type:
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # Amount in cents for fixed type or basis points (1/100th of a percent) for
+                  # percent type
+                  amount: nil,
+                  type: nil
+                )
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      amount: Integer,
+                      type:
+                        FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol
+                    }
+                  )
+                end
+                def to_hash
+                end
+
+                module Type
+                  extend FinchAPI::Internal::Type::Enum
+
+                  TaggedSymbol =
+                    T.type_alias do
+                      T.all(
+                        Symbol,
+                        FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type
+                      )
+                    end
+                  OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                  FIXED =
+                    T.let(
+                      :fixed,
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol
+                    )
+                  PERCENT =
+                    T.let(
+                      :percent,
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol
+                    )
+
+                  sig do
+                    override.returns(
+                      T::Array[
+                        FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol
+                      ]
+                    )
+                  end
+                  def self.values
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        class IndividualEnrolledIDsParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
+          sig do
+            params(request_options: FinchAPI::RequestOptions::OrHash).returns(
+              T.attached_class
+            )
+          end
+          def self.new(request_options: {})
+          end
+
+          sig do
+            override.returns({ request_options: FinchAPI::RequestOptions })
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        class IndividualEnrolledIDsResponse < FinchAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
+          # The id of the benefit.
+          sig { returns(String) }
+          attr_accessor :benefit_id
+
+          sig { returns(T::Array[String]) }
+          attr_accessor :individual_ids
+
+          sig do
+            params(
+              benefit_id: String,
+              individual_ids: T::Array[String]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The id of the benefit.
+            benefit_id:,
+            individual_ids:
+          )
+          end
+
+          sig do
+            override.returns(
+              { benefit_id: String, individual_ids: T::Array[String] }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        class IndividualRetrieveManyBenefitsParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
+          # comma-delimited list of stable Finch uuids for each individual. If empty,
+          # defaults to all individuals
+          sig { returns(T.nilable(String)) }
+          attr_reader :individual_ids
+
+          sig { params(individual_ids: String).void }
+          attr_writer :individual_ids
+
+          sig do
+            params(
+              individual_ids: String,
+              request_options: FinchAPI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # comma-delimited list of stable Finch uuids for each individual. If empty,
+            # defaults to all individuals
+            individual_ids: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                individual_ids: String,
+                request_options: FinchAPI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        class IndividualUnenrollManyParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
+          # Array of individual_ids to unenroll.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :individual_ids
+
+          sig { params(individual_ids: T::Array[String]).void }
+          attr_writer :individual_ids
+
+          sig do
+            params(
+              individual_ids: T::Array[String],
+              request_options: FinchAPI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Array of individual_ids to unenroll.
+            individual_ids: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                individual_ids: T::Array[String],
+                request_options: FinchAPI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        class UnenrolledIndividualBenefitResponse < FinchAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
+          sig { returns(String) }
+          attr_accessor :job_id
+
+          sig { params(job_id: String).returns(T.attached_class) }
+          def self.new(job_id:)
+          end
+
+          sig { override.returns({ job_id: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end