Module: Orb::Models::Customers::Credits::LedgerListParams::EntryStatus

Extended by:
Internal::Type::Enum
Defined in:
lib/orb/models/customers/credits/ledger_list_params.rb,
sig/orb/models/customers/credits/ledger_list_params.rbs

Constant Summary collapse

COMMITTED =

Returns:

  • (:committed) 
:committed
PENDING =

Returns:

  • (:pending) 
:pending

Instance Method Summary collapse

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Instance Method Details

#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: {}) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::Customers::Credits::LedgerListParams for more details.

Parameters:

  • customer_id (String)
  • created_at_gt (Time, nil) (defaults to: nil)
  • created_at_gte (Time, nil) (defaults to: nil)
  • created_at_lt (Time, nil) (defaults to: nil)
  • created_at_lte (Time, nil) (defaults to: nil)
  • currency (String, nil) (defaults to: nil) —

    The ledger currency or custom pricing unit to use.

  • cursor (String, nil) (defaults to: nil) —

    Cursor for pagination. This can be populated by the next_cursor value returned

  • entry_status (Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus, nil) (defaults to: nil)
  • entry_type (Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType, nil) (defaults to: nil)
  • limit (Integer) (defaults to: nil) —

    The number of items to fetch. Defaults to 20.

  • minimum_amount (String, nil) (defaults to: nil)
  • request_options (Orb::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


103
104
105
106
107
108
109
110
111
 
# File 'lib/orb/models/customers/credits/ledger_list_params.rb', line 103

module EntryStatus
  extend Orb::Internal::Type::Enum

  COMMITTED = :committed
  PENDING = :pending

  # @!method self.values
  #   @return [Array<Symbol>]
end

#self?.values ⇒ ::Array[Orb::Models::Customers::Credits::LedgerListParams::entry_status]

Returns:

  • (::Array[Orb::Models::Customers::Credits::LedgerListParams::entry_status]) 


87
 
# File 'sig/orb/models/customers/credits/ledger_list_params.rbs', line 87

def self?.values: -> ::Array[Orb::Models::Customers::Credits::LedgerListParams::entry_status]