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/orb/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, Orb::FilePart) }
+    end
   end
 end

rbi/orb/internal.rbi

@@ -8,6 +8,9 @@ module Orb
     # 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, Orb::FilePart) }
+
     OMIT = T.let(Object.new.freeze, T.anything)
   end
 end

rbi/orb/models/subscription_price_intervals_params.rbi

@@ -146,11 +146,7 @@ module Orb
 
         # The start date of the price interval. This is the date that the price will start
         # billing on the subscription.
-        sig do
-          returns(
-            Orb::SubscriptionPriceIntervalsParams::Add::StartDate::Variants
-          )
-        end
+        sig { returns(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)) }
         attr_accessor :start_date
 
         # The definition of a new allocation price to create and add to the subscription.
@@ -193,9 +189,7 @@ module Orb
         # billing on the subscription.
         sig do
           returns(
-            T.nilable(
-              Orb::SubscriptionPriceIntervalsParams::Add::EndDate::Variants
-            )
+            T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
           )
         end
         attr_accessor :end_date
@@ -287,8 +281,7 @@ module Orb
 
         sig do
           params(
-            start_date:
-              Orb::SubscriptionPriceIntervalsParams::Add::StartDate::Variants,
+            start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol),
             allocation_price:
               T.nilable(
                 Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::OrHash
@@ -304,9 +297,7 @@ module Orb
                 ]
               ),
             end_date:
-              T.nilable(
-                Orb::SubscriptionPriceIntervalsParams::Add::EndDate::Variants
-              ),
+              T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)),
             external_price_id: T.nilable(String),
             filter: T.nilable(String),
             fixed_fee_quantity_transitions:
@@ -397,8 +388,7 @@ module Orb
         sig do
           override.returns(
             {
-              start_date:
-                Orb::SubscriptionPriceIntervalsParams::Add::StartDate::Variants,
+              start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol),
               allocation_price:
                 T.nilable(
                   Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice
@@ -414,9 +404,7 @@ module Orb
                   ]
                 ),
               end_date:
-                T.nilable(
-                  Orb::SubscriptionPriceIntervalsParams::Add::EndDate::Variants
-                ),
+                T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)),
               external_price_id: T.nilable(String),
               filter: T.nilable(String),
               fixed_fee_quantity_transitions:
@@ -13896,11 +13884,7 @@ module Orb
         # will start affecting prices on the subscription. The adjustment will apply to
         # invoice dates that overlap with this `start_date`. This `start_date` is treated
         # as inclusive for in-advance prices, and exclusive for in-arrears prices.
-        sig do
-          returns(
-            Orb::SubscriptionPriceIntervalsParams::AddAdjustment::StartDate::Variants
-          )
-        end
+        sig { returns(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)) }
         attr_accessor :start_date
 
         # The end date of the adjustment interval. This is the date that the adjustment
@@ -13909,9 +13893,7 @@ module Orb
         # exclusive for in-advance prices, and inclusive for in-arrears prices.
         sig do
           returns(
-            T.nilable(
-              Orb::SubscriptionPriceIntervalsParams::AddAdjustment::EndDate::Variants
-            )
+            T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
           )
         end
         attr_accessor :end_date
@@ -13926,12 +13908,9 @@ module Orb
                 Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum::OrHash,
                 Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum::OrHash
               ),
-            start_date:
-              Orb::SubscriptionPriceIntervalsParams::AddAdjustment::StartDate::Variants,
+            start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol),
             end_date:
-              T.nilable(
-                Orb::SubscriptionPriceIntervalsParams::AddAdjustment::EndDate::Variants
-              )
+              T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
           ).returns(T.attached_class)
         end
         def self.new(
@@ -13961,12 +13940,9 @@ module Orb
                   Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum,
                   Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum
                 ),
-              start_date:
-                Orb::SubscriptionPriceIntervalsParams::AddAdjustment::StartDate::Variants,
+              start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol),
               end_date:
-                T.nilable(
-                  Orb::SubscriptionPriceIntervalsParams::AddAdjustment::EndDate::Variants
-                )
+                T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
             }
           )
         end
@@ -14377,9 +14353,7 @@ module Orb
         # will not be updated.
         sig do
           returns(
-            T.nilable(
-              Orb::SubscriptionPriceIntervalsParams::Edit::EndDate::Variants
-            )
+            T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
           )
         end
         attr_accessor :end_date
@@ -14409,17 +14383,14 @@ module Orb
         # will not be updated.
         sig do
           returns(
-            T.nilable(
-              Orb::SubscriptionPriceIntervalsParams::Edit::StartDate::Variants
-            )
+            T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
           )
         end
         attr_reader :start_date
 
         sig do
           params(
-            start_date:
-              Orb::SubscriptionPriceIntervalsParams::Edit::StartDate::Variants
+            start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)
           ).void
         end
         attr_writer :start_date
