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

data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        # @see FinchAPI::Resources::HRIS::Benefits::Individuals#enroll_many
+        class IndividualEnrollManyParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          # @!attribute individuals
+          #   Array of the individual_id to enroll and a configuration object.
+          #
+          #   @return [Array<FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual>, nil]
+          optional :individuals,
+                   -> {
+                     FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual]
+                   }
+
+          # @!method initialize(individuals: nil, request_options: {})
+          #   @param individuals [Array<FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual>] Array of the individual_id to enroll and a configuration object.
+          #
+          #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+
+          class Individual < FinchAPI::Internal::Type::BaseModel
+            # @!attribute configuration
+            #
+            #   @return [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, nil]
+            optional :configuration,
+                     -> { FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration }
+
+            # @!attribute individual_id
+            #   Finch id (uuidv4) for the individual to enroll
+            #
+            #   @return [String, nil]
+            optional :individual_id, String
+
+            # @!method initialize(configuration: nil, individual_id: nil)
+            #   @param configuration [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration]
+            #
+            #   @param individual_id [String] Finch id (uuidv4) for the individual to enroll
+
+            # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual#configuration
+            class Configuration < FinchAPI::Internal::Type::BaseModel
+              # @!attribute annual_contribution_limit
+              #   For HSA benefits only - whether the contribution limit is for an individual or
+              #   family
+              #
+              #   @return [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit, nil]
+              optional :annual_contribution_limit,
+                       enum: -> {
+                         FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit
+                       }
+
+              # @!attribute annual_maximum
+              #   Maximum annual amount in cents
+              #
+              #   @return [Integer, nil]
+              optional :annual_maximum, Integer, nil?: true
+
+              # @!attribute catch_up
+              #   For retirement benefits only - whether catch up contributions are enabled
+              #
+              #   @return [Boolean, nil]
+              optional :catch_up, FinchAPI::Internal::Type::Boolean
+
+              # @!attribute company_contribution
+              #
+              #   @return [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, nil]
+              optional :company_contribution,
+                       -> {
+                         FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution
+                       }
+
+              # @!attribute effective_date
+              #   The date the enrollment will take effect
+              #
+              #   @return [Date, nil]
+              optional :effective_date, Date
+
+              # @!attribute employee_deduction
+              #
+              #   @return [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, nil]
+              optional :employee_deduction,
+                       -> {
+                         FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction
+                       }
+
+              # @!method initialize(annual_contribution_limit: nil, annual_maximum: nil, catch_up: nil, company_contribution: nil, effective_date: nil, employee_deduction: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration}
+              #   for more details.
+              #
+              #   @param annual_contribution_limit [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit] For HSA benefits only - whether the contribution limit is for an individual or f
+              #
+              #   @param annual_maximum [Integer, nil] Maximum annual amount in cents
+              #
+              #   @param catch_up [Boolean] For retirement benefits only - whether catch up contributions are enabled
+              #
+              #   @param company_contribution [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution]
+              #
+              #   @param effective_date [Date] The date the enrollment will take effect
+              #
+              #   @param employee_deduction [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction]
+
+              # For HSA benefits only - whether the contribution limit is for an individual or
+              # family
+              #
+              # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#annual_contribution_limit
+              module AnnualContributionLimit
+                extend FinchAPI::Internal::Type::Enum
+
+                INDIVIDUAL = :individual
+                FAMILY = :family
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#company_contribution
+              class CompanyContribution < FinchAPI::Internal::Type::BaseModel
+                # @!attribute amount
+                #   Amount in cents for fixed type or basis points (1/100th of a percent) for
+                #   percent type
+                #
+                #   @return [Integer, nil]
+                optional :amount, Integer
+
+                # @!attribute type
+                #
+                #   @return [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type, nil]
+                optional :type,
+                         enum: -> {
+                           FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type
+                         }
+
+                # @!method initialize(amount: nil, type: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution}
+                #   for more details.
+                #
+                #   @param amount [Integer] Amount in cents for fixed type or basis points (1/100th of a percent) for percen
+                #
+                #   @param type [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type]
+
+                # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution#type
+                module Type
+                  extend FinchAPI::Internal::Type::Enum
+
+                  FIXED = :fixed
+                  PERCENT = :percent
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+
+              # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#employee_deduction
+              class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel
+                # @!attribute amount
+                #   Amount in cents for fixed type or basis points (1/100th of a percent) for
+                #   percent type
+                #
+                #   @return [Integer, nil]
+                optional :amount, Integer
+
+                # @!attribute type
+                #
+                #   @return [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type, nil]
+                optional :type,
+                         enum: -> {
+                           FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type
+                         }
+
+                # @!method initialize(amount: nil, type: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction}
+                #   for more details.
+                #
+                #   @param amount [Integer] Amount in cents for fixed type or basis points (1/100th of a percent) for percen
+                #
+                #   @param type [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type]
+
+                # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction#type
+                module Type
+                  extend FinchAPI::Internal::Type::Enum
+
+                  FIXED = :fixed
+                  PERCENT = :percent
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        # @see FinchAPI::Resources::HRIS::Benefits::Individuals#enrolled_ids
+        class IndividualEnrolledIDsParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          # @!method initialize(request_options: {})
+          #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/benefits/individual_enrolled_ids_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        # @see FinchAPI::Resources::HRIS::Benefits::Individuals#enrolled_ids
+        class IndividualEnrolledIDsResponse < FinchAPI::Internal::Type::BaseModel
+          # @!attribute benefit_id
+          #   The id of the benefit.
+          #
+          #   @return [String]
+          required :benefit_id, String
+
+          # @!attribute individual_ids
+          #
+          #   @return [Array<String>]
+          required :individual_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(benefit_id:, individual_ids:)
+          #   @param benefit_id [String] The id of the benefit.
+          #
+          #   @param individual_ids [Array<String>]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        # @see FinchAPI::Resources::HRIS::Benefits::Individuals#retrieve_many_benefits
+        class IndividualRetrieveManyBenefitsParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          # @!attribute individual_ids
+          #   comma-delimited list of stable Finch uuids for each individual. If empty,
+          #   defaults to all individuals
+          #
+          #   @return [String, nil]
+          optional :individual_ids, String
+
+          # @!method initialize(individual_ids: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams} for
+          #   more details.
+          #
+          #   @param individual_ids [String] comma-delimited list of stable Finch uuids for each individual. If empty, defaul
+          #
+          #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        # @see FinchAPI::Resources::HRIS::Benefits::Individuals#unenroll_many
+        class IndividualUnenrollManyParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          # @!attribute individual_ids
+          #   Array of individual_ids to unenroll.
+          #
+          #   @return [Array<String>, nil]
+          optional :individual_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(individual_ids: nil, request_options: {})
+          #   @param individual_ids [Array<String>] Array of individual_ids to unenroll.
+          #
+          #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        # @see FinchAPI::Resources::HRIS::Benefits::Individuals#unenroll_many
+        class UnenrolledIndividualBenefitResponse < FinchAPI::Internal::Type::BaseModel
+          # @!attribute job_id
+          #
+          #   @return [String]
+          required :job_id, String
+
+          # @!method initialize(job_id:)
+          #   @param job_id [String]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/benefits_support.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class BenefitsSupport < FinchAPI::Internal::Type::BaseModel
+        # @!attribute commuter
+        #
+        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :commuter, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute custom_post_tax
+        #
+        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :custom_post_tax, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute custom_pre_tax
+        #
+        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :custom_pre_tax, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute fsa_dependent_care
+        #
+        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :fsa_dependent_care, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute fsa_medical
+        #
+        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :fsa_medical, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute hsa_post
+        #
+        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :hsa_post, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute hsa_pre
+        #
+        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :hsa_pre, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute s125_dental
+        #
+        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :s125_dental, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute s125_medical
+        #
+        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :s125_medical, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute s125_vision
+        #
+        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :s125_vision, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute simple
+        #
+        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :simple, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute simple_ira
+        #
+        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :simple_ira, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!method initialize(commuter: nil, custom_post_tax: nil, custom_pre_tax: nil, fsa_dependent_care: nil, fsa_medical: nil, hsa_post: nil, hsa_pre: nil, s125_dental: nil, s125_medical: nil, s125_vision: nil, simple: nil, simple_ira: nil)
+        #   Each benefit type and their supported features. If the benefit type is not
+        #   supported, the property will be null
+        #
+        #   @param commuter [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @param custom_post_tax [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @param custom_pre_tax [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @param fsa_dependent_care [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @param fsa_medical [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @param hsa_post [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @param hsa_pre [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @param s125_dental [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @param s125_medical [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @param s125_vision [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @param simple [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @param simple_ira [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Company
+        module PayStatementItem
+          # @see FinchAPI::Resources::HRIS::Company::PayStatementItem::Rules#create
+          class RuleCreateParams < FinchAPI::Internal::Type::BaseModel
+            extend FinchAPI::Internal::Type::RequestParameters::Converter
+            include FinchAPI::Internal::Type::RequestParameters
+
+            # @!attribute attributes
+            #   Specifies the fields to be applied when the condition is met.
+            #
+            #   @return [FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, nil]
+            optional :attributes,
+                     -> {
+                       FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes
+                     }
+
+            # @!attribute conditions
+            #
+            #   @return [Array<FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>, nil]
+            optional :conditions,
+                     -> {
+                       FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition]
+                     }
+
+            # @!attribute effective_end_date
+            #   Specifies when the rules should stop applying rules based on the date.
+            #
+            #   @return [String, nil]
+            optional :effective_end_date, String, nil?: true
+
+            # @!attribute effective_start_date
+            #   Specifies when the rule should begin applying based on the date.
+            #
+            #   @return [String, nil]
+            optional :effective_start_date, String, nil?: true
+
+            # @!attribute entity_type
+            #   The entity type to which the rule is applied.
+            #
+            #   @return [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType, nil]
+            optional :entity_type,
+                     enum: -> { FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType }
+
+            # @!method initialize(attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {})
+            #   @param attributes [FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met.
+            #
+            #   @param conditions [Array<FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>]
+            #
+            #   @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date.
+            #
+            #   @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date.
+            #
+            #   @param entity_type [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType] The entity type to which the rule is applied.
+            #
+            #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+
+            class Attributes < FinchAPI::Internal::Type::BaseModel
+              # @!attribute metadata
+              #   The metadata to be attached in the entity. It is a key-value pairs where the
+              #   values can be of any type (string, number, boolean, object, array, etc.).
+              #
+              #   @return [Hash{Symbol=>Object}, nil]
+              optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
+
+              # @!method initialize(metadata: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes} for
+              #   more details.
+              #
+              #   Specifies the fields to be applied when the condition is met.
+              #
+              #   @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
+            end
+
+            class Condition < FinchAPI::Internal::Type::BaseModel
+              # @!attribute field
+              #   The field to be checked in the rule.
+              #
+              #   @return [String, nil]
+              optional :field, String
+
+              # @!attribute operator
+              #   The operator to be used in the rule.
+              #
+              #   @return [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator, nil]
+              optional :operator,
+                       enum: -> {
+                         FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator
+                       }
+
+              # @!attribute value
+              #   The value of the field to be checked in the rule.
+              #
+              #   @return [String, nil]
+              optional :value, String
+
+              # @!method initialize(field: nil, operator: nil, value: nil)
+              #   @param field [String] The field to be checked in the rule.
+              #
+              #   @param operator [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator] The operator to be used in the rule.
+              #
+              #   @param value [String] The value of the field to be checked in the rule.
+
+              # The operator to be used in the rule.
+              #
+              # @see FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition#operator
+              module Operator
+                extend FinchAPI::Internal::Type::Enum
+
+                EQUALS = :equals
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            # The entity type to which the rule is applied.
+            module EntityType
+              extend FinchAPI::Internal::Type::Enum
+
+              PAY_STATEMENT_ITEM = :pay_statement_item
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end