orb-billing 0.2.0 → 0.3.0

data/rbi/lib/orb/models/invoice_issue_params.rbi

@@ -21,8 +21,15 @@ module Orb
         params(synchronous: T::Boolean, request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
           .returns(T.attached_class)
       end
-      def self.new(synchronous: nil, request_options: {}); end
-
+      def self.new(
+        # If true, the invoice will be issued synchronously. If false, the invoice will be
+        # issued asynchronously. The synchronous option is only available for invoices
+        # that have no usage fees. If the invoice is configured to sync to an external
+        # provider, a successful response from this endpoint guarantees the invoice is
+        # present in the provider.
+        synchronous: nil,
+        request_options: {}
+      ); end
       sig { override.returns({synchronous: T::Boolean, request_options: Orb::RequestOptions}) }
       def to_hash; end
     end

data/rbi/lib/orb/models/invoice_line_item_create_params.rbi

@@ -43,8 +43,22 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(amount:, end_date:, invoice_id:, name:, quantity:, start_date:, request_options: {}); end
-
+      def self.new(
+        # The total amount in the invoice's currency to add to the line item.
+        amount:,
+        # A date string to specify the line item's end date in the customer's timezone.
+        end_date:,
+        # The id of the Invoice to add this line item.
+        invoice_id:,
+        # The item name associated with this line item. If an item with the same name
+        # exists in Orb, that item will be associated with the line item.
+        name:,
+        # The number of units on the line item
+        quantity:,
+        # A date string to specify the line item's start date in the customer's timezone.
+        start_date:,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/orb/models/invoice_line_item_create_response.rbi

@@ -275,27 +275,65 @@ module Orb
           .returns(T.attached_class)
       end
       def self.new(
+        # A unique ID for this line item.
         id:,
+        # The line amount after any adjustments and before overage conversion, credits and
+        # partial invoicing.
         adjusted_subtotal:,
+        # All adjustments applied to the line item in the order they were applied based on
+        # invoice calculations (ie. usage discounts -> amount discounts -> percentage
+        # discounts -> minimums -> maximums).
         adjustments:,
+        # The final amount for a line item after all adjustments and pre paid credits have
+        # been applied.
         amount:,
+        # The number of prepaid credits applied.
         credits_applied:,
         discount:,
+        # The end date of the range of time applied for this line item's price.
         end_date:,
+        # An additional filter that was used to calculate the usage for this line item.
         filter:,
+        # [DEPRECATED] For configured prices that are split by a grouping key, this will
+        # be populated with the key and a value. The `amount` and `subtotal` will be the
+        # values for this particular grouping.
         grouping:,
+        # This field is deprecated in favor of `adjustments`.
         maximum:,
+        # This field is deprecated in favor of `adjustments`.
         maximum_amount:,
+        # This field is deprecated in favor of `adjustments`.
         minimum:,
+        # This field is deprecated in favor of `adjustments`.
         minimum_amount:,
+        # The name of the price associated with this line item.
         name:,
+        # Any amount applied from a partial invoice
         partially_invoiced_amount:,
+        # The Price resource represents a price that can be billed on a subscription,
+        # resulting in a charge on an invoice in the form of an invoice line item. Prices
+        # take a quantity and determine an amount to bill.
+        #
+        # Orb supports a few different pricing models out of the box. Each of these models
+        # is serialized differently in a given Price object. The model_type field
+        # determines the key for the configuration object that is present.
+        #
+        # For more on the types of prices, see
+        # [the core concepts documentation](/core-concepts#plan-and-price)
         price:,
+        # Either the fixed fee quantity or the usage during the service period.
         quantity:,
+        # The start date of the range of time applied for this line item's price.
         start_date:,
+        # For complex pricing structures, the line item can be broken down further in
+        # `sub_line_items`.
         sub_line_items:,
+        # The line amount before before any adjustments.
         subtotal:,
+        # An array of tax rates and their incurred tax amounts. Empty if no tax
+        # integration is configured.
         tax_amounts:,
+        # A list of customer ids that were used to calculate the usage for this line item.
         usage_customer_ids:
       ); end
       sig do
@@ -427,10 +465,17 @@ module Orb
           end
           def self.new(
             id:,
+            # The value applied by an adjustment.
             amount:,
+            # The price IDs that this adjustment applies to.
             applies_to_price_ids:,
+            # True for adjustments that apply to an entire invocice, false for adjustments
+            # that apply to only one price.
             is_invoice_level:,
+            # The reason for the adjustment.
             reason:,
+            # The number of usage units by which to discount the price this adjustment applies
+            # to in a given billing period.
             usage_discount:,
             adjustment_type: :usage_discount
           ); end
@@ -494,10 +539,17 @@ module Orb
           end
           def self.new(
             id:,
+            # The value applied by an adjustment.
             amount:,
+            # The amount by which to discount the prices this adjustment applies to in a given
+            # billing period.
             amount_discount:,
+            # The price IDs that this adjustment applies to.
             applies_to_price_ids:,
+            # True for adjustments that apply to an entire invocice, false for adjustments
+            # that apply to only one price.
             is_invoice_level:,
+            # The reason for the adjustment.
             reason:,
             adjustment_type: :amount_discount
           ); end
@@ -561,10 +613,17 @@ module Orb
           end
           def self.new(
             id:,
+            # The value applied by an adjustment.
             amount:,
+            # The price IDs that this adjustment applies to.
             applies_to_price_ids:,
+            # True for adjustments that apply to an entire invocice, false for adjustments
+            # that apply to only one price.
             is_invoice_level:,
+            # The percentage (as a value between 0 and 1) by which to discount the price
+            # intervals this adjustment applies to in a given billing period.
             percentage_discount:,
+            # The reason for the adjustment.
             reason:,
             adjustment_type: :percentage_discount
           ); end
@@ -633,11 +692,19 @@ module Orb
           end
           def self.new(
             id:,
+            # The value applied by an adjustment.
             amount:,
+            # The price IDs that this adjustment applies to.
             applies_to_price_ids:,
+            # True for adjustments that apply to an entire invocice, false for adjustments
+            # that apply to only one price.
             is_invoice_level:,
+            # The item ID that revenue from this minimum will be attributed to.
             item_id:,
+            # The minimum amount to charge in a given billing period for the prices this
+            # adjustment applies to.
             minimum_amount:,
+            # The reason for the adjustment.
             reason:,
             adjustment_type: :minimum
           ); end
@@ -702,10 +769,17 @@ module Orb
           end
           def self.new(
             id:,
+            # The value applied by an adjustment.
             amount:,
+            # The price IDs that this adjustment applies to.
             applies_to_price_ids:,
+            # True for adjustments that apply to an entire invocice, false for adjustments
+            # that apply to only one price.
             is_invoice_level:,
+            # The maximum amount to charge in a given billing period for the prices this
+            # adjustment applies to.
             maximum_amount:,
+            # The reason for the adjustment.
             reason:,
             adjustment_type: :maximum
           ); end
@@ -749,8 +823,13 @@ module Orb
         sig do
           params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class)
         end
-        def self.new(applies_to_price_ids:, maximum_amount:); end
-
+        def self.new(
+          # List of price_ids that this maximum amount applies to. For plan/plan phase
+          # maximums, this can be a subset of prices.
+          applies_to_price_ids:,
+          # Maximum amount applied
+          maximum_amount:
+        ); end
         sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) }
         def to_hash; end
       end
