feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 46
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-03a89ccdf10add981e714ad74c145cd3a2408bd0223108bbfe01cef4256ef7ed.yml
-openapi_spec_hash: 4179c69ca2f55a9fcfab41710a2f452c
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-0105d239fcaf84750c886dfa6c2cfbf2b2087f89a48f8827c4cbe28479ebfb13.yml
+openapi_spec_hash: 34895c3d3c137fb9f5a019ac5370afbb
 config_hash: 6d3585c0032e08d723d077d660fc8448

README.md

@@ -30,7 +30,7 @@ require "finch_api"
 
 finch = FinchAPI::Client.new(access_token: "My Access Token")
 
-page = finch.hris.directory.list(entity_ids: ["550e8400-e29b-41d4-a716-446655440000"])
+page = finch.hris.directory.list
 
 puts(page.id)
 ```
@@ -42,7 +42,7 @@ List methods in the Finch API are paginated.
 This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
 
 ```ruby
-page = finch.hris.directory.list(entity_ids: ["550e8400-e29b-41d4-a716-446655440000"])
+page = finch.hris.directory.list
 
 # Fetch single item from page.
 directory = page.individuals[0]
@@ -69,7 +69,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  company = finch.hris.company.retrieve(entity_ids: ["550e8400-e29b-41d4-a716-446655440000"])
+  company = finch.hris.company.retrieve
 rescue FinchAPI::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -112,10 +112,7 @@ finch = FinchAPI::Client.new(
 )
 
 # Or, configure per-request:
-finch.hris.directory.list(
-  entity_ids: ["550e8400-e29b-41d4-a716-446655440000"],
-  request_options: {max_retries: 5}
-)
+finch.hris.directory.list(request_options: {max_retries: 5})
 ```
 
 ### Timeouts
@@ -129,10 +126,7 @@ finch = FinchAPI::Client.new(
 )
 
 # Or, configure per-request:
-finch.hris.directory.list(
-  entity_ids: ["550e8400-e29b-41d4-a716-446655440000"],
-  request_options: {timeout: 5}
-)
+finch.hris.directory.list(request_options: {timeout: 5})
 ```
 
 On timeout, `FinchAPI::Errors::APITimeoutError` is raised.
@@ -164,7 +158,6 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 ```ruby
 page =
   finch.hris.directory.list(
-    entity_ids: ["550e8400-e29b-41d4-a716-446655440000"],
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -210,17 +203,17 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-finch.hris.directory.list(entity_ids: ["550e8400-e29b-41d4-a716-446655440000"])
+finch.hris.directory.list
 ```
 
 Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-finch.hris.directory.list(entity_ids: ["550e8400-e29b-41d4-a716-446655440000"])
+finch.hris.directory.list
 
 # You can also splat a full Params class:
-params = FinchAPI::HRIS::DirectoryListParams.new(entity_ids: ["550e8400-e29b-41d4-a716-446655440000"])
+params = FinchAPI::HRIS::DirectoryListParams.new
 finch.hris.directory.list(**params)
 ```
 

lib/finch_api/models/hris/benefit_create_params.rb

@@ -11,8 +11,8 @@ class BenefitCreateParams < FinchAPI::Internal::Type::BaseModel
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access.
         #
-        #   @return [Array<String>]
-        required :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
         # @!attribute company_contribution
         #   The company match for this benefit.
@@ -42,7 +42,7 @@ class BenefitCreateParams < FinchAPI::Internal::Type::BaseModel
         #   @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
         optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true
 
-        # @!method initialize(entity_ids:, 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.
         #

lib/finch_api/models/hris/benefit_list_params.rb

@@ -11,10 +11,10 @@ class BenefitListParams < FinchAPI::Internal::Type::BaseModel
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access.
         #
-        #   @return [Array<String>]
-        required :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
-        # @!method initialize(entity_ids:, request_options: {})
+        # @!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}]

lib/finch_api/models/hris/benefit_list_supported_benefits_params.rb

@@ -11,10 +11,10 @@ class BenefitListSupportedBenefitsParams < FinchAPI::Internal::Type::BaseModel
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access.
         #
-        #   @return [Array<String>]
-        required :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
-        # @!method initialize(entity_ids:, request_options: {})
+        # @!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}]

lib/finch_api/models/hris/benefit_retrieve_params.rb

@@ -11,10 +11,10 @@ class BenefitRetrieveParams < FinchAPI::Internal::Type::BaseModel
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access.
         #
-        #   @return [Array<String>]
-        required :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
-        # @!method initialize(entity_ids:, request_options: {})
+        # @!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}]

lib/finch_api/models/hris/benefit_update_params.rb

@@ -11,16 +11,16 @@ class BenefitUpdateParams < FinchAPI::Internal::Type::BaseModel
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access.
         #
-        #   @return [Array<String>]
-        required :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+        #   @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(entity_ids:, 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.

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

@@ -12,8 +12,8 @@ class IndividualEnrollManyParams < FinchAPI::Internal::Type::BaseModel
           # @!attribute entity_ids
           #   The entity IDs to specify which entities' data to access.
           #
-          #   @return [Array<String>]
-          required :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+          #   @return [Array<String>, nil]
+          optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
           # @!attribute individuals
           #   Array of the individual_id to enroll and a configuration object.
@@ -22,7 +22,7 @@ class IndividualEnrollManyParams < FinchAPI::Internal::Type::BaseModel
           optional :individuals,
                    -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual] }
 
-          # @!method initialize(entity_ids:, individuals: nil, request_options: {})
+          # @!method initialize(entity_ids: nil, individuals: nil, request_options: {})
           #   @param entity_ids [Array<String>] 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.

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

@@ -12,10 +12,10 @@ class IndividualEnrolledIDsParams < FinchAPI::Internal::Type::BaseModel
           # @!attribute entity_ids
           #   The entity IDs to specify which entities' data to access.
           #
-          #   @return [Array<String>]
-          required :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+          #   @return [Array<String>, nil]
+          optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
-          # @!method initialize(entity_ids:, request_options: {})
+          # @!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}]

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

@@ -12,8 +12,8 @@ class IndividualRetrieveManyBenefitsParams < FinchAPI::Internal::Type::BaseModel
           # @!attribute entity_ids
           #   The entity IDs to specify which entities' data to access.
           #
-          #   @return [Array<String>]
-          required :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+          #   @return [Array<String>, nil]
+          optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
           # @!attribute individual_ids
           #   comma-delimited list of stable Finch uuids for each individual. If empty,
@@ -22,7 +22,7 @@ class IndividualRetrieveManyBenefitsParams < FinchAPI::Internal::Type::BaseModel
           #   @return [String, nil]
           optional :individual_ids, String
 
-          # @!method initialize(entity_ids:, individual_ids: nil, request_options: {})
+          # @!method initialize(entity_ids: nil, individual_ids: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams} for
           #   more details.