Class: Increase::Models::InboundMailItem::Check

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

Instance Attribute 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, 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(id: , checks: , 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.

  • checks (Array<Increase::Models::InboundMailItem::Check>) (defaults to: ) —

    The checks in the mail item.

  • 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 ‘



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/increase/models/inbound_mail_item.rb', line 88

class Check < Increase::Internal::Type::BaseModel
  # @!attribute amount
  #   The amount of the check.
  #
  #   @return [Integer]
  required :amount, Integer

  # @!attribute back_file_id
  #   The identifier for the File containing the back of the check.
  #
  #   @return [String, nil]
  required :back_file_id, String, nil?: true

  # @!attribute check_deposit_id
  #   The identifier of the Check Deposit if this check was deposited.
  #
  #   @return [String, nil]
  required :check_deposit_id, String, nil?: true

  # @!attribute front_file_id
  #   The identifier for the File containing the front of the check.
  #
  #   @return [String, nil]
  required :front_file_id, String, nil?: true

  # @!method initialize(amount:, back_file_id:, check_deposit_id:, front_file_id:)
  #   Inbound Mail Item Checks represent the checks in an Inbound Mail Item.
  #
  #   @param amount [Integer] The amount of the check.
  #
  #   @param back_file_id [String, nil] The identifier for the File containing the back of the check.
  #
  #   @param check_deposit_id [String, nil] The identifier of the Check Deposit if this check was deposited.
  #
  #   @param front_file_id [String, nil] The identifier for the File containing the front of the check.
end

Instance Attribute Details

#amount ⇒ Integer

The amount of the check.

Returns:

  • (Integer) 


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

required :amount, Integer

#back_file_id ⇒ String?

The identifier for the File containing the back of the check.

Returns:

  • (String, nil) 


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

required :back_file_id, String, nil?: true

#check_deposit_id ⇒ String?

The identifier of the Check Deposit if this check was deposited.

Returns:

  • (String, nil) 


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

required :check_deposit_id, String, nil?: true

#front_file_id ⇒ String?

The identifier for the File containing the front of the check.

Returns:

  • (String, nil) 


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

required :front_file_id, String, nil?: true