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

data/lib/finch_api/models/provider_list_response.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    # @see FinchAPI::Resources::Providers#list
+    class ProviderListResponse < FinchAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The id of the payroll provider used in Connect.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute display_name
+      #   The display name of the payroll provider.
+      #
+      #   @return [String]
+      required :display_name, String
+
+      # @!attribute products
+      #   The list of Finch products supported on this payroll provider.
+      #
+      #   @return [Array<String>]
+      required :products, FinchAPI::Internal::Type::ArrayOf[String]
+
+      # @!attribute authentication_methods
+      #   The authentication methods supported by the provider.
+      #
+      #   @return [Array<FinchAPI::Models::ProviderListResponse::AuthenticationMethod>, nil]
+      optional :authentication_methods,
+               -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::ProviderListResponse::AuthenticationMethod] }
+
+      # @!attribute beta
+      #   `true` if the integration is in a beta state, `false` otherwise
+      #
+      #   @return [Boolean, nil]
+      optional :beta, FinchAPI::Internal::Type::Boolean
+
+      # @!attribute icon
+      #   The url to the official icon of the payroll provider.
+      #
+      #   @return [String, nil]
+      optional :icon, String
+
+      # @!attribute logo
+      #   The url to the official logo of the payroll provider.
+      #
+      #   @return [String, nil]
+      optional :logo, String
+
+      # @!attribute manual
+      #   @deprecated
+      #
+      #   [DEPRECATED] Whether the Finch integration with this provider uses the Assisted
+      #   Connect Flow by default. This field is now deprecated. Please check for a `type`
+      #   of `assisted` in the `authentication_methods` field instead.
+      #
+      #   @return [Boolean, nil]
+      optional :manual, FinchAPI::Internal::Type::Boolean
+
+      # @!attribute mfa_required
+      #   whether MFA is required for the provider.
+      #
+      #   @return [Boolean, nil]
+      optional :mfa_required, FinchAPI::Internal::Type::Boolean
+
+      # @!attribute primary_color
+      #   The hex code for the primary color of the payroll provider.
+      #
+      #   @return [String, nil]
+      optional :primary_color, String
+
+      # @!method initialize(id:, display_name:, products:, authentication_methods: nil, beta: nil, icon: nil, logo: nil, manual: nil, mfa_required: nil, primary_color: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {FinchAPI::Models::ProviderListResponse} for more details.
+      #
+      #   @param id [String] The id of the payroll provider used in Connect.
+      #
+      #   @param display_name [String] The display name of the payroll provider.
+      #
+      #   @param products [Array<String>] The list of Finch products supported on this payroll provider.
+      #
+      #   @param authentication_methods [Array<FinchAPI::Models::ProviderListResponse::AuthenticationMethod>] The authentication methods supported by the provider.
+      #
+      #   @param beta [Boolean] `true` if the integration is in a beta state, `false` otherwise
+      #
+      #   @param icon [String] The url to the official icon of the payroll provider.
+      #
+      #   @param logo [String] The url to the official logo of the payroll provider.
+      #
+      #   @param manual [Boolean] [DEPRECATED] Whether the Finch integration with this provider uses the Assisted
+      #
+      #   @param mfa_required [Boolean] whether MFA is required for the provider.
+      #
+      #   @param primary_color [String] The hex code for the primary color of the payroll provider.
+
+      class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of authentication method
+        #
+        #   @return [Symbol, FinchAPI::Models::ProviderListResponse::AuthenticationMethod::Type]
+        required :type, enum: -> { FinchAPI::Models::ProviderListResponse::AuthenticationMethod::Type }
+
+        # @!attribute benefits_support
+        #   The supported benefit types and their configurations
+        #
+        #   @return [Hash{Symbol=>Object, nil}, nil]
+        optional :benefits_support,
+                 FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
+
+        # @!attribute supported_fields
+        #   The supported fields for each Finch product
+        #
+        #   @return [Hash{Symbol=>Object, nil}, nil]
+        optional :supported_fields,
+                 FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
+
+        # @!method initialize(type:, benefits_support: nil, supported_fields: nil)
+        #   @param type [Symbol, FinchAPI::Models::ProviderListResponse::AuthenticationMethod::Type] The type of authentication method
+        #
+        #   @param benefits_support [Hash{Symbol=>Object, nil}] The supported benefit types and their configurations
+        #
+        #   @param supported_fields [Hash{Symbol=>Object, nil}] The supported fields for each Finch product
+
+        # The type of authentication method
+        #
+        # @see FinchAPI::Models::ProviderListResponse::AuthenticationMethod#type
+        module Type
+          extend FinchAPI::Internal::Type::Enum
+
+          ASSISTED = :assisted
+          CREDENTIAL = :credential
+          API_TOKEN = :api_token
+          API_CREDENTIAL = :api_credential
+          OAUTH = :oauth
+          API = :api
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/request_forwarding_forward_params.rb

