orb-billing 1.13.0 → 1.15.0

data/lib/orb/models/customers/credit_list_by_external_id_response.rb

@@ -15,6 +15,16 @@ module Orb
         #   @return [Float]
         required :balance, Float
 
+        # @!attribute credit_block_source
+        #   How this credit block was created: `allocation` (a subscription's recurring
+        #   credit allocation), `top_up` (an automatic balance-threshold top-up), or
+        #   `manual` (a manual credit ledger increment, including credits voided or expired
+        #   off another block).
+        #
+        #   @return [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource]
+        required :credit_block_source,
+                 enum: -> { Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource }
+
         # @!attribute effective_date
         #
         #   @return [Time, nil]
@@ -55,7 +65,16 @@ module Orb
         #   @return [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status]
         required :status, enum: -> { Orb::Models::Customers::CreditListByExternalIDResponse::Status }
 
-        # @!method initialize(id:, balance:, effective_date:, expiry_date:, filters:, maximum_initial_balance:, metadata:, per_unit_cost_basis:, status:)
+        # @!attribute credit_allocation
+        #   The credit allocation that funded a block. Extends the allocation resource
+        #   serialized on prices with the catalog-item attribution of the funding price.
+        #
+        #   @return [Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation, nil]
+        optional :credit_allocation,
+                 -> { Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation },
+                 nil?: true
+
+        # @!method initialize(id:, balance:, credit_block_source:, effective_date:, expiry_date:, filters:, maximum_initial_balance:, metadata:, per_unit_cost_basis:, status:, credit_allocation: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::Customers::CreditListByExternalIDResponse} for more details.
         #
@@ -63,6 +82,8 @@ module Orb
         #
         #   @param balance [Float]
         #
+        #   @param credit_block_source [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource] How this credit block was created: `allocation` (a subscription's recurring cred
+        #
         #   @param effective_date [Time, nil]
         #
         #   @param expiry_date [Time, nil]
@@ -76,6 +97,25 @@ module Orb
         #   @param per_unit_cost_basis [String, nil]
         #
         #   @param status [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status]
+        #
+        #   @param credit_allocation [Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation, nil] The credit allocation that funded a block. Extends the allocation resource
+
+        # How this credit block was created: `allocation` (a subscription's recurring
+        # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+        # `manual` (a manual credit ledger increment, including credits voided or expired
+        # off another block).
+        #
+        # @see Orb::Models::Customers::CreditListByExternalIDResponse#credit_block_source
+        module CreditBlockSource
+          extend Orb::Internal::Type::Enum
+
+          ALLOCATION = :allocation
+          TOP_UP = :top_up
+          MANUAL = :manual
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
 
         class Filter < Orb::Internal::Type::BaseModel
           # @!attribute field
@@ -141,6 +181,120 @@ module Orb
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # @see Orb::Models::Customers::CreditListByExternalIDResponse#credit_allocation
+        class CreditAllocation < Orb::Internal::Type::BaseModel
+          # @!attribute allows_rollover
+          #
+          #   @return [Boolean]
+          required :allows_rollover, Orb::Internal::Type::Boolean
+
+          # @!attribute currency
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!attribute custom_expiration
+          #
+          #   @return [Orb::Models::CustomExpiration, nil]
+          required :custom_expiration, -> { Orb::CustomExpiration }, nil?: true
+
+          # @!attribute item_id
+          #   The ID of the catalog item this block was allocated from, derived from the
+          #   allocation's price.
+          #
+          #   @return [String]
+          required :item_id, String
+
+          # @!attribute filters
+          #
+          #   @return [Array<Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter>, nil]
+          optional :filters,
+                   -> { Orb::Internal::Type::ArrayOf[Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter] }
+
+          # @!attribute license_type_id
+          #
+          #   @return [String, nil]
+          optional :license_type_id, String, nil?: true
+
+          # @!method initialize(allows_rollover:, currency:, custom_expiration:, item_id:, filters: nil, license_type_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation} for
+          #   more details.
+          #
+          #   The credit allocation that funded a block. Extends the allocation resource
+          #   serialized on prices with the catalog-item attribution of the funding price.
+          #
+          #   @param allows_rollover [Boolean]
+          #
+          #   @param currency [String]
+          #
+          #   @param custom_expiration [Orb::Models::CustomExpiration, nil]
+          #
+          #   @param item_id [String] The ID of the catalog item this block was allocated from, derived from the alloc
+          #
+          #   @param filters [Array<Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter>]
+          #
+          #   @param license_type_id [String, nil]
+
+          class Filter < Orb::Internal::Type::BaseModel
+            # @!attribute field
+            #   The property of the price to filter on.
+            #
+            #   @return [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field]
+            required :field,
+                     enum: -> { Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field }
+
+            # @!attribute operator
+            #   Should prices that match the filter be included or excluded.
+            #
+            #   @return [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator]
+            required :operator,
+                     enum: -> { Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::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::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field] The property of the price to filter on.
+            #
+            #   @param operator [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::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::Customers::CreditListByExternalIDResponse::CreditAllocation::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::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter#operator
+            module Operator
+              extend Orb::Internal::Type::Enum
+
+              INCLUDES = :includes
+              EXCLUDES = :excludes
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
       end
     end
   end