@@ -769,8 +848,13 @@ module Orb
         sig do
           params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class)
         end
-        def self.new(applies_to_price_ids:, minimum_amount:); end
-
+        def self.new(
+          # List of price_ids that this minimum amount applies to. For plan/plan phase
+          # minimums, this can be a subset of prices.
+          applies_to_price_ids:,
+          # Minimum amount applied
+          minimum_amount:
+        ); end
         sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) }
         def to_hash; end
       end
@@ -841,8 +925,15 @@ module Orb
             )
               .returns(T.attached_class)
           end
-          def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix); end
-
+          def self.new(
+            # The total amount for this sub line item.
+            amount:,
+            grouping:,
+            matrix_config:,
+            name:,
+            quantity:,
+            type: :matrix
+          ); end
           sig do
             override
               .returns(
@@ -867,8 +958,11 @@ module Orb
             attr_accessor :value
 
             sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
-            def self.new(key:, value:); end
-
+            def self.new(
+              key:,
+              # No value indicates the default group
+              value:
+            ); end
             sig { override.returns({key: String, value: T.nilable(String)}) }
             def to_hash; end
           end
@@ -879,8 +973,10 @@ module Orb
             attr_accessor :dimension_values
 
             sig { params(dimension_values: T::Array[T.nilable(String)]).returns(T.attached_class) }
-            def self.new(dimension_values:); end
-
+            def self.new(
+              # The ordered dimension values for this line item.
+              dimension_values:
+            ); end
             sig { override.returns({dimension_values: T::Array[T.nilable(String)]}) }
             def to_hash; end
           end
@@ -949,8 +1045,15 @@ module Orb
             )
               .returns(T.attached_class)
           end
-          def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier); end
-
+          def self.new(
+            # The total amount for this sub line item.
+            amount:,
+            grouping:,
+            name:,
+            quantity:,
+            tier_config:,
+            type: :tier
+          ); end
           sig do
             override
               .returns(
@@ -975,8 +1078,11 @@ module Orb
             attr_accessor :value
 
             sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
-            def self.new(key:, value:); end
-
+            def self.new(
+              key:,
+              # No value indicates the default group
+              value:
+            ); end
             sig { override.returns({key: String, value: T.nilable(String)}) }
             def to_hash; end
           end
@@ -1050,8 +1156,14 @@ module Orb
             )
               .returns(T.attached_class)
           end
