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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Admin::Organization::RoleCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/admin/organization/role_create_params.rb

Overview

See Also:

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

Instance Attribute Summary

• #description ⇒ String^?

  Optional description of the role.

• #permissions ⇒ Array<String>

  Permissions to grant to the role.

• #role_name ⇒ String

  Unique name for the role.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(permissions:, role_name:, description: nil, request_options: {}) ⇒ Object constructor

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

dump_request

Methods included from Internal::Type::RequestParameters

included

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(permissions:, role_name:, description: nil, request_options: {}) ⇒ Object

Parameters:

• permissions (Array<String>) —

  Permissions to grant to the role.

• role_name (String) —

  Unique name for the role.

• description (String, nil) (defaults to: nil) —

  Optional description of the role.

• request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

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

Instance Attribute Details

#description ⇒ String^?

Optional description of the role.

Returns:

• (String, nil)

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

optional :description, String, nil?: true

#permissions ⇒ Array<String>

Permissions to grant to the role.

Returns:

• (Array<String>)

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

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

#role_name ⇒ String

Unique name for the role.

Returns:

• (String)

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

required :role_name, String