finch-api 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

data/lib/finch_api/models/base_webhook_event.rb

@@ -30,7 +30,7 @@ module FinchAPI
 
       # @!method initialize(account_id:, company_id:, connection_id: nil)
       #   Some parameter documentations has been truncated, see
-      #   {FinchAPI::BaseWebhookEvent} for more details.
+      #   {FinchAPI::Models::BaseWebhookEvent} for more details.
       #
       #   @param account_id [String] [DEPRECATED] Unique Finch ID of the employer account used to make this connectio
       #

data/lib/finch_api/models/company_event.rb

@@ -10,12 +10,12 @@ module FinchAPI
 
       # @!attribute event_type
       #
-      #   @return [Symbol, FinchAPI::CompanyEvent::EventType, nil]
+      #   @return [Symbol, FinchAPI::Models::CompanyEvent::EventType, nil]
       optional :event_type, enum: -> { FinchAPI::CompanyEvent::EventType }
 
       # @!method initialize(data: nil, event_type: nil)
       #   @param data [Hash{Symbol=>Object}, nil]
-      #   @param event_type [Symbol, FinchAPI::CompanyEvent::EventType]
+      #   @param event_type [Symbol, FinchAPI::Models::CompanyEvent::EventType]
 
       module EventType
         extend FinchAPI::Internal::Type::Enum

data/lib/finch_api/models/connect/session_new_params.rb

@@ -20,7 +20,7 @@ module FinchAPI
 
         # @!attribute products
         #
-        #   @return [Array<Symbol, FinchAPI::Connect::SessionNewParams::Product>]
+        #   @return [Array<Symbol, FinchAPI::Models::Connect::SessionNewParams::Product>]
         required :products,
                  -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Connect::SessionNewParams::Product] }
 
@@ -31,7 +31,7 @@ module FinchAPI
 
         # @!attribute integration
         #
-        #   @return [FinchAPI::Connect::SessionNewParams::Integration, nil]
+        #   @return [FinchAPI::Models::Connect::SessionNewParams::Integration, nil]
         optional :integration, -> { FinchAPI::Connect::SessionNewParams::Integration }, nil?: true
 
         # @!attribute manual
@@ -40,8 +40,8 @@ module FinchAPI
         optional :manual, FinchAPI::Internal::Type::Boolean, nil?: true
 
         # @!attribute minutes_to_expire
-        #   The number of minutes until the session expires (defaults to 43,200, which is 30
-        #   days)
+        #   The number of minutes until the session expires (defaults to 129,600, which is
+        #   90 days)
         #
         #   @return [Float, nil]
         optional :minutes_to_expire, Float, nil?: true
@@ -53,7 +53,7 @@ module FinchAPI
 
         # @!attribute sandbox
         #
-        #   @return [Symbol, FinchAPI::Connect::SessionNewParams::Sandbox, nil]
+        #   @return [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil]
         optional :sandbox, enum: -> { FinchAPI::Connect::SessionNewParams::Sandbox }, nil?: true
 
         # @!method initialize(customer_id:, customer_name:, products:, customer_email: nil, integration: nil, manual: nil, minutes_to_expire: nil, redirect_uri: nil, sandbox: nil, request_options: {})
@@ -64,19 +64,19 @@ module FinchAPI
         #
         #   @param customer_name [String]
         #
-        #   @param products [Array<Symbol, FinchAPI::Connect::SessionNewParams::Product>]
+        #   @param products [Array<Symbol, FinchAPI::Models::Connect::SessionNewParams::Product>]
         #
         #   @param customer_email [String, nil]
         #
-        #   @param integration [FinchAPI::Connect::SessionNewParams::Integration, nil]
+        #   @param integration [FinchAPI::Models::Connect::SessionNewParams::Integration, nil]
         #
         #   @param manual [Boolean, nil]
         #
-        #   @param minutes_to_expire [Float, nil] The number of minutes until the session expires (defaults to 43,200, which is 30
+        #   @param minutes_to_expire [Float, nil] The number of minutes until the session expires (defaults to 129,600, which is 9
         #
         #   @param redirect_uri [String, nil]
         #