@@ -34,15 +34,19 @@ module FinchAPI
       #   specified as an object of key-value pairs. Example:
       #   `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
       #
-      #   @return [Object, nil]
-      optional :headers, FinchAPI::Internal::Type::Unknown, nil?: true
+      #   @return [Hash{Symbol=>Object, nil}, nil]
+      optional :headers,
+               FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true],
+               nil?: true
 
       # @!attribute params
       #   The query parameters for the forwarded request. This value must be specified as
       #   a valid JSON object rather than a query string.
       #
-      #   @return [Object, nil]
-      optional :params, FinchAPI::Internal::Type::Unknown, nil?: true
+      #   @return [Hash{Symbol=>Object, nil}, nil]
+      optional :params,
+               FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true],
+               nil?: true
 
       # @!method initialize(method_:, route:, data: nil, headers: nil, params: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
@@ -54,9 +58,9 @@ module FinchAPI
       #
       #   @param data [String, nil] The body for the forwarded request. This value must be specified as either a str
       #
-      #   @param headers [Object, nil] The HTTP headers to include on the forwarded request. This value must be specifi
+      #   @param headers [Hash{Symbol=>Object, nil}, nil] The HTTP headers to include on the forwarded request. This value must be specifi
       #
-      #   @param params [Object, nil] The query parameters for the forwarded request. This value must be specified as
+      #   @param params [Hash{Symbol=>Object, nil}, nil] The query parameters for the forwarded request. This value must be specified as
       #
       #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/finch_api/models/request_forwarding_forward_response.rb

@@ -4,21 +4,6 @@ module FinchAPI
   module Models
     # @see FinchAPI::Resources::RequestForwarding#forward
     class RequestForwardingForwardResponse < FinchAPI::Internal::Type::BaseModel
-      # @!attribute data
-      #   A string representation of the HTTP response body of the forwarded request's
-      #   response received from the underlying integration's API. This field may be null
-      #   in the case where the upstream system's response is empty.
-      #
-      #   @return [String, nil]
-      required :data, String, nil?: true
-
-      # @!attribute headers
-      #   The HTTP headers of the forwarded request's response, exactly as received from
-      #   the underlying integration's API.
-      #
-      #   @return [Object, nil]
-      required :headers, FinchAPI::Internal::Type::Unknown, nil?: true
-
       # @!attribute request
       #   An object containing details of your original forwarded request, for your ease
       #   of reference.
@@ -33,35 +18,37 @@ module FinchAPI
       #   @return [Integer]
       required :status_code, Integer, api_name: :statusCode
 
-      # @!method initialize(data:, headers:, request:, status_code:)
-      #   Some parameter documentations has been truncated, see
-      #   {FinchAPI::Models::RequestForwardingForwardResponse} for more details.
+      # @!attribute data
+      #   A string representation of the HTTP response body of the forwarded request's
+      #   response received from the underlying integration's API. This field may be null
+      #   in the case where the upstream system's response is empty.
       #
-      #   @param data [String, nil] A string representation of the HTTP response body of the forwarded request's res
+      #   @return [String, nil]
+      optional :data, String, nil?: true
+
+      # @!attribute headers
+      #   The HTTP headers of the forwarded request's response, exactly as received from
+      #   the underlying integration's API.
       #
-      #   @param headers [Object, nil] The HTTP headers of the forwarded request's response, exactly as received from t
+      #   @return [Hash{Symbol=>Object, nil}, nil]
+      optional :headers,
+               FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true],
+               nil?: true
+
+      # @!method initialize(request:, status_code:, data: nil, headers: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {FinchAPI::Models::RequestForwardingForwardResponse} for more details.
       #
       #   @param request [FinchAPI::Models::RequestForwardingForwardResponse::Request] An object containing details of your original forwarded request, for your ease o
       #
       #   @param status_code [Integer] The HTTP status code of the forwarded request's response, exactly received from