data/lib/orb/models/customers/credit_list_params.rb

@@ -8,6 +8,11 @@ module Orb
         extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
         # @!attribute currency
         #   The ledger currency or custom pricing unit to use.
         #
@@ -54,10 +59,12 @@ module Orb
         #   @return [Integer, nil]
         optional :limit, Integer
 
-        # @!method initialize(currency: nil, cursor: nil, effective_date_gt: nil, effective_date_gte: nil, effective_date_lt: nil, effective_date_lte: nil, include_all_blocks: nil, limit: nil, request_options: {})
+        # @!method initialize(customer_id:, currency: nil, cursor: nil, effective_date_gt: nil, effective_date_gte: nil, effective_date_lt: nil, effective_date_lte: nil, include_all_blocks: nil, limit: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::Customers::CreditListParams} for more details.
         #
+        #   @param customer_id [String]
+        #
         #   @param currency [String, nil] The ledger currency or custom pricing unit to use.
         #
         #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned

data/lib/orb/models/customers/credit_list_response.rb

@@ -15,6 +15,15 @@ module Orb
         #   @return [Float]
         required :balance, Float
 
+        # @!attribute credit_block_source
+        #   How this credit block was created: `allocation` (a subscription's recurring
+        #   credit allocation), `top_up` (an automatic balance-threshold top-up), or
+        #   `manual` (a manual credit ledger increment, including credits voided or expired
+        #   off another block).
+        #
+        #   @return [Symbol, Orb::Models::Customers::CreditListResponse::CreditBlockSource]
+        required :credit_block_source, enum: -> { Orb::Models::Customers::CreditListResponse::CreditBlockSource }
+
         # @!attribute effective_date
         #
         #   @return [Time, nil]
@@ -54,7 +63,16 @@ module Orb
         #   @return [Symbol, Orb::Models::Customers::CreditListResponse::Status]
         required :status, enum: -> { Orb::Models::Customers::CreditListResponse::Status }
 
-        # @!method initialize(id:, balance:, effective_date:, expiry_date:, filters:, maximum_initial_balance:, metadata:, per_unit_cost_basis:, status:)
+        # @!attribute credit_allocation
+        #   The credit allocation that funded a block. Extends the allocation resource
+        #   serialized on prices with the catalog-item attribution of the funding price.
+        #
+        #   @return [Orb::Models::Customers::CreditListResponse::CreditAllocation, nil]
+        optional :credit_allocation,
+                 -> { Orb::Models::Customers::CreditListResponse::CreditAllocation },
+                 nil?: true
+
+        # @!method initialize(id:, balance:, credit_block_source:, effective_date:, expiry_date:, filters:, maximum_initial_balance:, metadata:, per_unit_cost_basis:, status:, credit_allocation: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::Customers::CreditListResponse} for more details.
         #
@@ -62,6 +80,8 @@ module Orb
         #
         #   @param balance [Float]
         #
+        #   @param credit_block_source [Symbol, Orb::Models::Customers::CreditListResponse::CreditBlockSource] How this credit block was created: `allocation` (a subscription's recurring cred
+        #
         #   @param effective_date [Time, nil]
         #
         #   @param expiry_date [Time, nil]
@@ -75,6 +95,25 @@ module Orb
         #   @param per_unit_cost_basis [String, nil]
         #
         #   @param status [Symbol, Orb::Models::Customers::CreditListResponse::Status]