-        #   @param sandbox [Symbol, FinchAPI::Connect::SessionNewParams::Sandbox, nil]
+        #   @param sandbox [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil]
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
@@ -102,7 +102,7 @@ module FinchAPI
         class Integration < FinchAPI::Internal::Type::BaseModel
           # @!attribute auth_method
           #
-          #   @return [Symbol, FinchAPI::Connect::SessionNewParams::Integration::AuthMethod, nil]
+          #   @return [Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod, nil]
           optional :auth_method,
                    enum: -> { FinchAPI::Connect::SessionNewParams::Integration::AuthMethod },
                    nil?: true
@@ -113,10 +113,10 @@ module FinchAPI
           optional :provider, String, nil?: true
 
           # @!method initialize(auth_method: nil, provider: nil)
-          #   @param auth_method [Symbol, FinchAPI::Connect::SessionNewParams::Integration::AuthMethod, nil]
+          #   @param auth_method [Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod, nil]
           #   @param provider [String, nil]
 
-          # @see FinchAPI::Connect::SessionNewParams::Integration#auth_method
+          # @see FinchAPI::Models::Connect::SessionNewParams::Integration#auth_method
           module AuthMethod
             extend FinchAPI::Internal::Type::Enum
 

data/lib/finch_api/models/connect/session_reauthenticate_params.rb

@@ -24,7 +24,7 @@ module FinchAPI
         # @!attribute products
         #   The products to request access to (optional for reauthentication)
         #
-        #   @return [Array<Symbol, FinchAPI::Connect::SessionReauthenticateParams::Product>, nil]
+        #   @return [Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil]
         optional :products,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Connect::SessionReauthenticateParams::Product]
@@ -45,7 +45,7 @@ module FinchAPI
         #
         #   @param minutes_to_expire [Integer, nil] The number of minutes until the session expires (defaults to 43,200, which is 30
         #
-        #   @param products [Array<Symbol, FinchAPI::Connect::SessionReauthenticateParams::Product>, nil] The products to request access to (optional for reauthentication)
+        #   @param products [Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil] The products to request access to (optional for reauthentication)
         #
         #   @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
         #

data/lib/finch_api/models/create_access_token_response.rb

@@ -22,7 +22,7 @@ module FinchAPI
       # @!attribute client_type
       #   The type of application associated with a token.
       #
-      #   @return [Symbol, FinchAPI::CreateAccessTokenResponse::ClientType]
+      #   @return [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType]
       required :client_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ClientType }
 
       # @!attribute company_id
@@ -46,7 +46,7 @@ module FinchAPI
       #   - `provider` - connection to an external provider
       #   - `finch` - finch-generated data.
       #
-      #   @return [Symbol, FinchAPI::CreateAccessTokenResponse::ConnectionType]
+      #   @return [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType]
       required :connection_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ConnectionType }
 
       # @!attribute products
@@ -76,19 +76,19 @@ module FinchAPI
 
       # @!method initialize(access_token:, account_id:, client_type:, company_id:, connection_id:, connection_type:, products:, provider_id:, customer_id: nil, token_type: nil)
       #   Some parameter documentations has been truncated, see
-      #   {FinchAPI::CreateAccessTokenResponse} for more details.
+      #   {FinchAPI::Models::CreateAccessTokenResponse} for more details.
       #
       #   @param access_token [String] The access token for the connection.
       #
       #   @param account_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this acco
       #
-      #   @param client_type [Symbol, FinchAPI::CreateAccessTokenResponse::ClientType] The type of application associated with a token.
+      #   @param client_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType] The type of application associated with a token.
       #
       #   @param company_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this comp
       #
       #   @param connection_id [String] The Finch UUID of the connection associated with the `access_token`.
       #
-      #   @param connection_type [Symbol, FinchAPI::CreateAccessTokenResponse::ConnectionType] The type of the connection associated with the token.
+      #   @param connection_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType] The type of the connection associated with the token.
       #
       #   @param products [Array<String>] An array of the authorized products associated with the `access_token`.
       #
@@ -100,7 +100,7 @@ module FinchAPI
 
       # The type of application associated with a token.
       #
-      # @see FinchAPI::CreateAccessTokenResponse#client_type
+      # @see FinchAPI::Models::CreateAccessTokenResponse#client_type
       module ClientType
         extend FinchAPI::Internal::Type::Enum
 
