Class: OpenAI::Resources::Admin::Organization::Groups

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/admin/organization/groups.rb,
lib/openai/resources/admin/organization/groups/roles.rb,
lib/openai/resources/admin/organization/groups/users.rb

Defined Under Namespace

Classes: Roles, Users

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Groups

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Groups.

Parameters:



118
119
120
121
122
 
# File 'lib/openai/resources/admin/organization/groups.rb', line 118

def initialize(client:)
  @client = client
  @users = OpenAI::Resources::Admin::Organization::Groups::Users.new(client: client)
  @roles = OpenAI::Resources::Admin::Organization::Groups::Roles.new(client: client)
end

Instance Attribute Details

#roles ⇒ OpenAI::Resources::Admin::Organization::Groups::Roles (readonly)

Returns:



12
13
14
 
# File 'lib/openai/resources/admin/organization/groups.rb', line 12

def roles
  @roles
end

#users ⇒ OpenAI::Resources::Admin::Organization::Groups::Users (readonly)

Returns:



9
10
11
 
# File 'lib/openai/resources/admin/organization/groups.rb', line 9

def users
  @users
end

Instance Method Details

#create(name:, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Group

Creates a new group in the organization.

Parameters:

  • name (String) —

    Human readable name for the group.

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

Returns:

See Also:



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/openai/resources/admin/organization/groups.rb', line 25

def create(params)
  parsed, options = OpenAI::Admin::Organization::GroupCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "organization/groups",
    body: parsed,
    model: OpenAI::Admin::Organization::Group,
    security: {admin_api_key_auth: true},
    options: options
  )
end

#delete(group_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::GroupDeleteResponse

Deletes a group from the organization.

Parameters:

  • group_id (String) —

    The ID of the group to delete.

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

Returns:

See Also:



105
106
107
108
109
110
111
112
113
 
# File 'lib/openai/resources/admin/organization/groups.rb', line 105

def delete(group_id, params = {})
  @client.request(
    method: :delete,
    path: ["organization/groups/%1$s", group_id],
    model: OpenAI::Models::Admin::Organization::GroupDeleteResponse,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end

#list(after: nil, limit: nil, order: nil, request_options: {}) ⇒ OpenAI::Internal::NextCursorPage<OpenAI::Models::Admin::Organization::Group>

Some parameter documentations has been truncated, see Models::Admin::Organization::GroupListParams for more details.

Lists all groups in the organization.

Parameters:

Returns:

See Also:



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/openai/resources/admin/organization/groups.rb', line 80

def list(params = {})
  parsed, options = OpenAI::Admin::Organization::GroupListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "organization/groups",
    query: query,
    page: OpenAI::Internal::NextCursorPage,
    model: OpenAI::Admin::Organization::Group,
    security: {admin_api_key_auth: true},
    options: options
  )
end

#update(group_id, name:, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::GroupUpdateResponse

Updates a group’s information.

Parameters:

  • group_id (String) —

    The ID of the group to update.

  • name (String) —

    New display name for the group.

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

Returns:

See Also:



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/openai/resources/admin/organization/groups.rb', line 50

def update(group_id, params)
  parsed, options = OpenAI::Admin::Organization::GroupUpdateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["organization/groups/%1$s", group_id],
    body: parsed,
    model: OpenAI::Models::Admin::Organization::GroupUpdateResponse,
    security: {admin_api_key_auth: true},
    options: options
  )
end