Class: Cadenya::Resources::ToolSets::Secrets

Inherits:
Object
  • Object
show all
Defined in:
lib/cadenya/resources/tool_sets/secrets.rb,
sig/cadenya/resources/tool_sets/secrets.rbs

Overview

Manage tool sets and the tools they contain. Tool sets group related tools, and tools define specific capabilities available to agents.

When a tool set is managed, only API key actors can modify its tools; human (profile) actors cannot.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Secrets

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

Parameters:



200
201
202
 
# File 'lib/cadenya/resources/tool_sets/secrets.rb', line 200

def initialize(client:)
  @client = client
end

Instance Method Details

#create(tool_set_id, metadata:, spec:, workspace_id: nil, request_options: {}) ⇒ Cadenya::Models::ToolSets::ToolSetSecret

Some parameter documentations has been truncated, see Models::ToolSets::SecretCreateParams for more details.

Creates a new secret scoped to the tool set

f

Parameters:

Returns:

See Also:



33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/cadenya/resources/tool_sets/secrets.rb', line 33

def create(tool_set_id, params)
  parsed, options = Cadenya::ToolSets::SecretCreateParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :post,
    path: ["v1/workspaces/%1$s/tool_sets/%2$s/secrets", workspace_id, tool_set_id],
    body: parsed,
    model: Cadenya::ToolSets::ToolSetSecret,
    options: options
  )
end

#delete(tool_set_id, id, workspace_id: nil, request_options: {}) ⇒ nil

Some parameter documentations has been truncated, see Models::ToolSets::SecretDeleteParams for more details.

Deletes a secret scoped to the tool set

Parameters:

  • tool_set_id (String) —

    The tool set the secret belongs to. Accepts the canonical ts_… form

  • id (String) —

    The secret to delete.

  • workspace_id (String) —

    The workspace that owns the tool set.

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

Returns:

  • (nil)

See Also:



183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/cadenya/resources/tool_sets/secrets.rb', line 183

def delete(tool_set_id, id, params = {})
  parsed, options = Cadenya::ToolSets::SecretDeleteParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :delete,
    path: ["v1/workspaces/%1$s/tool_sets/%2$s/secrets/%3$s", workspace_id, tool_set_id, id],
    model: NilClass,
    options: options
  )
end

#list(tool_set_id, workspace_id: nil, cursor: nil, include_info: nil, limit: nil, prefix: nil, query: nil, sort_order: nil, request_options: {}) ⇒ Cadenya::Internal::CursorPagination<Cadenya::Models::ToolSets::ToolSetSecret>

Some parameter documentations has been truncated, see Models::ToolSets::SecretListParams for more details.

Lists all secrets scoped to the tool set

ts_

Parameters:

  • tool_set_id (String) —

    Path param: The tool set whose secrets will be listed. Accepts the canonical

  • workspace_id (String) —

    Path param: The workspace that owns the tool set.

  • cursor (String) —

    Query param: Pagination cursor from previous response

  • include_info (Boolean) —

    Query param: When set to true you may use more of your alloted API rate-limit

  • limit (Integer) —

    Query param: Maximum number of results to return

  • prefix (String) —

    Query param: Filter expression (query param: prefix)

  • query (String) —

    Query param: Free-form search query

  • sort_order (String) —

    Query param: Sort order for results (asc or desc by creation time)

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

Returns:

See Also:



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/cadenya/resources/tool_sets/secrets.rb', line 148

def list(tool_set_id, params = {})
  parsed, options = Cadenya::ToolSets::SecretListParams.dump_request(params)
  query = Cadenya::Internal::Util.encode_query_params(parsed)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :get,
    path: ["v1/workspaces/%1$s/tool_sets/%2$s/secrets", workspace_id, tool_set_id],
    query: query.transform_keys(include_info: "includeInfo", sort_order: "sortOrder"),
    page: Cadenya::Internal::CursorPagination,
    model: Cadenya::ToolSets::ToolSetSecret,
    options: options
  )
end

#retrieve(tool_set_id, id, workspace_id: nil, request_options: {}) ⇒ Cadenya::Models::ToolSets::ToolSetSecret

Some parameter documentations has been truncated, see Models::ToolSets::SecretRetrieveParams for more details.

Retrieves a tool set secret by ID from the tool set

Parameters:

  • tool_set_id (String) —

    The tool set the secret belongs to. Accepts the canonical ts_… form

  • id (String) —

    The secret to retrieve.

  • workspace_id (String) —

    The workspace that owns the tool set.

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

Returns:

See Also:



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/cadenya/resources/tool_sets/secrets.rb', line 66

def retrieve(tool_set_id, id, params = {})
  parsed, options = Cadenya::ToolSets::SecretRetrieveParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :get,
    path: ["v1/workspaces/%1$s/tool_sets/%2$s/secrets/%3$s", workspace_id, tool_set_id, id],
    model: Cadenya::ToolSets::ToolSetSecret,
    options: options
  )
end

#update(tool_set_id, id, workspace_id: nil, metadata: nil, spec: nil, update_mask: nil, request_options: {}) ⇒ Cadenya::Models::ToolSets::ToolSetSecret

Some parameter documentations has been truncated, see Models::ToolSets::SecretUpdateParams for more details.

Updates a secret scoped to the tool set

Parameters:

  • tool_set_id (String) —

    Path param: The tool set the secret belongs to. Accepts the canonical ts_… form

  • id (String) —

    Path param: The secret to update.

  • workspace_id (String) —

    Path param: The workspace that owns the tool set.

  • metadata (Cadenya::Models::UpdateResourceMetadata) —

    Body param: UpdateResourceMetadata contains the user-provided fields for updatin

  • spec (Cadenya::Models::ToolSets::ToolSetSecretSpec) —

    Body param

  • update_mask (String) —

    Body param: Fields to update.

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

Returns:

See Also:



104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/cadenya/resources/tool_sets/secrets.rb', line 104

def update(tool_set_id, id, params = {})
  parsed, options = Cadenya::ToolSets::SecretUpdateParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :patch,
    path: ["v1/workspaces/%1$s/tool_sets/%2$s/secrets/%3$s", workspace_id, tool_set_id, id],
    body: parsed,
    model: Cadenya::ToolSets::ToolSetSecret,
    options: options
  )
end