Class: EInvoiceAPI::Models::InboxListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/e_invoice_api/models/inbox_list_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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

Parameters:

  • date_from (Time, nil) (defaults to: nil) —

    Filter by issue date (from)

  • date_to (Time, nil) (defaults to: nil) —

    Filter by issue date (to)

  • 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

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

    Filter by sender ID

  • 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/inbox_list_params.rb', line 58

Instance Attribute Details

#date_from ⇒ Time?

Filter by issue date (from)

Returns:

  • (Time, nil) 


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

optional :date_from, Time, nil?: true

#date_to ⇒ Time?

Filter by issue date (to)

Returns:

  • (Time, nil) 


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

optional :date_to, Time, nil?: true

#page ⇒ Integer?

Page number

Returns:

  • (Integer, nil) 


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

optional :page, Integer

#page_size ⇒ Integer?

Number of items per page

Returns:

  • (Integer, nil) 


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

optional :page_size, Integer

#search ⇒ String?

Search in invoice number, seller/buyer names

Returns:

  • (String, nil) 


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

optional :search, String, nil?: true

#sender ⇒ String?

Filter by sender ID

Returns:

  • (String, nil) 


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

optional :sender, String, nil?: true

#state ⇒ Symbol, ...

Filter by document state

Returns:



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

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

#type ⇒ Symbol, ...

Filter by document type

Returns:



56
 
# File 'lib/e_invoice_api/models/inbox_list_params.rb', line 56

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