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

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/admin/organization/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:



53
54
55
# File 'lib/openai/resources/admin/organization/data_retention.rb', line 53

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(request_options: {}) ⇒ OpenAI::Models::Admin::Organization::OrganizationDataRetention

Retrieves organization data retention controls.



17
18
19
20
21
22
23
24
25
# File 'lib/openai/resources/admin/organization/data_retention.rb', line 17

def retrieve(params = {})
  @client.request(
    method: :get,
    path: "organization/data_retention",
    model: OpenAI::Admin::Organization::OrganizationDataRetention,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end

#update(retention_type:, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::OrganizationDataRetention

Updates organization data retention controls.

Parameters:

Returns:

See Also:



38
39
40
41
42
43
44
45
46
47
48
# File 'lib/openai/resources/admin/organization/data_retention.rb', line 38

def update(params)
  parsed, options = OpenAI::Admin::Organization::DataRetentionUpdateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "organization/data_retention",
    body: parsed,
    model: OpenAI::Admin::Organization::OrganizationDataRetention,
    security: {admin_api_key_auth: true},
    options: options
  )
end