Class: Increase::Models::LockboxListParams

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

Overview

See Also:

Defined Under Namespace

Classes: CreatedAt

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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

#account_id ⇒ String?

Filter Lockboxes to those associated with the provided Account.

Returns:

  • (String, nil) 


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

optional :account_id, String

#created_at ⇒ Increase::Models::LockboxListParams::CreatedAt?

Returns:



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

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

#cursor ⇒ String?

Return the page of entries after this one.

Returns:

  • (String, nil) 


25
 
# File 'lib/increase/models/lockbox_list_params.rb', line 25

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) 


34
 
# File 'lib/increase/models/lockbox_list_params.rb', line 34

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) 


41
 
# File 'lib/increase/models/lockbox_list_params.rb', line 41

optional :limit, Integer