Class: EInvoiceAPI::Models::OutboxListDraftDocumentsParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• EInvoiceAPI::Models::OutboxListDraftDocumentsParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/e_invoice_api/models/outbox_list_draft_documents_params.rb

Overview

See Also:

• Resources::Outbox#list_draft_documents

Defined Under Namespace

Modules: SortBy, SortOrder

Instance Attribute Summary

• #page ⇒ Integer^?

  Page number.

• #page_size ⇒ Integer^?

  Number of items per page.

• #search ⇒ String^?

  Search in invoice number, seller/buyer names.

• #sort_by ⇒ Symbol, ...

  Field to sort by.

• #sort_order ⇒ Symbol, ...

  Sort direction (asc/desc).

• #state ⇒ Symbol, ...

  Filter by document state.

• #type ⇒ Symbol, ...

  Filter by document type.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(page: nil, page_size: nil, search: nil, sort_by: nil, sort_order: nil, state: nil, type: nil, request_options: {}) ⇒ Object constructor

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(page: nil, page_size: nil, search: nil, sort_by: nil, sort_order: nil, state: nil, type: nil, request_options: {}) ⇒ Object

Parameters:

• page (Integer) (defaults to: nil) —

  Page number

• page_size (Integer) (defaults to: nil) —

  Number of items per page

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

  Search in invoice number, seller/buyer names

• sort_by (Symbol, EInvoiceAPI::Models::OutboxListDraftDocumentsParams::SortBy) (defaults to: nil) —

  Field to sort by

• sort_order (Symbol, EInvoiceAPI::Models::OutboxListDraftDocumentsParams::SortOrder) (defaults to: nil) —

  Sort direction (asc/desc)

• state (Symbol, EInvoiceAPI::Models::DocumentState, nil) (defaults to: nil) —

  Filter by document state

• type (Symbol, EInvoiceAPI::Models::DocumentType, nil) (defaults to: nil) —

  Filter by document type

• request_options (EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/e_invoice_api/models/outbox_list_draft_documents_params.rb', line 52

Instance Attribute Details

#page ⇒ Integer^?

Page number

Returns:

• (Integer, nil)

# File 'lib/e_invoice_api/models/outbox_list_draft_documents_params.rb', line 14

optional :page, Integer

#page_size ⇒ Integer^?

Number of items per page

Returns:

• (Integer, nil)

# File 'lib/e_invoice_api/models/outbox_list_draft_documents_params.rb', line 20

optional :page_size, Integer

#search ⇒ String^?

Search in invoice number, seller/buyer names

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/outbox_list_draft_documents_params.rb', line 26

optional :search, String, nil?: true

#sort_by ⇒ Symbol, ...

Field to sort by

Returns:

• (Symbol, EInvoiceAPI::Models::OutboxListDraftDocumentsParams::SortBy, nil)

# File 'lib/e_invoice_api/models/outbox_list_draft_documents_params.rb', line 32

optional :sort_by, enum: -> { EInvoiceAPI::OutboxListDraftDocumentsParams::SortBy }

#sort_order ⇒ Symbol, ...

Sort direction (asc/desc)

Returns:

• (Symbol, EInvoiceAPI::Models::OutboxListDraftDocumentsParams::SortOrder, nil)

# File 'lib/e_invoice_api/models/outbox_list_draft_documents_params.rb', line 38

optional :sort_order, enum: -> { EInvoiceAPI::OutboxListDraftDocumentsParams::SortOrder }

#state ⇒ Symbol, ...

Filter by document state

Returns:

• (Symbol, EInvoiceAPI::Models::DocumentState, nil)

# File 'lib/e_invoice_api/models/outbox_list_draft_documents_params.rb', line 44

optional :state, enum: -> { EInvoiceAPI::DocumentState }, nil?: true

#type ⇒ Symbol, ...

Filter by document type

Returns:

• (Symbol, EInvoiceAPI::Models::DocumentType, nil)

# File 'lib/e_invoice_api/models/outbox_list_draft_documents_params.rb', line 50

optional :type, enum: -> { EInvoiceAPI::DocumentType }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/e_invoice_api/models/outbox_list_draft_documents_params.rb', line 81