Class: Increase::Models::InboundMailItem

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/increase/models/inbound_mail_item.rb

Defined Under Namespace

Classes: ReturnAddress

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #inspect, #to_h, #to_s

Instance Attribute Details

#created_at ⇒ String

The ISO 8601 time at which the Inbound Mail Item was created.

Returns:

  • (String) 


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

required :created_at, String

#file_id ⇒ String

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

Returns:

  • (String) 


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

required :file_id, String

#id ⇒ String

The Inbound Mail Item identifier.

Returns:

  • (String) 


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

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) 


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

required :lockbox_id, String

#recipient_name ⇒ String

The recipient name as written on the mail item.

Returns:

  • (String) 


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

required :recipient_name, String

#rejection_reason ⇒ Symbol

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

Returns:

  • (Symbol) 


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

required :rejection_reason, Increase::Enum.new(:no_matching_lockbox, :no_check, :lockbox_not_active)

#return_address ⇒ Increase::Models::InboundMailItem::ReturnAddress

The return address as written on the mail item.

Returns:



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

required :return_address, -> { Increase::Models::InboundMailItem::ReturnAddress }

#status ⇒ Symbol

If the mail item has been processed.

Returns:

  • (Symbol) 


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

required :status, Increase::Enum.new(:pending, :processed, :rejected)

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


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

required :type, Increase::Enum.new(:inbound_mail_item)