Class: Orb::Models::Customers::Credits::LedgerListByExternalIDParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb,
sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs

Overview

See Also:

  • Orb::Resources::Customers::Credits::Ledger#list_by_external_id

Defined Under Namespace

Modules: EntryStatus, EntryType

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize ⇒ Object 



49
 
# File 'sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs', line 49

def initialize: (

Instance Attribute Details

#created_at_gt ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


20
 
# File 'lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb', line 20

optional :created_at_gt, Time, nil?: true

#created_at_gte ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


25
 
# File 'lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb', line 25

optional :created_at_gte, Time, nil?: true

#created_at_lt ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


30
 
# File 'lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb', line 30

optional :created_at_lt, Time, nil?: true

#created_at_lte ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


35
 
# File 'lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb', line 35

optional :created_at_lte, Time, nil?: true

#currency ⇒ String?

The ledger currency or custom pricing unit to use.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


41
 
# File 'lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb', line 41

optional :currency, String, nil?: true

#cursor ⇒ String?

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

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


48
 
# File 'lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb', line 48

optional :cursor, String, nil?: true

#entry_status ⇒ Symbol, ...

Parameters:

  • value (Orb::Models::Customers::Credits::LedgerListByExternalIDParams::entry_status, nil)

Returns:



53
54
55
 
# File 'lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb', line 53

optional :entry_status,
enum: -> { Orb::Customers::Credits::LedgerListByExternalIDParams::EntryStatus },
nil?: true

#entry_type ⇒ Symbol, ...

Parameters:

  • value (Orb::Models::Customers::Credits::LedgerListByExternalIDParams::entry_type, nil)

Returns:



60
61
62
 
# File 'lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb', line 60

optional :entry_type,
enum: -> { Orb::Customers::Credits::LedgerListByExternalIDParams::EntryType },
nil?: true

#external_customer_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb', line 15

required :external_customer_id, String

#limit ⇒ Integer?

The number of items to fetch. Defaults to 20.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


68
 
# File 'lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb', line 68

optional :limit, Integer

#minimum_amount ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


73
 
# File 'lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb', line 73

optional :minimum_amount, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb', line 110

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


64
 
# File 'sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs', line 64

def to_hash: -> {