orb-billing 0.1.3 → 0.3.0

data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi

@@ -77,13 +77,25 @@ module Orb
               .returns(T.attached_class)
           end
           def self.new(
+            # The amount to increment when the threshold is reached.
             amount:,
+            # The currency or custom pricing unit to use for this top-up. If this is a
+            # real-world currency, it must match the customer's invoicing currency.
             currency:,
+            # Settings for invoices generated by triggered top-ups.
             invoice_settings:,
+            # How much, in the customer's currency, to charge for each unit.
             per_unit_cost_basis:,
+            # The threshold at which to trigger the top-up. If the balance is at or below this
+            # threshold, the top-up will be triggered.
             threshold:,
+            # The date from which the top-up is active. If unspecified, the top-up is active
+            # immediately.
             active_from: nil,
+            # The number of days or months after which the top-up expires. If unspecified, it
+            # does not expire.
             expires_after: nil,
+            # The unit of expires_after.
             expires_after_unit: nil,
             request_options: {}
           ); end
@@ -139,8 +151,20 @@ module Orb
               )
                 .returns(T.attached_class)
             end
-            def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end
-
+            def self.new(
+              # Whether the credits purchase invoice should auto collect with the customer's
+              # saved payment method.
+              auto_collection:,
+              # The net terms determines the difference between the invoice date and the issue
+              # date for the invoice. If you intend the invoice to be due on issue, set this
+              # to 0.
+              net_terms:,
+              # An optional memo to display on the invoice.
+              memo: nil,
+              # If true, new credit blocks created by this top-up will require that the
+              # corresponding invoice is paid before they can be drawn down from.
+              require_successful_payment: nil
+            ); end
             sig do
               override
                 .returns(
@@ -161,14 +185,7 @@ module Orb
 
             TaggedSymbol =
               T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit) }
-            OrSymbol =
-              T.type_alias do
-                T.any(
-                  Symbol,
-                  String,
-                  Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::TaggedSymbol
-                )
-              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             DAY =
               T.let(

data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi

@@ -74,12 +74,22 @@ module Orb
           end
           def self.new(
             id:,
+            # The amount to increment when the threshold is reached.
             amount:,
+            # The currency or custom pricing unit to use for this top-up. If this is a
+            # real-world currency, it must match the customer's invoicing currency.
             currency:,
+            # Settings for invoices generated by triggered top-ups.
             invoice_settings:,
+            # How much, in the customer's currency, to charge for each unit.
             per_unit_cost_basis:,
+            # The threshold at which to trigger the top-up. If the balance is at or below this
+            # threshold, the top-up will be triggered.
             threshold:,
+            # The number of days or months after which the top-up expires. If unspecified, it
+            # does not expire.
             expires_after: nil,
+            # The unit of expires_after.
             expires_after_unit: nil
           ); end
           sig do
@@ -135,8 +145,20 @@ module Orb
               )
                 .returns(T.attached_class)
             end
-            def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end
-
+            def self.new(
+              # Whether the credits purchase invoice should auto collect with the customer's
+              # saved payment method.
+              auto_collection:,
+              # The net terms determines the difference between the invoice date and the issue
+              # date for the invoice. If you intend the invoice to be due on issue, set this
+              # to 0.
+              net_terms:,
+              # An optional memo to display on the invoice.
+              memo: nil,
+              # If true, new credit blocks created by this top-up will require that the
+              # corresponding invoice is paid before they can be drawn down from.
+              require_successful_payment: nil
+            ); end
             sig do
               override
                 .returns(
@@ -157,14 +179,7 @@ module Orb
 
             TaggedSymbol =
               T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit) }
-            OrSymbol =
-              T.type_alias do
-                T.any(
-                  Symbol,
-                  String,
-                  Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol
-                )
-              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             DAY =
               T.let(

data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi

@@ -67,13 +67,25 @@ module Orb
               .returns(T.attached_class)
           end
           def self.new(
+            # The amount to increment when the threshold is reached.
             amount:,
+            # The currency or custom pricing unit to use for this top-up. If this is a
+            # real-world currency, it must match the customer's invoicing currency.
             currency:,
+            # Settings for invoices generated by triggered top-ups.
             invoice_settings:,
+            # How much, in the customer's currency, to charge for each unit.
             per_unit_cost_basis:,
+            # The threshold at which to trigger the top-up. If the balance is at or below this
+            # threshold, the top-up will be triggered.
             threshold:,
+            # The date from which the top-up is active. If unspecified, the top-up is active
+            # immediately.
             active_from: nil,
+            # The number of days or months after which the top-up expires. If unspecified, it
+            # does not expire.
             expires_after: nil,
+            # The unit of expires_after.
             expires_after_unit: nil,
             request_options: {}
           ); end
@@ -129,8 +141,20 @@ module Orb
               )
                 .returns(T.attached_class)
             end
