Class: Increase::Models::InboundMailItem

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/inbound_mail_item.rb

Overview

See Also:

Defined Under Namespace

Modules: RejectionReason, Status, Type

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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, 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(id: , created_at: , file_id: , lockbox_id: , recipient_name: , rejection_reason: , status: , type: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::InboundMailItem for more details.

Inbound Mail Items represent pieces of physical mail delivered to a Lockbox.

Parameters:

  • id (String) (defaults to: ) —

    The Inbound Mail Item identifier.

  • created_at (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the Inbound

  • file_id (String) (defaults to: ) —

    The identifier for the File containing the scanned contents of the mail item.

  • lockbox_id (String, nil) (defaults to: ) —

    The identifier for the Lockbox that received this mail item. For mail items that

  • recipient_name (String, nil) (defaults to: ) —

    The recipient name as written on the mail item.

  • rejection_reason (Symbol, Increase::Models::InboundMailItem::RejectionReason, nil) (defaults to: ) —

    If the mail item has been rejected, why it was rejected.

  • status (Symbol, Increase::Models::InboundMailItem::Status) (defaults to: ) —

    If the mail item has been processed.

  • type (Symbol, Increase::Models::InboundMailItem::Type) (defaults to: ) —

    A constant representing the object’s type. For this resource it will always be ‘




# File 'lib/increase/models/inbound_mail_item.rb', line 58

Instance Attribute Details

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the Inbound Mail Item was created.

Returns:

  • (Time) 


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

required :created_at, Time

#file_id ⇒ String

The identifier for the File containing the scanned contents of the mail item.

Returns:

  • (String) 


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

required :file_id, String

#id ⇒ String

The Inbound Mail Item identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/inbound_mail_item.rb', line 11

required :id, String

#lockbox_id ⇒ String?

The identifier for the Lockbox that received this mail item. For mail items that could not be processed due to an invalid address, this will be null.

Returns:

  • (String, nil) 


31
 
# File 'lib/increase/models/inbound_mail_item.rb', line 31

required :lockbox_id, String, nil?: true

#recipient_name ⇒ String?

The recipient name as written on the mail item.

Returns:

  • (String, nil) 


37
 
# File 'lib/increase/models/inbound_mail_item.rb', line 37

required :recipient_name, String, nil?: true

#rejection_reason ⇒ Symbol, ...

If the mail item has been rejected, why it was rejected.

Returns:



43
 
# File 'lib/increase/models/inbound_mail_item.rb', line 43

required :rejection_reason, enum: -> { Increase::InboundMailItem::RejectionReason }, nil?: true

#status ⇒ Symbol, Increase::Models::InboundMailItem::Status

If the mail item has been processed.

Returns:



49
 
# File 'lib/increase/models/inbound_mail_item.rb', line 49

required :status, enum: -> { Increase::InboundMailItem::Status }

#type ⇒ Symbol, Increase::Models::InboundMailItem::Type

A constant representing the object’s type. For this resource it will always be ‘inbound_mail_item`.

Returns:



56
 
# File 'lib/increase/models/inbound_mail_item.rb', line 56

required :type, enum: -> { Increase::InboundMailItem::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/inbound_mail_item.rb', line 95