feat(api): benefits mutation API endpoints (create benefit, update benefit, enroll individual, unenroll individual) now properly return async response types

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 46
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-8c83f0eae70d2a02ed3e2059fc251affdccd2f848f45445e4fed64dfd9ca5985.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-bf858f37d7ab420841ddc6329dad8c46377308b6a5c8e935908011d0f9845e22.yml
 openapi_spec_hash: 2523952a32436e3c7fd3b55508c2e7ee
-config_hash: ce10384813f68ba3fed61c7b601b396b
+config_hash: 4a8def48077df6382ed9fe00588baecf

lib/finch_api.rb

@@ -82,13 +82,14 @@
 require_relative "finch_api/models/hris/benefit_list_supported_benefits_params"
 require_relative "finch_api/models/hris/benefit_list_supported_benefits_response"
 require_relative "finch_api/models/hris/benefit_retrieve_params"
+require_relative "finch_api/models/hris/benefits/enrolled_individual_benifit"
 require_relative "finch_api/models/hris/benefits/individual_benefit"
 require_relative "finch_api/models/hris/benefits/individual_enrolled_ids_params"
 require_relative "finch_api/models/hris/benefits/individual_enrolled_ids_response"
 require_relative "finch_api/models/hris/benefits/individual_enroll_many_params"
-require_relative "finch_api/models/hris/benefits/individual_enroll_many_response"
 require_relative "finch_api/models/hris/benefits/individual_retrieve_many_benefits_params"
 require_relative "finch_api/models/hris/benefits/individual_unenroll_many_params"
+require_relative "finch_api/models/hris/benefits/individual_unenroll_many_response"
 require_relative "finch_api/models/hris/benefits_support"
 require_relative "finch_api/models/hris/benefit_type"
 require_relative "finch_api/models/hris/benefit_update_params"

lib/finch_api/models/hris/benefits/individual_enroll_many_response.rb → lib/finch_api/models/hris/benefits/enrolled_individual_benifit.rb

@@ -5,7 +5,7 @@ module Models
     module HRIS
       module Benefits
         # @see FinchAPI::Resources::HRIS::Benefits::Individuals#enroll_many
-        class IndividualEnrollManyResponse < FinchAPI::Internal::Type::BaseModel
+        class EnrolledIndividualBenifit < FinchAPI::Internal::Type::BaseModel
           # @!attribute job_id
           #
           #   @return [String]

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        # @see FinchAPI::Resources::HRIS::Benefits::Individuals#unenroll_many
+        class IndividualUnenrollManyResponse < FinchAPI::Internal::Type::BaseModel
+          # @!attribute job_id
+          #
+          #   @return [String]
+          required :job_id, String
+
+          # @!parse
+          #   # @param job_id [String]
+          #   #
+          #   def initialize(job_id:, **) = super
+
+          # def initialize: (Hash | FinchAPI::Internal::Type::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

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

@@ -16,7 +16,7 @@ class Individuals
           # @param individuals [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual>]
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyResponse]
+          # @return [FinchAPI::Models::HRIS::Benefits::EnrolledIndividualBenifit]
           #
           # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams
           def enroll_many(benefit_id, params = {})
@@ -25,7 +25,7 @@ def enroll_many(benefit_id, params = {})
               method: :post,
               path: ["employer/benefits/%1$s/individuals", benefit_id],
               body: parsed[:individuals],
-              model: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyResponse,
+              model: FinchAPI::Models::HRIS::Benefits::EnrolledIndividualBenifit,
               options: options
             )
           end
@@ -81,7 +81,7 @@ def retrieve_many_benefits(benefit_id, params = {})
           # @param individual_ids [Array<String>]
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [FinchAPI::Internal::SinglePage<Object>]
+          # @return [FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyResponse]
           #
           # @see FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyParams
           def unenroll_many(benefit_id, params = {})
@@ -90,8 +90,7 @@ def unenroll_many(benefit_id, params = {})
               method: :delete,
               path: ["employer/benefits/%1$s/individuals", benefit_id],
               body: parsed,
-              page: FinchAPI::Internal::SinglePage,
-              model: FinchAPI::Internal::Type::Unknown,
+              model: FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyResponse,
               options: options
             )
           end