-            def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end
-
+            def self.new(
+              # Whether the credits purchase invoice should auto collect with the customer's
+              # saved payment method.
+              auto_collection:,
+              # The net terms determines the difference between the invoice date and the issue
+              # date for the invoice. If you intend the invoice to be due on issue, set this
+              # to 0.
+              net_terms:,
+              # An optional memo to display on the invoice.
+              memo: nil,
+              # If true, new credit blocks created by this top-up will require that the
+              # corresponding invoice is paid before they can be drawn down from.
+              require_successful_payment: nil
+            ); end
             sig do
               override
                 .returns(
@@ -151,8 +175,7 @@ module Orb
 
             TaggedSymbol =
               T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit) }
-            OrSymbol =
-              T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             DAY = T.let(:day, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol)
             MONTH = T.let(:month, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol)

data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi

@@ -62,12 +62,22 @@ module Orb
           end
           def self.new(
             id:,
+            # The amount to increment when the threshold is reached.
             amount:,
+            # The currency or custom pricing unit to use for this top-up. If this is a
+            # real-world currency, it must match the customer's invoicing currency.
             currency:,
+            # Settings for invoices generated by triggered top-ups.
             invoice_settings:,
+            # How much, in the customer's currency, to charge for each unit.
             per_unit_cost_basis:,
+            # The threshold at which to trigger the top-up. If the balance is at or below this
+            # threshold, the top-up will be triggered.
             threshold:,
+            # The number of days or months after which the top-up expires. If unspecified, it
+            # does not expire.
             expires_after: nil,
+            # The unit of expires_after.
             expires_after_unit: nil
           ); end
           sig do
@@ -121,8 +131,20 @@ module Orb
               )
                 .returns(T.attached_class)
             end
-            def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end
-
+            def self.new(
+              # Whether the credits purchase invoice should auto collect with the customer's
+              # saved payment method.
+              auto_collection:,
+              # The net terms determines the difference between the invoice date and the issue
+              # date for the invoice. If you intend the invoice to be due on issue, set this
+              # to 0.
+              net_terms:,
+              # An optional memo to display on the invoice.
+              memo: nil,
+              # If true, new credit blocks created by this top-up will require that the
+              # corresponding invoice is paid before they can be drawn down from.
+              require_successful_payment: nil
+            ); end
             sig do
               override
                 .returns(
@@ -143,14 +165,7 @@ module Orb
 
             TaggedSymbol =
               T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit) }
-            OrSymbol =
-              T.type_alias do
-                T.any(
-                  Symbol,
-                  String,
-                  Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit::TaggedSymbol
-                )
-              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             DAY = T.let(:day, Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit::TaggedSymbol)
             MONTH =

data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi

@@ -28,8 +28,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(
               {

data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi

@@ -72,12 +72,22 @@ module Orb
           end
           def self.new(
             id:,
+            # The amount to increment when the threshold is reached.
             amount:,
+            # The currency or custom pricing unit to use for this top-up. If this is a
+            # real-world currency, it must match the customer's invoicing currency.
             currency:,
+            # Settings for invoices generated by triggered top-ups.
             invoice_settings:,
+            # How much, in the customer's currency, to charge for each unit.
             per_unit_cost_basis:,
+            # The threshold at which to trigger the top-up. If the balance is at or below this
+            # threshold, the top-up will be triggered.
             threshold:,
+            # The number of days or months after which the top-up expires. If unspecified, it
+            # does not expire.
             expires_after: nil,
+            # The unit of expires_after.
             expires_after_unit: nil
           ); end
           sig do
@@ -131,8 +141,20 @@ module Orb
               )
                 .returns(T.attached_class)
             end
-            def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end
-
+            def self.new(
+              # Whether the credits purchase invoice should auto collect with the customer's
+              # saved payment method.
+              auto_collection:,
+              # The net terms determines the difference between the invoice date and the issue
+              # date for the invoice. If you intend the invoice to be due on issue, set this
+              # to 0.
+              net_terms:,
+              # An optional memo to display on the invoice.
+              memo: nil,
+              # If true, new credit blocks created by this top-up will require that the
+              # corresponding invoice is paid before they can be drawn down from.
+              require_successful_payment: nil
+            ); end
             sig do
               override
                 .returns(
@@ -153,14 +175,7 @@ module Orb
 
             TaggedSymbol =
               T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit) }
