feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 118
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-947253d9be505473c1c2cb0193d2602fa6b017e221f482be3f4f374c6156b350.yml
-openapi_spec_hash: 1b40d1a85b4b846a1c14634fbbc65da3
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-4ad3b44ca7f484243d8706b6aa7f4498fc5bf2b37fadf3da0a06d657e482c08f.yml
+openapi_spec_hash: 9ead1a2aae36be1086c627c3636064ea
 config_hash: e6db17547fe854b1c240407cf4c6dc9e

lib/orb/models/plan.rb

@@ -16,6 +16,18 @@ class Plan < Orb::Internal::Type::BaseModel
       #   @return [Array<Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment>]
       required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Plan::Adjustment] }
 
+      # @!attribute base_plan
+      #
+      #   @return [Orb::Models::Plan::BasePlan, nil]
+      required :base_plan, -> { Orb::Plan::BasePlan }, nil?: true
+
+      # @!attribute base_plan_id
+      #   The parent plan id if the given plan was created by overriding one or more of
+      #   the parent's prices
+      #
+      #   @return [String, nil]
+      required :base_plan_id, String, nil?: true
+
       # @!attribute created_at
       #
       #   @return [Time]
@@ -143,19 +155,7 @@ class Plan < Orb::Internal::Type::BaseModel
       #   @return [Integer]
       required :version, Integer
 
-      # @!attribute base_plan
-      #
-      #   @return [Orb::Models::Plan::BasePlan, nil]
-      optional :base_plan, -> { Orb::Plan::BasePlan }, nil?: true
-
-      # @!attribute base_plan_id
-      #   The parent plan id if the given plan was created by overriding one or more of
-      #   the parent's prices
-      #
-      #   @return [String, nil]
-      optional :base_plan_id, String, nil?: true
-
-      # @!method initialize(id:, adjustments:, created_at:, currency:, default_invoice_memo:, description:, discount:, external_plan_id:, invoicing_currency:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, net_terms:, plan_phases:, prices:, product:, status:, trial_config:, version:, base_plan: nil, base_plan_id: nil)
+      # @!method initialize(id:, adjustments:, base_plan:, base_plan_id:, created_at:, currency:, default_invoice_memo:, description:, discount:, external_plan_id:, invoicing_currency:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, net_terms:, plan_phases:, prices:, product:, status:, trial_config:, version:)
       #   Some parameter documentations has been truncated, see {Orb::Models::Plan} for
       #   more details.
       #
@@ -168,6 +168,10 @@ class Plan < Orb::Internal::Type::BaseModel
       #
       #   @param adjustments [Array<Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
       #
+      #   @param base_plan [Orb::Models::Plan::BasePlan, nil]
+      #
+      #   @param base_plan_id [String, nil] The parent plan id if the given plan was created by overriding one or more of th
+      #
       #   @param created_at [Time]
       #
       #   @param currency [String] An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's p
@@ -207,10 +211,6 @@ class Plan < Orb::Internal::Type::BaseModel
       #   @param trial_config [Orb::Models::Plan::TrialConfig]
       #
       #   @param version [Integer]
-      #
-      #   @param base_plan [Orb::Models::Plan::BasePlan, nil]
-      #
-      #   @param base_plan_id [String, nil] The parent plan id if the given plan was created by overriding one or more of th
 
       module Adjustment
         extend Orb::Internal::Type::Union
@@ -231,6 +231,37 @@ module Adjustment
         #   @return [Array(Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment)]
       end
 
+      # @see Orb::Models::Plan#base_plan
+      class BasePlan < Orb::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        required :id, String, nil?: true
+
+        # @!attribute external_plan_id
+        #   An optional user-defined ID for this plan resource, used throughout the system
+        #   as an alias for this Plan. Use this field to identify a plan by an existing
+        #   identifier in your system.
+        #
+        #   @return [String, nil]
+        required :external_plan_id, String, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!method initialize(id:, external_plan_id:, name:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Plan::BasePlan} for more details.
+        #
+        #   @param id [String, nil]
+        #
+        #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
+        #
+        #   @param name [String, nil]
+      end
+
       class PlanPhase < Orb::Internal::Type::BaseModel
         # @!attribute id
         #
@@ -392,37 +423,6 @@ module TrialPeriodUnit
           #   @return [Array<Symbol>]
         end
       end
-
-      # @see Orb::Models::Plan#base_plan
-      class BasePlan < Orb::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String, nil]
-        required :id, String, nil?: true
-
-        # @!attribute external_plan_id
-        #   An optional user-defined ID for this plan resource, used throughout the system
-        #   as an alias for this Plan. Use this field to identify a plan by an existing
-        #   identifier in your system.
-        #
-        #   @return [String, nil]
-        required :external_plan_id, String, nil?: true
-
-        # @!attribute name
-        #
-        #   @return [String, nil]
-        required :name, String, nil?: true
-
-        # @!method initialize(id:, external_plan_id:, name:)
-        #   Some parameter documentations has been truncated, see
-        #   {Orb::Models::Plan::BasePlan} for more details.
-        #
-        #   @param id [String, nil]
-        #
-        #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
-        #
-        #   @param name [String, nil]
-      end
     end
   end
 end

rbi/orb/models/plan.rbi

