Class: Anthropic::Models::Organization::OrganizationInvite

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/anthropic/models/organization/organization_invite.rb,
sig/anthropic/models/organization/organization_invite.rbs

Overview

See Also:

  • Anthropic::Resources::Organization::Invites#create

Defined Under Namespace

Modules: Status

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:, accepted_at:, email:, expires_at:, invited_at:, rbac_group_ids:, role:, status:, type: :invite) ⇒ void

Some parameter documentations has been truncated, see Anthropic::Models::Organization::OrganizationInvite for more details.

Parameters:

  • id (String) —

    ID of the Invite.

  • accepted_at (Time, nil) —

    RFC 3339 datetime string indicating when the Invite was accepted, or null.

  • email (String) —

    Email of the User being invited.

  • expires_at (Time) —

    RFC 3339 datetime string indicating when the Invite expires.

  • invited_at (Time) —

    RFC 3339 datetime string indicating when the Invite was created.

  • rbac_group_ids (Array<String>) —

    RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be a

  • role (Symbol, Anthropic::Models::OrganizationRole) —

    Organization role of the User.

  • status (Symbol, Anthropic::Models::Organization::OrganizationInvite::Status) —

    Status of the Invite.

  • type (Symbol, :invite) (defaults to: :invite) —

    Object type.




# File 'lib/anthropic/models/organization/organization_invite.rb', line 65

Instance Attribute Details

#accepted_at ⇒ Time?

RFC 3339 datetime string indicating when the Invite was accepted, or null.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


18
 
# File 'lib/anthropic/models/organization/organization_invite.rb', line 18

required :accepted_at, Time, nil?: true

#email ⇒ String

Email of the User being invited.

Parameters:

  • value (String)

Returns:

  • (String) 


24
 
# File 'lib/anthropic/models/organization/organization_invite.rb', line 24

required :email, String

#expires_at ⇒ Time

RFC 3339 datetime string indicating when the Invite expires.

Parameters:

  • value (Time)

Returns:

  • (Time) 


30
 
# File 'lib/anthropic/models/organization/organization_invite.rb', line 30

required :expires_at, Time

#id ⇒ String

ID of the Invite.

Parameters:

  • value (String)

Returns:

  • (String) 


12
 
# File 'lib/anthropic/models/organization/organization_invite.rb', line 12

required :id, String

#invited_at ⇒ Time

RFC 3339 datetime string indicating when the Invite was created.

Parameters:

  • value (Time)

Returns:

  • (Time) 


36
 
# File 'lib/anthropic/models/organization/organization_invite.rb', line 36

required :invited_at, Time

#rbac_group_ids ⇒ Array<String>

RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. [] when none.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


43
 
# File 'lib/anthropic/models/organization/organization_invite.rb', line 43

required :rbac_group_ids, Anthropic::Internal::Type::ArrayOf[String]

#role ⇒ Symbol, Anthropic::Models::OrganizationRole

Organization role of the User.

Parameters:

  • value (Anthropic::Models::organization_role)

Returns:



49
 
# File 'lib/anthropic/models/organization/organization_invite.rb', line 49

required :role, enum: -> { Anthropic::OrganizationRole }

#status ⇒ Symbol, Anthropic::Models::Organization::OrganizationInvite::Status

Status of the Invite.

Parameters:

  • value (Anthropic::Models::Organization::OrganizationInvite::status)

Returns:



55
 
# File 'lib/anthropic/models/organization/organization_invite.rb', line 55

required :status, enum: -> { Anthropic::Organization::OrganizationInvite::Status }

#type ⇒ Symbol, :invite

Object type.

For Invites, this is always "invite".

Parameters:

  • value (:invite)

Returns:

  • (Symbol, :invite) 


63
 
# File 'lib/anthropic/models/organization/organization_invite.rb', line 63

required :type, const: :invite

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


50
 
# File 'sig/anthropic/models/organization/organization_invite.rbs', line 50

def to_hash: -> {