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

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

@@ -8,114 +8,110 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
+        # @!attribute customer_email
+        #   Email address of the customer
+        #
+        #   @return [String, nil]
+        required :customer_email, String, nil?: true
+
         # @!attribute customer_id
+        #   Unique identifier for the customer
         #
         #   @return [String]
         required :customer_id, String
 
         # @!attribute customer_name
+        #   Name of the customer
         #
         #   @return [String]
         required :customer_name, String
 
-        # @!attribute products
-        #
-        #   @return [Array<Symbol, FinchAPI::Models::Connect::SessionNewParams::Product>]
-        required :products,
-                 -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Connect::SessionNewParams::Product] }
-
-        # @!attribute customer_email
-        #
-        #   @return [String, nil]
-        optional :customer_email, String, nil?: true
-
         # @!attribute integration
+        #   Integration configuration for the connect session
         #
         #   @return [FinchAPI::Models::Connect::SessionNewParams::Integration, nil]
-        optional :integration, -> { FinchAPI::Connect::SessionNewParams::Integration }, nil?: true
+        required :integration, -> { FinchAPI::Connect::SessionNewParams::Integration }, nil?: true
 
         # @!attribute manual
+        #   Enable manual authentication mode
         #
         #   @return [Boolean, nil]
-        optional :manual, FinchAPI::Internal::Type::Boolean, nil?: true
+        required :manual, FinchAPI::Internal::Type::Boolean, nil?: true
 
         # @!attribute minutes_to_expire
         #   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
+        required :minutes_to_expire, Float, nil?: true
+
+        # @!attribute products
+        #   The Finch products to request access to
+        #
+        #   @return [Array<Symbol, FinchAPI::Models::Connect::SessionNewParams::Product>]
+        required :products,
+                 -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Connect::SessionNewParams::Product] }
 
         # @!attribute redirect_uri
+        #   The URI to redirect to after the Connect flow is completed
         #
         #   @return [String, nil]
-        optional :redirect_uri, String, nil?: true
+        required :redirect_uri, String, nil?: true
 
         # @!attribute sandbox
+        #   Sandbox mode for testing
         #
         #   @return [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil]
-        optional :sandbox, enum: -> { FinchAPI::Connect::SessionNewParams::Sandbox }, nil?: true
+        required :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: {})
+        # @!method initialize(customer_email:, customer_id:, customer_name:, integration:, manual:, minutes_to_expire:, products:, redirect_uri:, sandbox:, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::Connect::SessionNewParams} for more details.
         #
-        #   @param customer_id [String]
+        #   @param customer_email [String, nil] Email address of the customer
         #
-        #   @param customer_name [String]
+        #   @param customer_id [String] Unique identifier for the customer
         #
-        #   @param products [Array<Symbol, FinchAPI::Models::Connect::SessionNewParams::Product>]
+        #   @param customer_name [String] Name of the customer
         #
-        #   @param customer_email [String, nil]
+        #   @param integration [FinchAPI::Models::Connect::SessionNewParams::Integration, nil] Integration configuration for the connect session
         #
-        #   @param integration [FinchAPI::Models::Connect::SessionNewParams::Integration, nil]
-        #
-        #   @param manual [Boolean, nil]
+        #   @param manual [Boolean, nil] Enable manual authentication mode
         #
         #   @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 products [Array<Symbol, FinchAPI::Models::Connect::SessionNewParams::Product>] The Finch products to request access to
+        #
+        #   @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
         #
-        #   @param sandbox [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil]
+        #   @param sandbox [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil] Sandbox mode for testing
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
-        # The Finch products that can be requested during the Connect flow.
-        module Product
-          extend FinchAPI::Internal::Type::Enum
-
-          COMPANY = :company
-          DIRECTORY = :directory
-          INDIVIDUAL = :individual
-          EMPLOYMENT = :employment
-          PAYMENT = :payment
-          PAY_STATEMENT = :pay_statement
-          BENEFITS = :benefits
-          SSN = :ssn
-          DEDUCTION = :deduction
-          DOCUMENTS = :documents
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
         class Integration < FinchAPI::Internal::Type::BaseModel
           # @!attribute auth_method
