orb-billing 0.1.3 → 0.3.0

data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi

@@ -29,8 +29,15 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(currency:, type:, thresholds: nil, request_options: {}); end
-
+      def self.new(
+        # The case sensitive currency or custom pricing unit to use for this alert.
+        currency:,
+        # The type of alert to create. This must be a valid alert type.
+        type:,
+        # The thresholds that define the values at which the alert will be triggered.
+        thresholds: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(
@@ -49,8 +56,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         CREDIT_BALANCE_DEPLETED =
           T.let(:credit_balance_depleted, Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol)
@@ -73,8 +79,12 @@ module Orb
         # Thresholds are used to define the conditions under which an alert will be
         # triggered.
         sig { params(value: Float).returns(T.attached_class) }
-        def self.new(value:); end
-
+        def self.new(
+          # The value at which an alert will fire. For credit balance alerts, the alert will
+          # fire at or below this value. For usage and cost alerts, the alert will fire at
+          # or above this value.
+          value:
+        ); end
         sig { override.returns({value: Float}) }
         def to_hash; end
       end

data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi

@@ -27,8 +27,15 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(thresholds:, type:, metric_id: nil, request_options: {}); end
-
+      def self.new(
+        # The thresholds that define the values at which the alert will be triggered.
+        thresholds:,
+        # The type of alert to create. This must be a valid alert type.
+        type:,
+        # The metric to track usage for.
+        metric_id: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(
@@ -52,8 +59,12 @@ module Orb
         # Thresholds are used to define the conditions under which an alert will be
         # triggered.
         sig { params(value: Float).returns(T.attached_class) }
-        def self.new(value:); end
-
+        def self.new(
+          # The value at which an alert will fire. For credit balance alerts, the alert will
+          # fire at or below this value. For usage and cost alerts, the alert will fire at
+          # or above this value.
+          value:
+        ); end
         sig { override.returns({value: Float}) }
         def to_hash; end
       end
@@ -63,8 +74,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::AlertCreateForSubscriptionParams::Type::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         USAGE_EXCEEDED =
           T.let(:usage_exceeded, Orb::Models::AlertCreateForSubscriptionParams::Type::TaggedSymbol)

data/rbi/lib/orb/models/alert_disable_params.rbi

@@ -17,8 +17,11 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(subscription_id: nil, request_options: {}); end
-
+      def self.new(
+        # Used to update the status of a plan alert scoped to this subscription_id
+        subscription_id: nil,
+        request_options: {}
+      ); end
       sig { override.returns({subscription_id: T.nilable(String), request_options: Orb::RequestOptions}) }
       def to_hash; end
     end

data/rbi/lib/orb/models/alert_enable_params.rbi

@@ -17,8 +17,11 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(subscription_id: nil, request_options: {}); end
-
+      def self.new(
+        # Used to update the status of a plan alert scoped to this subscription_id
+        subscription_id: nil,
+        request_options: {}
+      ); end
       sig { override.returns({subscription_id: T.nilable(String), request_options: Orb::RequestOptions}) }
       def to_hash; end
     end

data/rbi/lib/orb/models/alert_list_params.rbi

@@ -62,10 +62,16 @@ module Orb
         created_at_gte: nil,
         created_at_lt: nil,
         created_at_lte: nil,
+        # Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # from the initial request.
         cursor: nil,
+        # Fetch alerts scoped to this customer_id
         customer_id: nil,
+        # Fetch alerts scoped to this external_customer_id
         external_customer_id: nil,
+        # The number of items to fetch. Defaults to 20.
         limit: nil,
+        # Fetch alerts scoped to this subscription_id
         subscription_id: nil,
         request_options: {}
       ); end

data/rbi/lib/orb/models/alert_update_params.rbi

@@ -17,8 +17,11 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(thresholds:, request_options: {}); end
-
+      def self.new(
+        # The thresholds that define the values at which the alert will be triggered.
+        thresholds:,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(
@@ -37,8 +40,12 @@ module Orb
         # Thresholds are used to define the conditions under which an alert will be
         # triggered.
         sig { params(value: Float).returns(T.attached_class) }
-        def self.new(value:); end
-
+        def self.new(
+          # The value at which an alert will fire. For credit balance alerts, the alert will
+          # fire at or below this value. For usage and cost alerts, the alert will fire at
+          # or above this value.
+          value:
+        ); end
         sig { override.returns({value: Float}) }
         def to_hash; end
       end

data/rbi/lib/orb/models/amount_discount.rbi

@@ -27,8 +27,15 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(amount_discount:, applies_to_price_ids:, discount_type:, reason: nil); end
-
+      def self.new(
+        # Only available if discount_type is `amount`.
+        amount_discount:,
+        # 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:,
+        reason: nil
+      ); end
       sig do
         override
           .returns(
@@ -46,8 +53,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AmountDiscount::DiscountType) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::AmountDiscount::DiscountType::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         AMOUNT = T.let(:amount, Orb::Models::AmountDiscount::DiscountType::TaggedSymbol)
 

data/rbi/lib/orb/models/billable_metric.rbi

@@ -45,8 +45,21 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(id:, description:, item:, metadata:, name:, status:); end
-
+      def self.new(
+        id:,
+        description:,
+        # The Item resource represents a sellable product or good. Items are associated
+        # with all line items, billable metrics, and prices and are used for defining
+        # external sync behavior for invoices and tax calculation purposes.
+        item:,
+        # User specified key-value pairs for the resource. If not present, this defaults
+        # to an empty dictionary. Individual keys can be removed by setting the value to
+        # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+        # `null`.
+        metadata:,
+        name:,
+        status:
+      ); end
       sig do
         override
           .returns(
@@ -66,7 +79,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::BillableMetric::Status) }
-        OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::BillableMetric::Status::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         ACTIVE = T.let(:active, Orb::Models::BillableMetric::Status::TaggedSymbol)
         DRAFT = T.let(:draft, Orb::Models::BillableMetric::Status::TaggedSymbol)

data/rbi/lib/orb/models/billing_cycle_relative_date.rbi

@@ -6,7 +6,7 @@ module Orb
       extend Orb::Internal::Type::Enum
 
       TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::BillingCycleRelativeDate) }
-      OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::BillingCycleRelativeDate::TaggedSymbol) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
 
       START_OF_TERM = T.let(:start_of_term, Orb::Models::BillingCycleRelativeDate::TaggedSymbol)
       END_OF_TERM = T.let(:end_of_term, Orb::Models::BillingCycleRelativeDate::TaggedSymbol)

data/rbi/lib/orb/models/coupon.rbi

@@ -51,16 +51,23 @@ module Orb
           .returns(T.attached_class)
       end
       def self.new(
+        # Also referred to as coupon_id in this documentation.
         id:,
+        # An archived coupon can no longer be redeemed. Active coupons will have a value
+        # of null for `archived_at`; this field will be non-null for archived coupons.
         archived_at:,
         discount:,
+        # This allows for a coupon's discount to apply for a limited time (determined in
+        # months); a `null` value here means "unlimited time".
         duration_in_months:,
+        # The maximum number of redemptions allowed for this coupon before it is
+        # exhausted; `null` here means "unlimited".
         max_redemptions:,
+        # This string can be used to redeem this coupon for a given subscription.
         redemption_code:,
+        # The number of times this coupon has been redeemed.
         times_redeemed:
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/orb/models/coupon_create_params.rbi

@@ -46,13 +46,16 @@ module Orb
       end
       def self.new(
         discount:,
+        # This string can be used to redeem this coupon for a given subscription.
         redemption_code:,
+        # This allows for a coupon's discount to apply for a limited time (determined in
+        # months); a `null` value here means "unlimited time".
         duration_in_months: nil,
+        # The maximum number of redemptions allowed for this coupon before it is
+        # exhausted;`null` here means "unlimited".
         max_redemptions: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/orb/models/coupon_list_params.rbi

@@ -37,9 +37,19 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {})
-      end
-
+      def self.new(
+        # Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # from the initial request.
+        cursor: nil,
+        # The number of items to fetch. Defaults to 20.
+        limit: nil,
+        # Filter to coupons matching this redemption code.
+        redemption_code: nil,
+        # Show archived coupons as well (by default, this endpoint only returns active
+        # coupons).
+        show_archived: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/orb/models/coupons/subscription_list_params.rbi

@@ -27,8 +27,14 @@ module Orb
           )
             .returns(T.attached_class)
         end
-        def self.new(cursor: nil, limit: nil, request_options: {}); end
-
+        def self.new(
+          # Cursor for pagination. This can be populated by the `next_cursor` value returned
+          # from the initial request.
+          cursor: nil,
+          # The number of items to fetch. Defaults to 20.
+          limit: nil,
+          request_options: {}
+        ); end
         sig do
           override.returns({cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOptions})
         end

data/rbi/lib/orb/models/credit_note.rbi

@@ -102,21 +102,34 @@ module Orb
           .returns(T.attached_class)
       end
       def self.new(
+        # The Orb id of this credit note.
         id:,
+        # The creation time of the resource in Orb.
         created_at:,
+        # The unique identifier for credit notes.
         credit_note_number:,
+        # A URL to a PDF of the credit note.
         credit_note_pdf:,
         customer:,
+        # The id of the invoice resource that this credit note is applied to.
         invoice_id:,
+        # All of the line items associated with this credit note.
         line_items:,
+        # The maximum amount applied on the original invoice
         maximum_amount_adjustment:,
+        # An optional memo supplied on the credit note.
         memo:,
+        # Any credited amount from the applied minimum on the invoice.
         minimum_amount_refunded:,
         reason:,
+        # The total prior to any creditable invoice-level discounts or minimums.
         subtotal:,
+        # The total including creditable invoice-level discounts or minimums, and tax.
         total:,
         type:,
+        # The time at which the credit note was voided in Orb, if applicable.
         voided_at:,
+        # Any discounts applied on the original invoice.
         discounts: nil
       ); end
       sig do
@@ -210,8 +223,24 @@ module Orb
           )
             .returns(T.attached_class)
         end
-        def self.new(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil); end
-
+        def self.new(
+          # The Orb id of this resource.
+          id:,
+          # The amount of the line item, including any line item minimums and discounts.
+          amount:,
+          # The id of the item associated with this line item.
+          item_id:,
+          # The name of the corresponding invoice line item.
+          name:,
+          # An optional quantity credited.
+          quantity:,
+          # The amount of the line item, excluding any line item minimums and discounts.
+          subtotal:,
+          # Any tax amounts applied onto the line item.
+          tax_amounts:,
+          # Any line item discounts from the invoice's line item.
+          discounts: nil
+        ); end
         sig do
           override
             .returns(
@@ -246,8 +275,14 @@ module Orb
             params(amount: String, tax_rate_description: String, tax_rate_percentage: T.nilable(String))
               .returns(T.attached_class)
           end
-          def self.new(amount:, tax_rate_description:, tax_rate_percentage:); end
-
+          def self.new(
+            # The amount of additional tax incurred by this tax rate.
+            amount:,
+            # The human-readable description of the applied tax rate.
+            tax_rate_description:,
+            # The tax rate percentage, out of 100.
+            tax_rate_percentage:
+          ); end
           sig do
             override.returns(
               {
@@ -323,8 +358,7 @@ module Orb
             extend Orb::Internal::Type::Enum
 
             TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType) }
-            OrSymbol =
-              T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             PERCENTAGE = T.let(:percentage, Orb::Models::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol)
             AMOUNT = T.let(:amount, Orb::Models::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol)
@@ -392,8 +426,7 @@ module Orb
 
           TaggedSymbol =
             T.type_alias { T.all(Symbol, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           PERCENTAGE =
             T.let(:percentage, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType::TaggedSymbol)
@@ -421,7 +454,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNote::Reason) }
-        OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::Reason::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         DUPLICATE = T.let(:Duplicate, Orb::Models::CreditNote::Reason::TaggedSymbol)
         FRAUDULENT = T.let(:Fraudulent, Orb::Models::CreditNote::Reason::TaggedSymbol)
@@ -436,7 +469,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNote::Type) }
-        OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::Type::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         REFUND = T.let(:refund, Orb::Models::CreditNote::Type::TaggedSymbol)
         ADJUSTMENT = T.let(:adjustment, Orb::Models::CreditNote::Type::TaggedSymbol)