-            OrSymbol =
-              T.type_alias do
-                T.any(
-                  Symbol,
-                  String,
-                  Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol
-                )
-              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             DAY =
               T.let(

data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi

@@ -28,8 +28,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(
               {

data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi

@@ -62,12 +62,22 @@ module Orb
           end
           def self.new(
             id:,
+            # The amount to increment when the threshold is reached.
             amount:,
+            # The currency or custom pricing unit to use for this top-up. If this is a
+            # real-world currency, it must match the customer's invoicing currency.
             currency:,
+            # Settings for invoices generated by triggered top-ups.
             invoice_settings:,
+            # How much, in the customer's currency, to charge for each unit.
             per_unit_cost_basis:,
+            # The threshold at which to trigger the top-up. If the balance is at or below this
+            # threshold, the top-up will be triggered.
             threshold:,
+            # The number of days or months after which the top-up expires. If unspecified, it
+            # does not expire.
             expires_after: nil,
+            # The unit of expires_after.
             expires_after_unit: nil
           ); end
           sig do
@@ -121,8 +131,20 @@ module Orb
               )
                 .returns(T.attached_class)
             end
-            def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end
-
+            def self.new(
+              # Whether the credits purchase invoice should auto collect with the customer's
+              # saved payment method.
+              auto_collection:,
+              # The net terms determines the difference between the invoice date and the issue
+              # date for the invoice. If you intend the invoice to be due on issue, set this
+              # to 0.
+              net_terms:,
+              # An optional memo to display on the invoice.
+              memo: nil,
+              # If true, new credit blocks created by this top-up will require that the
+              # corresponding invoice is paid before they can be drawn down from.
+              require_successful_payment: nil
+            ); end
             sig do
               override
                 .returns(
@@ -143,8 +165,7 @@ module Orb
 
             TaggedSymbol =
               T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit) }
-            OrSymbol =
-              T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit::TaggedSymbol) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             DAY = T.let(:day, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit::TaggedSymbol)
             MONTH = T.let(:month, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit::TaggedSymbol)

data/rbi/lib/orb/models/dimensional_price_group.rbi

