Class: Infrawrench::WorkflowSecretsNamespace

Inherits:
Object
  • Object
show all
Defined in:
lib/infrawrench/client.rb,
sig/infrawrench/sdk.rbs

Overview

client.workflow_secrets

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ WorkflowSecretsNamespace

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

Parameters:



16275
16276
16277
 
# File 'lib/infrawrench/client.rb', line 16275

def initialize(transport)
  @transport = transport
end

Instance Method Details

#create(body:, org_id: nil, request_options: nil) ⇒ Hash

Create workflow secret metadata

Creates metadata without a value. Write the value separately through the write-only value endpoint.

Requires permission: secrets:write.

POST /api/org/orgId/workflow-secrets

Raises on 400: Bad request

Raises on 409: Conflict

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • body (Hash) —

    Request body, shaped as WorkflowSecretCreate.

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • body: (workflow_secret_create)
  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as WorkflowSecret — see sig/infrawrench/sdk.rbs.

Raises:



16298
16299
16300
16301
16302
16303
16304
16305
16306
 
# File 'lib/infrawrench/client.rb', line 16298

def create(body:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "POST",
    path: "/api/org/{orgId}/workflow-secrets",
    path_params: { "orgId" => org_id },
    body: body,
    request_options: request_options
  )
end

#delete(id:, org_id: nil, request_options: nil) ⇒ Hash

Delete a workflow secret

Also removes every workflow assignment through database cascades.

Requires permission: secrets:write.

DELETE /api/org/orgId/workflow-secrets/id

Raises on 404: Not found

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • id (String) —

    Workflow secret id

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • id: (String)
  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as Ok — see sig/infrawrench/sdk.rbs.

Raises:



16324
16325
16326
16327
16328
16329
16330
16331
 
# File 'lib/infrawrench/client.rb', line 16324

def delete(id:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "DELETE",
    path: "/api/org/{orgId}/workflow-secrets/{id}",
    path_params: { "orgId" => org_id, "id" => id },
    request_options: request_options
  )
end

#list(org_id: nil, request_options: nil) ⇒ Array<Hash>

List reusable workflow secrets

Returns metadata and hasValue only; plaintext values are never returned.

Requires permission: secrets:read.

GET /api/org/orgId/workflow-secrets

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Array<Hash>) —

    Parsed JSON, shaped as Array<WorkflowSecret> — see sig/infrawrench/sdk.rbs.

Raises:



16347
16348
16349
16350
16351
16352
16353
16354
 
# File 'lib/infrawrench/client.rb', line 16347

def list(org_id: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/workflow-secrets",
    path_params: { "orgId" => org_id },
    request_options: request_options
  )
end

#update(id:, body:, org_id: nil, request_options: nil) ⇒ Hash

Update workflow secret metadata

Requires permission: secrets:write.

PATCH /api/org/orgId/workflow-secrets/id

Raises on 400: Bad request

Raises on 404: Not found

Raises on 409: Conflict

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • id (String) —

    Workflow secret id

  • body (Hash) —

    Request body, shaped as WorkflowSecretUpdate.

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • id: (String)
  • body: (workflow_secret_update)
  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as WorkflowSecret — see sig/infrawrench/sdk.rbs.

Raises:



16375
16376
16377
16378
16379
16380
16381
16382
16383
 
# File 'lib/infrawrench/client.rb', line 16375

def update(id:, body:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "PATCH",
    path: "/api/org/{orgId}/workflow-secrets/{id}",
    path_params: { "orgId" => org_id, "id" => id },
    body: body,
    request_options: request_options
  )
end

#value(id:, body:, org_id: nil, request_options: nil) ⇒ Hash

Write a workflow secret value

Write-only. The response contains metadata and hasValue, never the supplied plaintext.

Requires permission: secrets:write.

PUT /api/org/orgId/workflow-secrets/id/value

Raises on 400: Bad request

Raises on 404: Not found

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • id (String) —

    Workflow secret id

  • body (Hash) —

    Request body, shaped as WorkflowSecretValueWrite.

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • id: (String)
  • body: (workflow_secret_value_write)
  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as WorkflowSecret — see sig/infrawrench/sdk.rbs.

Raises:



16405
16406
16407
16408
16409
16410
16411
16412
16413
 
# File 'lib/infrawrench/client.rb', line 16405

def value(id:, body:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "PUT",
    path: "/api/org/{orgId}/workflow-secrets/{id}/value",
    path_params: { "orgId" => org_id, "id" => id },
    body: body,
    request_options: request_options
  )
end