+      #
+      #   @param data [String, nil] A string representation of the HTTP response body of the forwarded request's res
+      #
+      #   @param headers [Hash{Symbol=>Object, nil}, nil] The HTTP headers of the forwarded request's response, exactly as received from t
 
       # @see FinchAPI::Models::RequestForwardingForwardResponse#request
       class Request < FinchAPI::Internal::Type::BaseModel
-        # @!attribute data
-        #   The body that was specified for the forwarded request. If a value was not
-        #   specified in the original request, this value will be returned as null ;
-        #   otherwise, this value will always be returned as a string.
-        #
-        #   @return [String, nil]
-        required :data, String, nil?: true
-
-        # @!attribute headers
-        #   The specified HTTP headers that were included in the forwarded request. If no
-        #   headers were specified, this will be returned as `null`.
-        #
-        #   @return [Object, nil]
-        required :headers, FinchAPI::Internal::Type::Unknown, nil?: true
-
         # @!attribute method_
         #   The HTTP method that was specified for the forwarded request. Valid values
         #   include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.
@@ -69,35 +56,69 @@ module FinchAPI
         #   @return [String]
         required :method_, String, api_name: :method
 
-        # @!attribute params
-        #   The query parameters that were included in the forwarded request. If no query
-        #   parameters were specified, this will be returned as `null`.
-        #
-        #   @return [Object, nil]
-        required :params, FinchAPI::Internal::Type::Unknown, nil?: true
-
         # @!attribute route
         #   The URL route path that was specified for the forwarded request.
         #
         #   @return [String]
         required :route, String
 
-        # @!method initialize(data:, headers:, method_:, params:, route:)
+        # @!attribute data
+        #   The body that was specified for the forwarded request.
+        #
+        #   @return [String, Hash{Symbol=>Object, nil}, nil]
+        optional :data,
+                 union: -> { FinchAPI::Models::RequestForwardingForwardResponse::Request::Data },
+                 nil?: true
+
+        # @!attribute headers
+        #   The HTTP headers that were specified for the forwarded request.
+        #
+        #   @return [Hash{Symbol=>Object, nil}, nil]
+        optional :headers,
+                 FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true],
+                 nil?: true
+
+        # @!attribute params
+        #   The query parameters that were specified for the forwarded request.
+        #
+        #   @return [Hash{Symbol=>Object, nil}, nil]
+        optional :params,
+                 FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true],
+                 nil?: true
+
+        # @!method initialize(method_:, route:, data: nil, headers: nil, params: nil)
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::RequestForwardingForwardResponse::Request} for more details.
         #
         #   An object containing details of your original forwarded request, for your ease
         #   of reference.
         #
-        #   @param data [String, nil] The body that was specified for the forwarded request. If a value was not specif
+        #   @param method_ [String] The HTTP method that was specified for the forwarded request. Valid values inclu
         #
-        #   @param headers [Object, nil] The specified HTTP headers that were included in the forwarded request. If no he
+        #   @param route [String] The URL route path that was specified for the forwarded request.
         #
-        #   @param method_ [String] The HTTP method that was specified for the forwarded request. Valid values inclu
+        #   @param data [String, Hash{Symbol=>Object, nil}, nil] The body that was specified for the forwarded request.
         #
-        #   @param params [Object, nil] The query parameters that were included in the forwarded request. If no query pa
+        #   @param headers [Hash{Symbol=>Object, nil}, nil] The HTTP headers that were specified for the forwarded request.
         #
-        #   @param route [String] The URL route path that was specified for the forwarded request.
+        #   @param params [Hash{Symbol=>Object, nil}, nil] The query parameters that were specified for the forwarded request.
+
+        # The body that was specified for the forwarded request.
+        #
+        # @see FinchAPI::Models::RequestForwardingForwardResponse::Request#data
+        module Data
+          extend FinchAPI::Internal::Type::Union
+
+          variant String
+
+          variant -> { FinchAPI::Models::RequestForwardingForwardResponse::Request::Data::UnionMember1Map }
+
+          # @!method self.variants
+          #   @return [Array(String, Hash{Symbol=>Object, nil})]
+
+          # @type [FinchAPI::Internal::Type::Converter]
+          UnionMember1Map = FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
+        end
       end
     end
   end

data/lib/finch_api/resources/connect/sessions.rb

@@ -9,25 +9,25 @@ module FinchAPI
         #
         # Create a new connect session for an employer
         #
-        # @overload new(customer_id:, customer_name:, products:, customer_email: nil, integration: nil, manual: nil, minutes_to_expire: nil, redirect_uri: nil, sandbox: nil, request_options: {})
+        # @overload new(customer_email:, customer_id:, customer_name:, integration:, manual:, minutes_to_expire:, products:, redirect_uri:, sandbox:, request_options: {})
         #