@@ -47,14 +47,22 @@ module Orb
       end
       def self.new(
         id:,
+        # The billable metric associated with this dimensional price group. All prices
+        # associated with this dimensional price group will be computed using this
+        # billable metric.
         billable_metric_id:,
+        # The dimensions that this dimensional price group is defined over
         dimensions:,
+        # An alias for the dimensional price group
         external_dimensional_price_group_id:,
+        # 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:,
+        # The name of the dimensional price group
         name:
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi

@@ -38,9 +38,13 @@ module Orb
       end
       def self.new(
         billable_metric_id:,
+        # The set of keys (in order) used to disambiguate prices in the group.
         dimensions:,
         name:,
         external_dimensional_price_group_id: nil,
+        # 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

data/rbi/lib/orb/models/dimensional_price_group_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/evaluate_price_group.rbi

@@ -19,8 +19,14 @@ module Orb
         params(amount: String, grouping_values: T::Array[T.any(String, Float, T::Boolean)], quantity: Float)
           .returns(T.attached_class)
       end
-      def self.new(amount:, grouping_values:, quantity:); end
-
+      def self.new(
+        # The price's output for the group
+        amount:,
+        # The values for the group in the order specified by `grouping_keys`
+        grouping_values:,
+        # The price's usage quantity for the group
+        quantity:
+      ); end
       sig do
         override
           .returns({

data/rbi/lib/orb/models/event_deprecate_response.rbi

@@ -8,8 +8,10 @@ module Orb
       attr_accessor :deprecated
 
       sig { params(deprecated: String).returns(T.attached_class) }
-      def self.new(deprecated:); end
-
+      def self.new(
+        # event_id of the deprecated event, if successfully updated
+        deprecated:
+      ); end
       sig { override.returns({deprecated: String}) }
       def to_hash; end
     end

data/rbi/lib/orb/models/event_ingest_params.rbi

@@ -30,8 +30,15 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(events:, backfill_id: nil, debug: nil, request_options: {}); end
-
+      def self.new(
+        events:,
+        # If this ingestion request is part of a backfill, this parameter ties the
+        # ingested events to the backfill
+        backfill_id: nil,
+        # Flag to enable additional debug information in the endpoint response
+        debug: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(
@@ -88,15 +95,25 @@ module Orb
             .returns(T.attached_class)
         end
         def self.new(
+          # A name to meaningfully identify the action or event type.
           event_name:,
+          # A unique value, generated by the client, that is used to de-duplicate events.
+          # Exactly one event with a given idempotency key will be ingested, which allows
+          # for safe request retries.
           idempotency_key:,
+          # A dictionary of custom properties. Values in this dictionary must be numeric,
+          # boolean, or strings. Nested dictionaries are disallowed.
           properties:,
+          # An ISO 8601 format date with no timezone offset (i.e. UTC). This should
+          # represent the time that usage was recorded, and is particularly important to
+          # attribute usage to a given billing period.
           timestamp:,
+          # The Orb Customer identifier
           customer_id: nil,
+          # An alias for the Orb customer, whose mapping is specified when creating the
+          # customer
           external_customer_id: nil
-        )
-        end
-
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/orb/models/event_ingest_response.rbi

@@ -23,8 +23,14 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(validation_failed:, debug: nil); end
-
+      def self.new(
+        # Contains all failing validation events. In the case of a 200, this array will
+        # always be empty. This field will always be present.
+        validation_failed:,
+        # Optional debug information (only present when debug=true is passed to the
+        # endpoint). Contains ingested and duplicate event idempotency keys.
+        debug: nil
+      ); end
       sig do
         override
           .returns(
@@ -47,8 +53,13 @@ module Orb
         attr_accessor :validation_errors
 
         sig { params(idempotency_key: String, validation_errors: T::Array[String]).returns(T.attached_class) }
-        def self.new(idempotency_key:, validation_errors:); end
-
+        def self.new(
+          # The passed idempotency_key corresponding to the validation_errors
+          idempotency_key:,
+          # An array of strings corresponding to validation failures for this
+          # idempotency_key.
+          validation_errors:
+        ); end
         sig { override.returns({idempotency_key: String, validation_errors: T::Array[String]}) }
         def to_hash; end
       end

data/rbi/lib/orb/models/event_search_params.rbi

@@ -32,8 +32,20 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {}); end
-
+      def self.new(
+        # This is an explicit array of IDs to filter by. Note that an event's ID is the
+        # idempotency_key that was originally used for ingestion, and this only supports
+        # events that have not been amended. Values in this array will be treated case
+        # sensitively.
+        event_ids:,
+        # The end of the timeframe, exclusive, in which to search events. If not
+        # specified, the current time is used.
+        timeframe_end: nil,
+        # The start of the timeframe, inclusive, in which to search events. If not
+        # specified, the one week ago is used.
+        timeframe_start: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/orb/models/event_search_response.rbi

@@ -66,16 +66,27 @@ module Orb
             .returns(T.attached_class)
         end
         def self.new(
+          # A unique value, generated by the client, that is used to de-duplicate events.
+          # Exactly one event with a given idempotency key will be ingested, which allows
+          # for safe request retries.
           id:,
+          # The Orb Customer identifier
           customer_id:,
+          # A boolean indicating whether the event is currently deprecated.
           deprecated:,
+          # A name to meaningfully identify the action or event type.
           event_name:,
+          # An alias for the Orb customer, whose mapping is specified when creating the
+          # customer
           external_customer_id:,
+          # A dictionary of custom properties. Values in this dictionary must be numeric,
+          # boolean, or strings. Nested dictionaries are disallowed.
           properties:,
+          # An ISO 8601 format date with no timezone offset (i.e. UTC). This should
+          # represent the time that usage was recorded, and is particularly important to
+          # attribute usage to a given billing period.
           timestamp:
-        )
-        end
-
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/orb/models/event_update_params.rbi

@@ -42,15 +42,22 @@ module Orb
           .returns(T.attached_class)
       end
       def self.new(
+        # A name to meaningfully identify the action or event type.
         event_name:,
+        # A dictionary of custom properties. Values in this dictionary must be numeric,
+        # boolean, or strings. Nested dictionaries are disallowed.
         properties:,
+        # An ISO 8601 format date with no timezone offset (i.e. UTC). This should
+        # represent the time that usage was recorded, and is particularly important to
+        # attribute usage to a given billing period.
         timestamp:,
+        # The Orb Customer identifier
         customer_id: nil,
+        # An alias for the Orb customer, whose mapping is specified when creating the
+        # customer
         external_customer_id: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/orb/models/event_update_response.rbi

@@ -8,8 +8,10 @@ module Orb
       attr_accessor :amended
 
       sig { params(amended: String).returns(T.attached_class) }
-      def self.new(amended:); end
-
+      def self.new(
+        # event_id of the amended event, if successfully ingested
+        amended:
+      ); end
       sig { override.returns({amended: String}) }
       def to_hash; end
     end