@@ -498,8 +531,7 @@ module Orb
           extend Orb::Internal::Type::Enum
 
           TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNote::Discount::DiscountType) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::Discount::DiscountType::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           PERCENTAGE = T.let(:percentage, Orb::Models::CreditNote::Discount::DiscountType::TaggedSymbol)
 

data/rbi/lib/orb/models/credit_note_create_params.rbi

@@ -26,8 +26,14 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(line_items:, memo: nil, reason: nil, request_options: {}); end
-
+      def self.new(
+        line_items:,
+        # An optional memo to attach to the credit note.
+        memo: nil,
+        # An optional reason for the credit note.
+        reason: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(
@@ -51,8 +57,12 @@ module Orb
         attr_accessor :invoice_line_item_id
 
         sig { params(amount: String, invoice_line_item_id: String).returns(T.attached_class) }
-        def self.new(amount:, invoice_line_item_id:); end
-
+        def self.new(
+          # The total amount in the invoice's currency to credit this line item.
+          amount:,
+          # The ID of the line item to credit.
+          invoice_line_item_id:
+        ); end
         sig { override.returns({amount: String, invoice_line_item_id: String}) }
         def to_hash; end
       end
@@ -62,8 +72,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNoteCreateParams::Reason) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::CreditNoteCreateParams::Reason::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         DUPLICATE = T.let(:duplicate, Orb::Models::CreditNoteCreateParams::Reason::TaggedSymbol)
         FRAUDULENT = T.let(:fraudulent, Orb::Models::CreditNoteCreateParams::Reason::TaggedSymbol)

data/rbi/lib/orb/models/credit_note_list_params.rbi

@@ -47,7 +47,10 @@ module Orb
         created_at_gte: nil,
         created_at_lt: nil,
         created_at_lte: nil,
+        # Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # from the initial request.
         cursor: nil,
+        # The number of items to fetch. Defaults to 20.
         limit: nil,
         request_options: {}
       ); end