Class: OpenAI::Models::Admin::Organization::RoleUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/admin/organization/role_update_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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

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

Parameters:

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

    New description for the role.

  • permissions (Array<String>, nil) (defaults to: nil) —

    Updated set of permissions for the role.

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

    New name for the role.

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



# File 'lib/openai/models/admin/organization/role_update_params.rb', line 35

Instance Attribute Details

#description ⇒ String?

New description for the role.

Returns:

  • (String, nil) 


21
 
# File 'lib/openai/models/admin/organization/role_update_params.rb', line 21

optional :description, String, nil?: true

#permissions ⇒ Array<String>?

Updated set of permissions for the role.

Returns:

  • (Array<String>, nil) 


27
 
# File 'lib/openai/models/admin/organization/role_update_params.rb', line 27

optional :permissions, OpenAI::Internal::Type::ArrayOf[String], nil?: true

#role_id ⇒ String

Returns:

  • (String) 


15
 
# File 'lib/openai/models/admin/organization/role_update_params.rb', line 15

required :role_id, String

#role_name ⇒ String?

New name for the role.

Returns:

  • (String, nil) 


33
 
# File 'lib/openai/models/admin/organization/role_update_params.rb', line 33

optional :role_name, String, nil?: true