Class: Increase::Models::IntrafiAccountEnrollment

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

Overview

See Also:

Defined Under Namespace

Modules: 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(id: , account_id: , created_at: , email_address: , idempotency_key: , intrafi_id: , status: , type: ) ⇒ Object

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

IntraFi is a [network of financial institutions](www.intrafi.com/network-banks) that allows Increase users to sweep funds to multiple banks. This enables accounts to become eligible for additional Federal Deposit Insurance Corporation (FDIC) insurance. An IntraFi Account Enrollment object represents the status of an account in the network. Sweeping an account to IntraFi doesn’t affect funds availability.

Parameters:

  • id (String) (defaults to: ) —

    The identifier of this enrollment at IntraFi.

  • account_id (String) (defaults to: ) —

    The identifier of the Increase Account being swept into the network.

  • created_at (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which th

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

    The contact email for the account owner, to be shared with IntraFi.

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

    The idempotency key you chose for this object. This value is unique across Incre

  • intrafi_id (String) (defaults to: ) —

    The identifier of the account in IntraFi’s system. This identifier will be print

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

    The status of the account in the network. An account takes about one business da

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

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




# File 'lib/increase/models/intrafi_account_enrollment.rb', line 61

Instance Attribute Details

#account_id ⇒ String

The identifier of the Increase Account being swept into the network.

Returns:

  • (String) 


17
 
# File 'lib/increase/models/intrafi_account_enrollment.rb', line 17

required :account_id, String

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which the enrollment was created.

Returns:

  • (Time) 


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

required :created_at, Time

#email_address ⇒ String?

The contact email for the account owner, to be shared with IntraFi.

Returns:

  • (String, nil) 


30
 
# File 'lib/increase/models/intrafi_account_enrollment.rb', line 30

required :email_address, String, nil?: true

#id ⇒ String

The identifier of this enrollment at IntraFi.

Returns:

  • (String) 


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

required :id, String

#idempotency_key ⇒ String?

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


38
 
# File 'lib/increase/models/intrafi_account_enrollment.rb', line 38

required :idempotency_key, String, nil?: true

#intrafi_id ⇒ String

The identifier of the account in IntraFi’s system. This identifier will be printed on any IntraFi statements or documents.

Returns:

  • (String) 


45
 
# File 'lib/increase/models/intrafi_account_enrollment.rb', line 45

required :intrafi_id, String

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

The status of the account in the network. An account takes about one business day to go from ‘pending_enrolling` to `enrolled`.

Returns:



52
 
# File 'lib/increase/models/intrafi_account_enrollment.rb', line 52

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

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

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

Returns:



59
 
# File 'lib/increase/models/intrafi_account_enrollment.rb', line 59

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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