Class: VitableConnect::Models::EmployerListInvoicesParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• VitableConnect::Models::EmployerListInvoicesParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/vitable_connect/models/employer_list_invoices_params.rb,
sig/vitable_connect/models/employer_list_invoices_params.rbs

Overview

See Also:

• VitableConnect::Resources::Employers#list_invoices

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::VitableConnect

Instance Attribute Summary

• #employer_id ⇒ String

  Unique employer identifier (empr_*).

• #limit ⇒ Integer^?

  Maximum number of invoices per page.

• #offset ⇒ String^?

  Opaque cursor from a previous page's next_offset.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(employer_id:, limit: nil, offset: nil, request_options: {}) ⇒ Object constructor
• #to_hash ⇒ {

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(employer_id:, limit: nil, offset: nil, request_options: {}) ⇒ Object

Parameters:

• employer_id (String) —

  Unique employer identifier (empr_*)

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

  Maximum number of invoices per page

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

  Opaque cursor from a previous page's next_offset

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

# File 'lib/vitable_connect/models/employer_list_invoices_params.rb', line 28

Instance Attribute Details

#employer_id ⇒ String

Unique employer identifier (empr_*)

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/vitable_connect/models/employer_list_invoices_params.rb', line 14

required :employer_id, String

#limit ⇒ Integer^?

Maximum number of invoices per page

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/vitable_connect/models/employer_list_invoices_params.rb', line 20

optional :limit, Integer

#offset ⇒ String^?

Opaque cursor from a previous page's next_offset

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/vitable_connect/models/employer_list_invoices_params.rb', line 26

optional :offset, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/vitable_connect/models/employer_list_invoices_params.rbs', line 26

def to_hash: -> {