orb-billing 1.14.0 → 1.16.0

data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi

@@ -18,6 +18,18 @@ module Orb
         sig { returns(Float) }
         attr_accessor :balance
 
+        # How this credit block was created: `allocation` (a subscription's recurring
+        # credit allocation), `top_up` (an automatic balance-threshold top-up),
+        # `commitment` (a subscription commitment true-up rolled forward as credit), or
+        # `manual` (a manual credit ledger increment, including credits voided or expired
+        # off another block).
+        sig do
+          returns(
+            Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol
+          )
+        end
+        attr_accessor :credit_block_source
+
         sig { returns(T.nilable(Time)) }
         attr_accessor :effective_date
 
@@ -53,10 +65,54 @@ module Orb
         end
         attr_accessor :status
 
+        # The credit allocation that funded a block. Extends the allocation resource
+        # serialized on prices with the catalog-item attribution of the funding price.
+        sig do
+          returns(
+            T.nilable(
+              Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation
+            )
+          )
+        end
+        attr_reader :credit_allocation
+
+        sig do
+          params(
+            credit_allocation:
+              T.nilable(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::OrHash
+              )
+          ).void
+        end
+        attr_writer :credit_allocation
+
+        # The subscription commitment whose true-up rolled forward into this credit block.
+        # Present only when `credit_block_source` is `commitment`.
+        sig do
+          returns(
+            T.nilable(
+              Orb::Models::Customers::CreditListByExternalIDResponse::CreditCommitment
+            )
+          )
+        end
+        attr_reader :credit_commitment
+
+        sig do
+          params(
+            credit_commitment:
+              T.nilable(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditCommitment::OrHash
+              )
+          ).void
+        end
+        attr_writer :credit_commitment
+
         sig do
           params(
             id: String,
             balance: Float,
+            credit_block_source:
+              Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::OrSymbol,
             effective_date: T.nilable(Time),
             expiry_date: T.nilable(Time),
             filters:
@@ -67,12 +123,26 @@ module Orb
             metadata: T::Hash[Symbol, String],
             per_unit_cost_basis: T.nilable(String),
             status:
-              Orb::Models::Customers::CreditListByExternalIDResponse::Status::OrSymbol
+              Orb::Models::Customers::CreditListByExternalIDResponse::Status::OrSymbol,
+            credit_allocation:
+              T.nilable(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::OrHash
+              ),
+            credit_commitment:
+              T.nilable(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditCommitment::OrHash
+              )
           ).returns(T.attached_class)
         end
         def self.new(
           id:,
           balance:,
+          # How this credit block was created: `allocation` (a subscription's recurring
+          # credit allocation), `top_up` (an automatic balance-threshold top-up),
+          # `commitment` (a subscription commitment true-up rolled forward as credit), or
+          # `manual` (a manual credit ledger increment, including credits voided or expired
+          # off another block).
+          credit_block_source:,
           effective_date:,
           expiry_date:,
           filters:,
@@ -83,7 +153,13 @@ module Orb
           # `null`.
           metadata:,
           per_unit_cost_basis:,
-          status:
+          status:,
+          # The credit allocation that funded a block. Extends the allocation resource
+          # serialized on prices with the catalog-item attribution of the funding price.
+          credit_allocation: nil,
+          # The subscription commitment whose true-up rolled forward into this credit block.
+          # Present only when `credit_block_source` is `commitment`.
+          credit_commitment: nil
         )
         end
 
@@ -92,6 +168,8 @@ module Orb
             {
               id: String,
               balance: Float,
+              credit_block_source:
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol,
               effective_date: T.nilable(Time),
               expiry_date: T.nilable(Time),
               filters:
@@ -102,13 +180,70 @@ module Orb
               metadata: T::Hash[Symbol, String],
               per_unit_cost_basis: T.nilable(String),
               status:
-                Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol
+                Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol,
+              credit_allocation:
+                T.nilable(
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation
+                ),
+              credit_commitment:
+                T.nilable(
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditCommitment
+                )
             }
           )
         end
         def to_hash
         end
 
