Class: OpenAI::Models::Admin::Organization::Groups::OrganizationGroupUser

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/admin/organization/groups/organization_group_user.rb,
sig/openai/models/admin/organization/groups/organization_group_user.rbs

Overview

See Also:

  • OpenAI::Resources::Admin::Organization::Groups::Users#list

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:, email:, name:) ⇒ OrganizationGroupUser

Represents an individual user returned when inspecting group membership.

Parameters:

  • id (String)

    The identifier, which can be referenced in API endpoints

  • email (String, nil)

    The email address of the user.

  • name (String)

    The name of the user.

  • id: (String)
  • email: (String, nil)
  • name: (String)


# File 'lib/openai/models/admin/organization/groups/organization_group_user.rb', line 28

Instance Attribute Details

#emailString?

The email address of the user.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil)


20
# File 'lib/openai/models/admin/organization/groups/organization_group_user.rb', line 20

required :email, String, nil?: true

#idString

The identifier, which can be referenced in API endpoints

Parameters:

  • value (String)

Returns:

  • (String)


14
# File 'lib/openai/models/admin/organization/groups/organization_group_user.rb', line 14

required :id, String

#nameString

The name of the user.

Parameters:

  • value (String)

Returns:

  • (String)


26
# File 'lib/openai/models/admin/organization/groups/organization_group_user.rb', line 26

required :name, String

Instance Method Details

#to_hash{ id: String, email: String?, name: String }

Returns:

  • ({ id: String, email: String?, name: String })


18
# File 'sig/openai/models/admin/organization/groups/organization_group_user.rbs', line 18

def to_hash: -> { id: String, email: String?, name: String }