orb-billing 0.10.0 → 0.12.0

data/rbi/orb/models/trial_discount.rbi

@@ -14,6 +14,10 @@ module Orb
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :applies_to_price_ids
 
+      # The filters that determine which prices to apply this discount to.
+      sig { returns(T.nilable(T::Array[Orb::TrialDiscount::Filter])) }
+      attr_accessor :filters
+
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
@@ -29,6 +33,7 @@ module Orb
         params(
           discount_type: Orb::TrialDiscount::DiscountType::OrSymbol,
           applies_to_price_ids: T.nilable(T::Array[String]),
+          filters: T.nilable(T::Array[Orb::TrialDiscount::Filter::OrHash]),
           reason: T.nilable(String),
           trial_amount_discount: T.nilable(String),
           trial_percentage_discount: T.nilable(Float)
@@ -39,6 +44,8 @@ module Orb
         # List of price_ids that this discount applies to. For plan/plan phase discounts,
         # this can be a subset of prices.
         applies_to_price_ids: nil,
+        # The filters that determine which prices to apply this discount to.
+        filters: nil,
         reason: nil,
         # Only available if discount_type is `trial`
         trial_amount_discount: nil,
@@ -52,6 +59,7 @@ module Orb
           {
             discount_type: Orb::TrialDiscount::DiscountType::OrSymbol,
             applies_to_price_ids: T.nilable(T::Array[String]),
+            filters: T.nilable(T::Array[Orb::TrialDiscount::Filter]),
             reason: T.nilable(String),
             trial_amount_discount: T.nilable(String),
             trial_percentage_discount: T.nilable(Float)
@@ -78,6 +86,107 @@ module Orb
         def self.values
         end
       end
+
+      class Filter < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Orb::TrialDiscount::Filter, Orb::Internal::AnyHash)
+          end
+
+        # The property of the price to filter on.
+        sig { returns(Orb::TrialDiscount::Filter::Field::OrSymbol) }
+        attr_accessor :field
+
+        # Should prices that match the filter be included or excluded.
+        sig { returns(Orb::TrialDiscount::Filter::Operator::OrSymbol) }
+        attr_accessor :operator
+
+        # The IDs or values that match this filter.
+        sig { returns(T::Array[String]) }
+        attr_accessor :values
+
+        sig do
+          params(
+            field: Orb::TrialDiscount::Filter::Field::OrSymbol,
+            operator: Orb::TrialDiscount::Filter::Operator::OrSymbol,
+            values: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The property of the price to filter on.
+          field:,
+          # Should prices that match the filter be included or excluded.
+          operator:,
+          # The IDs or values that match this filter.
+          values:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              field: Orb::TrialDiscount::Filter::Field::OrSymbol,
+              operator: Orb::TrialDiscount::Filter::Operator::OrSymbol,
+              values: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The property of the price to filter on.
+        module Field
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Orb::TrialDiscount::Filter::Field) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PRICE_ID =
+            T.let(:price_id, Orb::TrialDiscount::Filter::Field::TaggedSymbol)
+          ITEM_ID =
+            T.let(:item_id, Orb::TrialDiscount::Filter::Field::TaggedSymbol)
+          PRICE_TYPE =
+            T.let(:price_type, Orb::TrialDiscount::Filter::Field::TaggedSymbol)
+          CURRENCY =
+            T.let(:currency, Orb::TrialDiscount::Filter::Field::TaggedSymbol)
+          PRICING_UNIT_ID =
+            T.let(
+              :pricing_unit_id,
+              Orb::TrialDiscount::Filter::Field::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Orb::TrialDiscount::Filter::Field::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Should prices that match the filter be included or excluded.
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Orb::TrialDiscount::Filter::Operator) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          INCLUDES =
+            T.let(:includes, Orb::TrialDiscount::Filter::Operator::TaggedSymbol)
+          EXCLUDES =
+            T.let(:excludes, Orb::TrialDiscount::Filter::Operator::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Orb::TrialDiscount::Filter::Operator::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

data/rbi/orb/models/usage_discount.rbi

@@ -19,6 +19,10 @@ module Orb
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :applies_to_price_ids
 
+      # The filters that determine which prices to apply this discount to.
+      sig { returns(T.nilable(T::Array[Orb::UsageDiscount::Filter])) }
+      attr_accessor :filters
+
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
@@ -27,6 +31,7 @@ module Orb
           discount_type: Orb::UsageDiscount::DiscountType::OrSymbol,
           usage_discount: Float,
           applies_to_price_ids: T.nilable(T::Array[String]),
+          filters: T.nilable(T::Array[Orb::UsageDiscount::Filter::OrHash]),
           reason: T.nilable(String)
         ).returns(T.attached_class)
       end
@@ -38,6 +43,8 @@ module Orb
         # List of price_ids that this discount applies to. For plan/plan phase discounts,
         # this can be a subset of prices.
         applies_to_price_ids: nil,
+        # The filters that determine which prices to apply this discount to.
+        filters: nil,
         reason: nil
       )
       end
