finch-api 0.1.0.pre.alpha.30 → 0.1.0.pre.alpha.31

data/rbi/finch_api/models/hris/benefit_contribution.rbi

@@ -3,83 +3,301 @@
 module FinchAPI
   module Models
     module HRIS
-      class BenefitContribution < FinchAPI::Internal::Type::BaseModel
-        OrHash =
+      module BenefitContribution
+        extend FinchAPI::Internal::Type::Union
+
+        Variants =
           T.type_alias do
             T.any(
-              FinchAPI::HRIS::BenefitContribution,
-              FinchAPI::Internal::AnyHash
+              FinchAPI::HRIS::BenefitContribution::UnionMember0,
+              FinchAPI::HRIS::BenefitContribution::UnionMember1,
+              FinchAPI::HRIS::BenefitContribution::UnionMember2
             )
           end
 
-        # Contribution amount in cents (if `fixed`) or basis points (if `percent`).
-        sig { returns(T.nilable(Integer)) }
-        attr_accessor :amount
+        class UnionMember0 < FinchAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                FinchAPI::HRIS::BenefitContribution::UnionMember0,
+                FinchAPI::Internal::AnyHash
+              )
+            end
+
+          # Contribution amount in cents.
+          sig { returns(Integer) }
+          attr_accessor :amount
 
