Class: Increase::Models::DocumentListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/increase/models/document_list_params.rb

Overview

See Also:

• Resources::Documents#list

Defined Under Namespace

Classes: Category, CreatedAt

Instance Attribute Summary

• #category ⇒ Increase::Models::DocumentListParams::Category^?
• #created_at ⇒ Increase::Models::DocumentListParams::CreatedAt^?
• #cursor ⇒ String^?

  Return the page of entries after this one.

• #entity_id ⇒ String^?

  Filter Documents to ones belonging to the specified Entity.

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

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 Increase::Internal::Type::BaseModel

Instance Attribute Details

#category ⇒ Increase::Models::DocumentListParams::Category^?

Returns:

• (Increase::Models::DocumentListParams::Category, nil)

# File 'lib/increase/models/document_list_params.rb', line 13

optional :category, -> { Increase::DocumentListParams::Category }

#created_at ⇒ Increase::Models::DocumentListParams::CreatedAt^?

Returns:

• (Increase::Models::DocumentListParams::CreatedAt, nil)

# File 'lib/increase/models/document_list_params.rb', line 18

optional :created_at, -> { Increase::DocumentListParams::CreatedAt }

#cursor ⇒ String^?

Return the page of entries after this one.

Returns:

• (String, nil)

# File 'lib/increase/models/document_list_params.rb', line 24

optional :cursor, String

#entity_id ⇒ String^?

Filter Documents to ones belonging to the specified Entity.

Returns:

• (String, nil)

# File 'lib/increase/models/document_list_params.rb', line 30

optional :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](increase.com/documentation/idempotency-keys).

Returns:

• (String, nil)

# File 'lib/increase/models/document_list_params.rb', line 39

optional :idempotency_key, String

#limit ⇒ Integer^?

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

Returns:

• (Integer, nil)

# File 'lib/increase/models/document_list_params.rb', line 46

optional :limit, Integer

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/increase/models/document_list_params.rb', line 104