orb-billing 0.5.5 → 0.7.0

data/lib/orb/resources/subscriptions.rb

@@ -263,7 +263,7 @@ module Orb
       # subscription. E.g. pass in `10.00` to issue an invoice when usage amounts hit
       # $10.00 for a subscription that invoices in USD.
       #
-      # @overload create(add_adjustments: nil, add_prices: nil, align_billing_with_subscription_start_date: nil, auto_collection: nil, aws_region: nil, billing_cycle_anchor_configuration: nil, coupon_redemption_code: nil, credits_overage_rate: nil, customer_id: nil, default_invoice_memo: nil, end_date: nil, external_customer_id: nil, external_marketplace: nil, external_marketplace_reporting_id: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, start_date: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {})
+      # @overload create(add_adjustments: nil, add_prices: nil, align_billing_with_subscription_start_date: nil, auto_collection: nil, aws_region: nil, billing_cycle_anchor_configuration: nil, coupon_redemption_code: nil, credits_overage_rate: nil, currency: nil, customer_id: nil, default_invoice_memo: nil, end_date: nil, external_customer_id: nil, external_marketplace: nil, external_marketplace_reporting_id: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, metadata: nil, name: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, start_date: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {})
       #
       # @param add_adjustments [Array<Orb::Models::SubscriptionCreateParams::AddAdjustment>, nil] Additional adjustments to be added to the subscription. (Only available for acco
       #
@@ -281,6 +281,8 @@ module Orb
       #
       # @param credits_overage_rate [Float, nil]
       #
+      # @param currency [String, nil] The currency to use for the subscription. If not specified, the invoicing curren
+      #
       # @param customer_id [String, nil]
       #
       # @param default_invoice_memo [String, nil] Determines the default memo on this subscription's invoices. Note that if this i
@@ -303,6 +305,8 @@ module Orb
       #
       # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
       #
+      # @param name [String, nil] The name to use for the subscription. If not specified, the plan name will be us
+      #
       # @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d
       #
       # @param per_credit_overage_amount [Float, nil]

data/lib/orb/version.rb

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

data/lib/orb.rb

@@ -61,6 +61,12 @@ require_relative "orb/models/alert_list_params"
 require_relative "orb/models/alert_retrieve_params"
 require_relative "orb/models/alert_update_params"
 require_relative "orb/models/amount_discount"
+require_relative "orb/models/beta/external_plan_id_create_plan_version_params"
+require_relative "orb/models/beta/external_plan_id_fetch_plan_version_params"
+require_relative "orb/models/beta/external_plan_id_set_default_plan_version_params"
+require_relative "orb/models/beta_create_plan_version_params"
+require_relative "orb/models/beta_fetch_plan_version_params"
+require_relative "orb/models/beta_set_default_plan_version_params"
 require_relative "orb/models/billable_metric"
 require_relative "orb/models/billing_cycle_relative_date"
 require_relative "orb/models/coupon"
@@ -156,6 +162,7 @@ require_relative "orb/models/invoice_pay_params"
 require_relative "orb/models/invoice_update_params"
 require_relative "orb/models/invoice_void_params"
 require_relative "orb/models/item"
+require_relative "orb/models/item_archive_params"
 require_relative "orb/models/item_create_params"
 require_relative "orb/models/item_fetch_params"
 require_relative "orb/models/item_list_params"
@@ -173,8 +180,12 @@ require_relative "orb/models/plan_list_params"
 require_relative "orb/models/plans/external_plan_id_fetch_params"
 require_relative "orb/models/plans/external_plan_id_update_params"
 require_relative "orb/models/plan_update_params"
+require_relative "orb/models/plan_version"
+require_relative "orb/models/plan_version_phase"
 require_relative "orb/models/price"
 require_relative "orb/models/price_create_params"
+require_relative "orb/models/price_evaluate_multiple_params"
+require_relative "orb/models/price_evaluate_multiple_response"
 require_relative "orb/models/price_evaluate_params"
 require_relative "orb/models/price_evaluate_response"
 require_relative "orb/models/price_fetch_params"
@@ -225,6 +236,8 @@ require_relative "orb/models/trial_discount"
 require_relative "orb/models/usage_discount"
 require_relative "orb/models"
 require_relative "orb/resources/alerts"
+require_relative "orb/resources/beta"
+require_relative "orb/resources/beta/external_plan_id"
 require_relative "orb/resources/coupons"
 require_relative "orb/resources/coupons/subscriptions"
 require_relative "orb/resources/credit_notes"

data/rbi/orb/client.rbi