@@ -117,7 +117,7 @@ module FinchAPI
       # - `provider` - connection to an external provider
       # - `finch` - finch-generated data.
       #
-      # @see FinchAPI::CreateAccessTokenResponse#connection_type
+      # @see FinchAPI::Models::CreateAccessTokenResponse#connection_type
       module ConnectionType
         extend FinchAPI::Internal::Type::Enum
 

data/lib/finch_api/models/directory_event.rb

@@ -5,17 +5,17 @@ module FinchAPI
     class DirectoryEvent < FinchAPI::Models::BaseWebhookEvent
       # @!attribute data
       #
-      #   @return [FinchAPI::DirectoryEvent::Data, nil]
+      #   @return [FinchAPI::Models::DirectoryEvent::Data, nil]
       optional :data, -> { FinchAPI::DirectoryEvent::Data }
 
       # @!attribute event_type
       #
-      #   @return [Symbol, FinchAPI::DirectoryEvent::EventType, nil]
+      #   @return [Symbol, FinchAPI::Models::DirectoryEvent::EventType, nil]
       optional :event_type, enum: -> { FinchAPI::DirectoryEvent::EventType }
 
       # @!method initialize(data: nil, event_type: nil)
-      #   @param data [FinchAPI::DirectoryEvent::Data]
-      #   @param event_type [Symbol, FinchAPI::DirectoryEvent::EventType]
+      #   @param data [FinchAPI::Models::DirectoryEvent::Data]
+      #   @param event_type [Symbol, FinchAPI::Models::DirectoryEvent::EventType]
 
       class Data < FinchAPI::Internal::Type::BaseModel
         # @!attribute individual_id

data/lib/finch_api/models/employment_event.rb

@@ -5,17 +5,17 @@ module FinchAPI
     class EmploymentEvent < FinchAPI::Models::BaseWebhookEvent
       # @!attribute data
       #
-      #   @return [FinchAPI::EmploymentEvent::Data, nil]
+      #   @return [FinchAPI::Models::EmploymentEvent::Data, nil]
       optional :data, -> { FinchAPI::EmploymentEvent::Data }
 
       # @!attribute event_type
       #
-      #   @return [Symbol, FinchAPI::EmploymentEvent::EventType, nil]
+      #   @return [Symbol, FinchAPI::Models::EmploymentEvent::EventType, nil]
       optional :event_type, enum: -> { FinchAPI::EmploymentEvent::EventType }
 
       # @!method initialize(data: nil, event_type: nil)
-      #   @param data [FinchAPI::EmploymentEvent::Data]
-      #   @param event_type [Symbol, FinchAPI::EmploymentEvent::EventType]
+      #   @param data [FinchAPI::Models::EmploymentEvent::Data]
+      #   @param event_type [Symbol, FinchAPI::Models::EmploymentEvent::EventType]
 
       class Data < FinchAPI::Internal::Type::BaseModel
         # @!attribute individual_id

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

@@ -13,17 +13,17 @@ module FinchAPI
         # @!attribute type
         #   Contribution type.
         #
-        #   @return [Symbol, FinchAPI::HRIS::BenefitContribution::Type, nil]
+        #   @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type, nil]
         optional :type, enum: -> { FinchAPI::HRIS::BenefitContribution::Type }, nil?: true
 
         # @!method initialize(amount: nil, type: nil)
         #   @param amount [Integer, nil] Contribution amount in cents (if `fixed`) or basis points (if `percent`).
         #
-        #   @param type [Symbol, FinchAPI::HRIS::BenefitContribution::Type, nil] Contribution type.
+        #   @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type, nil] Contribution type.
 
         # Contribution type.
         #
-        # @see FinchAPI::HRIS::BenefitContribution#type
+        # @see FinchAPI::Models::HRIS::BenefitContribution#type
         module Type
           extend FinchAPI::Internal::Type::Enum
 

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

@@ -11,7 +11,7 @@ module FinchAPI
         # @!attribute company_contribution
         #   The company match for this benefit.
         #
