Class: Increase::Models::SupplementalDocumentListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Increase::Models::SupplementalDocumentListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/increase/models/supplemental_document_list_params.rb,
sig/increase/models/supplemental_document_list_params.rbs

Overview

See Also:

• Increase::Resources::SupplementalDocuments#list

Instance Attribute Summary

• #cursor ⇒ String^?

  Return the page of entries after this one.

• #entity_id ⇒ String

  The identifier of the Entity to list supplemental documents for.

• #idempotency_key ⇒ String^?

  Filter records to the one with the specified idempotency_key you chose for that object.

• #limit ⇒ Integer^?

  Limit the size of the list that is returned.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(entity_id:, cursor: nil, idempotency_key: nil, limit: 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(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) ⇒ Object

Parameters:

• The identifier of the Entity to list supplemental documents for.

• (defaults to: nil)

  Return the page of entries after this one.

• (defaults to: nil)

  Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

• (defaults to: nil)

  Limit the size of the list that is returned. The default (and maximum) is 100 objects.

  Defaults to 100.

• (defaults to: {})

# File 'lib/increase/models/supplemental_document_list_params.rb', line 40

Instance Attribute Details

#cursor ⇒ String^?

Return the page of entries after this one.

Parameters:

Returns:

# File 'lib/increase/models/supplemental_document_list_params.rb', line 20

optional :cursor, String

#entity_id ⇒ String

The identifier of the Entity to list supplemental documents for.

Parameters:

Returns:

# File 'lib/increase/models/supplemental_document_list_params.rb', line 14

required :entity_id, String

#idempotency_key ⇒ String^?

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Parameters:

Returns:

# File 'lib/increase/models/supplemental_document_list_params.rb', line 29

optional :idempotency_key, String

#limit ⇒ Integer^?

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

Defaults to 100.

Parameters:

Returns:

# File 'lib/increase/models/supplemental_document_list_params.rb', line 38

optional :limit, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

# File 'sig/increase/models/supplemental_document_list_params.rbs', line 38

def to_hash: -> {