+          #   The authentication method to use
           #
           #   @return [Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod, nil]
-          optional :auth_method,
+          required :auth_method,
                    enum: -> { FinchAPI::Connect::SessionNewParams::Integration::AuthMethod },
                    nil?: true
 
           # @!attribute provider
+          #   The provider to integrate with
           #
           #   @return [String, nil]
-          optional :provider, String, nil?: true
+          required :provider, String, nil?: true
 
-          # @!method initialize(auth_method: nil, provider: nil)
-          #   @param auth_method [Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod, nil]
-          #   @param provider [String, nil]
+          # @!method initialize(auth_method:, provider:)
+          #   Integration configuration for the connect session
+          #
+          #   @param auth_method [Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod, nil] The authentication method to use
+          #
+          #   @param provider [String, nil] The provider to integrate with
 
+          # The authentication method to use
+          #
           # @see FinchAPI::Models::Connect::SessionNewParams::Integration#auth_method
           module AuthMethod
             extend FinchAPI::Internal::Type::Enum
@@ -130,6 +126,26 @@ module FinchAPI
           end
         end
 
+        # The Finch products that can be requested during the Connect flow.
+        module Product
+          extend FinchAPI::Internal::Type::Enum
+
+          BENEFITS = :benefits
+          COMPANY = :company
+          DEDUCTION = :deduction
+          DIRECTORY = :directory
+          DOCUMENTS = :documents
+          EMPLOYMENT = :employment
+          INDIVIDUAL = :individual
+          PAYMENT = :payment
+          PAY_STATEMENT = :pay_statement
+          SSN = :ssn
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Sandbox mode for testing
         module Sandbox
           extend FinchAPI::Internal::Type::Enum
 

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

@@ -18,14 +18,14 @@ module FinchAPI
         #   The number of minutes until the session expires (defaults to 43,200, which is 30
         #   days)
         #
-        #   @return [Integer, nil]
-        optional :minutes_to_expire, Integer, nil?: true
+        #   @return [Integer]
+        required :minutes_to_expire, Integer
 
         # @!attribute products
         #   The products to request access to (optional for reauthentication)
         #
         #   @return [Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil]
-        optional :products,
+        required :products,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Connect::SessionReauthenticateParams::Product]
                  },
@@ -35,15 +35,15 @@ module FinchAPI
         #   The URI to redirect to after the Connect flow is completed
         #
         #   @return [String, nil]
-        optional :redirect_uri, String, nil?: true
+        required :redirect_uri, String, nil?: true
 
-        # @!method initialize(connection_id:, minutes_to_expire: nil, products: nil, redirect_uri: nil, request_options: {})
+        # @!method initialize(connection_id:, minutes_to_expire:, products:, redirect_uri:, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::Connect::SessionReauthenticateParams} for more details.
         #
         #   @param connection_id [String] The ID of the existing connection to reauthenticate
         #
-        #   @param minutes_to_expire [Integer, nil] The number of minutes until the session expires (defaults to 43,200, which is 30
+        #   @param minutes_to_expire [Integer] The number of minutes until the session expires (defaults to 43,200, which is 30
         #
         #   @param products [Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil] The products to request access to (optional for reauthentication)
         #
@@ -55,16 +55,16 @@ module FinchAPI
         module Product
           extend FinchAPI::Internal::Type::Enum
 
+          BENEFITS = :benefits
           COMPANY = :company
+          DEDUCTION = :deduction
           DIRECTORY = :directory
-          INDIVIDUAL = :individual
+          DOCUMENTS = :documents
           EMPLOYMENT = :employment
+          INDIVIDUAL = :individual
           PAYMENT = :payment
           PAY_STATEMENT = :pay_statement
