Class: OpenAI::Resources::Admin::Organization::Projects::DataRetention

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ DataRetention

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

Parameters:



58
59
60
 
# File 'lib/openai/resources/admin/organization/projects/data_retention.rb', line 58

def initialize(client:)
  @client = client
end

Instance Method Details

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

Retrieves project data retention controls.

Parameters:

  • project_id (String) —

    The ID of the project to inspect.

  • 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/data_retention.rb', line 20

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

#update(project_id, retention_type:, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Projects::ProjectDataRetention

Updates project data retention controls.

Parameters:

Returns:

See Also:



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/openai/resources/admin/organization/projects/data_retention.rb', line 43

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