Class: Orb::Models::InvoiceListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::InvoiceListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/orb/models/invoice_list_params.rb

Overview

See Also:

• Resources::Invoices#list

Defined Under Namespace

Modules: DateType, Status

Instance Attribute Summary

• #amount ⇒ String^?
• #amount_gt ⇒ String^?
• #amount_lt ⇒ String^?
• #cursor ⇒ String^?

  Cursor for pagination.

• #customer_id ⇒ String^?
• #date_type ⇒ Symbol, ...
• #due_date ⇒ Date^?
• #due_date_gt ⇒ Date^?
• #due_date_lt ⇒ Date^?
• #due_date_window ⇒ String^?

  Filters invoices by their due dates within a specific time range in the past.

• #external_customer_id ⇒ String^?
• #invoice_date_gt ⇒ Time^?
• #invoice_date_gte ⇒ Time^?
• #invoice_date_lt ⇒ Time^?
• #invoice_date_lte ⇒ Time^?
• #is_recurring ⇒ Boolean^?
• #limit ⇒ Integer^?

  The number of items to fetch.

• #status ⇒ Array<Symbol, Orb::Models::InvoiceListParams::Status>^?
• #subscription_id ⇒ String^?

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

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, #initialize, 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

This class inherits a constructor from Orb::Internal::Type::BaseModel

Instance Attribute Details

#amount ⇒ String^?

Returns:

• (String, nil)

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

optional :amount, String, nil?: true

#amount_gt ⇒ String^?

Returns:

• (String, nil)

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

optional :amount_gt, String, nil?: true

#amount_lt ⇒ String^?

Returns:

• (String, nil)

# 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.

Returns:

• (String, nil)

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

optional :cursor, String, nil?: true

#customer_id ⇒ String^?

Returns:

• (String, nil)

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

optional :customer_id, String, nil?: true

#date_type ⇒ Symbol, ...

Returns:

• (Symbol, Orb::Models::InvoiceListParams::DateType, nil)

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

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

#due_date ⇒ Date^?

Returns:

• (Date, nil)

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

optional :due_date, Date, nil?: true

#due_date_gt ⇒ Date^?

Returns:

• (Date, nil)

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

optional :due_date_gt, Date, nil?: true

#due_date_lt ⇒ Date^?

Returns:

• (Date, nil)

# 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.

Returns:

• (String, nil)

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

optional :due_date_window, String, nil?: true

#external_customer_id ⇒ String^?

Returns:

• (String, nil)

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

optional :external_customer_id, String, nil?: true

#invoice_date_gt ⇒ Time^?

Returns:

• (Time, nil)

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

optional :invoice_date_gt, Time, nil?: true

#invoice_date_gte ⇒ Time^?

Returns:

• (Time, nil)

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

optional :invoice_date_gte, Time, nil?: true

#invoice_date_lt ⇒ Time^?

Returns:

• (Time, nil)

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

optional :invoice_date_lt, Time, nil?: true

#invoice_date_lte ⇒ Time^?

Returns:

• (Time, nil)

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

optional :invoice_date_lte, Time, nil?: true

#is_recurring ⇒ Boolean^?

Returns:

• (Boolean, nil)

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

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

#limit ⇒ Integer^?

The number of items to fetch. Defaults to 20.

Returns:

• (Integer, nil)

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

optional :limit, Integer

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

Returns:

• (Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil)

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

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

#subscription_id ⇒ String^?

Returns:

• (String, nil)

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

optional :subscription_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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