orb-billing 0.11.0 → 0.12.0

data/lib/orb/models/trial_discount.rb

@@ -15,6 +15,12 @@ module Orb
       #   @return [Array<String>, nil]
       optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
 
+      # @!attribute filters
+      #   The filters that determine which prices to apply this discount to.
+      #
+      #   @return [Array<Orb::Models::TrialDiscount::Filter>, nil]
+      optional :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TrialDiscount::Filter] }, nil?: true
+
       # @!attribute reason
       #
       #   @return [String, nil]
@@ -32,7 +38,7 @@ module Orb
       #   @return [Float, nil]
       optional :trial_percentage_discount, Float, nil?: true
 
-      # @!method initialize(discount_type:, applies_to_price_ids: nil, reason: nil, trial_amount_discount: nil, trial_percentage_discount: nil)
+      # @!method initialize(discount_type:, applies_to_price_ids: nil, filters: nil, reason: nil, trial_amount_discount: nil, trial_percentage_discount: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::TrialDiscount} for more details.
       #
@@ -40,6 +46,8 @@ module Orb
       #
       #   @param applies_to_price_ids [Array<String>, nil] List of price_ids that this discount applies to. For plan/plan phase discounts,
       #
+      #   @param filters [Array<Orb::Models::TrialDiscount::Filter>, nil] The filters that determine which prices to apply this discount to.
+      #
       #   @param reason [String, nil]
       #
       #   @param trial_amount_discount [String, nil] Only available if discount_type is `trial`
@@ -55,6 +63,62 @@ module Orb
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      class Filter < Orb::Internal::Type::BaseModel
+        # @!attribute field
+        #   The property of the price to filter on.
+        #
+        #   @return [Symbol, Orb::Models::TrialDiscount::Filter::Field]
+        required :field, enum: -> { Orb::TrialDiscount::Filter::Field }
+
+        # @!attribute operator
+        #   Should prices that match the filter be included or excluded.
+        #
+        #   @return [Symbol, Orb::Models::TrialDiscount::Filter::Operator]
+        required :operator, enum: -> { Orb::TrialDiscount::Filter::Operator }
+
+        # @!attribute values
+        #   The IDs or values that match this filter.
+        #
+        #   @return [Array<String>]
+        required :values, Orb::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(field:, operator:, values:)
+        #   @param field [Symbol, Orb::Models::TrialDiscount::Filter::Field] The property of the price to filter on.
+        #
+        #   @param operator [Symbol, Orb::Models::TrialDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
+        #
+        #   @param values [Array<String>] The IDs or values that match this filter.
+
+        # The property of the price to filter on.
+        #
+        # @see Orb::Models::TrialDiscount::Filter#field
+        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
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Should prices that match the filter be included or excluded.
+        #
+        # @see Orb::Models::TrialDiscount::Filter#operator
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          INCLUDES = :includes
+          EXCLUDES = :excludes
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
     end
   end
 end

data/lib/orb/models/usage_discount.rb

@@ -22,12 +22,18 @@ module Orb
       #   @return [Array<String>, nil]
       optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
 
+      # @!attribute filters
+      #   The filters that determine which prices to apply this discount to.
+      #
+      #   @return [Array<Orb::Models::UsageDiscount::Filter>, nil]
+      optional :filters, -> { Orb::Internal::Type::ArrayOf[Orb::UsageDiscount::Filter] }, nil?: true
+
       # @!attribute reason
       #
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!method initialize(discount_type:, usage_discount:, applies_to_price_ids: nil, reason: nil)
+      # @!method initialize(discount_type:, usage_discount:, applies_to_price_ids: nil, filters: nil, reason: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::UsageDiscount} for more details.
       #
@@ -37,6 +43,8 @@ module Orb
       #
       #   @param applies_to_price_ids [Array<String>, nil] List of price_ids that this discount applies to. For plan/plan phase discounts,
       #
+      #   @param filters [Array<Orb::Models::UsageDiscount::Filter>, nil] The filters that determine which prices to apply this discount to.
+      #
       #   @param reason [String, nil]
 
       # @see Orb::Models::UsageDiscount#discount_type
@@ -48,6 +56,62 @@ module Orb
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      class Filter < Orb::Internal::Type::BaseModel
+        # @!attribute field
+        #   The property of the price to filter on.
+        #
+        #   @return [Symbol, Orb::Models::UsageDiscount::Filter::Field]
+        required :field, enum: -> { Orb::UsageDiscount::Filter::Field }
+
+        # @!attribute operator
+        #   Should prices that match the filter be included or excluded.
+        #
+        #   @return [Symbol, Orb::Models::UsageDiscount::Filter::Operator]
+        required :operator, enum: -> { Orb::UsageDiscount::Filter::Operator }
+
+        # @!attribute values
+        #   The IDs or values that match this filter.
+        #
+        #   @return [Array<String>]
+        required :values, Orb::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(field:, operator:, values:)
+        #   @param field [Symbol, Orb::Models::UsageDiscount::Filter::Field] The property of the price to filter on.
+        #
+        #   @param operator [Symbol, Orb::Models::UsageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
+        #
+        #   @param values [Array<String>] The IDs or values that match this filter.
+
+        # The property of the price to filter on.
+        #
+        # @see Orb::Models::UsageDiscount::Filter#field
+        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
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Should prices that match the filter be included or excluded.
+        #
+        # @see Orb::Models::UsageDiscount::Filter#operator
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          INCLUDES = :includes
+          EXCLUDES = :excludes
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
     end
   end
 end

