Class: Increase::Models::AccountCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Increase::Models::AccountCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/increase/models/account_create_params.rb

Overview

See Also:

• Resources::Accounts#create

Instance Attribute Summary

• #entity_id ⇒ String^?

  The identifier for the Entity that will own the Account.

• #informational_entity_id ⇒ String^?

  The identifier of an Entity that, while not owning the Account, is associated with its activity.

• #name ⇒ String

  The name you choose for the Account.

• #program_id ⇒ String^?

  The identifier for the Program that this Account falls under.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(name: , entity_id: nil, informational_entity_id: nil, program_id: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see AccountCreateParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(name: , entity_id: nil, informational_entity_id: nil, program_id: nil, request_options: {}) ⇒ Object

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

Parameters:

• name (String) (defaults to: ) —

  The name you choose for the Account.

• entity_id (String) (defaults to: nil) —

  The identifier for the Entity that will own the Account.

• informational_entity_id (String) (defaults to: nil) —

  The identifier of an Entity that, while not owning the Account, is associated wi

• program_id (String) (defaults to: nil) —

  The identifier for the Program that this Account falls under. Required if you op

• request_options (Increase::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

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

Instance Attribute Details

#entity_id ⇒ String^?

The identifier for the Entity that will own the Account.

Returns:

• (String, nil)

# File 'lib/increase/models/account_create_params.rb', line 20

optional :entity_id, String

#informational_entity_id ⇒ String^?

The identifier of an Entity that, while not owning the Account, is associated with its activity. This is generally the beneficiary of the funds.

Returns:

• (String, nil)

# File 'lib/increase/models/account_create_params.rb', line 27

optional :informational_entity_id, String

#name ⇒ String

The name you choose for the Account.

Returns:

• (String)

# File 'lib/increase/models/account_create_params.rb', line 14

required :name, String

#program_id ⇒ String^?

The identifier for the Program that this Account falls under. Required if you operate more than one Program.

Returns:

• (String, nil)

# File 'lib/increase/models/account_create_params.rb', line 34

optional :program_id, String