Class: Increase::Models::Program

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

Overview

See Also:

Defined Under Namespace

Modules: Bank, 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:, bank:, billing_account_id:, created_at:, default_digital_card_profile_id:, interest_rate:, name:, type:, updated_at:) ⇒ Object

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

Programs determine the compliance and commercial terms of Accounts. By default, you have a Commercial Banking program for managing your own funds. If you are lending or managing funds on behalf of your customers, or otherwise engaged in regulated activity, we will work together to create additional Programs for you.

Parameters:

  • id (String) —

    The Program identifier.

  • bank (Symbol, Increase::Models::Program::Bank) —

    The Bank the Program is with.

  • billing_account_id (String, nil) —

    The Program billing account.

  • created_at (Time) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the Program

  • default_digital_card_profile_id (String, nil) —

    The default configuration for digital cards attached to this Program.

  • interest_rate (String) —

    The Interest Rate currently being earned on the accounts in this program, as a s

  • name (String) —

    The name of the Program.

  • type (Symbol, Increase::Models::Program::Type) —

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

  • updated_at (Time) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the Program




# File 'lib/increase/models/program.rb', line 66

Instance Attribute Details

#bank ⇒ Symbol, Increase::Models::Program::Bank

The Bank the Program is with.

Returns:



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

required :bank, enum: -> { Increase::Program::Bank }

#billing_account_id ⇒ String?

The Program billing account.

Returns:

  • (String, nil) 


23
 
# File 'lib/increase/models/program.rb', line 23

required :billing_account_id, String, nil?: true

#created_at ⇒ Time

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

Returns:

  • (Time) 


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

required :created_at, Time

#default_digital_card_profile_id ⇒ String?

The default configuration for digital cards attached to this Program.

Returns:

  • (String, nil) 


36
 
# File 'lib/increase/models/program.rb', line 36

required :default_digital_card_profile_id, String, nil?: true

#id ⇒ String

The Program identifier.

Returns:

  • (String) 


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

required :id, String

#interest_rate ⇒ String

The Interest Rate currently being earned on the accounts in this program, as a string containing a decimal number. For example, a 1% interest rate would be represented as “0.01”.

Returns:

  • (String) 


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

required :interest_rate, String

#name ⇒ String

The name of the Program.

Returns:

  • (String) 


50
 
# File 'lib/increase/models/program.rb', line 50

required :name, String

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

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

Returns:



57
 
# File 'lib/increase/models/program.rb', line 57

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

#updated_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the Program was last updated.

Returns:

  • (Time) 


64
 
# File 'lib/increase/models/program.rb', line 64

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/program.rb', line 108