orb-billing 0.2.0 → 0.3.1

data/rbi/{lib/orb → 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 → 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 → 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 → 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 → 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 → 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 → 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 → 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 → 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 → 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 → 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)