@@ -48,6 +55,7 @@ module Orb
             discount_type: Orb::UsageDiscount::DiscountType::OrSymbol,
             usage_discount: Float,
             applies_to_price_ids: T.nilable(T::Array[String]),
+            filters: T.nilable(T::Array[Orb::UsageDiscount::Filter]),
             reason: T.nilable(String)
           }
         )
@@ -72,6 +80,107 @@ module Orb
         def self.values
         end
       end
+
+      class Filter < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Orb::UsageDiscount::Filter, Orb::Internal::AnyHash)
+          end
+
+        # The property of the price to filter on.
+        sig { returns(Orb::UsageDiscount::Filter::Field::OrSymbol) }
+        attr_accessor :field
+
+        # Should prices that match the filter be included or excluded.
+        sig { returns(Orb::UsageDiscount::Filter::Operator::OrSymbol) }
+        attr_accessor :operator
+
+        # The IDs or values that match this filter.
+        sig { returns(T::Array[String]) }
+        attr_accessor :values
+
+        sig do
+          params(
+            field: Orb::UsageDiscount::Filter::Field::OrSymbol,
+            operator: Orb::UsageDiscount::Filter::Operator::OrSymbol,
+            values: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The property of the price to filter on.
+          field:,
+          # Should prices that match the filter be included or excluded.
+          operator:,
+          # The IDs or values that match this filter.
+          values:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              field: Orb::UsageDiscount::Filter::Field::OrSymbol,
+              operator: Orb::UsageDiscount::Filter::Operator::OrSymbol,
+              values: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The property of the price to filter on.
+        module Field
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Orb::UsageDiscount::Filter::Field) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PRICE_ID =
+            T.let(:price_id, Orb::UsageDiscount::Filter::Field::TaggedSymbol)
+          ITEM_ID =
+            T.let(:item_id, Orb::UsageDiscount::Filter::Field::TaggedSymbol)
+          PRICE_TYPE =
+            T.let(:price_type, Orb::UsageDiscount::Filter::Field::TaggedSymbol)
+          CURRENCY =
+            T.let(:currency, Orb::UsageDiscount::Filter::Field::TaggedSymbol)
+          PRICING_UNIT_ID =
+            T.let(
+              :pricing_unit_id,
+              Orb::UsageDiscount::Filter::Field::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Orb::UsageDiscount::Filter::Field::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Should prices that match the filter be included or excluded.
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Orb::UsageDiscount::Filter::Operator) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          INCLUDES =
+            T.let(:includes, Orb::UsageDiscount::Filter::Operator::TaggedSymbol)
+          EXCLUDES =
+            T.let(:excludes, Orb::UsageDiscount::Filter::Operator::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Orb::UsageDiscount::Filter::Operator::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

data/rbi/orb/resources/subscriptions.rbi

@@ -1013,17 +1013,16 @@ module Orb
           subscription_id: String,
           change_option:
             Orb::SubscriptionRedeemCouponParams::ChangeOption::OrSymbol,
-          coupon_id: String,
           allow_invoice_credit_or_void: T.nilable(T::Boolean),
           change_date: T.nilable(Time),
+          coupon_id: T.nilable(String),
+          coupon_redemption_code: T.nilable(String),
           request_options: Orb::RequestOptions::OrHash
         ).returns(Orb::Models::SubscriptionRedeemCouponResponse)
       end
       def redeem_coupon(
         subscription_id,
         change_option:,
-        # Coupon ID to be redeemed for this subscription.
-        coupon_id:,
         # If false, this request will fail if it would void an issued invoice or create a
         # credit note. Consider using this as a safety mechanism if you do not expect
         # existing invoices to be changed.
@@ -1031,6 +1030,10 @@ module Orb
         # The date that the coupon discount should take effect. This parameter can only be
         # passed if the `change_option` is `requested_date`.
         change_date: nil,
+        # Coupon ID to be redeemed for this subscription.
+        coupon_id: nil,
+        # Redemption code of the coupon to be redeemed for this subscription.
+        coupon_redemption_code: nil,
         request_options: {}
       )
       end