@@ -14438,18 +14409,15 @@ module Orb
             price_interval_id: String,
             billing_cycle_day: T.nilable(Integer),
             end_date:
-              T.nilable(
-                Orb::SubscriptionPriceIntervalsParams::Edit::EndDate::Variants
-              ),
+              T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)),
             filter: T.nilable(String),
             fixed_fee_quantity_transitions:
               T.nilable(
                 T::Array[
                   Orb::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition::OrHash
                 ]
               ),
-            start_date:
-              Orb::SubscriptionPriceIntervalsParams::Edit::StartDate::Variants,
+            start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol),
             usage_customer_ids: T.nilable(T::Array[String])
           ).returns(T.attached_class)
         end
@@ -14491,18 +14459,15 @@ module Orb
               price_interval_id: String,
               billing_cycle_day: T.nilable(Integer),
               end_date:
-                T.nilable(
-                  Orb::SubscriptionPriceIntervalsParams::Edit::EndDate::Variants
-                ),
+                T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)),
               filter: T.nilable(String),
               fixed_fee_quantity_transitions:
                 T.nilable(
                   T::Array[
                     Orb::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition
                   ]
                 ),
-              start_date:
-                Orb::SubscriptionPriceIntervalsParams::Edit::StartDate::Variants,
+              start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol),
               usage_customer_ids: T.nilable(T::Array[String])
             }
           )
@@ -14605,9 +14570,7 @@ module Orb
         # date will not be updated.
         sig do
           returns(
-            T.nilable(
-              Orb::SubscriptionPriceIntervalsParams::EditAdjustment::EndDate::Variants
-            )
+            T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
           )
         end
         attr_accessor :end_date
@@ -14616,17 +14579,14 @@ module Orb
         # date will not be updated.
         sig do
           returns(
-            T.nilable(
-              Orb::SubscriptionPriceIntervalsParams::EditAdjustment::StartDate::Variants
-            )
+            T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
           )
         end
         attr_reader :start_date
 
         sig do
           params(
-            start_date:
-              Orb::SubscriptionPriceIntervalsParams::EditAdjustment::StartDate::Variants
+            start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)
           ).void
         end
         attr_writer :start_date
@@ -14635,11 +14595,8 @@ module Orb
           params(
             adjustment_interval_id: String,
             end_date:
-              T.nilable(
-                Orb::SubscriptionPriceIntervalsParams::EditAdjustment::EndDate::Variants
-              ),
-            start_date:
-              Orb::SubscriptionPriceIntervalsParams::EditAdjustment::StartDate::Variants
+              T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)),
+            start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -14659,11 +14616,8 @@ module Orb
             {
               adjustment_interval_id: String,
               end_date:
-                T.nilable(
-                  Orb::SubscriptionPriceIntervalsParams::EditAdjustment::EndDate::Variants
-                ),
-              start_date:
-                Orb::SubscriptionPriceIntervalsParams::EditAdjustment::StartDate::Variants
+                T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)),
+              start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)
             }
           )
         end

rbi/orb/models/subscription_update_trial_params.rbi

@@ -14,7 +14,12 @@ module Orb
       # The new date that the trial should end, or the literal string `immediate` to end
       # the trial immediately.
       sig do
-        returns(Orb::SubscriptionUpdateTrialParams::TrialEndDate::Variants)
+        returns(
+          T.any(
+            Time,
+            Orb::SubscriptionUpdateTrialParams::TrialEndDate::OrSymbol
+          )
+        )
       end
       attr_accessor :trial_end_date
 
@@ -29,7 +34,10 @@ module Orb
       sig do
         params(
           trial_end_date:
-            Orb::SubscriptionUpdateTrialParams::TrialEndDate::Variants,
+            T.any(
+              Time,
+              Orb::SubscriptionUpdateTrialParams::TrialEndDate::OrSymbol
+            ),
           shift: T::Boolean,
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -49,7 +57,10 @@ module Orb
         override.returns(
           {
             trial_end_date:
-              Orb::SubscriptionUpdateTrialParams::TrialEndDate::Variants,
+              T.any(
+                Time,
+                Orb::SubscriptionUpdateTrialParams::TrialEndDate::OrSymbol
+              ),
             shift: T::Boolean,
             request_options: Orb::RequestOptions
           }

rbi/orb/resources/subscriptions.rbi

@@ -1479,7 +1479,10 @@ module Orb
         params(
           subscription_id: String,
           trial_end_date:
-            Orb::SubscriptionUpdateTrialParams::TrialEndDate::Variants,
+            T.any(
+              Time,
+              Orb::SubscriptionUpdateTrialParams::TrialEndDate::OrSymbol
+            ),
           shift: T::Boolean,
           request_options: Orb::RequestOptions::OrHash
         ).returns(Orb::Models::SubscriptionUpdateTrialResponse)

sig/orb/internal.rbs

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

sorbet/config

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

test/orb/internal/sorbet_runtime_support_test.rb

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