@@ -13,6 +13,17 @@ module Orb
       sig { returns(T::Array[Orb::Plan::Adjustment::Variants]) }
       attr_accessor :adjustments
 
+      sig { returns(T.nilable(Orb::Plan::BasePlan)) }
+      attr_reader :base_plan
+
+      sig { params(base_plan: T.nilable(Orb::Plan::BasePlan::OrHash)).void }
+      attr_writer :base_plan
+
+      # The parent plan id if the given plan was created by overriding one or more of
+      # the parent's prices
+      sig { returns(T.nilable(String)) }
+      attr_accessor :base_plan_id
+
       sig { returns(Time) }
       attr_accessor :created_at
 
@@ -105,17 +116,6 @@ module Orb
       sig { returns(Integer) }
       attr_accessor :version
 
-      sig { returns(T.nilable(Orb::Plan::BasePlan)) }
-      attr_reader :base_plan
-
-      sig { params(base_plan: T.nilable(Orb::Plan::BasePlan::OrHash)).void }
-      attr_writer :base_plan
-
-      # The parent plan id if the given plan was created by overriding one or more of
-      # the parent's prices
-      sig { returns(T.nilable(String)) }
-      attr_accessor :base_plan_id
-
       # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
       # subscribed to by a customer. Plans define the billing behavior of the
       # subscription. You can see more about how to configure prices in the
@@ -133,6 +133,8 @@ module Orb
                 Orb::PlanPhaseMaximumAdjustment::OrHash
               )
             ],
+          base_plan: T.nilable(Orb::Plan::BasePlan::OrHash),
+          base_plan_id: T.nilable(String),
           created_at: Time,
           currency: String,
           default_invoice_memo: T.nilable(String),
@@ -195,16 +197,18 @@ module Orb
           product: Orb::Plan::Product::OrHash,
           status: Orb::Plan::Status::OrSymbol,
           trial_config: Orb::Plan::TrialConfig::OrHash,
-          version: Integer,
-          base_plan: T.nilable(Orb::Plan::BasePlan::OrHash),
-          base_plan_id: T.nilable(String)
+          version: Integer
         ).returns(T.attached_class)
       end
       def self.new(
         id:,
         # Adjustments for this plan. If the plan has phases, this includes adjustments
         # across all phases of the plan.
         adjustments:,
+        base_plan:,
+        # The parent plan id if the given plan was created by overriding one or more of
+        # the parent's prices
+        base_plan_id:,
         created_at:,
         # An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's
         # prices.
@@ -244,11 +248,7 @@ module Orb
         product:,
         status:,
         trial_config:,
-        version:,
-        base_plan: nil,
-        # The parent plan id if the given plan was created by overriding one or more of
-        # the parent's prices
-        base_plan_id: nil
+        version:
       )
       end
 
@@ -257,6 +257,8 @@ module Orb
           {
             id: String,
             adjustments: T::Array[Orb::Plan::Adjustment::Variants],
+            base_plan: T.nilable(Orb::Plan::BasePlan),
+            base_plan_id: T.nilable(String),
             created_at: Time,
             currency: String,
             default_invoice_memo: T.nilable(String),
@@ -276,9 +278,7 @@ module Orb
             product: Orb::Plan::Product,
             status: Orb::Plan::Status::TaggedSymbol,
             trial_config: Orb::Plan::TrialConfig,
-            version: Integer,
-            base_plan: T.nilable(Orb::Plan::BasePlan),
-            base_plan_id: T.nilable(String)
+            version: Integer
           }
         )
       end
@@ -304,6 +304,52 @@ module Orb
         end
       end
 
+      class BasePlan < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias { T.any(Orb::Plan::BasePlan, Orb::Internal::AnyHash) }
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :id
+
+        # An optional user-defined ID for this plan resource, used throughout the system
+        # as an alias for this Plan. Use this field to identify a plan by an existing
+        # identifier in your system.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_plan_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        sig do
+          params(
+            id: T.nilable(String),
+            external_plan_id: T.nilable(String),
+            name: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # An optional user-defined ID for this plan resource, used throughout the system
+          # as an alias for this Plan. Use this field to identify a plan by an existing
+          # identifier in your system.
+          external_plan_id:,
+          name:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: T.nilable(String),
+              external_plan_id: T.nilable(String),
+              name: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
       class PlanPhase < Orb::Internal::Type::BaseModel
         OrHash =
           T.type_alias { T.any(Orb::Plan::PlanPhase, Orb::Internal::AnyHash) }
@@ -539,52 +585,6 @@ module Orb
           end
         end
       end
-
-      class BasePlan < Orb::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias { T.any(Orb::Plan::BasePlan, Orb::Internal::AnyHash) }
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :id
-
-        # An optional user-defined ID for this plan resource, used throughout the system
-        # as an alias for this Plan. Use this field to identify a plan by an existing
-        # identifier in your system.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :external_plan_id
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :name
-
-        sig do
-          params(
-            id: T.nilable(String),
-            external_plan_id: T.nilable(String),
-            name: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          id:,
-          # An optional user-defined ID for this plan resource, used throughout the system
-          # as an alias for this Plan. Use this field to identify a plan by an existing
-          # identifier in your system.
-          external_plan_id:,
-          name:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: T.nilable(String),
-              external_plan_id: T.nilable(String),
-              name: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end