Class: Braintrust::Models::Role

Inherits:
BaseModel show all
Defined in:
lib/braintrust/models/role.rb

Defined Under Namespace

Classes: MemberPermission

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #initialize, #inspect, #to_h, #to_s

Constructor Details

This class inherits a constructor from Braintrust::BaseModel

Instance Attribute Details

#created ⇒ DateTime

Date of role creation

Returns:

  • (DateTime) 


19
 
# File 'lib/braintrust/models/role.rb', line 19

optional :created, DateTime

#deleted_at ⇒ DateTime

Date of role deletion, or null if the role is still active

Returns:

  • (DateTime) 


24
 
# File 'lib/braintrust/models/role.rb', line 24

optional :deleted_at, DateTime

#description ⇒ String

Textual description of the role

Returns:

  • (String) 


29
 
# File 'lib/braintrust/models/role.rb', line 29

optional :description, String

#id ⇒ String

Unique identifier for the role

Returns:

  • (String) 


9
 
# File 'lib/braintrust/models/role.rb', line 9

required :id, String

#member_permissions ⇒ Array<Braintrust::Models::Role::MemberPermission>

(permission, restrict_object_type) tuples which belong to this role

Returns:



34
 
# File 'lib/braintrust/models/role.rb', line 34

optional :member_permissions, Braintrust::ArrayOf.new(-> { Braintrust::Models::Role::MemberPermission })

#member_roles ⇒ Object

Ids of the roles this role inherits from



41
 
# File 'lib/braintrust/models/role.rb', line 41

optional :member_roles, Braintrust::ArrayOf.new(String)

#name_ ⇒ String

Name of the role

Returns:

  • (String) 


14
 
# File 'lib/braintrust/models/role.rb', line 14

required :name_, String

#org_id ⇒ Object

Unique id for the organization that the role belongs under



50
 
# File 'lib/braintrust/models/role.rb', line 50

optional :org_id, String

#user_id ⇒ String

Identifies the user who created the role

Returns:

  • (String) 


55
 
# File 'lib/braintrust/models/role.rb', line 55

optional :user_id, String