feat!: bump min supported ruby version to 3.1 (oldest non-EOL) (#105)

Author: stainless-app[bot]

README.md

@@ -1,6 +1,6 @@
 # Finch Ruby API library
 
-The Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.0.0+ application.
+The Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.1.0+ application.
 
 It is generated with [Stainless](https://www.stainless.com/).
 
@@ -158,4 +158,4 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ
 
 ## Requirements
 
-Ruby 3.0.0 or higher.
+Ruby 3.1.0 or higher.

lib/finch_api/internal/individuals_page.rb

@@ -11,18 +11,6 @@ module Internal
     #   individuals_page.auto_paging_each do |directory|
     #     puts(directory)
     #   end
-    #
-    # @example
-    #   directories =
-    #     individuals_page
-    #     .to_enum
-    #     .lazy
-    #     .select { _1.object_id.even? }
-    #     .map(&:itself)
-    #     .take(2)
-    #     .to_a
-    #
-    #   directories => Array
     class IndividualsPage
       include FinchAPI::Internal::Type::BasePage
 

lib/finch_api/internal/page.rb

@@ -11,18 +11,6 @@ module Internal
     #   page.auto_paging_each do |item|
     #     puts(item)
     #   end
-    #
-    # @example
-    #   items =
-    #     page
-    #     .to_enum
-    #     .lazy
-    #     .select { _1.object_id.even? }
-    #     .map(&:itself)
-    #     .take(2)
-    #     .to_a
-    #
-    #   items => Array
     class Page
       include FinchAPI::Internal::Type::BasePage
 

lib/finch_api/internal/responses_page.rb

@@ -11,18 +11,6 @@ module Internal
     #   responses_page.auto_paging_each do |individual|
     #     puts(individual)
     #   end
-    #
-    # @example
-    #   individuals =
-    #     responses_page
-    #     .to_enum
-    #     .lazy
-    #     .select { _1.object_id.even? }
-    #     .map(&:itself)
-    #     .take(2)
-    #     .to_a
-    #
-    #   individuals => Array
     class ResponsesPage
       include FinchAPI::Internal::Type::BasePage
 

lib/finch_api/internal/single_page.rb

@@ -11,18 +11,6 @@ module Internal
     #   single_page.auto_paging_each do |payment|
     #     puts(payment)
     #   end
-    #
-    # @example
-    #   payments =
-    #     single_page
-    #     .to_enum
-    #     .lazy
-    #     .select { _1.object_id.even? }
-    #     .map(&:itself)
-    #     .take(2)
-    #     .to_a
-    #
-    #   payments => Array
     class SinglePage < ::Array
       include FinchAPI::Internal::Type::BasePage
 

lib/finch_api/internal/type/base_page.rb

@@ -3,27 +3,7 @@
 module FinchAPI
   module Internal
     module Type
-      # @example
-      #   if page.has_next?
-      #     page = page.next_page
-      #   end
-      #
-      # @example
-      #   page.auto_paging_each do |access_token|
-      #     puts(access_token)
-      #   end
-      #
-      # @example
-      #   access_tokens =
-      #     page
-      #     .to_enum
-      #     .lazy
-      #     .select { _1.object_id.even? }
-      #     .map(&:itself)
-      #     .take(2)
-      #     .to_a
-      #
-      #   access_tokens => Array
+      # This module provides a base implementation for paginated responses in the SDK.
       module BasePage
         # rubocop:disable Lint/UnusedMethodArgument
 

rbi/lib/finch_api/internal.rbi

@@ -6,5 +6,7 @@ module FinchAPI
     # Due to the current WIP status of Shapes support in Sorbet, types referencing
     #   this alias might be refined in the future.
     AnyHash = T.type_alias { T::Hash[Symbol, T.anything] }
+
+    OMIT = T.let(T.anything, T.anything)
   end
 end

rbi/lib/finch_api/internal/type/base_page.rbi

@@ -3,6 +3,7 @@
 module FinchAPI
   module Internal
     module Type
+      # This module provides a base implementation for paginated responses in the SDK.
       module BasePage
         Elem = type_member(:out)
 

sig/finch_api/internal.rbs

@@ -1,4 +1,5 @@
 module FinchAPI
   module Internal
+    OMIT: top
   end
 end