rbi/lib/finch_api/models/hris/benefits/individual_enroll_many_response.rbi → rbi/lib/finch_api/models/hris/benefits/enrolled_individual_benifit.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module HRIS
       module Benefits
-        class IndividualEnrollManyResponse < FinchAPI::Internal::Type::BaseModel
+        class EnrolledIndividualBenifit < FinchAPI::Internal::Type::BaseModel
           sig { returns(String) }
           attr_accessor :job_id
 

rbi/lib/finch_api/models/hris/benefits/individual_unenroll_many_response.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        class IndividualUnenrollManyResponse < FinchAPI::Internal::Type::BaseModel
+          sig { returns(String) }
+          attr_accessor :job_id
+
+          sig { params(job_id: String).returns(T.attached_class) }
+          def self.new(job_id:); end
+
+          sig { override.returns({job_id: String}) }
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

rbi/lib/finch_api/resources/hris/benefits/individuals.rbi

@@ -20,7 +20,7 @@ module FinchAPI
               ],
               request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
             )
-              .returns(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyResponse)
+              .returns(FinchAPI::Models::HRIS::Benefits::EnrolledIndividualBenifit)
           end
           def enroll_many(
             benefit_id,
@@ -61,7 +61,7 @@ module FinchAPI
               individual_ids: T::Array[String],
               request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
             )
-              .returns(FinchAPI::Internal::SinglePage[T.anything])
+              .returns(FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyResponse)
           end
           def unenroll_many(
             benefit_id,

sig/finch_api/models/hris/benefits/enrolled_individual_benifit.rbs

@@ -0,0 +1,17 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        type enrolled_individual_benifit = { job_id: String }
+
+        class EnrolledIndividualBenifit < FinchAPI::Internal::Type::BaseModel
+          attr_accessor job_id: String
+
+          def initialize: (job_id: String) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::Benefits::enrolled_individual_benifit
+        end
+      end
+    end
+  end
+end

sig/finch_api/models/hris/benefits/individual_enroll_many_response.rbs → sig/finch_api/models/hris/benefits/individual_unenroll_many_response.rbs

@@ -2,14 +2,14 @@ module FinchAPI
   module Models
     module HRIS
       module Benefits
-        type individual_enroll_many_response = { job_id: String }
+        type individual_unenroll_many_response = { job_id: String }
 
-        class IndividualEnrollManyResponse < FinchAPI::Internal::Type::BaseModel
+        class IndividualUnenrollManyResponse < FinchAPI::Internal::Type::BaseModel
           attr_accessor job_id: String
 
           def initialize: (job_id: String) -> void
 
-          def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_enroll_many_response
+          def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_unenroll_many_response
         end
       end
     end

sig/finch_api/resources/hris/benefits/individuals.rbs

@@ -7,7 +7,7 @@ module FinchAPI
             String benefit_id,
             ?individuals: ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual],
             ?request_options: FinchAPI::request_opts
-          ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyResponse
+          ) -> FinchAPI::Models::HRIS::Benefits::EnrolledIndividualBenifit
 
           def enrolled_ids: (
             String benefit_id,
@@ -24,7 +24,7 @@ module FinchAPI
             String benefit_id,
             ?individual_ids: ::Array[String],
             ?request_options: FinchAPI::request_opts
-          ) -> FinchAPI::Internal::SinglePage[top]
+          ) -> FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyResponse
 
           def initialize: (client: FinchAPI::Client) -> void
         end

test/finch_api/resources/hris/benefits/individuals_test.rb

@@ -7,7 +7,7 @@ def test_enroll_many
     response = @finch.hris.benefits.individuals.enroll_many("benefit_id")
 
     assert_pattern do
-      response => FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyResponse
+      response => FinchAPI::Models::HRIS::Benefits::EnrolledIndividualBenifit
     end
 
     assert_pattern do
@@ -59,14 +59,13 @@ def test_unenroll_many
     response = @finch.hris.benefits.individuals.unenroll_many("benefit_id")
 
     assert_pattern do
-      response => FinchAPI::Internal::SinglePage
+      response => FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyResponse
     end
 
-    row = response.to_enum.first
-    return if row.nil?
-
     assert_pattern do
-      row => FinchAPI::Internal::Type::Unknown
+      response => {
+        job_id: String
+      }
     end
   end
 end