orb-billing 0.1.0.pre.alpha.33

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

@@ -0,0 +1,1310 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      module Credits
+        # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+        #   credits within Orb.
+        #
+        # @see Orb::Resources::Customers::Credits::Ledger#list_by_external_id
+        module LedgerListByExternalIDResponse
+          extend Orb::Union
+
+          discriminator :entry_type
+
+          variant :increment,
+                  -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry }
+
+          variant :decrement,
+                  -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry }
+
+          variant :expiration_change,
+                  -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry }
+
+          variant :credit_block_expiry,
+                  -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry }
+
+          variant :void, -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry }
+
+          variant :void_initiated,
+                  -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry }
+
+          variant :amendment,
+                  -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry }
+
+          class IncrementLedgerEntry < Orb::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute amount
+            #
+            #   @return [Float]
+            required :amount, Float
+
+            # @!attribute created_at
+            #
+            #   @return [Time]
+            required :created_at, Time
+
+            # @!attribute credit_block
+            #
+            #   @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::CreditBlock]
+            required :credit_block,
+                     -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::CreditBlock }
+
+            # @!attribute currency
+            #
+            #   @return [String]
+            required :currency, String
+
+            # @!attribute customer
+            #
+            #   @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::Customer]
+            required :customer,
+                     -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::Customer }
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            required :description, String, nil?: true
+
+            # @!attribute ending_balance
+            #
+            #   @return [Float]
+            required :ending_balance, Float
+
+            # @!attribute entry_status
+            #
+            #   @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus]
+            required :entry_status,
+                     enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus }
+
+            # @!attribute entry_type
+            #
+            #   @return [Symbol, :increment]
+            required :entry_type, const: :increment
+
+            # @!attribute ledger_sequence_number
+            #
+            #   @return [Integer]
+            required :ledger_sequence_number, Integer
+
+            # @!attribute metadata
+            #   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`.
+            #
+            #   @return [Hash{Symbol=>String}]
+            required :metadata, Orb::HashOf[String]
+
+            # @!attribute starting_balance
+            #
+            #   @return [Float]
+            required :starting_balance, Float
+
+            # @!parse
+            #   # @param id [String]
+            #   # @param amount [Float]
+            #   # @param created_at [Time]
+            #   # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::CreditBlock]
+            #   # @param currency [String]
+            #   # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::Customer]
+            #   # @param description [String, nil]
+            #   # @param ending_balance [Float]
+            #   # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus]
+            #   # @param ledger_sequence_number [Integer]
+            #   # @param metadata [Hash{Symbol=>String}]
+            #   # @param starting_balance [Float]
+            #   # @param entry_type [Symbol, :increment]
+            #   #
+            #   def initialize(
+            #     id:,
+            #     amount:,
+            #     created_at:,
+            #     credit_block:,
+            #     currency:,
+            #     customer:,
+            #     description:,
+            #     ending_balance:,
+            #     entry_status:,
+            #     ledger_sequence_number:,
+            #     metadata:,
+            #     starting_balance:,
+            #     entry_type: :increment,
+            #     **
+            #   )
+            #     super
+            #   end
+
+            # def initialize: (Hash | Orb::BaseModel) -> void
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry#credit_block
+            class CreditBlock < Orb::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute expiry_date
+              #
+              #   @return [Time, nil]
+              required :expiry_date, Time, nil?: true
+
+              # @!attribute per_unit_cost_basis
+              #
+              #   @return [String, nil]
+              required :per_unit_cost_basis, String, nil?: true
+
+              # @!parse
+              #   # @param id [String]
+              #   # @param expiry_date [Time, nil]
+              #   # @param per_unit_cost_basis [String, nil]
+              #   #
+              #   def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
+
+              # def initialize: (Hash | Orb::BaseModel) -> void
+            end
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry#customer
+            class Customer < Orb::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute external_customer_id
+              #
+              #   @return [String, nil]
+              required :external_customer_id, String, nil?: true
+
+              # @!parse
+              #   # @param id [String]
+              #   # @param external_customer_id [String, nil]
+              #   #
+              #   def initialize(id:, external_customer_id:, **) = super
+
+              # def initialize: (Hash | Orb::BaseModel) -> void
+            end
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry#entry_status
+            module EntryStatus
+              extend Orb::Enum
+
+              COMMITTED = :committed
+              PENDING = :pending
+
+              finalize!
+
+              # @!parse
+              #   # @return [Array<Symbol>]
+              #   def self.values; end
+            end
+          end
+
+          class DecrementLedgerEntry < Orb::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute amount
+            #
+            #   @return [Float]
+            required :amount, Float
+
+            # @!attribute created_at
+            #
+            #   @return [Time]
+            required :created_at, Time
+
+            # @!attribute credit_block
+            #
+            #   @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::CreditBlock]
+            required :credit_block,
+                     -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::CreditBlock }
+
+            # @!attribute currency
+            #
+            #   @return [String]
+            required :currency, String
+
+            # @!attribute customer
+            #
+            #   @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::Customer]
+            required :customer,
+                     -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::Customer }
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            required :description, String, nil?: true
+
+            # @!attribute ending_balance
+            #
+            #   @return [Float]
+            required :ending_balance, Float
+
+            # @!attribute entry_status
+            #
+            #   @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus]
+            required :entry_status,
+                     enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus }
+
+            # @!attribute entry_type
+            #
+            #   @return [Symbol, :decrement]
+            required :entry_type, const: :decrement
+
+            # @!attribute ledger_sequence_number
+            #
+            #   @return [Integer]
+            required :ledger_sequence_number, Integer
+
+            # @!attribute metadata
+            #   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`.
+            #
+            #   @return [Hash{Symbol=>String}]
+            required :metadata, Orb::HashOf[String]
+
+            # @!attribute starting_balance
+            #
+            #   @return [Float]
+            required :starting_balance, Float
+
+            # @!attribute event_id
+            #
+            #   @return [String, nil]
+            optional :event_id, String, nil?: true
+
+            # @!attribute invoice_id
+            #
+            #   @return [String, nil]
+            optional :invoice_id, String, nil?: true
+
+            # @!attribute price_id
+            #
+            #   @return [String, nil]
+            optional :price_id, String, nil?: true
+
+            # @!parse
+            #   # @param id [String]
+            #   # @param amount [Float]
+            #   # @param created_at [Time]
+            #   # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::CreditBlock]
+            #   # @param currency [String]
+            #   # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::Customer]
+            #   # @param description [String, nil]
+            #   # @param ending_balance [Float]
+            #   # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus]
+            #   # @param ledger_sequence_number [Integer]
+            #   # @param metadata [Hash{Symbol=>String}]
+            #   # @param starting_balance [Float]
+            #   # @param event_id [String, nil]
+            #   # @param invoice_id [String, nil]
+            #   # @param price_id [String, nil]
+            #   # @param entry_type [Symbol, :decrement]
+            #   #
+            #   def initialize(
+            #     id:,
+            #     amount:,
+            #     created_at:,
+            #     credit_block:,
+            #     currency:,
+            #     customer:,
+            #     description:,
+            #     ending_balance:,
+            #     entry_status:,
+            #     ledger_sequence_number:,
+            #     metadata:,
+            #     starting_balance:,
+            #     event_id: nil,
+            #     invoice_id: nil,
+            #     price_id: nil,
+            #     entry_type: :decrement,
+            #     **
+            #   )
+            #     super
+            #   end
+
+            # def initialize: (Hash | Orb::BaseModel) -> void
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry#credit_block
+            class CreditBlock < Orb::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute expiry_date
+              #
+              #   @return [Time, nil]
+              required :expiry_date, Time, nil?: true
+
+              # @!attribute per_unit_cost_basis
+              #
+              #   @return [String, nil]
+              required :per_unit_cost_basis, String, nil?: true
+
+              # @!parse
+              #   # @param id [String]
+              #   # @param expiry_date [Time, nil]
+              #   # @param per_unit_cost_basis [String, nil]
+              #   #
+              #   def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
+
+              # def initialize: (Hash | Orb::BaseModel) -> void
+            end
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry#customer
+            class Customer < Orb::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute external_customer_id
+              #
+              #   @return [String, nil]
+              required :external_customer_id, String, nil?: true
+
+              # @!parse
+              #   # @param id [String]
+              #   # @param external_customer_id [String, nil]
+              #   #
+              #   def initialize(id:, external_customer_id:, **) = super
+
+              # def initialize: (Hash | Orb::BaseModel) -> void
+            end
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry#entry_status
+            module EntryStatus
+              extend Orb::Enum
+
+              COMMITTED = :committed
+              PENDING = :pending
+
+              finalize!
+
+              # @!parse
+              #   # @return [Array<Symbol>]
+              #   def self.values; end
+            end
+          end
+
+          class ExpirationChangeLedgerEntry < Orb::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute amount
+            #
+            #   @return [Float]
+            required :amount, Float
+
+            # @!attribute created_at
+            #
+            #   @return [Time]
+            required :created_at, Time
+
+            # @!attribute credit_block
+            #
+            #   @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock]
+            required :credit_block,
+                     -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock }
+
+            # @!attribute currency
+            #
+            #   @return [String]
+            required :currency, String
+
+            # @!attribute customer
+            #
+            #   @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::Customer]
+            required :customer,
+                     -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::Customer }
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            required :description, String, nil?: true
+
+            # @!attribute ending_balance
+            #
+            #   @return [Float]
+            required :ending_balance, Float
+
+            # @!attribute entry_status
+            #
+            #   @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus]
+            required :entry_status,
+                     enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus }
+
+            # @!attribute entry_type
+            #
+            #   @return [Symbol, :expiration_change]
+            required :entry_type, const: :expiration_change
+
+            # @!attribute ledger_sequence_number
+            #
+            #   @return [Integer]
+            required :ledger_sequence_number, Integer
+
+            # @!attribute metadata
+            #   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`.
+            #
+            #   @return [Hash{Symbol=>String}]
+            required :metadata, Orb::HashOf[String]
+
+            # @!attribute new_block_expiry_date
+            #
+            #   @return [Time, nil]
+            required :new_block_expiry_date, Time, nil?: true
+
+            # @!attribute starting_balance
+            #
+            #   @return [Float]
+            required :starting_balance, Float
+
+            # @!parse
+            #   # @param id [String]
+            #   # @param amount [Float]
+            #   # @param created_at [Time]
+            #   # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock]
+            #   # @param currency [String]
+            #   # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::Customer]
+            #   # @param description [String, nil]
+            #   # @param ending_balance [Float]
+            #   # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus]
+            #   # @param ledger_sequence_number [Integer]
+            #   # @param metadata [Hash{Symbol=>String}]
+            #   # @param new_block_expiry_date [Time, nil]
+            #   # @param starting_balance [Float]
+            #   # @param entry_type [Symbol, :expiration_change]
+            #   #
+            #   def initialize(
+            #     id:,
+            #     amount:,
+            #     created_at:,
+            #     credit_block:,
+            #     currency:,
+            #     customer:,
+            #     description:,
+            #     ending_balance:,
+            #     entry_status:,
+            #     ledger_sequence_number:,
+            #     metadata:,
+            #     new_block_expiry_date:,
+            #     starting_balance:,
+            #     entry_type: :expiration_change,
+            #     **
+            #   )
+            #     super
+            #   end
+
+            # def initialize: (Hash | Orb::BaseModel) -> void
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry#credit_block
+            class CreditBlock < Orb::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute expiry_date
+              #
+              #   @return [Time, nil]
+              required :expiry_date, Time, nil?: true
+
+              # @!attribute per_unit_cost_basis
+              #
+              #   @return [String, nil]
+              required :per_unit_cost_basis, String, nil?: true
+
+              # @!parse
+              #   # @param id [String]
+              #   # @param expiry_date [Time, nil]
+              #   # @param per_unit_cost_basis [String, nil]
+              #   #
+              #   def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
+
+              # def initialize: (Hash | Orb::BaseModel) -> void
+            end
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry#customer
+            class Customer < Orb::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute external_customer_id
+              #
+              #   @return [String, nil]
+              required :external_customer_id, String, nil?: true
+
+              # @!parse
+              #   # @param id [String]
+              #   # @param external_customer_id [String, nil]
+              #   #
+              #   def initialize(id:, external_customer_id:, **) = super
+
+              # def initialize: (Hash | Orb::BaseModel) -> void
+            end
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry#entry_status
+            module EntryStatus
+              extend Orb::Enum
+
+              COMMITTED = :committed
+              PENDING = :pending
+
+              finalize!
+
+              # @!parse
+              #   # @return [Array<Symbol>]
+              #   def self.values; end
+            end
+          end
+
+          class CreditBlockExpiryLedgerEntry < Orb::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute amount
+            #
+            #   @return [Float]
+            required :amount, Float
+
+            # @!attribute created_at
+            #
+            #   @return [Time]
+            required :created_at, Time
+
+            # @!attribute credit_block
+            #
+            #   @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock]
+            required :credit_block,
+                     -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock }
+
+            # @!attribute currency
+            #
+            #   @return [String]
+            required :currency, String
+
+            # @!attribute customer
+            #
+            #   @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer]
+            required :customer,
+                     -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer }
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            required :description, String, nil?: true
+
+            # @!attribute ending_balance
+            #
+            #   @return [Float]
+            required :ending_balance, Float
+
+            # @!attribute entry_status
+            #
+            #   @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus]
+            required :entry_status,
+                     enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus }
+
+            # @!attribute entry_type
+            #
+            #   @return [Symbol, :credit_block_expiry]
+            required :entry_type, const: :credit_block_expiry
+
+            # @!attribute ledger_sequence_number
+            #
+            #   @return [Integer]
+            required :ledger_sequence_number, Integer
+
+            # @!attribute metadata
+            #   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`.
+            #
+            #   @return [Hash{Symbol=>String}]
+            required :metadata, Orb::HashOf[String]
+
+            # @!attribute starting_balance
+            #
+            #   @return [Float]
+            required :starting_balance, Float
+
+            # @!parse
+            #   # @param id [String]
+            #   # @param amount [Float]
+            #   # @param created_at [Time]
+            #   # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock]
+            #   # @param currency [String]
+            #   # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer]
+            #   # @param description [String, nil]
+            #   # @param ending_balance [Float]
+            #   # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus]
+            #   # @param ledger_sequence_number [Integer]
+            #   # @param metadata [Hash{Symbol=>String}]
+            #   # @param starting_balance [Float]
+            #   # @param entry_type [Symbol, :credit_block_expiry]
+            #   #
+            #   def initialize(
+            #     id:,
+            #     amount:,
+            #     created_at:,
+            #     credit_block:,
+            #     currency:,
+            #     customer:,
+            #     description:,
+            #     ending_balance:,
+            #     entry_status:,
+            #     ledger_sequence_number:,
+            #     metadata:,
+            #     starting_balance:,
+            #     entry_type: :credit_block_expiry,
+            #     **
+            #   )
+            #     super
+            #   end
+
+            # def initialize: (Hash | Orb::BaseModel) -> void
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry#credit_block
+            class CreditBlock < Orb::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute expiry_date
+              #
+              #   @return [Time, nil]
+              required :expiry_date, Time, nil?: true
+
+              # @!attribute per_unit_cost_basis
+              #
+              #   @return [String, nil]
+              required :per_unit_cost_basis, String, nil?: true
+
+              # @!parse
+              #   # @param id [String]
+              #   # @param expiry_date [Time, nil]
+              #   # @param per_unit_cost_basis [String, nil]
+              #   #
+              #   def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
+
+              # def initialize: (Hash | Orb::BaseModel) -> void
+            end
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry#customer
+            class Customer < Orb::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute external_customer_id
+              #
+              #   @return [String, nil]
+              required :external_customer_id, String, nil?: true
+
+              # @!parse
+              #   # @param id [String]
+              #   # @param external_customer_id [String, nil]
+              #   #
+              #   def initialize(id:, external_customer_id:, **) = super
+
+              # def initialize: (Hash | Orb::BaseModel) -> void
+            end
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry#entry_status
+            module EntryStatus
+              extend Orb::Enum
+
+              COMMITTED = :committed
+              PENDING = :pending
+
+              finalize!
+
+              # @!parse
+              #   # @return [Array<Symbol>]
+              #   def self.values; end
+            end
+          end
+
+          class VoidLedgerEntry < Orb::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute amount
+            #
+            #   @return [Float]
+            required :amount, Float
+
+            # @!attribute created_at
+            #
+            #   @return [Time]
+            required :created_at, Time
+
+            # @!attribute credit_block
+            #
+            #   @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::CreditBlock]
+            required :credit_block,
+                     -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::CreditBlock }
+
+            # @!attribute currency
+            #
+            #   @return [String]
+            required :currency, String
+
+            # @!attribute customer
+            #
+            #   @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::Customer]
+            required :customer,
+                     -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::Customer }
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            required :description, String, nil?: true
+
+            # @!attribute ending_balance
+            #
+            #   @return [Float]
+            required :ending_balance, Float
+
+            # @!attribute entry_status
+            #
+            #   @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus]
+            required :entry_status,
+                     enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus }
+
+            # @!attribute entry_type
+            #
+            #   @return [Symbol, :void]
+            required :entry_type, const: :void
+
+            # @!attribute ledger_sequence_number
+            #
+            #   @return [Integer]
+            required :ledger_sequence_number, Integer
+
+            # @!attribute metadata
+            #   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`.
+            #
+            #   @return [Hash{Symbol=>String}]
+            required :metadata, Orb::HashOf[String]
+
+            # @!attribute starting_balance
+            #
+            #   @return [Float]
+            required :starting_balance, Float
+
+            # @!attribute void_amount
+            #
+            #   @return [Float]
+            required :void_amount, Float
+
+            # @!attribute void_reason
+            #
+            #   @return [String, nil]
+            required :void_reason, String, nil?: true
+
+            # @!parse
+            #   # @param id [String]
+            #   # @param amount [Float]
+            #   # @param created_at [Time]
+            #   # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::CreditBlock]
+            #   # @param currency [String]
+            #   # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::Customer]
+            #   # @param description [String, nil]
+            #   # @param ending_balance [Float]
+            #   # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus]
+            #   # @param ledger_sequence_number [Integer]
+            #   # @param metadata [Hash{Symbol=>String}]
+            #   # @param starting_balance [Float]
+            #   # @param void_amount [Float]
+            #   # @param void_reason [String, nil]
+            #   # @param entry_type [Symbol, :void]
+            #   #
+            #   def initialize(
+            #     id:,
+            #     amount:,
+            #     created_at:,
+            #     credit_block:,
+            #     currency:,
+            #     customer:,
+            #     description:,
+            #     ending_balance:,
+            #     entry_status:,
+            #     ledger_sequence_number:,
+            #     metadata:,
+            #     starting_balance:,
+            #     void_amount:,
+            #     void_reason:,
+            #     entry_type: :void,
+            #     **
+            #   )
+            #     super
+            #   end
+
+            # def initialize: (Hash | Orb::BaseModel) -> void
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry#credit_block
+            class CreditBlock < Orb::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute expiry_date
+              #
+              #   @return [Time, nil]
+              required :expiry_date, Time, nil?: true
+
+              # @!attribute per_unit_cost_basis
+              #
+              #   @return [String, nil]
+              required :per_unit_cost_basis, String, nil?: true
+
+              # @!parse
+              #   # @param id [String]
+              #   # @param expiry_date [Time, nil]
+              #   # @param per_unit_cost_basis [String, nil]
+              #   #
+              #   def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
+
+              # def initialize: (Hash | Orb::BaseModel) -> void
+            end
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry#customer
+            class Customer < Orb::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute external_customer_id
+              #
+              #   @return [String, nil]
+              required :external_customer_id, String, nil?: true
+
+              # @!parse
+              #   # @param id [String]
+              #   # @param external_customer_id [String, nil]
+              #   #
+              #   def initialize(id:, external_customer_id:, **) = super
+
+              # def initialize: (Hash | Orb::BaseModel) -> void
+            end
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry#entry_status
+            module EntryStatus
+              extend Orb::Enum
+
+              COMMITTED = :committed
+              PENDING = :pending
+
+              finalize!
+
+              # @!parse
+              #   # @return [Array<Symbol>]
+              #   def self.values; end
+            end
+          end
+
+          class VoidInitiatedLedgerEntry < Orb::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute amount
+            #
+            #   @return [Float]
+            required :amount, Float
+
+            # @!attribute created_at
+            #
+            #   @return [Time]
+            required :created_at, Time
+
+            # @!attribute credit_block
+            #
+            #   @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock]
+            required :credit_block,
+                     -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock }
+
+            # @!attribute currency
+            #
+            #   @return [String]
+            required :currency, String
+
+            # @!attribute customer
+            #
+            #   @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::Customer]
+            required :customer,
+                     -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::Customer }
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            required :description, String, nil?: true
+
+            # @!attribute ending_balance
+            #
+            #   @return [Float]
+            required :ending_balance, Float
+
+            # @!attribute entry_status
+            #
+            #   @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus]
+            required :entry_status,
+                     enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus }
+
+            # @!attribute entry_type
+            #
+            #   @return [Symbol, :void_initiated]
+            required :entry_type, const: :void_initiated
+
+            # @!attribute ledger_sequence_number
+            #
+            #   @return [Integer]
+            required :ledger_sequence_number, Integer
+
+            # @!attribute metadata
+            #   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`.
+            #
+            #   @return [Hash{Symbol=>String}]
+            required :metadata, Orb::HashOf[String]
+
+            # @!attribute new_block_expiry_date
+            #
+            #   @return [Time]
+            required :new_block_expiry_date, Time
+
+            # @!attribute starting_balance
+            #
+            #   @return [Float]
+            required :starting_balance, Float
+
+            # @!attribute void_amount
+            #
+            #   @return [Float]
+            required :void_amount, Float
+
+            # @!attribute void_reason
+            #
+            #   @return [String, nil]
+            required :void_reason, String, nil?: true
+
+            # @!parse
+            #   # @param id [String]
+            #   # @param amount [Float]
+            #   # @param created_at [Time]
+            #   # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock]
+            #   # @param currency [String]
+            #   # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::Customer]
+            #   # @param description [String, nil]
+            #   # @param ending_balance [Float]
+            #   # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus]
+            #   # @param ledger_sequence_number [Integer]
+            #   # @param metadata [Hash{Symbol=>String}]
+            #   # @param new_block_expiry_date [Time]
+            #   # @param starting_balance [Float]
+            #   # @param void_amount [Float]
+            #   # @param void_reason [String, nil]
+            #   # @param entry_type [Symbol, :void_initiated]
+            #   #
+            #   def initialize(
+            #     id:,
+            #     amount:,
+            #     created_at:,
+            #     credit_block:,
+            #     currency:,
+            #     customer:,
+            #     description:,
+            #     ending_balance:,
+            #     entry_status:,
+            #     ledger_sequence_number:,
+            #     metadata:,
+            #     new_block_expiry_date:,
+            #     starting_balance:,
+            #     void_amount:,
+            #     void_reason:,
+            #     entry_type: :void_initiated,
+            #     **
+            #   )
+            #     super
+            #   end
+
+            # def initialize: (Hash | Orb::BaseModel) -> void
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry#credit_block
+            class CreditBlock < Orb::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute expiry_date
+              #
+              #   @return [Time, nil]
+              required :expiry_date, Time, nil?: true
+
+              # @!attribute per_unit_cost_basis
+              #
+              #   @return [String, nil]
+              required :per_unit_cost_basis, String, nil?: true
+
+              # @!parse
+              #   # @param id [String]
+              #   # @param expiry_date [Time, nil]
+              #   # @param per_unit_cost_basis [String, nil]
+              #   #
+              #   def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
+
+              # def initialize: (Hash | Orb::BaseModel) -> void
+            end
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry#customer
+            class Customer < Orb::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute external_customer_id
+              #
+              #   @return [String, nil]
+              required :external_customer_id, String, nil?: true
+
+              # @!parse
+              #   # @param id [String]
+              #   # @param external_customer_id [String, nil]
+              #   #
+              #   def initialize(id:, external_customer_id:, **) = super
+
+              # def initialize: (Hash | Orb::BaseModel) -> void
+            end
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry#entry_status
+            module EntryStatus
+              extend Orb::Enum
+
+              COMMITTED = :committed
+              PENDING = :pending
+
+              finalize!
+
+              # @!parse
+              #   # @return [Array<Symbol>]
+              #   def self.values; end
+            end
+          end
+
+          class AmendmentLedgerEntry < Orb::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute amount
+            #
+            #   @return [Float]
+            required :amount, Float
+
+            # @!attribute created_at
+            #
+            #   @return [Time]
+            required :created_at, Time
+
+            # @!attribute credit_block
+            #
+            #   @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::CreditBlock]
+            required :credit_block,
+                     -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::CreditBlock }
+
+            # @!attribute currency
+            #
+            #   @return [String]
+            required :currency, String
+
+            # @!attribute customer
+            #
+            #   @return [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::Customer]
+            required :customer,
+                     -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::Customer }
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            required :description, String, nil?: true
+
+            # @!attribute ending_balance
+            #
+            #   @return [Float]
+            required :ending_balance, Float
+
+            # @!attribute entry_status
+            #
+            #   @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus]
+            required :entry_status,
+                     enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus }
+
+            # @!attribute entry_type
+            #
+            #   @return [Symbol, :amendment]
+            required :entry_type, const: :amendment
+
+            # @!attribute ledger_sequence_number
+            #
+            #   @return [Integer]
+            required :ledger_sequence_number, Integer
+
+            # @!attribute metadata
+            #   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`.
+            #
+            #   @return [Hash{Symbol=>String}]
+            required :metadata, Orb::HashOf[String]
+
+            # @!attribute starting_balance
+            #
+            #   @return [Float]
+            required :starting_balance, Float
+
+            # @!parse
+            #   # @param id [String]
+            #   # @param amount [Float]
+            #   # @param created_at [Time]
+            #   # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::CreditBlock]
+            #   # @param currency [String]
+            #   # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::Customer]
+            #   # @param description [String, nil]
+            #   # @param ending_balance [Float]
+            #   # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus]
+            #   # @param ledger_sequence_number [Integer]
+            #   # @param metadata [Hash{Symbol=>String}]
+            #   # @param starting_balance [Float]
+            #   # @param entry_type [Symbol, :amendment]
+            #   #
+            #   def initialize(
+            #     id:,
+            #     amount:,
+            #     created_at:,
+            #     credit_block:,
+            #     currency:,
+            #     customer:,
+            #     description:,
+            #     ending_balance:,
+            #     entry_status:,
+            #     ledger_sequence_number:,
+            #     metadata:,
+            #     starting_balance:,
+            #     entry_type: :amendment,
+            #     **
+            #   )
+            #     super
+            #   end
+
+            # def initialize: (Hash | Orb::BaseModel) -> void
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry#credit_block
+            class CreditBlock < Orb::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute expiry_date
+              #
+              #   @return [Time, nil]
+              required :expiry_date, Time, nil?: true
+
+              # @!attribute per_unit_cost_basis
+              #
+              #   @return [String, nil]
+              required :per_unit_cost_basis, String, nil?: true
+
+              # @!parse
+              #   # @param id [String]
+              #   # @param expiry_date [Time, nil]
+              #   # @param per_unit_cost_basis [String, nil]
+              #   #
+              #   def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
+
+              # def initialize: (Hash | Orb::BaseModel) -> void
+            end
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry#customer
+            class Customer < Orb::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute external_customer_id
+              #
+              #   @return [String, nil]
+              required :external_customer_id, String, nil?: true
+
+              # @!parse
+              #   # @param id [String]
+              #   # @param external_customer_id [String, nil]
+              #   #
+              #   def initialize(id:, external_customer_id:, **) = super
+
+              # def initialize: (Hash | Orb::BaseModel) -> void
+            end
+
+            # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry#entry_status
+            module EntryStatus
+              extend Orb::Enum
+
+              COMMITTED = :committed
+              PENDING = :pending
+
+              finalize!
+
+              # @!parse
+              #   # @return [Array<Symbol>]
+              #   def self.values; end
+            end
+          end
+
+          # @!parse
+          #   # @return [Array(Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry)]
+          #   def self.variants; end
+        end
+      end
+    end
+  end
+end