Class: OpenAI::Resources::Beta::Agents::Vaults

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/beta/agents/vaults.rb,
lib/openai/resources/beta/agents/vaults/credentials.rb,
sig/openai/resources/beta/agents/vaults.rbs,
sig/openai/resources/beta/agents/vaults/credentials.rbs

Defined Under Namespace

Classes: Credentials

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Vaults

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

Parameters:



129
130
131
132
 
# File 'lib/openai/resources/beta/agents/vaults.rb', line 129

def initialize(client:)
  @client = client
  @credentials = OpenAI::Resources::Beta::Agents::Vaults::Credentials.new(client: client)
end

Instance Attribute Details

#credentials ⇒ OpenAI::Resources::Beta::Agents::Vaults::Credentials (readonly)

Returns:



9
10
11
 
# File 'lib/openai/resources/beta/agents/vaults.rb', line 9

def credentials
  @credentials
end

Instance Method Details

#create(metadata: nil, name: nil, request_options: {}) ⇒ OpenAI::Models::Beta::Agents::Vault

Creates a vault for the current project. See vaults.

Parameters:

  • metadata (Hash{Symbol=>String}, nil) —

    Key-value pairs to associate with the vault, such as an application or team identifier.

  • name (String) —

    The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after trimming.

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

Returns:

See Also:



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/openai/resources/beta/agents/vaults.rb', line 29

def create(params = {})
  parsed, options = OpenAI::Beta::Agents::VaultCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "vaults",
    body: parsed,
    model: OpenAI::Beta::Agents::Vault,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
  )
end

#delete(vault_id, request_options: {}) ⇒ OpenAI::Models::Beta::Agents::VaultDeleted

Deletes a vault and all its credentials. See vaults.

Parameters:

  • vault_id (String) —

    The ID of the vault.

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

Returns:

See Also:



116
117
118
119
120
121
122
123
124
 
# File 'lib/openai/resources/beta/agents/vaults.rb', line 116

def delete(vault_id, params = {})
  @client.request(
    method: :delete,
    path: ["vaults/%1$s", vault_id],
    model: OpenAI::Beta::Agents::VaultDeleted,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **params[:request_options].to_h}
  )
end

#list(after: nil, limit: nil, order: nil, status: nil, request_options: {}) ⇒ OpenAI::Internal::CursorPage<OpenAI::Models::Beta::Agents::Vault>

Lists vaults using ID-based pagination. See vaults.

Parameters:

Returns:

See Also:



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/openai/resources/beta/agents/vaults.rb', line 89

def list(params = {})
  parsed, options = OpenAI::Beta::Agents::VaultListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "vaults",
    query: query,
    page: OpenAI::Internal::CursorPage,
    model: OpenAI::Beta::Agents::Vault,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
  )
end

#retrieve(vault_id, request_options: {}) ⇒ OpenAI::Models::Beta::Agents::Vault

Retrieves a vault by its ID. See vaults.

Parameters:

  • vault_id (String) —

    The ID of the vault.

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

Returns:

See Also:



54
55
56
57
58
59
60
61
62
 
# File 'lib/openai/resources/beta/agents/vaults.rb', line 54

def retrieve(vault_id, params = {})
  @client.request(
    method: :get,
    path: ["vaults/%1$s", vault_id],
    model: OpenAI::Beta::Agents::Vault,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **params[:request_options].to_h}
  )
end