Class: Increase::Models::InboundMailItemListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/increase/models/inbound_mail_item_list_params.rb

Overview

See Also:

• Resources::InboundMailItems#list

Defined Under Namespace

Classes: CreatedAt

Instance Attribute Summary

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

  Return the page of entries after this one.

• #limit ⇒ Integer^?

  Limit the size of the list that is returned.

• #lockbox_id ⇒ String^?

  Filter Inbound Mail Items to ones sent to the provided Lockbox.

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

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

Returns:

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

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

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

#cursor ⇒ String^?

Return the page of entries after this one.

Returns:

• (String, nil)

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

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

optional :limit, Integer

#lockbox_id ⇒ String^?

Filter Inbound Mail Items to ones sent to the provided Lockbox.

Returns:

• (String, nil)

# File 'lib/increase/models/inbound_mail_item_list_params.rb', line 32

optional :lockbox_id, String