-        #   @return [FinchAPI::HRIS::BenefitCreateParams::CompanyContribution, nil]
+        #   @return [FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, nil]
         optional :company_contribution,
                  -> { FinchAPI::HRIS::BenefitCreateParams::CompanyContribution },
                  nil?: true
@@ -27,33 +27,33 @@ module FinchAPI
         # @!attribute frequency
         #   The frequency of the benefit deduction/contribution.
         #
-        #   @return [Symbol, FinchAPI::HRIS::BenefitFrequency, nil]
+        #   @return [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil]
         optional :frequency, enum: -> { FinchAPI::HRIS::BenefitFrequency }, nil?: true
 
         # @!attribute type
         #   Type of benefit.
         #
-        #   @return [Symbol, FinchAPI::HRIS::BenefitType, nil]
+        #   @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
         optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true
 
         # @!method initialize(company_contribution: nil, description: nil, frequency: nil, type: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::HRIS::BenefitCreateParams} for more details.
         #
-        #   @param company_contribution [FinchAPI::HRIS::BenefitCreateParams::CompanyContribution, nil] The company match for this benefit.
+        #   @param company_contribution [FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, nil] The company match for this benefit.
         #
         #   @param description [String] Name of the benefit as it appears in the provider and pay statements. Recommend
         #
-        #   @param frequency [Symbol, FinchAPI::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
+        #   @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
         #
-        #   @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit.
+        #   @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit.
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
         class CompanyContribution < FinchAPI::Internal::Type::BaseModel
           # @!attribute tiers
           #
-          #   @return [Array<FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier>, nil]
+          #   @return [Array<FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier>, nil]
           optional :tiers,
                    -> {
                      FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier]
@@ -61,14 +61,14 @@ module FinchAPI
 
           # @!attribute type
           #
-          #   @return [Symbol, FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type, nil]
+          #   @return [Symbol, FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type, nil]
           optional :type, enum: -> { FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type }
 
           # @!method initialize(tiers: nil, type: nil)
           #   The company match for this benefit.
           #
-          #   @param tiers [Array<FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier>]
-          #   @param type [Symbol, FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type]
+          #   @param tiers [Array<FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier>]
+          #   @param type [Symbol, FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type]
 
           class Tier < FinchAPI::Internal::Type::BaseModel
             # @!attribute match
@@ -86,7 +86,7 @@ module FinchAPI
             #   @param threshold [Integer]
           end
 
-          # @see FinchAPI::HRIS::BenefitCreateParams::CompanyContribution#type
+          # @see FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution#type
           module Type
             extend FinchAPI::Internal::Type::Enum
 

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

@@ -6,132 +6,17 @@ module FinchAPI
       class BenefitFeaturesAndOperations < FinchAPI::Internal::Type::BaseModel
         # @!attribute supported_features
         #
-        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, nil]
-        optional :supported_features, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures }
+        #   @return [FinchAPI::Models::HRIS::SupportedBenefit, nil]
+        optional :supported_features, -> { FinchAPI::HRIS::SupportedBenefit }
 
         # @!attribute supported_operations
         #
-        #   @return [FinchAPI::HRIS::SupportPerBenefitType, nil]
+        #   @return [FinchAPI::Models::HRIS::SupportPerBenefitType, nil]
         optional :supported_operations, -> { FinchAPI::HRIS::SupportPerBenefitType }
 
         # @!method initialize(supported_features: nil, supported_operations: nil)