-        # @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}, nil]
         #
@@ -50,11 +50,11 @@ module FinchAPI
         #
         # Create a new Connect session for reauthenticating an existing connection
         #
-        # @overload reauthenticate(connection_id:, minutes_to_expire: nil, products: nil, redirect_uri: nil, request_options: {})
+        # @overload reauthenticate(connection_id:, minutes_to_expire:, products:, redirect_uri:, request_options: {})
         #
         # @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)
         #

data/lib/finch_api/resources/hris/benefits/individuals.rb

@@ -10,11 +10,13 @@ module FinchAPI
           # adjusted. Making the same request multiple times will not create new
           # enrollments, but will continue to set the state of the existing enrollment.
           #
-          # @overload enroll_many(benefit_id, individuals: nil, request_options: {})
+          # @overload enroll_many(benefit_id, entity_ids: nil, individuals: nil, request_options: {})
           #
-          # @param benefit_id [String]
+          # @param benefit_id [String] Path param:
+          #
+          # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
           #
-          # @param individuals [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual>] Array of the individual_id to enroll and a configuration object.
+          # @param individuals [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual>] Body param: Array of the individual_id to enroll and a configuration object.
           #
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -26,6 +28,7 @@ module FinchAPI
             @client.request(
               method: :post,
               path: ["employer/benefits/%1$s/individuals", benefit_id],
+              query: parsed.except(:individuals),
               body: parsed[:individuals],
               model: FinchAPI::HRIS::Benefits::EnrolledIndividualBenefitResponse,
               options: options
@@ -34,20 +37,25 @@ module FinchAPI
 
           # Lists individuals currently enrolled in a given deduction.
           #
-          # @overload enrolled_ids(benefit_id, request_options: {})
+          # @overload enrolled_ids(benefit_id, entity_ids: nil, request_options: {})
           #
           # @param benefit_id [String]
+          #
+          # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+          #
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse]
           #
           # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsParams
           def enrolled_ids(benefit_id, params = {})
+            parsed, options = FinchAPI::HRIS::Benefits::IndividualEnrolledIDsParams.dump_request(params)
             @client.request(
               method: :get,
               path: ["employer/benefits/%1$s/enrolled", benefit_id],
+              query: parsed,
               model: FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse,
-              options: params[:request_options]
+              options: options
             )
           end
 
@@ -57,10 +65,12 @@ module FinchAPI
           #
           # Get enrollment information for the given individuals.
           #
-          # @overload retrieve_many_benefits(benefit_id, individual_ids: nil, request_options: {})
+          # @overload retrieve_many_benefits(benefit_id, entity_ids: nil, individual_ids: nil, request_options: {})
           #
           # @param benefit_id [String]
           #
+          # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+          #
           # @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}, nil]
@@ -82,11 +92,13 @@ module FinchAPI
 
           # Unenroll individuals from a deduction or contribution
           #
-          # @overload unenroll_many(benefit_id, individual_ids: nil, request_options: {})
+          # @overload unenroll_many(benefit_id, entity_ids: nil, individual_ids: nil, request_options: {})
           #
-          # @param benefit_id [String]
+          # @param benefit_id [String] Path param:
+          #
+          # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
           #
-          # @param individual_ids [Array<String>] Array of individual_ids to unenroll.
+          # @param individual_ids [Array<String>] Body param: Array of individual_ids to unenroll.
           #
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -95,10 +107,12 @@ module FinchAPI
           # @see FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyParams
           def unenroll_many(benefit_id, params = {})
             parsed, options = FinchAPI::HRIS::Benefits::IndividualUnenrollManyParams.dump_request(params)
+            query_params = [:entity_ids]
             @client.request(
               method: :delete,
               path: ["employer/benefits/%1$s/individuals", benefit_id],
-              body: parsed,
+              query: parsed.slice(*query_params),
+              body: parsed.except(*query_params),
               model: FinchAPI::HRIS::Benefits::UnenrolledIndividualBenefitResponse,
               options: options
             )

data/lib/finch_api/resources/hris/benefits.rb

@@ -13,15 +13,17 @@ module FinchAPI
         # Creates a new company-wide deduction or contribution. Please use the
         # `/providers` endpoint to view available types for each provider.
         #
-        # @overload create(company_contribution: nil, description: nil, frequency: nil, type: nil, request_options: {})
+        # @overload create(entity_ids: nil, company_contribution: nil, description: nil, frequency: nil, type: nil, request_options: {})
         #
