Class: OpenAI::Resources::Admin::Organization::ExternalStorage

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/admin/organization/external_storage.rb,
sig/openai/resources/admin/organization/external_storage.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ExternalStorage

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

Parameters:



129
130
131
 
# File 'lib/openai/resources/admin/organization/external_storage.rb', line 129

def initialize(client:)
  @client = client
end

Instance Method Details

#create(project_id:, provider:, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::ExternalStorageConfiguration

Register one customer-managed external storage configuration.

Parameters:

Returns:

See Also:



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

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

#delete(external_storage_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::ExternalStorageDeleted

Disconnect a customer-managed external storage configuration. Removing the project's last configuration restores organization-default retention if customer-managed retention was active. Repeating a deletion also completes any interrupted retention update. Cloud storage is unchanged.

Parameters:

Returns:

See Also:



96
97
98
99
100
101
102
103
104
 
# File 'lib/openai/resources/admin/organization/external_storage.rb', line 96

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

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

List the organization's customer-managed external storage configurations.

Parameters:

Returns:

See Also:



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/openai/resources/admin/organization/external_storage.rb', line 69

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

#retrieve(external_storage_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::ExternalStorageConfiguration

Get one customer-managed external storage configuration.

Parameters:

Returns:

See Also:



41
42
43
44
45
46
47
48
49
 
# File 'lib/openai/resources/admin/organization/external_storage.rb', line 41

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

#validate(external_storage_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::ExternalStorageConfiguration

Validate one customer-managed external storage configuration.

Parameters:

Returns:

See Also:



116
117
118
119
120
121
122
123
124
 
# File 'lib/openai/resources/admin/organization/external_storage.rb', line 116

def validate(external_storage_id, params = {})
  @client.request(
    method: :post,
    path: ["organization/external_storage/%1$s/validate", external_storage_id],
    model: OpenAI::Admin::Organization::ExternalStorageConfiguration,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end