chore: refine Yard and Sorbet types and ensure linting is turned on for examples

Author: stainless-app[bot]

Rakefile

@@ -9,6 +9,7 @@ require "rake/clean"
 require "rubocop/rake_task"
 
 tapioca = "sorbet/tapioca"
+examples = "examples"
 ignore_file = ".ignore"
 
 CLEAN.push(*%w[.idea/ .ruby-lsp/ .yardoc/ doc/], *FileList["*.gem"], ignore_file)
@@ -39,7 +40,7 @@ locale = {"LC_ALL" => "C.UTF-8"}
 
 desc("Lint `*.rb(i)`")
 multitask(:"lint:rubocop") do
-  find = %w[find ./lib ./test ./rbi -type f -and ( -name *.rb -or -name *.rbi ) -print0]
+  find = %w[find ./lib ./test ./rbi ./examples -type f -and ( -name *.rb -or -name *.rbi ) -print0]
 
   rubocop = %w[rubocop]
   rubocop += %w[--format github] if ENV.key?("CI")
@@ -54,7 +55,7 @@ end
 desc("Format `*.rb`")
 multitask(:"format:rb") do
   # while `syntax_tree` is much faster than `rubocop`, `rubocop` is the only formatter with full syntax support
-  find = %w[find ./lib ./test -type f -and -name *.rb -print0]
+  find = %w[find ./lib ./test ./examples -type f -and -name *.rb -print0]
   fmt = xargs + %w[rubocop --fail-level F --autocorrect --format simple --]
   sh("#{find.shelljoin} | #{fmt.shelljoin}")
 end
@@ -117,12 +118,14 @@ multitask(:"typecheck:steep") do
   sh(*%w[steep check])
 end
 
+directory(examples)
+
 desc("Typecheck `*.rbi`")
-multitask(:"typecheck:sorbet") do
-  sh(*%w[srb typecheck])
+multitask("typecheck:sorbet": examples) do
+  sh(*%w[srb typecheck --dir], examples)
 end
 
-file(tapioca) do
+directory(tapioca) do
   sh(*%w[tapioca init])
 end
 

lib/lithic/internal.rb

@@ -13,5 +13,8 @@ module Internal
     define_sorbet_constant!(:AnyHash) do
       T.type_alias { T::Hash[Symbol, T.anything] }
     end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Lithic::FilePart) }
+    end
   end
 end

rbi/lithic/internal.rbi

@@ -8,6 +8,9 @@ module Lithic
     # this alias might be refined in the future.
     AnyHash = T.type_alias { T::Hash[Symbol, T.anything] }
 
+    FileInput =
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Lithic::FilePart) }
+
     OMIT = T.let(Object.new.freeze, T.anything)
   end
 end

rbi/lithic/models/auth_rules/velocity_limit_params.rbi

@@ -25,7 +25,12 @@ module Lithic
         # The size of the trailing window to calculate Spend Velocity over in seconds. The
         # minimum value is 10 seconds, and the maximum value is 2678400 seconds (31 days).
         sig do
-          returns(Lithic::AuthRules::VelocityLimitParams::Period::Variants)
+          returns(
+            T.any(
+              Integer,
+              Lithic::AuthRules::VelocityLimitParamsPeriodWindow::OrSymbol
+            )
+          )
         end
         attr_accessor :period
 
@@ -49,7 +54,11 @@ module Lithic
         sig do
           params(
             filters: Lithic::AuthRules::VelocityLimitParams::Filters::OrHash,
-            period: Lithic::AuthRules::VelocityLimitParams::Period::Variants,
+            period:
+              T.any(
+                Integer,
+                Lithic::AuthRules::VelocityLimitParamsPeriodWindow::OrSymbol
+              ),
             scope: Lithic::AuthRules::VelocityLimitParams::Scope::OrSymbol,
             limit_amount: T.nilable(Integer),
             limit_count: T.nilable(Integer)
@@ -78,7 +87,11 @@ module Lithic
           override.returns(
             {
               filters: Lithic::AuthRules::VelocityLimitParams::Filters,
-              period: Lithic::AuthRules::VelocityLimitParams::Period::Variants,
+              period:
+                T.any(
+                  Integer,
+                  Lithic::AuthRules::VelocityLimitParamsPeriodWindow::OrSymbol
+                ),
               scope: Lithic::AuthRules::VelocityLimitParams::Scope::OrSymbol,
               limit_amount: T.nilable(Integer),
               limit_count: T.nilable(Integer)

sig/lithic/internal.rbs

@@ -2,6 +2,8 @@ module Lithic
   module Internal
     extend Lithic::Internal::Util::SorbetRuntimeSupport
 
+    type file_input = Pathname | StringIO | IO | String | Lithic::FilePart
+
     OMIT: Object
   end
 end

sorbet/config

@@ -1,2 +1,2 @@
---dir=rbi
+--dir=rbi/
 --ignore=test/

test/lithic/internal/sorbet_runtime_support_test.rb

@@ -25,6 +25,7 @@ def test_nil_aliases
     err = Lithic::Internal::Util::SorbetRuntimeSupport::MissingSorbetRuntimeError
 
     assert_raises(err) { Lithic::Internal::AnyHash }
+    assert_raises(err) { Lithic::Internal::FileInput }
     assert_raises(err) { Lithic::Internal::Type::Converter::Input }
     assert_raises(err) { Lithic::Internal::Type::Converter::CoerceState }
     assert_raises(err) { Lithic::Internal::Type::Converter::DumpState }