Class: Increase::Models::Group

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

Overview

See Also:

Defined Under Namespace

Modules: ACHDebitStatus, ActivationStatus, 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: , ach_debit_status: , activation_status: , created_at: , type: ) ⇒ Object

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

Groups represent organizations using Increase. You can retrieve information about your own organization via the API. More commonly, OAuth platforms can retrieve information about the organizations that have granted them access. Learn more about OAuth [here](increase.com/documentation/oauth).

Parameters:




# File 'lib/increase/models/group.rb', line 39

Instance Attribute Details

#ach_debit_status ⇒ Symbol, Increase::Models::Group::ACHDebitStatus

If the Group is allowed to create ACH debits.

Returns:



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

required :ach_debit_status, enum: -> { Increase::Group::ACHDebitStatus }

#activation_status ⇒ Symbol, Increase::Models::Group::ActivationStatus

If the Group is activated or not.

Returns:



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

required :activation_status, enum: -> { Increase::Group::ActivationStatus }

#created_at ⇒ Time

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

Returns:

  • (Time) 


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

required :created_at, Time

#id ⇒ String

The Group identifier.

Returns:

  • (String) 


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

required :id, String

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

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

Returns:



37
 
# File 'lib/increase/models/group.rb', line 37

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/group.rb', line 70