-          BENEFITS = :benefits
           SSN = :ssn
-          DEDUCTION = :deduction
-          DOCUMENTS = :documents
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/finch_api/models/create_access_token_response.rb

@@ -31,6 +31,12 @@ module FinchAPI
       #   @return [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType]
       required :connection_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ConnectionType }
 
+      # @!attribute entity_ids
+      #   An array of entity IDs that can be accessed with this access token
+      #
+      #   @return [Array<String>]
+      required :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
       # @!attribute products
       #   An array of the authorized products associated with the `access_token`
       #
@@ -74,7 +80,7 @@ module FinchAPI
       #   @return [String, nil]
       optional :customer_id, String, nil?: true
 
-      # @!method initialize(access_token:, client_type:, connection_id:, connection_type:, products:, provider_id:, token_type:, account_id: nil, company_id: nil, customer_id: nil)
+      # @!method initialize(access_token:, client_type:, connection_id:, connection_type:, entity_ids:, products:, provider_id:, token_type:, account_id: nil, company_id: nil, customer_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {FinchAPI::Models::CreateAccessTokenResponse} for more details.
       #
@@ -86,6 +92,8 @@ module FinchAPI
       #
       #   @param connection_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType] The type of the connection associated with the token.
       #
+      #   @param entity_ids [Array<String>] An array of entity IDs that can be accessed with this access token
+      #
       #   @param products [Array<String>] An array of the authorized products associated with the `access_token`
       #
       #   @param provider_id [String] The ID of the provider associated with the `access_token`

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

@@ -3,36 +3,131 @@
 module FinchAPI
   module Models
     module HRIS