@@ -1436,7 +1439,7 @@ module Orb
       end
 
       # This endpoint can be used to unschedule any pending plan changes on an existing
-      # subscription.
+      # subscription. When called, all upcoming plan changes will be unscheduled.
       sig do
         params(
           subscription_id: String,

data/sig/orb/models/amount_discount.rbs

@@ -5,6 +5,7 @@ module Orb
         amount_discount: String,
         discount_type: Orb::Models::AmountDiscount::discount_type,
         applies_to_price_ids: ::Array[String]?,
+        filters: ::Array[Orb::AmountDiscount::Filter]?,
         reason: String?
       }
 
@@ -15,12 +16,15 @@ module Orb
 
       attr_accessor applies_to_price_ids: ::Array[String]?
 
+      attr_accessor filters: ::Array[Orb::AmountDiscount::Filter]?
+
       attr_accessor reason: String?
 
       def initialize: (
         amount_discount: String,
         discount_type: Orb::Models::AmountDiscount::discount_type,
         ?applies_to_price_ids: ::Array[String]?,
+        ?filters: ::Array[Orb::AmountDiscount::Filter]?,
         ?reason: String?
       ) -> void
 
@@ -28,6 +32,7 @@ module Orb
         amount_discount: String,
         discount_type: Orb::Models::AmountDiscount::discount_type,
         applies_to_price_ids: ::Array[String]?,
+        filters: ::Array[Orb::AmountDiscount::Filter]?,
         reason: String?
       }
 
@@ -40,6 +45,59 @@ module Orb
 
         def self?.values: -> ::Array[Orb::Models::AmountDiscount::discount_type]
       end
+
+      type filter =
+        {
+          field: Orb::Models::AmountDiscount::Filter::field,
+          operator: Orb::Models::AmountDiscount::Filter::operator,
+          values: ::Array[String]
+        }
+
+      class Filter < Orb::Internal::Type::BaseModel
+        attr_accessor field: Orb::Models::AmountDiscount::Filter::field
+
+        attr_accessor operator: Orb::Models::AmountDiscount::Filter::operator
+
+        attr_accessor values: ::Array[String]
+
+        def initialize: (
+          field: Orb::Models::AmountDiscount::Filter::field,
+          operator: Orb::Models::AmountDiscount::Filter::operator,
+          values: ::Array[String]
+        ) -> void
+
+        def to_hash: -> {
+          field: Orb::Models::AmountDiscount::Filter::field,
+          operator: Orb::Models::AmountDiscount::Filter::operator,
+          values: ::Array[String]
+        }
+
+        type field =
+          :price_id | :item_id | :price_type | :currency | :pricing_unit_id
+
+        module Field
+          extend Orb::Internal::Type::Enum
+
+          PRICE_ID: :price_id
+          ITEM_ID: :item_id
+          PRICE_TYPE: :price_type
+          CURRENCY: :currency
+          PRICING_UNIT_ID: :pricing_unit_id
+
+          def self?.values: -> ::Array[Orb::Models::AmountDiscount::Filter::field]
+        end
+
+        type operator = :includes | :excludes
+
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          INCLUDES: :includes
+          EXCLUDES: :excludes
+
+          def self?.values: -> ::Array[Orb::Models::AmountDiscount::Filter::operator]
+        end
+      end
     end
   end
 end