-        # @param company_contribution [FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, nil] The company match for this benefit.
+        # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
         #
-        # @param description [String] Name of the benefit as it appears in the provider and pay statements. Recommend
+        # @param company_contribution [FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, nil] Body param: The company match for this benefit.
         #
-        # @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
+        # @param description [String] Body param: Name of the benefit as it appears in the provider and pay statements
         #
-        # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit.
+        # @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] Body param: The frequency of the benefit deduction/contribution.
+        #
+        # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Body param: Type of benefit.
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -30,10 +32,12 @@ module FinchAPI
         # @see FinchAPI::Models::HRIS::BenefitCreateParams
         def create(params = {})
           parsed, options = FinchAPI::HRIS::BenefitCreateParams.dump_request(params)
+          query_params = [:entity_ids]
           @client.request(
             method: :post,
             path: "employer/benefits",
-            body: parsed,
+            query: parsed.slice(*query_params),
+            body: parsed.except(*query_params),
             model: FinchAPI::HRIS::CreateCompanyBenefitsResponse,
             options: options
           )
@@ -41,30 +45,37 @@ module FinchAPI
 
         # Lists deductions and contributions information for a given item
         #
-        # @overload retrieve(benefit_id, request_options: {})
+        # @overload retrieve(benefit_id, entity_ids: nil, request_options: {})
         #
         # @param benefit_id [String]
+        #
+        # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [FinchAPI::Models::HRIS::CompanyBenefit]
         #
         # @see FinchAPI::Models::HRIS::BenefitRetrieveParams
         def retrieve(benefit_id, params = {})
+          parsed, options = FinchAPI::HRIS::BenefitRetrieveParams.dump_request(params)
           @client.request(
             method: :get,
             path: ["employer/benefits/%1$s", benefit_id],
+            query: parsed,
             model: FinchAPI::HRIS::CompanyBenefit,
-            options: params[:request_options]
+            options: options
           )
         end
 
         # Updates an existing company-wide deduction or contribution
         #
-        # @overload update(benefit_id, description: nil, request_options: {})
+        # @overload update(benefit_id, entity_ids: nil, description: nil, request_options: {})
         #
-        # @param benefit_id [String]
+        # @param benefit_id [String] Path param:
         #
-        # @param description [String] Updated name or description.
+        # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
+        #
+        # @param description [String] Body param: Updated name or description.
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -73,10 +84,12 @@ module FinchAPI
         # @see FinchAPI::Models::HRIS::BenefitUpdateParams
         def update(benefit_id, params = {})
           parsed, options = FinchAPI::HRIS::BenefitUpdateParams.dump_request(params)
+          query_params = [:entity_ids]
           @client.request(
             method: :post,
             path: ["employer/benefits/%1$s", benefit_id],
-            body: parsed,
+            query: parsed.slice(*query_params),
+            body: parsed.except(*query_params),
             model: FinchAPI::HRIS::UpdateCompanyBenefitResponse,
             options: options
           )
@@ -84,7 +97,9 @@ module FinchAPI
 
         # List all company-wide deductions and contributions.
         #
-        # @overload list(request_options: {})
+        # @overload list(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}, nil]
         #
@@ -92,18 +107,22 @@ module FinchAPI
         #
         # @see FinchAPI::Models::HRIS::BenefitListParams
         def list(params = {})
+          parsed, options = FinchAPI::HRIS::BenefitListParams.dump_request(params)
           @client.request(
             method: :get,
             path: "employer/benefits",
+            query: parsed,
             page: FinchAPI::Internal::SinglePage,
             model: FinchAPI::HRIS::CompanyBenefit,
-            options: params[:request_options]
+            options: options
           )
         end
 
         # Get deductions metadata
         #
-        # @overload list_supported_benefits(request_options: {})
+        # @overload list_supported_benefits(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}, nil]
         #
@@ -111,12 +130,14 @@ module FinchAPI
         #
         # @see FinchAPI::Models::HRIS::BenefitListSupportedBenefitsParams
         def list_supported_benefits(params = {})
+          parsed, options = FinchAPI::HRIS::BenefitListSupportedBenefitsParams.dump_request(params)
           @client.request(
             method: :get,
             path: "employer/benefits/meta",
+            query: parsed,
             page: FinchAPI::Internal::SinglePage,
             model: FinchAPI::HRIS::SupportedBenefit,
-            options: params[:request_options]
+            options: options
           )
         end