Class: OpenAI::Models::Admin::Organization::Invite

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

Overview

See Also:

  • OpenAI::Resources::Admin::Organization::Invites#create

Defined Under Namespace

Modules: Role, Status Classes: Project

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 ⇒ Object 



37
 
# File 'sig/openai/models/admin/organization/invite.rbs', line 37

def initialize: (

Instance Attribute Details

#accepted_at ⇒ Integer?

The Unix timestamp (in seconds) of when the invite was accepted.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


55
 
# File 'lib/openai/models/admin/organization/invite.rb', line 55

optional :accepted_at, Integer, nil?: true

#created_at ⇒ Integer

The Unix timestamp (in seconds) of when the invite was sent.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


19
 
# File 'lib/openai/models/admin/organization/invite.rb', line 19

required :created_at, Integer

#email ⇒ String

The email address of the individual to whom the invite was sent

Parameters:

  • value (String)

Returns:

  • (String) 


25
 
# File 'lib/openai/models/admin/organization/invite.rb', line 25

required :email, String

#expires_at ⇒ Integer?

The Unix timestamp (in seconds) of when the invite expires.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


61
 
# File 'lib/openai/models/admin/organization/invite.rb', line 61

optional :expires_at, Integer, nil?: true

#id ⇒ String

The identifier, which can be referenced in API endpoints

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/openai/models/admin/organization/invite.rb', line 13

required :id, String

#object ⇒ Symbol, :"organization.invite"

The object type, which is always organization.invite

Parameters:

  • value (:"organization.invite")

Returns:

  • (Symbol, :"organization.invite") 


31
 
# File 'lib/openai/models/admin/organization/invite.rb', line 31

required :object, const: :"organization.invite"

#projects ⇒ Array<OpenAI::Models::Admin::Organization::Invite::Project>

The projects that were granted membership upon acceptance of the invite.

Parameters:

  • value (::Array[OpenAI::Admin::Organization::Invite::Project])

Returns:



37
 
# File 'lib/openai/models/admin/organization/invite.rb', line 37

required :projects, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Admin::Organization::Invite::Project] }

#role ⇒ Symbol, OpenAI::Models::Admin::Organization::Invite::Role

owner or reader

Parameters:

  • value (OpenAI::Models::Admin::Organization::Invite::role)

Returns:



43
 
# File 'lib/openai/models/admin/organization/invite.rb', line 43

required :role, enum: -> { OpenAI::Admin::Organization::Invite::Role }

#status ⇒ Symbol, OpenAI::Models::Admin::Organization::Invite::Status

accepted,expired, or pending

Parameters:

  • value (OpenAI::Models::Admin::Organization::Invite::status)

Returns:



49
 
# File 'lib/openai/models/admin/organization/invite.rb', line 49

required :status, enum: -> { OpenAI::Admin::Organization::Invite::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/admin/organization/invite.rb', line 111

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


49
 
# File 'sig/openai/models/admin/organization/invite.rbs', line 49

def to_hash: -> {