Class: Increase::Models::Group

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

Overview

See Also:

  • Increase::Resources::Groups#retrieve

Defined Under Namespace

Modules: Type

Instance Attribute 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:, 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.

Parameters:

  • id (String) —

    The Group identifier.

  • created_at (Time) —

    The ISO 8601 time at which the Group w

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

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




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

Instance Attribute Details

#created_at ⇒ Time

The ISO 8601 time at which the Group was created.

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :created_at, Time

#id ⇒ String

The Group identifier.

Parameters:

  • value (String)

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.

Parameters:

  • value (Increase::Models::Group::type_)

Returns:



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

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


19
 
# File 'sig/increase/models/group.rbs', line 19

def to_hash: -> {