finch-api 0.1.0.pre.alpha.4 → 0.1.0.pre.alpha.13

data/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb

@@ -1,237 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Benefits
-        class IndividualEnrollManyParams < FinchAPI::BaseModel
-          # @!parse
-          #   extend FinchAPI::RequestParameters::Converter
-          include FinchAPI::RequestParameters
-
-          # @!attribute [r] individuals
-          #   Array of the individual_id to enroll and a configuration object.
-          #
-          #   @return [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual>, nil]
-          optional :individuals,
-                   -> { FinchAPI::ArrayOf[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual] }
-
-          # @!parse
-          #   # @return [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual>]
-          #   attr_writer :individuals
-
-          # @!parse
-          #   # @param individuals [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual>]
-          #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-          #   #
-          #   def initialize(individuals: nil, request_options: {}, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          class Individual < FinchAPI::BaseModel
-            # @!attribute [r] configuration
-            #
-            #   @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, nil]
-            optional :configuration,
-                     -> { FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration }
-
-            # @!parse
-            #   # @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration]
-            #   attr_writer :configuration
-
-            # @!attribute [r] individual_id
-            #   Finch id (uuidv4) for the individual to enroll
-            #
-            #   @return [String, nil]
-            optional :individual_id, String
-
-            # @!parse
-            #   # @return [String]
-            #   attr_writer :individual_id
-
-            # @!parse
-            #   # @param configuration [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration]
-            #   # @param individual_id [String]
-            #   #
-            #   def initialize(configuration: nil, individual_id: nil, **) = super
-
-            # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-            class Configuration < FinchAPI::BaseModel
-              # @!attribute [r] annual_contribution_limit
-              #   For HSA benefits only - whether the contribution limit is for an individual or
-              #     family
-              #
-              #   @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit, nil]
-              optional :annual_contribution_limit,
-                       enum: -> { FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit }
-
-              # @!parse
-              #   # @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit]
-              #   attr_writer :annual_contribution_limit
-
-              # @!attribute annual_maximum
-              #   Maximum annual amount in cents
-              #
-              #   @return [Integer, nil]
-              optional :annual_maximum, Integer, nil?: true
-
-              # @!attribute [r] catch_up
-              #   For retirement benefits only - whether catch up contributions are enabled
-              #
-              #   @return [Boolean, nil]
-              optional :catch_up, FinchAPI::BooleanModel
-
-              # @!parse
-              #   # @return [Boolean]
-              #   attr_writer :catch_up
-
-              # @!attribute [r] company_contribution
-              #
-              #   @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, nil]
-              optional :company_contribution,
-                       -> { FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution }
-
-              # @!parse
-              #   # @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution]
-              #   attr_writer :company_contribution
-
-              # @!attribute [r] employee_deduction
-              #
-              #   @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, nil]
-              optional :employee_deduction,
-                       -> { FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction }
-
-              # @!parse
-              #   # @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction]
-              #   attr_writer :employee_deduction
-
-              # @!parse
-              #   # @param annual_contribution_limit [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit]
-              #   # @param annual_maximum [Integer, nil]
-              #   # @param catch_up [Boolean]
-              #   # @param company_contribution [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution]
-              #   # @param employee_deduction [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction]
-              #   #
-              #   def initialize(
-              #     annual_contribution_limit: nil,
-              #     annual_maximum: nil,
-              #     catch_up: nil,
-              #     company_contribution: nil,
-              #     employee_deduction: nil,
-              #     **
-              #   )
-              #     super
-              #   end
-
-              # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-              # For HSA benefits only - whether the contribution limit is for an individual or
-              #   family
-              module AnnualContributionLimit
-                extend FinchAPI::Enum
-
-                INDIVIDUAL = :individual
-                FAMILY = :family
-
-                finalize!
-
-                # @!parse
-                #   # @return [Array<Symbol>]
-                #   def self.values; end
-              end
-
-              class CompanyContribution < FinchAPI::BaseModel
-                # @!attribute [r] amount
-                #   Amount in cents for fixed type or basis points (1/100th of a percent) for
-                #     percent type
-                #
-                #   @return [Integer, nil]
-                optional :amount, Integer
-
-                # @!parse
-                #   # @return [Integer]
-                #   attr_writer :amount
-
-                # @!attribute [r] type
-                #
-                #   @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type, nil]
-                optional :type,
-                         enum: -> { FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type }
-
-                # @!parse
-                #   # @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type]
-                #   attr_writer :type
-
-                # @!parse
-                #   # @param amount [Integer]
-                #   # @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type]
-                #   #
-                #   def initialize(amount: nil, type: nil, **) = super
-
-                # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-                module Type
-                  extend FinchAPI::Enum
-
-                  FIXED = :fixed
-                  PERCENT = :percent
-
-                  finalize!
-
-                  # @!parse
-                  #   # @return [Array<Symbol>]
-                  #   def self.values; end
-                end
-              end
-
-              class EmployeeDeduction < FinchAPI::BaseModel
-                # @!attribute [r] amount
-                #   Amount in cents for fixed type or basis points (1/100th of a percent) for
-                #     percent type
-                #
-                #   @return [Integer, nil]
-                optional :amount, Integer
-
-                # @!parse
-                #   # @return [Integer]
-                #   attr_writer :amount
-
-                # @!attribute [r] type
-                #
-                #   @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type, nil]
-                optional :type,
-                         enum: -> { FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type }
-
-                # @!parse
-                #   # @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type]
-                #   attr_writer :type
-
-                # @!parse
-                #   # @param amount [Integer]
-                #   # @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type]
-                #   #
-                #   def initialize(amount: nil, type: nil, **) = super
-
-                # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-                module Type
-                  extend FinchAPI::Enum
-
-                  FIXED = :fixed
-                  PERCENT = :percent
-
-                  finalize!
-
-                  # @!parse
-                  #   # @return [Array<Symbol>]
-                  #   def self.values; end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Benefits
-        class IndividualEnrolledIDsParams < FinchAPI::BaseModel
-          # @!parse
-          #   extend FinchAPI::RequestParameters::Converter
-          include FinchAPI::RequestParameters
-
-          # @!parse
-          #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-          #   #
-          #   def initialize(request_options: {}, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Benefits
-        class IndividualEnrolledIDsResponse < FinchAPI::BaseModel
-          # @!attribute benefit_id
-          #
-          #   @return [String]
-          required :benefit_id, String
-
-          # @!attribute individual_ids
-          #
-          #   @return [Array<String>]
-          required :individual_ids, FinchAPI::ArrayOf[String]
-
-          # @!parse
-          #   # @param benefit_id [String]
-          #   # @param individual_ids [Array<String>]
-          #   #
-          #   def initialize(benefit_id:, individual_ids:, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Benefits
-        class IndividualRetrieveManyBenefitsParams < FinchAPI::BaseModel
-          # @!parse
-          #   extend FinchAPI::RequestParameters::Converter
-          include FinchAPI::RequestParameters
-
-          # @!attribute [r] 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
-
-          # @!parse
-          #   # @return [String]
-          #   attr_writer :individual_ids
-
-          # @!parse
-          #   # @param individual_ids [String]
-          #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-          #   #
-          #   def initialize(individual_ids: nil, request_options: {}, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Benefits
-        class IndividualUnenrollManyParams < FinchAPI::BaseModel
-          # @!parse
-          #   extend FinchAPI::RequestParameters::Converter
-          include FinchAPI::RequestParameters
-
-          # @!attribute [r] individual_ids
-          #   Array of individual_ids to unenroll.
-          #
-          #   @return [Array<String>, nil]
-          optional :individual_ids, FinchAPI::ArrayOf[String]
-
-          # @!parse
-          #   # @return [Array<String>]
-          #   attr_writer :individual_ids
-
-          # @!parse
-          #   # @param individual_ids [Array<String>]
-          #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-          #   #
-          #   def initialize(individual_ids: nil, request_options: {}, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefits/unenrolled_individual.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Benefits
-        class UnenrolledIndividual < FinchAPI::BaseModel
-          # @!attribute [r] body
-          #
-          #   @return [FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, nil]
-          optional :body, -> { FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body }
-
-          # @!parse
-          #   # @return [FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body]
-          #   attr_writer :body
-
-          # @!attribute [r] code
-          #   HTTP status code
-          #
-          #   @return [Integer, nil]
-          optional :code, Integer
-
-          # @!parse
-          #   # @return [Integer]
-          #   attr_writer :code
-
-          # @!attribute [r] individual_id
-          #
-          #   @return [String, nil]
-          optional :individual_id, String
-
-          # @!parse
-          #   # @return [String]
-          #   attr_writer :individual_id
-
-          # @!parse
-          #   # @param body [FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body]
-          #   # @param code [Integer]
-          #   # @param individual_id [String]
-          #   #
-          #   def initialize(body: nil, code: nil, individual_id: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          class Body < FinchAPI::BaseModel
-            # @!attribute finch_code
-            #   A descriptive identifier for the response.
-            #
-            #   @return [String, nil]
-            optional :finch_code, String, nil?: true
-
-            # @!attribute message
-            #   Short description in English that provides more information about the response.
-            #
-            #   @return [String, nil]
-            optional :message, String, nil?: true
-
-            # @!attribute name
-            #   Identifier indicating whether the benefit was newly enrolled or updated.
-            #
-            #   @return [String, nil]
-            optional :name, String, nil?: true
-
-            # @!parse
-            #   # @param finch_code [String, nil]
-            #   # @param message [String, nil]
-            #   # @param name [String, nil]
-            #   #
-            #   def initialize(finch_code: nil, message: nil, name: nil, **) = super
-
-            # def initialize: (Hash | FinchAPI::BaseModel) -> void
-          end
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefits_support.rb

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class BenefitsSupport < FinchAPI::BaseModel
-        # @!attribute commuter
-        #
-        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        optional :commuter, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
-
-        # @!attribute custom_post_tax
-        #
-        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        optional :custom_post_tax, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
-
-        # @!attribute custom_pre_tax
-        #
-        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        optional :custom_pre_tax, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
-
-        # @!attribute fsa_dependent_care
-        #
-        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        optional :fsa_dependent_care, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
-
-        # @!attribute fsa_medical
-        #
-        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        optional :fsa_medical, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
-
-        # @!attribute hsa_post
-        #
-        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        optional :hsa_post, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
-
-        # @!attribute hsa_pre
-        #
-        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        optional :hsa_pre, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
-
-        # @!attribute s125_dental
-        #
-        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        optional :s125_dental, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
-
-        # @!attribute s125_medical
-        #
-        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        optional :s125_medical, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
-
-        # @!attribute s125_vision
-        #
-        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        optional :s125_vision, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
-
-        # @!attribute simple
-        #
-        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        optional :simple, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
-
-        # @!attribute simple_ira
-        #
-        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        optional :simple_ira, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
-
-        # @!parse
-        #   # Each benefit type and their supported features. If the benefit type is not
-        #   #   supported, the property will be null
-        #   #
-        #   # @param commuter [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        #   # @param custom_post_tax [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        #   # @param custom_pre_tax [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        #   # @param fsa_dependent_care [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        #   # @param fsa_medical [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        #   # @param hsa_post [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        #   # @param hsa_pre [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        #   # @param s125_dental [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        #   # @param s125_medical [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        #   # @param s125_vision [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        #   # @param simple [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        #   # @param simple_ira [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
-        #   #
-        #   def 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,
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-    end
-  end
-end