Class: OpenAI::Resources::Admin::Organization::Projects::HostedToolPermissions

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/admin/organization/projects/hosted_tool_permissions.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ HostedToolPermissions

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 HostedToolPermissions.

Parameters:



67
68
69
 
# File 'lib/openai/resources/admin/organization/projects/hosted_tool_permissions.rb', line 67

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(project_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions

Returns hosted tool permissions for a project.

Parameters:

  • project_id (String) —

    The ID of the project.

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

Returns:

See Also:



20
21
22
23
24
25
26
27
28
 
# File 'lib/openai/resources/admin/organization/projects/hosted_tool_permissions.rb', line 20

def retrieve(project_id, params = {})
  @client.request(
    method: :get,
    path: ["organization/projects/%1$s/hosted_tool_permissions", project_id],
    model: OpenAI::Admin::Organization::Projects::ProjectHostedToolPermissions,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end

#update(project_id, code_interpreter: nil, file_search: nil, image_generation: nil, mcp: nil, web_search: nil, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions

Updates hosted tool permissions for a project.

Parameters:

Returns:

See Also:



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/openai/resources/admin/organization/projects/hosted_tool_permissions.rb', line 51

def update(project_id, params = {})
  parsed, options =
    OpenAI::Admin::Organization::Projects::HostedToolPermissionUpdateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["organization/projects/%1$s/hosted_tool_permissions", project_id],
    body: parsed,
    model: OpenAI::Admin::Organization::Projects::ProjectHostedToolPermissions,
    security: {admin_api_key_auth: true},
    options: options
  )
end