+        #
+        #   @param credit_allocation [Orb::Models::Customers::CreditListResponse::CreditAllocation, nil] The credit allocation that funded a block. Extends the allocation resource
+
+        # How this credit block was created: `allocation` (a subscription's recurring
+        # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+        # `manual` (a manual credit ledger increment, including credits voided or expired
+        # off another block).
+        #
+        # @see Orb::Models::Customers::CreditListResponse#credit_block_source
+        module CreditBlockSource
+          extend Orb::Internal::Type::Enum
+
+          ALLOCATION = :allocation
+          TOP_UP = :top_up
+          MANUAL = :manual
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
 
         class Filter < Orb::Internal::Type::BaseModel
           # @!attribute field
@@ -140,6 +179,118 @@ module Orb
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # @see Orb::Models::Customers::CreditListResponse#credit_allocation
+        class CreditAllocation < Orb::Internal::Type::BaseModel
+          # @!attribute allows_rollover
+          #
+          #   @return [Boolean]
+          required :allows_rollover, Orb::Internal::Type::Boolean
+
+          # @!attribute currency
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!attribute custom_expiration
+          #
+          #   @return [Orb::Models::CustomExpiration, nil]
+          required :custom_expiration, -> { Orb::CustomExpiration }, nil?: true
+
+          # @!attribute item_id
+          #   The ID of the catalog item this block was allocated from, derived from the
+          #   allocation's price.
+          #
+          #   @return [String]
+          required :item_id, String
+
+          # @!attribute filters
+          #
+          #   @return [Array<Orb::Models::Customers::CreditListResponse::CreditAllocation::Filter>, nil]
+          optional :filters,
+                   -> { Orb::Internal::Type::ArrayOf[Orb::Models::Customers::CreditListResponse::CreditAllocation::Filter] }
+
+          # @!attribute license_type_id
+          #
+          #   @return [String, nil]
+          optional :license_type_id, String, nil?: true
+
+          # @!method initialize(allows_rollover:, currency:, custom_expiration:, item_id:, filters: nil, license_type_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Customers::CreditListResponse::CreditAllocation} for more details.
+          #
+          #   The credit allocation that funded a block. Extends the allocation resource
+          #   serialized on prices with the catalog-item attribution of the funding price.
+          #
+          #   @param allows_rollover [Boolean]
+          #
+          #   @param currency [String]
+          #
+          #   @param custom_expiration [Orb::Models::CustomExpiration, nil]
+          #
+          #   @param item_id [String] The ID of the catalog item this block was allocated from, derived from the alloc
+          #
+          #   @param filters [Array<Orb::Models::Customers::CreditListResponse::CreditAllocation::Filter>]
+          #
+          #   @param license_type_id [String, nil]
+
+          class Filter < Orb::Internal::Type::BaseModel
+            # @!attribute field
+            #   The property of the price to filter on.
+            #
+            #   @return [Symbol, Orb::Models::Customers::CreditListResponse::CreditAllocation::Filter::Field]
+            required :field, enum: -> { Orb::Models::Customers::CreditListResponse::CreditAllocation::Filter::Field }
+
+            # @!attribute operator
+            #   Should prices that match the filter be included or excluded.
+            #
+            #   @return [Symbol, Orb::Models::Customers::CreditListResponse::CreditAllocation::Filter::Operator]
+            required :operator,
+                     enum: -> { Orb::Models::Customers::CreditListResponse::CreditAllocation::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::Customers::CreditListResponse::CreditAllocation::Filter::Field] The property of the price to filter on.
+            #
+            #   @param operator [Symbol, Orb::Models::Customers::CreditListResponse::CreditAllocation::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::Customers::CreditListResponse::CreditAllocation::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::Customers::CreditListResponse::CreditAllocation::Filter#operator
+            module Operator
+              extend Orb::Internal::Type::Enum
+
+              INCLUDES = :includes
+              EXCLUDES = :excludes
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
       end
     end
   end

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

@@ -75,6 +75,10 @@ module Orb
           required :starting_balance, Float
 
           # @!attribute event_id
+          #   @deprecated
+          #
+          #   This field is deprecated and will always be null. Decrements are not associated
+          #   with individual events.
           #
           #   @return [String, nil]
           optional :event_id, String, nil?: true
@@ -119,7 +123,7 @@ module Orb
           #
           #   @param starting_balance [Float]
           #
-          #   @param event_id [String, nil]
+          #   @param event_id [String, nil] This field is deprecated and will always be null. Decrements are not associated
           #
           #   @param invoice_id [String, nil]
           #