orb-billing 1.13.0 → 1.15.0

data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb

@@ -9,6 +9,11 @@ module Orb
           extend Orb::Internal::Type::RequestParameters::Converter
           include Orb::Internal::Type::RequestParameters
 
+          # @!attribute external_customer_id
+          #
+          #   @return [String]
+          required :external_customer_id, String
+
           # @!attribute created_at_gt
           #
           #   @return [Time, nil]
@@ -67,11 +72,13 @@ module Orb
           #   @return [String, nil]
           optional :minimum_amount, String, nil?: true
 
-          # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {})
+          # @!method initialize(external_customer_id:, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Customers::Credits::LedgerListByExternalIDParams} for more
           #   details.
           #
+          #   @param external_customer_id [String]
+          #
           #   @param created_at_gt [Time, nil]
           #
           #   @param created_at_gte [Time, nil]

data/lib/orb/models/customers/credits/ledger_list_params.rb

@@ -9,6 +9,11 @@ module Orb
           extend Orb::Internal::Type::RequestParameters::Converter
           include Orb::Internal::Type::RequestParameters
 
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
           # @!attribute created_at_gt
           #
           #   @return [Time, nil]
@@ -67,10 +72,12 @@ module Orb
           #   @return [String, nil]
           optional :minimum_amount, String, nil?: true
 
-          # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {})
+          # @!method initialize(customer_id:, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Customers::Credits::LedgerListParams} for more details.
           #
+          #   @param customer_id [String]
+          #
           #   @param created_at_gt [Time, nil]
           #
           #   @param created_at_gte [Time, nil]

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

@@ -9,6 +9,11 @@ module Orb
           extend Orb::Internal::Type::RequestParameters::Converter
           include Orb::Internal::Type::RequestParameters
 
+          # @!attribute external_customer_id
+          #
+          #   @return [String]
+          required :external_customer_id, String
+
           # @!attribute amount
           #   The amount to increment when the threshold is reached.
           #
@@ -63,11 +68,13 @@ module Orb
                    enum: -> { Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit },
                    nil?: true
 
-          # @!method initialize(amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
+          # @!method initialize(external_customer_id:, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams} for more
           #   details.
           #
+          #   @param external_customer_id [String]
+          #
           #   @param amount [String] The amount to increment when the threshold is reached.
           #
           #   @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo

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

@@ -9,6 +9,11 @@ module Orb
           extend Orb::Internal::Type::RequestParameters::Converter
           include Orb::Internal::Type::RequestParameters
 
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
           # @!attribute amount
           #   The amount to increment when the threshold is reached.
           #
@@ -63,10 +68,12 @@ module Orb
                    enum: -> { Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit },
                    nil?: true
 
-          # @!method initialize(amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
+          # @!method initialize(customer_id:, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Customers::Credits::TopUpCreateParams} for more details.
           #
+          #   @param customer_id [String]
+          #
           #   @param amount [String] The amount to increment when the threshold is reached.
           #
           #   @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo

data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb

@@ -14,8 +14,14 @@ module Orb
           #   @return [String]
           required :external_customer_id, String
 
-          # @!method initialize(external_customer_id:, request_options: {})
+          # @!attribute top_up_id
+          #
+          #   @return [String]
+          required :top_up_id, String
+
+          # @!method initialize(external_customer_id:, top_up_id:, request_options: {})
           #   @param external_customer_id [String]
+          #   @param top_up_id [String]
           #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
         end
       end

data/lib/orb/models/customers/credits/top_up_delete_params.rb

@@ -14,8 +14,14 @@ module Orb
           #   @return [String]
           required :customer_id, String
 
-          # @!method initialize(customer_id:, request_options: {})
+          # @!attribute top_up_id
+          #
+          #   @return [String]
+          required :top_up_id, String
+
+          # @!method initialize(customer_id:, top_up_id:, request_options: {})
           #   @param customer_id [String]
+          #   @param top_up_id [String]
           #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
         end
       end

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

@@ -9,6 +9,11 @@ module Orb
           extend Orb::Internal::Type::RequestParameters::Converter
           include Orb::Internal::Type::RequestParameters
 
+          # @!attribute external_customer_id
+          #
+          #   @return [String]
+          required :external_customer_id, String
+
           # @!attribute cursor
           #   Cursor for pagination. This can be populated by the `next_cursor` value returned
           #   from the initial request.
