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

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

Defined Under Namespace

Modules: Status

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(amount: , back_file_id: , check_deposit_id: , front_file_id: , status: ) ⇒ Object

Inbound Mail Item Checks represent the checks in an Inbound Mail Item.

Parameters:

  • amount (Integer) (defaults to: ) —

    The amount of the check.

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

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

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

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

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

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

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

    The status of the Inbound Mail Item Check.



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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# 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

  # @!attribute status
  #   The status of the Inbound Mail Item Check.
  #
  #   @return [Symbol, Increase::Models::InboundMailItem::Check::Status, nil]
  required :status, enum: -> { Increase::InboundMailItem::Check::Status }, nil?: true

  # @!method initialize(amount:, back_file_id:, check_deposit_id:, front_file_id:, status:)
  #   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.
  #
  #   @param status [Symbol, Increase::Models::InboundMailItem::Check::Status, nil] The status of the Inbound Mail Item Check.

  # The status of the Inbound Mail Item Check.
  #
  # @see Increase::Models::InboundMailItem::Check#status
  module Status
    extend Increase::Internal::Type::Enum

    # The check is pending processing.
    PENDING = :pending

    # The check has been deposited.
    DEPOSITED = :deposited

    # The check has been ignored.
    IGNORED = :ignored

    # @!method self.values
    #   @return [Array<Symbol>]
  end
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

#status ⇒ Symbol, ...

The status of the Inbound Mail Item Check.

Returns:



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

required :status, enum: -> { Increase::InboundMailItem::Check::Status }, nil?: true