Class: Orb::Models::InvoiceListParams

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

Overview

See Also:

  • Orb::Resources::Invoices#list

Defined Under Namespace

Modules: DateType, Status

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 



74
 
# File 'sig/orb/models/invoice_list_params.rbs', line 74

def initialize: (

Instance Attribute Details

#amount ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


13
 
# File 'lib/orb/models/invoice_list_params.rb', line 13

optional :amount, String, nil?: true

#amount_gt ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


18
 
# File 'lib/orb/models/invoice_list_params.rb', line 18

optional :amount_gt, String, nil?: true

#amount_lt ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


23
 
# File 'lib/orb/models/invoice_list_params.rb', line 23

optional :amount_lt, 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) 


30
 
# File 'lib/orb/models/invoice_list_params.rb', line 30

optional :cursor, String, nil?: true

#customer_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


35
 
# File 'lib/orb/models/invoice_list_params.rb', line 35

optional :customer_id, String, nil?: true

#date_type ⇒ Symbol, ...

Parameters:

  • value (Orb::Models::InvoiceListParams::date_type, nil)

Returns:



40
 
# File 'lib/orb/models/invoice_list_params.rb', line 40

optional :date_type, enum: -> { Orb::InvoiceListParams::DateType }, nil?: true

#due_date ⇒ Date?

Parameters:

  • value (Date, nil)

Returns:

  • (Date, nil) 


45
 
# File 'lib/orb/models/invoice_list_params.rb', line 45

optional :due_date, Date, nil?: true

#due_date_gt ⇒ Date?

Parameters:

  • value (Date, nil)

Returns:

  • (Date, nil) 


59
 
# File 'lib/orb/models/invoice_list_params.rb', line 59

optional :due_date_gt, Date, nil?: true

#due_date_lt ⇒ Date?

Parameters:

  • value (Date, nil)

Returns:

  • (Date, nil) 


64
 
# File 'lib/orb/models/invoice_list_params.rb', line 64

optional :due_date_lt, Date, nil?: true

#due_date_window ⇒ String?

Filters invoices by their due dates within a specific time range in the past. Specify the range as a number followed by 'd' (days) or 'm' (months). For example, '7d' filters invoices due in the last 7 days, and '2m' filters those due in the last 2 months.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


54
 
# File 'lib/orb/models/invoice_list_params.rb', line 54

optional :due_date_window, String, nil?: true

#external_customer_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


69
 
# File 'lib/orb/models/invoice_list_params.rb', line 69

optional :external_customer_id, String, nil?: true

#include_zero_quantity_line_items ⇒ Boolean?

Whether to return line items with a quantity of zero. When omitted, Orb returns every line item. A line item that is grouped as part of a line item minimum is always returned; an invoice-level minimum does not exempt it.

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


77
 
# File 'lib/orb/models/invoice_list_params.rb', line 77

optional :include_zero_quantity_line_items, Orb::Internal::Type::Boolean, nil?: true

#invoice_date_gt ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


82
 
# File 'lib/orb/models/invoice_list_params.rb', line 82

optional :invoice_date_gt, Time, nil?: true

#invoice_date_gte ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


87
 
# File 'lib/orb/models/invoice_list_params.rb', line 87

optional :invoice_date_gte, Time, nil?: true

#invoice_date_lt ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


92
 
# File 'lib/orb/models/invoice_list_params.rb', line 92

optional :invoice_date_lt, Time, nil?: true

#invoice_date_lte ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


97
 
# File 'lib/orb/models/invoice_list_params.rb', line 97

optional :invoice_date_lte, Time, nil?: true

#is_recurring ⇒ Boolean?

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


102
 
# File 'lib/orb/models/invoice_list_params.rb', line 102

optional :is_recurring, Orb::Internal::Type::Boolean, nil?: true

#limit ⇒ Integer?

The number of items to fetch. Defaults to 20.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


108
 
# File 'lib/orb/models/invoice_list_params.rb', line 108

optional :limit, Integer

#status ⇒ Array<Symbol, Orb::Models::InvoiceListParams::Status>?

Parameters:

  • value (::Array[Orb::Models::InvoiceListParams::status], nil)

Returns:



113
 
# File 'lib/orb/models/invoice_list_params.rb', line 113

optional :status, -> { Orb::Internal::Type::ArrayOf[enum: Orb::InvoiceListParams::Status] }, nil?: true

#subscription_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


118
 
# File 'lib/orb/models/invoice_list_params.rb', line 118

optional :subscription_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/invoice_list_params.rb', line 172

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


98
 
# File 'sig/orb/models/invoice_list_params.rbs', line 98

def to_hash: -> {