@@ -22,10 +27,12 @@ module Orb
           #   @return [Integer, nil]
           optional :limit, Integer
 
-          # @!method initialize(cursor: nil, limit: nil, request_options: {})
+          # @!method initialize(external_customer_id:, cursor: nil, limit: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Customers::Credits::TopUpListByExternalIDParams} for more details.
           #
+          #   @param external_customer_id [String]
+          #
           #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
           #
           #   @param limit [Integer] The number of items to fetch. Defaults to 20.

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

@@ -9,6 +9,11 @@ module Orb
           extend Orb::Internal::Type::RequestParameters::Converter
           include Orb::Internal::Type::RequestParameters
 
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
           # @!attribute cursor
           #   Cursor for pagination. This can be populated by the `next_cursor` value returned
           #   from the initial request.
@@ -22,10 +27,12 @@ module Orb
           #   @return [Integer, nil]
           optional :limit, Integer
 
-          # @!method initialize(cursor: nil, limit: nil, request_options: {})
+          # @!method initialize(customer_id:, cursor: nil, limit: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Customers::Credits::TopUpListParams} for more details.
           #
+          #   @param customer_id [String]
+          #
           #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
           #
           #   @param limit [Integer] The number of items to fetch. Defaults to 20.

data/lib/orb/models/dimensional_price_group.rb

@@ -49,7 +49,7 @@ module Orb
       #   {Orb::Models::DimensionalPriceGroup} for more details.
       #
       #   A dimensional price group is used to partition the result of a billable metric
-      #   by a set of dimensions. Prices in a price group must specify the parition used
+      #   by a set of dimensions. Prices in a price group must specify the partition used
       #   to derive their usage.
       #
       #   @param id [String]

data/lib/orb/models/dimensional_price_group_retrieve_params.rb

@@ -7,7 +7,13 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute dimensional_price_group_id
+      #
+      #   @return [String]
+      required :dimensional_price_group_id, String
+
+      # @!method initialize(dimensional_price_group_id:, request_options: {})
+      #   @param dimensional_price_group_id [String]
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/dimensional_price_group_update_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute dimensional_price_group_id
+      #
+      #   @return [String]
+      required :dimensional_price_group_id, String
+
       # @!attribute external_dimensional_price_group_id
       #   An optional user-defined ID for this dimensional price group resource, used
       #   throughout the system as an alias for this dimensional price group. Use this
@@ -24,10 +29,12 @@ module Orb
       #   @return [Hash{Symbol=>String, nil}, nil]
       optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
 
-      # @!method initialize(external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
+      # @!method initialize(dimensional_price_group_id:, external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::DimensionalPriceGroupUpdateParams} for more details.
       #
+      #   @param dimensional_price_group_id [String]
+      #
       #   @param external_dimensional_price_group_id [String, nil] An optional user-defined ID for this dimensional price group resource, used thro
       #
       #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed

data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb

@@ -8,7 +8,13 @@ module Orb
         extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute external_dimensional_price_group_id
+        #
+        #   @return [String]
+        required :external_dimensional_price_group_id, String
+
+        # @!method initialize(external_dimensional_price_group_id:, request_options: {})
+        #   @param external_dimensional_price_group_id [String]
         #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rb

@@ -8,6 +8,11 @@ module Orb
         extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
+        # @!attribute path_external_dimensional_price_group_id
+        #
+        #   @return [String]
+        required :path_external_dimensional_price_group_id, String
+
         # @!attribute body_external_dimensional_price_group_id
         #   An optional user-defined ID for this dimensional price group resource, used
         #   throughout the system as an alias for this dimensional price group. Use this
@@ -28,11 +33,13 @@ module Orb
         #   @return [Hash{Symbol=>String, nil}, nil]
         optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
 
-        # @!method initialize(body_external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
+        # @!method initialize(path_external_dimensional_price_group_id:, body_external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::DimensionalPriceGroups::ExternalDimensionalPriceGroupIDUpdateParams}
         #   for more details.
         #
+        #   @param path_external_dimensional_price_group_id [String]
+        #
         #   @param body_external_dimensional_price_group_id [String, nil] An optional user-defined ID for this dimensional price group resource, used thro
         #
         #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed

data/lib/orb/models/discount.rb

@@ -15,8 +15,152 @@ module Orb
 
       variant :amount, -> { Orb::AmountDiscount }
 
+      variant :tiered_percentage, -> { Orb::Discount::TieredPercentage }
+
+      class TieredPercentage < Orb::Internal::Type::BaseModel
+        # @!attribute discount_type
+        #
+        #   @return [Symbol, :tiered_percentage]
+        required :discount_type, const: :tiered_percentage
+
+        # @!attribute tiers
+        #   Only available if discount_type is `tiered_percentage`. The ordered, contiguous
+        #   bands of cumulative eligible spend, each discounted at its own percentage
+        #   (progressive fill-a-tier).
+        #
+        #   @return [Array<Orb::Models::Discount::TieredPercentage::Tier>]
+        required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Discount::TieredPercentage::Tier] }
+
+        # @!attribute applies_to_price_ids
+        #   List of price_ids that this discount applies to. For plan/plan phase discounts,
+        #   this can be a subset of prices.
+        #
+        #   @return [Array<String>, nil]
+        optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute filters
+        #   The filters that determine which prices to apply this discount to.
+        #
+        #   @return [Array<Orb::Models::Discount::TieredPercentage::Filter>, nil]
+        optional :filters,
+                 -> { Orb::Internal::Type::ArrayOf[Orb::Discount::TieredPercentage::Filter] },
+                 nil?: true
+
+        # @!attribute reason
+        #
+        #   @return [String, nil]
+        optional :reason, String, nil?: true
+
+        # @!method initialize(tiers:, applies_to_price_ids: nil, filters: nil, reason: nil, discount_type: :tiered_percentage)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Discount::TieredPercentage} for more details.
+        #
+        #   @param tiers [Array<Orb::Models::Discount::TieredPercentage::Tier>] Only available if discount_type is `tiered_percentage`. The ordered, contiguous
+        #
+        #   @param applies_to_price_ids [Array<String>, nil] List of price_ids that this discount applies to. For plan/plan phase discounts,
+        #
+        #   @param filters [Array<Orb::Models::Discount::TieredPercentage::Filter>, nil] The filters that determine which prices to apply this discount to.
+        #
+        #   @param reason [String, nil]
+        #
+        #   @param discount_type [Symbol, :tiered_percentage]
+
+        class Tier < Orb::Internal::Type::BaseModel
+          # @!attribute lower_bound
+          #   Exclusive lower bound of cumulative spend for this tier.
+          #
+          #   @return [Float]
+          required :lower_bound, Float
+
+          # @!attribute percentage
+          #   The percentage (between 0 and 1) discounted from spend that falls within this
+          #   tier.
+          #
+          #   @return [Float]
+          required :percentage, Float
+
+          # @!attribute upper_bound
+          #   Inclusive upper bound of cumulative spend for this tier; null for the final
+          #   open-ended tier.
+          #
+          #   @return [Float, nil]
+          optional :upper_bound, Float, nil?: true
+
+          # @!method initialize(lower_bound:, percentage:, upper_bound: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Discount::TieredPercentage::Tier} for more details.
+          #
+          #   One band of a tiered percentage discount. Bounds are denominated in the
+          #   discount's currency. `lower_bound` is the exclusive start of the band and
+          #   `upper_bound` is the inclusive end; `upper_bound` is null only for the
+          #   open-ended final tier.
+          #
+          #   @param lower_bound [Float] Exclusive lower bound of cumulative spend for this tier.
+          #
+          #   @param percentage [Float] The percentage (between 0 and 1) discounted from spend that falls within this ti
+          #
+          #   @param upper_bound [Float, nil] Inclusive upper bound of cumulative spend for this tier; null for the final open
+        end
+
+        class Filter < Orb::Internal::Type::BaseModel
+          # @!attribute field
+          #   The property of the price to filter on.
+          #
+          #   @return [Symbol, Orb::Models::Discount::TieredPercentage::Filter::Field]
+          required :field, enum: -> { Orb::Discount::TieredPercentage::Filter::Field }
+
+          # @!attribute operator
+          #   Should prices that match the filter be included or excluded.
+          #
+          #   @return [Symbol, Orb::Models::Discount::TieredPercentage::Filter::Operator]
+          required :operator, enum: -> { Orb::Discount::TieredPercentage::Filter::Operator }
+
+          # @!attribute values
+          #   The IDs or values that match this filter.
+          #
+          #   @return [Array<String>]
+          required :values, Orb::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(field:, operator:, values:)
+          #   @param field [Symbol, Orb::Models::Discount::TieredPercentage::Filter::Field] The property of the price to filter on.
+          #
+          #   @param operator [Symbol, Orb::Models::Discount::TieredPercentage::Filter::Operator] Should prices that match the filter be included or excluded.
+          #
+          #   @param values [Array<String>] The IDs or values that match this filter.
+
+          # The property of the price to filter on.
+          #
+          # @see Orb::Models::Discount::TieredPercentage::Filter#field
+          module Field
+            extend Orb::Internal::Type::Enum
+
+            PRICE_ID = :price_id
+            ITEM_ID = :item_id
+            PRICE_TYPE = :price_type
+            CURRENCY = :currency
+            PRICING_UNIT_ID = :pricing_unit_id
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Should prices that match the filter be included or excluded.
+          #
+          # @see Orb::Models::Discount::TieredPercentage::Filter#operator
+          module Operator
+            extend Orb::Internal::Type::Enum
+
+            INCLUDES = :includes
+            EXCLUDES = :excludes
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+
       # @!method self.variants