-      class BenefitContribution < FinchAPI::Internal::Type::BaseModel
-        # @!attribute amount
-        #   Contribution amount in cents (if `fixed`) or basis points (if `percent`).
-        #
-        #   @return [Integer, nil]
-        required :amount, Integer, nil?: true
-
-        # @!attribute type
-        #   Contribution type.
-        #
-        #   @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type, nil]
-        required :type, enum: -> { FinchAPI::HRIS::BenefitContribution::Type }, nil?: true
-
-        # @!method initialize(amount:, type:)
-        #   @param amount [Integer, nil] Contribution amount in cents (if `fixed`) or basis points (if `percent`).
-        #
-        #   @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type, nil] Contribution type.
-
-        # Contribution type.
-        #
-        # @see FinchAPI::Models::HRIS::BenefitContribution#type
-        module Type
-          extend FinchAPI::Internal::Type::Enum
-
-          FIXED = :fixed
-          PERCENT = :percent
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
+      module BenefitContribution
+        extend FinchAPI::Internal::Type::Union
+
+        variant -> { FinchAPI::HRIS::BenefitContribution::UnionMember0 }
+
+        variant -> { FinchAPI::HRIS::BenefitContribution::UnionMember1 }
+
+        variant -> { FinchAPI::HRIS::BenefitContribution::UnionMember2 }
+
+        class UnionMember0 < FinchAPI::Internal::Type::BaseModel
+          # @!attribute amount
+          #   Contribution amount in cents.
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute type
+          #   Fixed contribution type.
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::UnionMember0::Type]
+          required :type, enum: -> { FinchAPI::HRIS::BenefitContribution::UnionMember0::Type }
+
+          # @!method initialize(amount:, type:)
+          #   @param amount [Integer] Contribution amount in cents.
+          #
+          #   @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::UnionMember0::Type] Fixed contribution type.
+
+          # Fixed contribution type.
+          #
+          # @see FinchAPI::Models::HRIS::BenefitContribution::UnionMember0#type
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            FIXED = :fixed
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
+
+        class UnionMember1 < FinchAPI::Internal::Type::BaseModel
+          # @!attribute amount
+          #   Contribution amount in basis points (1/100th of a percent).
+          #
+          #   @return [Integer]
+          required :amount, Integer
+
+          # @!attribute type
+          #   Percentage contribution type.
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::UnionMember1::Type]
+          required :type, enum: -> { FinchAPI::HRIS::BenefitContribution::UnionMember1::Type }
+
+          # @!method initialize(amount:, type:)
+          #   @param amount [Integer] Contribution amount in basis points (1/100th of a percent).
+          #
+          #   @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::UnionMember1::Type] Percentage contribution type.
+
+          # Percentage contribution type.
+          #
+          # @see FinchAPI::Models::HRIS::BenefitContribution::UnionMember1#type
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            PERCENT = :percent
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class UnionMember2 < FinchAPI::Internal::Type::BaseModel
+          # @!attribute tiers
+          #   Array of tier objects defining employer match tiers based on employee
+          #   contribution thresholds.
+          #
+          #   @return [Array<FinchAPI::Models::HRIS::BenefitContribution::UnionMember2::Tier>]
+          required :tiers,
+                   -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::BenefitContribution::UnionMember2::Tier] }
+
+          # @!attribute type
+          #   Tiered contribution type (only valid for company_contribution).
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::UnionMember2::Type]
+          required :type, enum: -> { FinchAPI::HRIS::BenefitContribution::UnionMember2::Type }
+
+          # @!method initialize(tiers:, type:)
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::HRIS::BenefitContribution::UnionMember2} for more details.
+          #
+          #   @param tiers [Array<FinchAPI::Models::HRIS::BenefitContribution::UnionMember2::Tier>] Array of tier objects defining employer match tiers based on employee contributi
+          #
+          #   @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::UnionMember2::Type] Tiered contribution type (only valid for company_contribution).
+
+          class Tier < FinchAPI::Internal::Type::BaseModel
+            # @!attribute match
+            #
+            #   @return [Integer]
+            required :match, Integer
+
+            # @!attribute threshold
+            #
+            #   @return [Integer]
+            required :threshold, Integer
+
+            # @!method initialize(match:, threshold:)
+            #   @param match [Integer]
+            #   @param threshold [Integer]
+          end
+
+          # Tiered contribution type (only valid for company_contribution).
+          #
+          # @see FinchAPI::Models::HRIS::BenefitContribution::UnionMember2#type
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            TIERED = :tiered
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @!method self.variants
+        #   @return [Array(FinchAPI::Models::HRIS::BenefitContribution::UnionMember0, FinchAPI::Models::HRIS::BenefitContribution::UnionMember1, FinchAPI::Models::HRIS::BenefitContribution::UnionMember2)]
       end
     end
   end

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

@@ -8,6 +8,12 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
+        # @!attribute entity_ids
+        #   The entity IDs to specify which entities' data to access.
+        #
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
         # @!attribute company_contribution
         #   The company match for this benefit.
         #
@@ -36,10 +42,12 @@ module FinchAPI
         #   @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: {})
+        # @!method initialize(entity_ids: nil, 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 entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @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

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

@@ -8,7 +8,15 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute entity_ids
+        #   The entity IDs to specify which entities' data to access.
+        #
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(entity_ids: nil, request_options: {})
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -8,7 +8,15 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute entity_ids
+        #   The entity IDs to specify which entities' data to access.
+        #
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(entity_ids: nil, request_options: {})
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -8,7 +8,15 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute entity_ids
+        #   The entity IDs to specify which entities' data to access.
+        #
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(entity_ids: nil, request_options: {})
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -8,13 +8,21 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
+        # @!attribute entity_ids
+        #   The entity IDs to specify which entities' data to access.
+        #
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
         # @!attribute description
         #   Updated name or description.
         #
         #   @return [String, nil]
         optional :description, String
 
-        # @!method initialize(description: nil, request_options: {})
+        # @!method initialize(entity_ids: nil, description: nil, request_options: {})
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @param description [String] Updated name or description.
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]