-        #   @param supported_features [FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures]
-        #   @param supported_operations [FinchAPI::HRIS::SupportPerBenefitType]
-
-        # @see FinchAPI::HRIS::BenefitFeaturesAndOperations#supported_features
-        class SupportedFeatures < FinchAPI::Internal::Type::BaseModel
-          # @!attribute annual_maximum
-          #   Whether the provider supports an annual maximum for this benefit.
-          #
-          #   @return [Boolean, nil]
-          optional :annual_maximum, FinchAPI::Internal::Type::Boolean, nil?: true
-
-          # @!attribute catch_up
-          #   Whether the provider supports catch up for this benefit. This field will only be
-          #   true for retirement benefits.
-          #
-          #   @return [Boolean, nil]
-          optional :catch_up, FinchAPI::Internal::Type::Boolean, nil?: true
-
-          # @!attribute company_contribution
-          #   Supported contribution types. An empty array indicates contributions are not
-          #   supported.
-          #
-          #   @return [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution, nil>, nil]
-          optional :company_contribution,
-                   -> {
-                     FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution,
-                                                       nil?: true]
-                   },
-                   nil?: true
-
-          # @!attribute description
-          #
-          #   @return [String, nil]
-          optional :description, String, nil?: true
-
-          # @!attribute employee_deduction
-          #   Supported deduction types. An empty array indicates deductions are not
-          #   supported.
-          #
-          #   @return [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction, nil>, nil]
-          optional :employee_deduction,
-                   -> {
-                     FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction,
-                                                       nil?: true]
-                   },
-                   nil?: true
-
-          # @!attribute frequencies
-          #   The list of frequencies supported by the provider for this benefit
-          #
-          #   @return [Array<Symbol, FinchAPI::HRIS::BenefitFrequency, nil>, nil]
-          optional :frequencies,
-                   -> {
-                     FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFrequency, nil?: true]
-                   }
-
-          # @!attribute hsa_contribution_limit
-          #   Whether the provider supports HSA contribution limits. Empty if this feature is
-          #   not supported for the benefit. This array only has values for HSA benefits.
-          #
-          #   @return [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit, nil>, nil]
-          optional :hsa_contribution_limit,
-                   -> {
-                     FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit,
-                                                       nil?: true]
-                   },
-                   nil?: true
-
-          # @!method initialize(annual_maximum: nil, catch_up: nil, company_contribution: nil, description: nil, employee_deduction: nil, frequencies: nil, hsa_contribution_limit: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures} for more
-          #   details.
-          #
-          #   @param annual_maximum [Boolean, nil] Whether the provider supports an annual maximum for this benefit.
-          #
-          #   @param catch_up [Boolean, nil] Whether the provider supports catch up for this benefit. This field will only be
-          #
-          #   @param company_contribution [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution, nil>, nil] Supported contribution types. An empty array indicates contributions are not sup
-          #
-          #   @param description [String, nil]
-          #
-          #   @param employee_deduction [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction, nil>, nil] Supported deduction types. An empty array indicates deductions are not supported
-          #
-          #   @param frequencies [Array<Symbol, FinchAPI::HRIS::BenefitFrequency, nil>] The list of frequencies supported by the provider for this benefit
-          #
-          #   @param hsa_contribution_limit [Array<Symbol, FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit, nil>, nil] Whether the provider supports HSA contribution limits. Empty if this feature is
-
-          module CompanyContribution
-            extend FinchAPI::Internal::Type::Enum
-
-            FIXED = :fixed
-            PERCENT = :percent
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-
-          module EmployeeDeduction
-            extend FinchAPI::Internal::Type::Enum
-
-            FIXED = :fixed
-            PERCENT = :percent
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-
-          module HsaContributionLimit
-            extend FinchAPI::Internal::Type::Enum
-
-            INDIVIDUAL = :individual
-            FAMILY = :family
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
+        #   @param supported_features [FinchAPI::Models::HRIS::SupportedBenefit]
+        #   @param supported_operations [FinchAPI::Models::HRIS::SupportPerBenefitType]
       end
     end
   end

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

@@ -7,25 +7,25 @@ module FinchAPI
       module BenefitType
         extend FinchAPI::Internal::Type::Enum
 
+        BENEFIT_TYPE_457 = :"457"
         BENEFIT_TYPE_401K = :"401k"
         BENEFIT_TYPE_401K_ROTH = :"401k_roth"
         BENEFIT_TYPE_401K_LOAN = :"401k_loan"
         BENEFIT_TYPE_403B = :"403b"
         BENEFIT_TYPE_403B_ROTH = :"403b_roth"
-        BENEFIT_TYPE_457 = :"457"
         BENEFIT_TYPE_457_ROTH = :"457_roth"
-        S125_MEDICAL = :s125_medical
-        S125_DENTAL = :s125_dental
-        S125_VISION = :s125_vision
-        HSA_PRE = :hsa_pre
-        HSA_POST = :hsa_post
-        FSA_MEDICAL = :fsa_medical
-        FSA_DEPENDENT_CARE = :fsa_dependent_care
-        SIMPLE_IRA = :simple_ira
-        SIMPLE = :simple
         COMMUTER = :commuter
         CUSTOM_POST_TAX = :custom_post_tax
         CUSTOM_PRE_TAX = :custom_pre_tax