@@ -16,6 +16,9 @@ module Orb
     sig { returns(Orb::Resources::TopLevel) }
     attr_reader :top_level
 
+    sig { returns(Orb::Resources::Beta) }
+    attr_reader :beta
+
     sig { returns(Orb::Resources::Coupons) }
     attr_reader :coupons
 

data/rbi/orb/models/alert.rbi

@@ -60,6 +60,11 @@ module Orb
       sig { returns(Orb::Alert::Type::TaggedSymbol) }
       attr_accessor :type
 
+      # The current status of the alert. This field is only present for credit balance
+      # alerts.
+      sig { returns(T.nilable(T::Array[Orb::Alert::BalanceAlertStatus])) }
+      attr_accessor :balance_alert_status
+
       # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
       # usage, or credit balance and trigger webhooks when a threshold is exceeded.
       #
@@ -76,7 +81,9 @@ module Orb
           plan: T.nilable(Orb::Alert::Plan::OrHash),
           subscription: T.nilable(Orb::Alert::Subscription::OrHash),
           thresholds: T.nilable(T::Array[Orb::Alert::Threshold::OrHash]),
-          type: Orb::Alert::Type::OrSymbol
+          type: Orb::Alert::Type::OrSymbol,
+          balance_alert_status:
+            T.nilable(T::Array[Orb::Alert::BalanceAlertStatus::OrHash])
         ).returns(T.attached_class)
       end
       def self.new(
@@ -100,7 +107,10 @@ module Orb
         # triggered.
         thresholds:,
         # The type of alert. This must be a valid alert type.
-        type:
+        type:,
+        # The current status of the alert. This field is only present for credit balance
+        # alerts.
+        balance_alert_status: nil
       )
       end
 
@@ -116,7 +126,9 @@ module Orb
             plan: T.nilable(Orb::Alert::Plan),
             subscription: T.nilable(Orb::Alert::Subscription),
             thresholds: T.nilable(T::Array[Orb::Alert::Threshold]),
-            type: Orb::Alert::Type::TaggedSymbol
+            type: Orb::Alert::Type::TaggedSymbol,
+            balance_alert_status:
+              T.nilable(T::Array[Orb::Alert::BalanceAlertStatus])
           }
         )
       end
@@ -286,6 +298,41 @@ module Orb
         def self.values
         end
       end
+
+      class BalanceAlertStatus < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Orb::Alert::BalanceAlertStatus, Orb::Internal::AnyHash)
+          end
+
+        # Whether the alert is currently in-alert or not.
+        sig { returns(T::Boolean) }
+        attr_accessor :in_alert
+
+        # The value of the threshold that defines the alert status.
+        sig { returns(Float) }
+        attr_accessor :threshold_value
+
+        # Alert status is used to determine if an alert is currently in-alert or not.
+        sig do
+          params(in_alert: T::Boolean, threshold_value: Float).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Whether the alert is currently in-alert or not.
+          in_alert:,
+          # The value of the threshold that defines the alert status.
+          threshold_value:
+        )
+        end
+
+        sig do
+          override.returns({ in_alert: T::Boolean, threshold_value: Float })
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/orb/models/amount_discount.rbi

@@ -10,32 +10,32 @@ module Orb
       sig { returns(String) }
       attr_accessor :amount_discount
 
+      sig { returns(Orb::AmountDiscount::DiscountType::OrSymbol) }
+      attr_accessor :discount_type
+
       # List of price_ids that this discount applies to. For plan/plan phase discounts,
       # this can be a subset of prices.
-      sig { returns(T::Array[String]) }
+      sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :applies_to_price_ids
 
-      sig { returns(Orb::AmountDiscount::DiscountType::OrSymbol) }
-      attr_accessor :discount_type
-
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
       sig do
         params(
           amount_discount: String,
-          applies_to_price_ids: T::Array[String],
           discount_type: Orb::AmountDiscount::DiscountType::OrSymbol,
+          applies_to_price_ids: T.nilable(T::Array[String]),
           reason: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
         # Only available if discount_type is `amount`.
         amount_discount:,
+        discount_type:,
         # 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:,
-        discount_type:,
+        applies_to_price_ids: nil,
         reason: nil
       )
       end
@@ -44,8 +44,8 @@ module Orb
         override.returns(
           {
             amount_discount: String,
-            applies_to_price_ids: T::Array[String],
             discount_type: Orb::AmountDiscount::DiscountType::OrSymbol,
+            applies_to_price_ids: T.nilable(T::Array[String]),
             reason: T.nilable(String)
           }
         )