+        # How this credit block was created: `allocation` (a subscription's recurring
+        # credit allocation), `top_up` (an automatic balance-threshold top-up),
+        # `commitment` (a subscription commitment true-up rolled forward as credit), or
+        # `manual` (a manual credit ledger increment, including credits voided or expired
+        # off another block).
+        module CreditBlockSource
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ALLOCATION =
+            T.let(
+              :allocation,
+              Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol
+            )
+          TOP_UP =
+            T.let(
+              :top_up,
+              Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol
+            )
+          COMMITMENT =
+            T.let(
+              :commitment,
+              Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol
+            )
+          MANUAL =
+            T.let(
+              :manual,
+              Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         class Filter < Orb::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -271,6 +406,293 @@ module Orb
           def self.values
           end
         end
+
+        class CreditAllocation < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T::Boolean) }
+          attr_accessor :allows_rollover
+
+          sig { returns(String) }
+          attr_accessor :currency
+
+          sig { returns(T.nilable(Orb::CustomExpiration)) }
+          attr_reader :custom_expiration
+
+          sig do
+            params(
+              custom_expiration: T.nilable(Orb::CustomExpiration::OrHash)
+            ).void
+          end
+          attr_writer :custom_expiration
+
+          # The ID of the catalog item this block was allocated from, derived from the
+          # allocation's price.
+          sig { returns(String) }
+          attr_accessor :item_id
+
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter
+                ]
+              )
+            )
+          end
+          attr_reader :filters
+
+          sig do
+            params(
+              filters:
+                T::Array[
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::OrHash
+                ]
+            ).void
+          end
+          attr_writer :filters
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :license_type_id
+
+          # The credit allocation that funded a block. Extends the allocation resource
+          # serialized on prices with the catalog-item attribution of the funding price.
+          sig do
+            params(
+              allows_rollover: T::Boolean,
+              currency: String,
+              custom_expiration: T.nilable(Orb::CustomExpiration::OrHash),
+              item_id: String,
+              filters:
+                T::Array[
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::OrHash
+                ],
+              license_type_id: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            allows_rollover:,
+            currency:,
+            custom_expiration:,
+            # The ID of the catalog item this block was allocated from, derived from the
+            # allocation's price.
+            item_id:,
+            filters: nil,
+            license_type_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                allows_rollover: T::Boolean,
+                currency: String,
+                custom_expiration: T.nilable(Orb::CustomExpiration),
+                item_id: String,
+                filters:
+                  T::Array[
+                    Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter
+                  ],
+                license_type_id: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Filter < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            # The property of the price to filter on.
+            sig do
+              returns(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol
+              )
+            end
+            attr_accessor :field
+
+            # Should prices that match the filter be included or excluded.
+            sig do
+              returns(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator::TaggedSymbol
+              )
+            end
+            attr_accessor :operator
+
+            # The IDs or values that match this filter.
+            sig { returns(T::Array[String]) }
+            attr_accessor :values
+
+            sig do
+              params(
+                field:
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::OrSymbol,
+                operator:
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator::OrSymbol,
+                values: T::Array[String]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The property of the price to filter on.
+              field:,
+              # Should prices that match the filter be included or excluded.
+              operator:,
+              # The IDs or values that match this filter.
+              values:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  field:
+                    Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol,
+                  operator:
+                    Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator::TaggedSymbol,
+                  values: T::Array[String]
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The property of the price to filter on.
+            module Field
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              PRICE_ID =
+                T.let(
+                  :price_id,
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol
+                )
+              ITEM_ID =
+                T.let(
+                  :item_id,
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol
+                )
+              PRICE_TYPE =
+                T.let(
+                  :price_type,
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol
+                )
+              CURRENCY =
+                T.let(
+                  :currency,
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol
+                )
+              PRICING_UNIT_ID =
+                T.let(
+                  :pricing_unit_id,
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Field::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            # Should prices that match the filter be included or excluded.
+            module Operator
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              INCLUDES =
+                T.let(
+                  :includes,
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator::TaggedSymbol
+                )
+              EXCLUDES =
+                T.let(
+                  :excludes,
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::Filter::Operator::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+
+        class CreditCommitment < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditCommitment,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # The ID of the subscription commitment this block was rolled forward from.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The subscription the commitment belongs to.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :subscription_id
+
+          # The subscription commitment whose true-up rolled forward into this credit block.
+          # Present only when `credit_block_source` is `commitment`.
+          sig do
+            params(id: String, subscription_id: T.nilable(String)).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # The ID of the subscription commitment this block was rolled forward from.
+            id:,
+            # The subscription the commitment belongs to.
+            subscription_id: nil
+          )
+          end
+
+          sig do
+            override.returns({ id: String, subscription_id: T.nilable(String) })
+          end
+          def to_hash
+          end
+        end
       end
     end
   end