-          def self.new(amount:, grouping:, name:, quantity:, type: :"'null'"); end
-
+          def self.new(
+            # The total amount for this sub line item.
+            amount:,
+            grouping:,
+            name:,
+            quantity:,
+            type: :"'null'"
+          ); end
           sig do
             override
               .returns(
@@ -1075,8 +1187,11 @@ module Orb
             attr_accessor :value
 
             sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
-            def self.new(key:, value:); end
-
+            def self.new(
+              key:,
+              # No value indicates the default group
+              value:
+            ); end
             sig { override.returns({key: String, value: T.nilable(String)}) }
             def to_hash; end
           end
@@ -1108,8 +1223,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(
             {

data/rbi/lib/orb/models/invoice_list_params.rbi

@@ -102,10 +102,16 @@ module Orb
         amount: nil,
         amount_gt: nil,
         amount_lt: nil,
+        # Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # from the initial request.
         cursor: nil,
         customer_id: nil,
         date_type: nil,
         due_date: nil,
+        # Filters invoices by their due dates within a specific time range in the past.
+        # Specify the range as a number followed by 'd' (days) or 'm' (months). For
+        # example, '7d' filters invoices due in the last 7 days, and '2m' filters those
+        # due in the last 2 months.
         due_date_window: nil,
         due_date_gt: nil,
         due_date_lt: nil,
@@ -115,6 +121,7 @@ module Orb
         invoice_date_lt: nil,
         invoice_date_lte: nil,
         is_recurring: nil,
+        # The number of items to fetch. Defaults to 20.
         limit: nil,
         status: nil,
         subscription_id: nil,
@@ -153,7 +160,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceListParams::DateType) }
-        OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceListParams::DateType::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         DUE_DATE = T.let(:due_date, Orb::Models::InvoiceListParams::DateType::TaggedSymbol)
         INVOICE_DATE = T.let(:invoice_date, Orb::Models::InvoiceListParams::DateType::TaggedSymbol)
@@ -166,7 +173,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceListParams::Status) }
-        OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceListParams::Status::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         DRAFT = T.let(:draft, Orb::Models::InvoiceListParams::Status::TaggedSymbol)
         ISSUED = T.let(:issued, Orb::Models::InvoiceListParams::Status::TaggedSymbol)

data/rbi/lib/orb/models/invoice_mark_paid_params.rbi

@@ -27,8 +27,15 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(payment_received_date:, external_id: nil, notes: nil, request_options: {}); end
-
+      def self.new(
+        # A date string to specify the date of the payment.
+        payment_received_date:,
+        # An optional external ID to associate with the payment.
+        external_id: nil,
+        # An optional note to associate with the payment.
+        notes: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/orb/models/invoice_update_params.rbi

@@ -19,8 +19,13 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(metadata: nil, request_options: {}); end
-
+      def self.new(
+        # User-specified key/value pairs for the resource. 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: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns({

data/rbi/lib/orb/models/item.rbi

@@ -74,8 +74,7 @@ module Orb
 
           TaggedSymbol =
             T.type_alias { T.all(Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           STRIPE = T.let(:stripe, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol)
           QUICKBOOKS =

data/rbi/lib/orb/models/item_create_params.rbi

@@ -14,8 +14,11 @@ module Orb
         params(name: String, request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
           .returns(T.attached_class)
       end
-      def self.new(name:, request_options: {}); end
-
+      def self.new(
+        # The name of the item.
+        name:,
+        request_options: {}
+      ); end
       sig { override.returns({name: String, request_options: Orb::RequestOptions}) }
       def to_hash; end
     end

data/rbi/lib/orb/models/item_list_params.rbi

@@ -26,8 +26,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/item_update_params.rbi

@@ -66,14 +66,7 @@ module Orb
 
           TaggedSymbol =
             T.type_alias { T.all(Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName) }
-          OrSymbol =
-            T.type_alias do
-              T.any(
-                Symbol,
-                String,
-                Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol
-              )
-            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           STRIPE =
             T.let(:stripe, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol)

data/rbi/lib/orb/models/metric_create_params.rbi

@@ -39,8 +39,21 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(description:, item_id:, name:, sql:, metadata: nil, request_options: {}); end
-
+      def self.new(
+        # A description of the metric.
+        description:,
+        # The id of the item
+        item_id:,
+        # The name of the metric.
+        name:,
+        # A sql string defining the metric.
+        sql:,
+        # User-specified key/value pairs for the resource. 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: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/orb/models/metric_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

data/rbi/lib/orb/models/metric_update_params.rbi

@@ -19,8 +19,13 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(metadata: nil, request_options: {}); end
-
+      def self.new(
+        # User-specified key/value pairs for the resource. 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: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns({

data/rbi/lib/orb/models/percentage_discount.rbi

@@ -28,8 +28,16 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(applies_to_price_ids:, discount_type:, percentage_discount:, reason: nil); end
-
+      def self.new(
+        # 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:,
+        # Only available if discount_type is `percentage`. This is a number between 0
+        # and 1.
+        percentage_discount:,
+        reason: nil
+      ); end
       sig do
         override
           .returns(
@@ -47,8 +55,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PercentageDiscount::DiscountType) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::PercentageDiscount::DiscountType::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         PERCENTAGE = T.let(:percentage, Orb::Models::PercentageDiscount::DiscountType::TaggedSymbol)