data/lib/orb/resources/subscriptions.rb

@@ -987,18 +987,20 @@ module Orb
       #
       # Redeem a coupon effective at a given time.
       #
-      # @overload redeem_coupon(subscription_id, change_option:, coupon_id:, allow_invoice_credit_or_void: nil, change_date: nil, request_options: {})
+      # @overload redeem_coupon(subscription_id, change_option:, allow_invoice_credit_or_void: nil, change_date: nil, coupon_id: nil, coupon_redemption_code: nil, request_options: {})
       #
       # @param subscription_id [String]
       #
       # @param change_option [Symbol, Orb::Models::SubscriptionRedeemCouponParams::ChangeOption]
       #
-      # @param coupon_id [String] Coupon ID to be redeemed for this subscription.
-      #
       # @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a
       #
       # @param change_date [Time, nil] The date that the coupon discount should take effect. This parameter can only be
       #
+      # @param coupon_id [String, nil] Coupon ID to be redeemed for this subscription.
+      #
+      # @param coupon_redemption_code [String, nil] Redemption code of the coupon to be redeemed for this subscription.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::SubscriptionRedeemCouponResponse]

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

data/rbi/orb/internal/util.rbi

@@ -326,6 +326,8 @@ module Orb
         end
 
         # @api private
+        #
+        # https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#special-considerations-for-multipart-content
         sig do
           params(body: T.anything).returns([String, T::Enumerable[String]])
         end

data/rbi/orb/models/amount_discount.rbi

@@ -18,6 +18,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::AmountDiscount::Filter])) }
+      attr_accessor :filters
+
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
@@ -26,6 +30,7 @@ module Orb
           amount_discount: String,
           discount_type: Orb::AmountDiscount::DiscountType::OrSymbol,
           applies_to_price_ids: T.nilable(T::Array[String]),
+          filters: T.nilable(T::Array[Orb::AmountDiscount::Filter::OrHash]),
           reason: T.nilable(String)
         ).returns(T.attached_class)
       end
@@ -36,6 +41,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
@@ -46,6 +53,7 @@ module Orb
             amount_discount: String,
             discount_type: Orb::AmountDiscount::DiscountType::OrSymbol,
             applies_to_price_ids: T.nilable(T::Array[String]),
+            filters: T.nilable(T::Array[Orb::AmountDiscount::Filter]),
             reason: T.nilable(String)
           }
         )
@@ -70,6 +78,115 @@ module Orb
         def self.values
         end
       end
+
+      class Filter < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Orb::AmountDiscount::Filter, Orb::Internal::AnyHash)
+          end
+
+        # The property of the price to filter on.
+        sig { returns(Orb::AmountDiscount::Filter::Field::OrSymbol) }
+        attr_accessor :field
+
+        # Should prices that match the filter be included or excluded.
+        sig { returns(Orb::AmountDiscount::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::AmountDiscount::Filter::Field::OrSymbol,
+            operator: Orb::AmountDiscount::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::AmountDiscount::Filter::Field::OrSymbol,
+              operator: Orb::AmountDiscount::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::AmountDiscount::Filter::Field) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PRICE_ID =
+            T.let(:price_id, Orb::AmountDiscount::Filter::Field::TaggedSymbol)
+          ITEM_ID =
+            T.let(:item_id, Orb::AmountDiscount::Filter::Field::TaggedSymbol)
+          PRICE_TYPE =
+            T.let(:price_type, Orb::AmountDiscount::Filter::Field::TaggedSymbol)
+          CURRENCY =
+            T.let(:currency, Orb::AmountDiscount::Filter::Field::TaggedSymbol)
+          PRICING_UNIT_ID =
+            T.let(
+              :pricing_unit_id,
+              Orb::AmountDiscount::Filter::Field::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Orb::AmountDiscount::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 do
+              T.all(Symbol, Orb::AmountDiscount::Filter::Operator)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          INCLUDES =
+            T.let(
+              :includes,
+              Orb::AmountDiscount::Filter::Operator::TaggedSymbol
+            )
+          EXCLUDES =
+            T.let(
+              :excludes,
+              Orb::AmountDiscount::Filter::Operator::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Orb::AmountDiscount::Filter::Operator::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end