Class: Increase::Models::EntityListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/increase/models/entity_list_params.rb

Overview

See Also:

• Resources::Entities#list

Defined Under Namespace

Classes: CreatedAt, Status

Instance Attribute Summary

• #created_at ⇒ Increase::Models::EntityListParams::CreatedAt^?
• #cursor ⇒ String^?

  Return the page of entries after this one.

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

• #status ⇒ Increase::Models::EntityListParams::Status^?

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see CreatedAt for more details.

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(after: nil, before: nil, on_or_after: nil, on_or_before: nil) ⇒ Object

Some parameter documentations has been truncated, see CreatedAt for more details.

Parameters:

• after (Time) (defaults to: nil) —

  Return results after this [ISO 8601](en.wikipedia.org/wiki/ISO_8601) tim

• before (Time) (defaults to: nil) —

  Return results before this [ISO 8601](en.wikipedia.org/wiki/ISO_8601) ti

• on_or_after (Time) (defaults to: nil) —

  Return results on or after this [ISO 8601](en.wikipedia.org/wiki/ISO_860

• on_or_before (Time) (defaults to: nil) —

  Return results on or before this [ISO 8601](en.wikipedia.org/wiki/ISO_86

# File 'lib/increase/models/entity_list_params.rb', line 87

Instance Attribute Details

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

Returns:

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

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

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

#cursor ⇒ String^?

Return the page of entries after this one.

Returns:

• (String, nil)

# File 'lib/increase/models/entity_list_params.rb', line 19

optional :cursor, 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/entity_list_params.rb', line 28

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/entity_list_params.rb', line 35

optional :limit, Integer

#status ⇒ Increase::Models::EntityListParams::Status^?

Returns:

• (Increase::Models::EntityListParams::Status, nil)

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

optional :status, -> { Increase::EntityListParams::Status }