-        # Contribution type.
-        sig do
-          returns(
-            T.nilable(FinchAPI::HRIS::BenefitContribution::Type::TaggedSymbol)
+          # Fixed contribution type.
+          sig do
+            returns(
+              FinchAPI::HRIS::BenefitContribution::UnionMember0::Type::OrSymbol
+            )
+          end
+          attr_accessor :type
+
+          sig do
+            params(
+              amount: Integer,
+              type:
+                FinchAPI::HRIS::BenefitContribution::UnionMember0::Type::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Contribution amount in cents.
+            amount:,
+            # Fixed contribution type.
+            type:
           )
-        end
-        attr_accessor :type
+          end
 
-        sig do
-          params(
-            amount: T.nilable(Integer),
-            type: T.nilable(FinchAPI::HRIS::BenefitContribution::Type::OrSymbol)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Contribution amount in cents (if `fixed`) or basis points (if `percent`).
-          amount:,
-          # Contribution type.
-          type:
-        )
+          sig do
+            override.returns(
+              {
+                amount: Integer,
+                type:
+                  FinchAPI::HRIS::BenefitContribution::UnionMember0::Type::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Fixed contribution type.
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  FinchAPI::HRIS::BenefitContribution::UnionMember0::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            FIXED =
+              T.let(
+                :fixed,
+                FinchAPI::HRIS::BenefitContribution::UnionMember0::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  FinchAPI::HRIS::BenefitContribution::UnionMember0::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
 
-        sig do
-          override.returns(
-            {
-              amount: T.nilable(Integer),
+        class UnionMember1 < FinchAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                FinchAPI::HRIS::BenefitContribution::UnionMember1,
+                FinchAPI::Internal::AnyHash
+              )
+            end
+
+          # Contribution amount in basis points (1/100th of a percent).
+          sig { returns(Integer) }
+          attr_accessor :amount
+
+          # Percentage contribution type.
+          sig do
+            returns(
+              FinchAPI::HRIS::BenefitContribution::UnionMember1::Type::OrSymbol
+            )
+          end
+          attr_accessor :type
+
+          sig do
+            params(
+              amount: Integer,
               type:
-                T.nilable(
-                  FinchAPI::HRIS::BenefitContribution::Type::TaggedSymbol
-                )
-            }
+                FinchAPI::HRIS::BenefitContribution::UnionMember1::Type::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Contribution amount in basis points (1/100th of a percent).
+            amount:,
+            # Percentage contribution type.
+            type:
           )
-        end
-        def to_hash
-        end
+          end
+
+          sig do
+            override.returns(
+              {
+                amount: Integer,
+                type:
+                  FinchAPI::HRIS::BenefitContribution::UnionMember1::Type::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Percentage contribution type.
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  FinchAPI::HRIS::BenefitContribution::UnionMember1::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PERCENT =
+              T.let(
+                :percent,
+                FinchAPI::HRIS::BenefitContribution::UnionMember1::Type::TaggedSymbol
+              )
 
-        # Contribution type.
-        module Type
-          extend FinchAPI::Internal::Type::Enum
+            sig do
+              override.returns(
+                T::Array[
+                  FinchAPI::HRIS::BenefitContribution::UnionMember1::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
 
-          TaggedSymbol =
+        class UnionMember2 < FinchAPI::Internal::Type::BaseModel
+          OrHash =
             T.type_alias do
-              T.all(Symbol, FinchAPI::HRIS::BenefitContribution::Type)
+              T.any(
+                FinchAPI::HRIS::BenefitContribution::UnionMember2,
+                FinchAPI::Internal::AnyHash
+              )
             end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          FIXED =
-            T.let(
-              :fixed,
-              FinchAPI::HRIS::BenefitContribution::Type::TaggedSymbol
+          # Array of tier objects defining employer match tiers based on employee
+          # contribution thresholds.
+          sig do
+            returns(
+              T::Array[FinchAPI::HRIS::BenefitContribution::UnionMember2::Tier]
             )
-          PERCENT =
-            T.let(
-              :percent,
-              FinchAPI::HRIS::BenefitContribution::Type::TaggedSymbol
+          end
+          attr_accessor :tiers
+
+          # Tiered contribution type (only valid for company_contribution).
+          sig do
+            returns(
+              FinchAPI::HRIS::BenefitContribution::UnionMember2::Type::OrSymbol
             )
+          end
+          attr_accessor :type
+
+          sig do
+            params(
+              tiers:
+                T::Array[
+                  FinchAPI::HRIS::BenefitContribution::UnionMember2::Tier::OrHash
+                ],
+              type:
+                FinchAPI::HRIS::BenefitContribution::UnionMember2::Type::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Array of tier objects defining employer match tiers based on employee
+            # contribution thresholds.
+            tiers:,
+            # Tiered contribution type (only valid for company_contribution).
+            type:
+          )
+          end
 
           sig do
             override.returns(
-              T::Array[FinchAPI::HRIS::BenefitContribution::Type::TaggedSymbol]
+              {
+                tiers:
+                  T::Array[
+                    FinchAPI::HRIS::BenefitContribution::UnionMember2::Tier
+                  ],
+                type:
+                  FinchAPI::HRIS::BenefitContribution::UnionMember2::Type::OrSymbol
+              }
             )
           end
-          def self.values
+          def to_hash
           end
+
+          class Tier < FinchAPI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  FinchAPI::HRIS::BenefitContribution::UnionMember2::Tier,
+                  FinchAPI::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Integer) }
+            attr_accessor :match
+
+            sig { returns(Integer) }
+            attr_accessor :threshold
+
+            sig do
+              params(match: Integer, threshold: Integer).returns(
+                T.attached_class
+              )
+            end
+            def self.new(match:, threshold:)
+            end
+
+            sig { override.returns({ match: Integer, threshold: Integer }) }
+            def to_hash
+            end
+          end
+
+          # Tiered contribution type (only valid for company_contribution).
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  FinchAPI::HRIS::BenefitContribution::UnionMember2::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            TIERED =
+              T.let(
+                :tiered,
+                FinchAPI::HRIS::BenefitContribution::UnionMember2::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  FinchAPI::HRIS::BenefitContribution::UnionMember2::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[FinchAPI::HRIS::BenefitContribution::Variants]
+          )
+        end
+        def self.variants
         end
       end
     end

data/rbi/finch_api/models/hris/benefit_create_params.rbi

@@ -15,6 +15,13 @@ module FinchAPI
             )
           end
 
+        # The entity IDs to specify which entities' data to access.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :entity_ids
+
+        sig { params(entity_ids: T::Array[String]).void }
+        attr_writer :entity_ids
+
         # The company match for this benefit.
         sig do
           returns(
@@ -52,6 +59,7 @@ module FinchAPI
 
         sig do
           params(
+            entity_ids: T::Array[String],
             company_contribution:
               T.nilable(
                 FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::OrHash
@@ -63,6 +71,8 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
           # The company match for this benefit.
           company_contribution: nil,
           # Name of the benefit as it appears in the provider and pay statements. Recommend
@@ -80,6 +90,7 @@ module FinchAPI
         sig do
           override.returns(
             {
+              entity_ids: T::Array[String],
               company_contribution:
                 T.nilable(
                   FinchAPI::HRIS::BenefitCreateParams::CompanyContribution

data/rbi/finch_api/models/hris/benefit_list_params.rbi

@@ -15,15 +15,34 @@ module FinchAPI
             )
           end
 
+        # The entity IDs to specify which entities' data to access.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :entity_ids
+
+        sig { params(entity_ids: T::Array[String]).void }
+        attr_writer :entity_ids
+
         sig do
-          params(request_options: FinchAPI::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            entity_ids: T::Array[String],
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          request_options: {}
+        )
         end
 
-        sig { override.returns({ request_options: FinchAPI::RequestOptions }) }
+        sig do
+          override.returns(
+            {
+              entity_ids: T::Array[String],
+              request_options: FinchAPI::RequestOptions
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi

@@ -15,15 +15,34 @@ module FinchAPI
             )
           end
 
+        # The entity IDs to specify which entities' data to access.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :entity_ids
+
+        sig { params(entity_ids: T::Array[String]).void }
+        attr_writer :entity_ids
+
         sig do
-          params(request_options: FinchAPI::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            entity_ids: T::Array[String],
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          request_options: {}
+        )
         end
 
-        sig { override.returns({ request_options: FinchAPI::RequestOptions }) }
+        sig do
+          override.returns(
+            {
+              entity_ids: T::Array[String],
+              request_options: FinchAPI::RequestOptions
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi

@@ -15,15 +15,34 @@ module FinchAPI
             )
           end
 
+        # The entity IDs to specify which entities' data to access.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :entity_ids
+
+        sig { params(entity_ids: T::Array[String]).void }
+        attr_writer :entity_ids
+
         sig do
-          params(request_options: FinchAPI::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            entity_ids: T::Array[String],
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          request_options: {}
+        )
         end
 
-        sig { override.returns({ request_options: FinchAPI::RequestOptions }) }
+        sig do
+          override.returns(
+            {
+              entity_ids: T::Array[String],
+              request_options: FinchAPI::RequestOptions
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/finch_api/models/hris/benefit_update_params.rbi

@@ -15,6 +15,13 @@ module FinchAPI
             )
           end
 
+        # The entity IDs to specify which entities' data to access.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :entity_ids
+
+        sig { params(entity_ids: T::Array[String]).void }
+        attr_writer :entity_ids
+
         # Updated name or description.
         sig { returns(T.nilable(String)) }
         attr_reader :description
@@ -24,11 +31,14 @@ module FinchAPI
 
         sig do
           params(
+            entity_ids: T::Array[String],
             description: String,
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
           # Updated name or description.
           description: nil,
           request_options: {}
@@ -37,7 +47,11 @@ module FinchAPI
 
         sig do
           override.returns(
-            { description: String, request_options: FinchAPI::RequestOptions }
+            {
+              entity_ids: T::Array[String],
+              description: String,
+              request_options: FinchAPI::RequestOptions
+            }
           )
         end
         def to_hash