+        FSA_DEPENDENT_CARE = :fsa_dependent_care
+        FSA_MEDICAL = :fsa_medical
+        HSA_POST = :hsa_post
+        HSA_PRE = :hsa_pre
+        S125_DENTAL = :s125_dental
+        S125_MEDICAL = :s125_medical
+        S125_VISION = :s125_vision
+        SIMPLE = :simple
+        SIMPLE_IRA = :simple_ira
 
         # @!method self.values
         #   @return [Array<Symbol>]

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

@@ -8,7 +8,7 @@ module FinchAPI
         class IndividualBenefit < FinchAPI::Internal::Type::BaseModel
           # @!attribute body
           #
-          #   @return [FinchAPI::HRIS::Benefits::IndividualBenefit::Body, nil]
+          #   @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, nil]
           optional :body, -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body }
 
           # @!attribute code
@@ -22,11 +22,11 @@ module FinchAPI
           optional :individual_id, String
 
           # @!method initialize(body: nil, code: nil, individual_id: nil)
-          #   @param body [FinchAPI::HRIS::Benefits::IndividualBenefit::Body]
+          #   @param body [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body]
           #   @param code [Integer]
           #   @param individual_id [String]
 
-          # @see FinchAPI::HRIS::Benefits::IndividualBenefit#body
+          # @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit#body
           class Body < FinchAPI::Internal::Type::BaseModel
             # @!attribute annual_maximum
             #   If the benefit supports annual maximum, the amount in cents for this individual.
@@ -43,39 +43,39 @@ module FinchAPI
 
             # @!attribute company_contribution
             #
-            #   @return [FinchAPI::HRIS::BenefitContribution, nil]
+            #   @return [FinchAPI::Models::HRIS::BenefitContribution, nil]
             optional :company_contribution, -> { FinchAPI::HRIS::BenefitContribution }, nil?: true
 
             # @!attribute employee_deduction
             #
-            #   @return [FinchAPI::HRIS::BenefitContribution, nil]
+            #   @return [FinchAPI::Models::HRIS::BenefitContribution, nil]
             optional :employee_deduction, -> { FinchAPI::HRIS::BenefitContribution }, nil?: true
 
             # @!attribute hsa_contribution_limit
             #   Type for HSA contribution limit if the benefit is a HSA.
             #
-            #   @return [Symbol, FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil]
+            #   @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil]
             optional :hsa_contribution_limit,
                      enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit },
                      nil?: true
 
             # @!method initialize(annual_maximum: nil, catch_up: nil, company_contribution: nil, employee_deduction: nil, hsa_contribution_limit: nil)
             #   Some parameter documentations has been truncated, see
-            #   {FinchAPI::HRIS::Benefits::IndividualBenefit::Body} for more details.
+            #   {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body} for more details.
             #
             #   @param annual_maximum [Integer, nil] If the benefit supports annual maximum, the amount in cents for this individual.
             #
             #   @param catch_up [Boolean, nil] If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled
             #
-            #   @param company_contribution [FinchAPI::HRIS::BenefitContribution, nil]
+            #   @param company_contribution [FinchAPI::Models::HRIS::BenefitContribution, nil]
             #
-            #   @param employee_deduction [FinchAPI::HRIS::BenefitContribution, nil]
+            #   @param employee_deduction [FinchAPI::Models::HRIS::BenefitContribution, nil]
             #
-            #   @param hsa_contribution_limit [Symbol, FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil] Type for HSA contribution limit if the benefit is a HSA.
+            #   @param hsa_contribution_limit [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil] Type for HSA contribution limit if the benefit is a HSA.
 
             # Type for HSA contribution limit if the benefit is a HSA.
             #
-            # @see FinchAPI::HRIS::Benefits::IndividualBenefit::Body#hsa_contribution_limit
+            # @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body#hsa_contribution_limit
             module HsaContributionLimit
               extend FinchAPI::Internal::Type::Enum