Class: Increase::Models::CheckDeposit::InboundFundsHold

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/check_deposit.rb,
sig/increase/models/check_deposit.rbs

Overview

See Also:

  • Increase::Models::CheckDeposit#inbound_funds_hold

Defined Under Namespace

Modules: Currency, 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, 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:, automatically_releases_at:, created_at:, currency:, held_transaction_id:, pending_transaction_id:, released_at:, status:, type:) ⇒ Object

Increase will sometimes hold the funds for Check Deposits. If funds are held, this sub-object will contain details of the hold.

Parameters:

  • amount (Integer) —

    The held amount in the minor unit of the account's currency. For dollars, for example, this is cents.

  • automatically_releases_at (Time) —

    When the hold will be released automatically. Certain conditions may cause it to be released before this time.

  • created_at (Time) —

    The ISO 8601 time at which the hold was created.

  • currency (Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Currency) —

    The ISO 4217 code for the hold's currency.

  • held_transaction_id (String, nil) —

    The ID of the Transaction for which funds were held.

  • pending_transaction_id (String, nil) —

    The ID of the Pending Transaction representing the held funds.

  • released_at (Time, nil) —

    When the hold was released (if it has been released).

  • status (Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Status) —

    The status of the hold.

  • type (Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Type) —

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




# File 'lib/increase/models/check_deposit.rb', line 748

Instance Attribute Details

#amount ⇒ Integer

The held amount in the minor unit of the account's currency. For dollars, for example, this is cents.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


694
 
# File 'lib/increase/models/check_deposit.rb', line 694

required :amount, Integer

#automatically_releases_at ⇒ Time

When the hold will be released automatically. Certain conditions may cause it to be released before this time.

Parameters:

  • value (Time)

Returns:

  • (Time) 


701
 
# File 'lib/increase/models/check_deposit.rb', line 701

required :automatically_releases_at, Time

#created_at ⇒ Time

The ISO 8601 time at which the hold was created.

Parameters:

  • value (Time)

Returns:

  • (Time) 


708
 
# File 'lib/increase/models/check_deposit.rb', line 708

required :created_at, Time

#currency ⇒ Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Currency

The ISO 4217 code for the hold's currency.

Parameters:

  • value (Increase::Models::CheckDeposit::InboundFundsHold::currency)

Returns:



715
 
# File 'lib/increase/models/check_deposit.rb', line 715

required :currency, enum: -> { Increase::CheckDeposit::InboundFundsHold::Currency }

#held_transaction_id ⇒ String?

The ID of the Transaction for which funds were held.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


721
 
# File 'lib/increase/models/check_deposit.rb', line 721

required :held_transaction_id, String, nil?: true

#pending_transaction_id ⇒ String?

The ID of the Pending Transaction representing the held funds.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


727
 
# File 'lib/increase/models/check_deposit.rb', line 727

required :pending_transaction_id, String, nil?: true

#released_at ⇒ Time?

When the hold was released (if it has been released).

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


733
 
# File 'lib/increase/models/check_deposit.rb', line 733

required :released_at, Time, nil?: true

#status ⇒ Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Status

The status of the hold.

Parameters:

  • value (Increase::Models::CheckDeposit::InboundFundsHold::status)

Returns:



739
 
# File 'lib/increase/models/check_deposit.rb', line 739

required :status, enum: -> { Increase::CheckDeposit::InboundFundsHold::Status }

#type ⇒ Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Type

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

Parameters:

  • value (Increase::Models::CheckDeposit::InboundFundsHold::type_)

Returns:



746
 
# File 'lib/increase/models/check_deposit.rb', line 746

required :type, enum: -> { Increase::CheckDeposit::InboundFundsHold::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/check_deposit.rb', line 790

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


557
 
# File 'sig/increase/models/check_deposit.rbs', line 557

def to_hash: -> {