-      #   @return [Array(Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount)]
+      #   @return [Array(Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, Orb::Models::Discount::TieredPercentage)]
     end
   end
 end

data/lib/orb/models/event_deprecate_params.rb

@@ -7,7 +7,13 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute event_id
+      #
+      #   @return [String]
+      required :event_id, String
+
+      # @!method initialize(event_id:, request_options: {})
+      #   @param event_id [String]
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/event_ingest_params.rb

@@ -20,7 +20,10 @@ module Orb
       optional :backfill_id, String, nil?: true
 
       # @!attribute debug
-      #   Flag to enable additional debug information in the endpoint response
+      #   @deprecated
+      #
+      #   Pending Deprecation: Flag to enable additional debug information in the endpoint
+      #   response
       #
       #   @return [Boolean, nil]
       optional :debug, Orb::Internal::Type::Boolean
@@ -33,7 +36,7 @@ module Orb
       #
       #   @param backfill_id [String, nil] If this ingestion request is part of a backfill, this parameter ties the ingeste
       #
-      #   @param debug [Boolean] Flag to enable additional debug information in the endpoint response
+      #   @param debug [Boolean] Pending Deprecation: Flag to enable additional debug information in the endpoint
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/orb/models/event_update_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute event_id
+      #
+      #   @return [String]
+      required :event_id, String
+
       # @!attribute event_name
       #   A name to meaningfully identify the action or event type.
       #
@@ -41,10 +46,12 @@ module Orb
       #   @return [String, nil]
       optional :external_customer_id, String, nil?: true
 
-      # @!method initialize(event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {})
+      # @!method initialize(event_id:, event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::EventUpdateParams} for more details.
       #
+      #   @param event_id [String]
+      #
       #   @param event_name [String] A name to meaningfully identify the action or event type.
       #
       #   @param properties [Hash{Symbol=>Object}] A dictionary of custom properties. Values in this dictionary must be numeric, bo

data/lib/orb/models/events/backfill_close_params.rb

@@ -8,7 +8,13 @@ module Orb
         extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute backfill_id
+        #
+        #   @return [String]
+        required :backfill_id, String
+
+        # @!method initialize(backfill_id:, request_options: {})
+        #   @param backfill_id [String]
         #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/orb/models/events/backfill_fetch_params.rb

@@ -8,7 +8,13 @@ module Orb
         extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute backfill_id
+        #
+        #   @return [String]
+        required :backfill_id, String
+
+        # @!method initialize(backfill_id:, request_options: {})
+        #   @param backfill_id [String]
         #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/orb/models/events/backfill_revert_params.rb

@@ -8,7 +8,13 @@ module Orb
         extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute backfill_id
+        #
+        #   @return [String]
+        required :backfill_id, String
+
+        # @!method initialize(backfill_id:, request_options: {})
+        #   @param backfill_id [String]
         #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
       end
     end