Class: OpenAI::Models::Admin::Organization::Projects::RoleCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/admin/organization/projects/role_create_params.rb,
sig/openai/models/admin/organization/projects/role_create_params.rbs

Overview

See Also:

  • OpenAI::Resources::Admin::Organization::Projects::Roles#create

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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(project_id:, permissions:, role_name:, description: nil, request_options: {}) ⇒ Object

Parameters:

  • permissions —

    Permissions to grant to the role.

  • role_name —

    Unique name for the role.

  • description (defaults to: nil) —

    Optional description of the role.




# File 'lib/openai/models/admin/organization/projects/role_create_params.rb', line 36

Instance Attribute Details

#description ⇒ String?

Optional description of the role.

Returns:

  • (String, nil) 


34
 
# File 'lib/openai/models/admin/organization/projects/role_create_params.rb', line 34

optional :description, String, nil?: true

#permissions ⇒ ::Array[String]

Permissions to grant to the role.

Returns:

  • (::Array[String]) 


22
 
# File 'lib/openai/models/admin/organization/projects/role_create_params.rb', line 22

required :permissions, OpenAI::Internal::Type::ArrayOf[String]

#project_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


16
 
# File 'lib/openai/models/admin/organization/projects/role_create_params.rb', line 16

required :project_id, String

#role_name ⇒ String

Unique name for the role.

Returns:

  • (String) 


28
 
# File 'lib/openai/models/admin/organization/projects/role_create_params.rb', line 28

required :role_name, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


44
 
# File 'sig/openai/models/admin/organization/projects/role_create_params.rbs', line 44

def to_hash: -> {