orb-billing 0.9.1 → 0.11.0

data/lib/orb/models.rb

@@ -244,6 +244,8 @@ module Orb
 
   SubscriptionPriceIntervalsParams = Orb::Models::SubscriptionPriceIntervalsParams
 
+  SubscriptionRedeemCouponParams = Orb::Models::SubscriptionRedeemCouponParams
+
   SubscriptionsAPI = Orb::Models::SubscriptionsAPI
 
   SubscriptionSchedulePlanChangeParams = Orb::Models::SubscriptionSchedulePlanChangeParams

data/lib/orb/resources/subscriptions.rb

@@ -982,6 +982,39 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::SubscriptionRedeemCouponParams} for more details.
+      #
+      # 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: {})
+      #
+      # @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 request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::SubscriptionRedeemCouponResponse]
+      #
+      # @see Orb::Models::SubscriptionRedeemCouponParams
+      def redeem_coupon(subscription_id, params)
+        parsed, options = Orb::SubscriptionRedeemCouponParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["subscriptions/%1$s/redeem_coupon", subscription_id],
+          body: parsed,
+          model: Orb::Models::SubscriptionRedeemCouponResponse,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {Orb::Models::SubscriptionSchedulePlanChangeParams} for more details.
       #
@@ -1324,7 +1357,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.
       #
       # @overload unschedule_pending_plan_changes(subscription_id, request_options: {})
       #

data/lib/orb/version.rb

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

data/lib/orb.rb

@@ -213,6 +213,8 @@ require_relative "orb/models/subscription_fetch_usage_params"
 require_relative "orb/models/subscription_list_params"
 require_relative "orb/models/subscription_price_intervals_params"
 require_relative "orb/models/subscription_price_intervals_response"
+require_relative "orb/models/subscription_redeem_coupon_params"
+require_relative "orb/models/subscription_redeem_coupon_response"
 require_relative "orb/models/subscriptions"
 require_relative "orb/models/subscription_schedule_plan_change_params"
 require_relative "orb/models/subscription_schedule_plan_change_response"

data/rbi/orb/models/invoice.rbi

@@ -1646,7 +1646,7 @@ module Orb
         #
         # For more on the types of prices, see
         # [the core concepts documentation](/core-concepts#plan-and-price)
-        sig { returns(T.nilable(Orb::Price::Variants)) }
+        sig { returns(Orb::Price::Variants) }
         attr_accessor :price
 
         # Either the fixed fee quantity or the usage during the service period.
@@ -1710,37 +1710,35 @@ module Orb
             name: String,
             partially_invoiced_amount: String,
             price:
-              T.nilable(
-                T.any(
-                  Orb::Price::Unit::OrHash,
-                  Orb::Price::Package::OrHash,
-                  Orb::Price::Matrix::OrHash,
-                  Orb::Price::Tiered::OrHash,
-                  Orb::Price::TieredBps::OrHash,
-                  Orb::Price::Bps::OrHash,
-                  Orb::Price::BulkBps::OrHash,
-                  Orb::Price::Bulk::OrHash,
-                  Orb::Price::ThresholdTotalAmount::OrHash,
-                  Orb::Price::TieredPackage::OrHash,
-                  Orb::Price::GroupedTiered::OrHash,
-                  Orb::Price::TieredWithMinimum::OrHash,
-                  Orb::Price::TieredPackageWithMinimum::OrHash,
-                  Orb::Price::PackageWithAllocation::OrHash,
-                  Orb::Price::UnitWithPercent::OrHash,
-                  Orb::Price::MatrixWithAllocation::OrHash,
-                  Orb::Price::TieredWithProration::OrHash,
-                  Orb::Price::UnitWithProration::OrHash,
-                  Orb::Price::GroupedAllocation::OrHash,
-                  Orb::Price::GroupedWithProratedMinimum::OrHash,
-                  Orb::Price::GroupedWithMeteredMinimum::OrHash,
-                  Orb::Price::MatrixWithDisplayName::OrHash,
-                  Orb::Price::BulkWithProration::OrHash,
-                  Orb::Price::GroupedTieredPackage::OrHash,
-                  Orb::Price::MaxGroupTieredPackage::OrHash,
-                  Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
-                  Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
-                  Orb::Price::CumulativeGroupedBulk::OrHash
-                )
+              T.any(
+                Orb::Price::Unit::OrHash,
+                Orb::Price::Package::OrHash,
+                Orb::Price::Matrix::OrHash,
+                Orb::Price::Tiered::OrHash,
+                Orb::Price::TieredBps::OrHash,
+                Orb::Price::Bps::OrHash,
+                Orb::Price::BulkBps::OrHash,
+                Orb::Price::Bulk::OrHash,
+                Orb::Price::ThresholdTotalAmount::OrHash,
+                Orb::Price::TieredPackage::OrHash,
+                Orb::Price::GroupedTiered::OrHash,
+                Orb::Price::TieredWithMinimum::OrHash,
+                Orb::Price::TieredPackageWithMinimum::OrHash,
+                Orb::Price::PackageWithAllocation::OrHash,
+                Orb::Price::UnitWithPercent::OrHash,
+                Orb::Price::MatrixWithAllocation::OrHash,
+                Orb::Price::TieredWithProration::OrHash,
+                Orb::Price::UnitWithProration::OrHash,
+                Orb::Price::GroupedAllocation::OrHash,
+                Orb::Price::GroupedWithProratedMinimum::OrHash,
+                Orb::Price::GroupedWithMeteredMinimum::OrHash,
+                Orb::Price::MatrixWithDisplayName::OrHash,
+                Orb::Price::BulkWithProration::OrHash,
+                Orb::Price::GroupedTieredPackage::OrHash,
+                Orb::Price::MaxGroupTieredPackage::OrHash,
+                Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
+                Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
+                Orb::Price::CumulativeGroupedBulk::OrHash
               ),
             quantity: Float,
             start_date: Time,
@@ -1840,7 +1838,7 @@ module Orb
               minimum_amount: T.nilable(String),
               name: String,
               partially_invoiced_amount: String,
-              price: T.nilable(Orb::Price::Variants),
+              price: Orb::Price::Variants,
               quantity: Float,
               start_date: Time,
               sub_line_items:

data/rbi/orb/models/invoice_fetch_upcoming_response.rbi

@@ -2421,7 +2421,7 @@ module Orb
         #
         # For more on the types of prices, see
         # [the core concepts documentation](/core-concepts#plan-and-price)
-        sig { returns(T.nilable(Orb::Price::Variants)) }
+        sig { returns(Orb::Price::Variants) }
         attr_accessor :price
 
         # Either the fixed fee quantity or the usage during the service period.
@@ -2503,37 +2503,35 @@ module Orb
             name: String,
             partially_invoiced_amount: String,
             price:
-              T.nilable(
-                T.any(
-                  Orb::Price::Unit::OrHash,
-                  Orb::Price::Package::OrHash,
-                  Orb::Price::Matrix::OrHash,
-                  Orb::Price::Tiered::OrHash,
-                  Orb::Price::TieredBps::OrHash,
-                  Orb::Price::Bps::OrHash,
-                  Orb::Price::BulkBps::OrHash,
-                  Orb::Price::Bulk::OrHash,
-                  Orb::Price::ThresholdTotalAmount::OrHash,
-                  Orb::Price::TieredPackage::OrHash,
-                  Orb::Price::GroupedTiered::OrHash,
-                  Orb::Price::TieredWithMinimum::OrHash,
-                  Orb::Price::TieredPackageWithMinimum::OrHash,
-                  Orb::Price::PackageWithAllocation::OrHash,
-                  Orb::Price::UnitWithPercent::OrHash,
-                  Orb::Price::MatrixWithAllocation::OrHash,
-                  Orb::Price::TieredWithProration::OrHash,
-                  Orb::Price::UnitWithProration::OrHash,
-                  Orb::Price::GroupedAllocation::OrHash,
-                  Orb::Price::GroupedWithProratedMinimum::OrHash,
-                  Orb::Price::GroupedWithMeteredMinimum::OrHash,
-                  Orb::Price::MatrixWithDisplayName::OrHash,
-                  Orb::Price::BulkWithProration::OrHash,
-                  Orb::Price::GroupedTieredPackage::OrHash,
-                  Orb::Price::MaxGroupTieredPackage::OrHash,
-                  Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
-                  Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
-                  Orb::Price::CumulativeGroupedBulk::OrHash
-                )
+              T.any(
+                Orb::Price::Unit::OrHash,
+                Orb::Price::Package::OrHash,
+                Orb::Price::Matrix::OrHash,
+                Orb::Price::Tiered::OrHash,
+                Orb::Price::TieredBps::OrHash,
+                Orb::Price::Bps::OrHash,
+                Orb::Price::BulkBps::OrHash,
+                Orb::Price::Bulk::OrHash,
+                Orb::Price::ThresholdTotalAmount::OrHash,
+                Orb::Price::TieredPackage::OrHash,
+                Orb::Price::GroupedTiered::OrHash,
+                Orb::Price::TieredWithMinimum::OrHash,
+                Orb::Price::TieredPackageWithMinimum::OrHash,
+                Orb::Price::PackageWithAllocation::OrHash,
+                Orb::Price::UnitWithPercent::OrHash,
+                Orb::Price::MatrixWithAllocation::OrHash,
+                Orb::Price::TieredWithProration::OrHash,
+                Orb::Price::UnitWithProration::OrHash,
+                Orb::Price::GroupedAllocation::OrHash,
+                Orb::Price::GroupedWithProratedMinimum::OrHash,
+                Orb::Price::GroupedWithMeteredMinimum::OrHash,
+                Orb::Price::MatrixWithDisplayName::OrHash,
+                Orb::Price::BulkWithProration::OrHash,
+                Orb::Price::GroupedTieredPackage::OrHash,
+                Orb::Price::MaxGroupTieredPackage::OrHash,
+                Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
+                Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
+                Orb::Price::CumulativeGroupedBulk::OrHash
               ),
             quantity: Float,
             start_date: Time,
@@ -2644,7 +2642,7 @@ module Orb
               minimum_amount: T.nilable(String),
               name: String,
               partially_invoiced_amount: String,
-              price: T.nilable(Orb::Price::Variants),
+              price: Orb::Price::Variants,
               quantity: Float,
               start_date: Time,
               sub_line_items:

data/rbi/orb/models/invoice_line_item_create_response.rbi

@@ -116,7 +116,7 @@ module Orb
       #
       # For more on the types of prices, see
       # [the core concepts documentation](/core-concepts#plan-and-price)
-      sig { returns(T.nilable(Orb::Price::Variants)) }
+      sig { returns(Orb::Price::Variants) }
       attr_accessor :price
 
       # Either the fixed fee quantity or the usage during the service period.
@@ -194,37 +194,35 @@ module Orb
           name: String,
           partially_invoiced_amount: String,
           price:
-            T.nilable(
-              T.any(
-                Orb::Price::Unit::OrHash,
-                Orb::Price::Package::OrHash,
-                Orb::Price::Matrix::OrHash,
-                Orb::Price::Tiered::OrHash,
-                Orb::Price::TieredBps::OrHash,
-                Orb::Price::Bps::OrHash,
-                Orb::Price::BulkBps::OrHash,
-                Orb::Price::Bulk::OrHash,
-                Orb::Price::ThresholdTotalAmount::OrHash,
-                Orb::Price::TieredPackage::OrHash,
-                Orb::Price::GroupedTiered::OrHash,
-                Orb::Price::TieredWithMinimum::OrHash,
-                Orb::Price::TieredPackageWithMinimum::OrHash,
-                Orb::Price::PackageWithAllocation::OrHash,
-                Orb::Price::UnitWithPercent::OrHash,
-                Orb::Price::MatrixWithAllocation::OrHash,
-                Orb::Price::TieredWithProration::OrHash,
-                Orb::Price::UnitWithProration::OrHash,
-                Orb::Price::GroupedAllocation::OrHash,
-                Orb::Price::GroupedWithProratedMinimum::OrHash,
-                Orb::Price::GroupedWithMeteredMinimum::OrHash,
-                Orb::Price::MatrixWithDisplayName::OrHash,
-                Orb::Price::BulkWithProration::OrHash,
-                Orb::Price::GroupedTieredPackage::OrHash,
-                Orb::Price::MaxGroupTieredPackage::OrHash,
-                Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
-                Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
-                Orb::Price::CumulativeGroupedBulk::OrHash
-              )
+            T.any(
+              Orb::Price::Unit::OrHash,
+              Orb::Price::Package::OrHash,
+              Orb::Price::Matrix::OrHash,
+              Orb::Price::Tiered::OrHash,
+              Orb::Price::TieredBps::OrHash,
+              Orb::Price::Bps::OrHash,
+              Orb::Price::BulkBps::OrHash,
+              Orb::Price::Bulk::OrHash,
+              Orb::Price::ThresholdTotalAmount::OrHash,
+              Orb::Price::TieredPackage::OrHash,
+              Orb::Price::GroupedTiered::OrHash,
+              Orb::Price::TieredWithMinimum::OrHash,
+              Orb::Price::TieredPackageWithMinimum::OrHash,
+              Orb::Price::PackageWithAllocation::OrHash,
+              Orb::Price::UnitWithPercent::OrHash,
+              Orb::Price::MatrixWithAllocation::OrHash,
+              Orb::Price::TieredWithProration::OrHash,
+              Orb::Price::UnitWithProration::OrHash,
+              Orb::Price::GroupedAllocation::OrHash,
+              Orb::Price::GroupedWithProratedMinimum::OrHash,
+              Orb::Price::GroupedWithMeteredMinimum::OrHash,
+              Orb::Price::MatrixWithDisplayName::OrHash,
+              Orb::Price::BulkWithProration::OrHash,
+              Orb::Price::GroupedTieredPackage::OrHash,
+              Orb::Price::MaxGroupTieredPackage::OrHash,
+              Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
+              Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
+              Orb::Price::CumulativeGroupedBulk::OrHash
             ),
           quantity: Float,
           start_date: Time,
@@ -331,7 +329,7 @@ module Orb
             minimum_amount: T.nilable(String),
             name: String,
             partially_invoiced_amount: String,
-            price: T.nilable(Orb::Price::Variants),
+            price: Orb::Price::Variants,
             quantity: Float,
             start_date: Time,
             sub_line_items:

data/rbi/orb/models/subscription_redeem_coupon_params.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module Orb
+  module Models
+    class SubscriptionRedeemCouponParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::SubscriptionRedeemCouponParams, Orb::Internal::AnyHash)
+        end
+
+      sig do
+        returns(Orb::SubscriptionRedeemCouponParams::ChangeOption::OrSymbol)
+      end
+      attr_accessor :change_option
+
+      # Coupon ID to be redeemed for this subscription.
+      sig { returns(String) }
+      attr_accessor :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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :allow_invoice_credit_or_void
+
+      # The date that the coupon discount should take effect. This parameter can only be
+      # passed if the `change_option` is `requested_date`.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :change_date
+
+      sig do
+        params(
+          change_option:
+            Orb::SubscriptionRedeemCouponParams::ChangeOption::OrSymbol,
+          coupon_id: String,
+          allow_invoice_credit_or_void: T.nilable(T::Boolean),
+          change_date: T.nilable(Time),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        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.
+        allow_invoice_credit_or_void: nil,
+        # 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,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            change_option:
+              Orb::SubscriptionRedeemCouponParams::ChangeOption::OrSymbol,
+            coupon_id: String,
+            allow_invoice_credit_or_void: T.nilable(T::Boolean),
+            change_date: T.nilable(Time),
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module ChangeOption
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::SubscriptionRedeemCouponParams::ChangeOption)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        REQUESTED_DATE =
+          T.let(
+            :requested_date,
+            Orb::SubscriptionRedeemCouponParams::ChangeOption::TaggedSymbol
+          )
+        END_OF_SUBSCRIPTION_TERM =
+          T.let(
+            :end_of_subscription_term,
+            Orb::SubscriptionRedeemCouponParams::ChangeOption::TaggedSymbol
+          )
+        IMMEDIATE =
+          T.let(
+            :immediate,
+            Orb::SubscriptionRedeemCouponParams::ChangeOption::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::SubscriptionRedeemCouponParams::ChangeOption::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end