Class: Infrawrench::AccountsNamespace

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

Overview

client.accounts

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ AccountsNamespace

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

Parameters:



127
128
129
130
131
 
# File 'lib/infrawrench/client.rb', line 127

def initialize(transport)
  @transport = transport
  @credentials = AccountsCredentialsNamespace.new(@transport)
  @sync_type = AccountsSyncTypeNamespace.new(@transport)
end

Instance Attribute Details

#credentials ⇒ AccountsCredentialsNamespace (readonly)

Returns client.accounts.credentials.

Returns:



121
122
123
 
# File 'lib/infrawrench/client.rb', line 121

def credentials
  @credentials
end

#sync_type ⇒ AccountsSyncTypeNamespace (readonly)

Returns client.accounts.sync_type.

Returns:



123
124
125
 
# File 'lib/infrawrench/client.rb', line 123

def sync_type
  @sync_type
end

Instance Method Details

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

Create an account

Stores encrypted credentials and triggers a first sync. syncError is set if the initial sync failed (the account row is still created).

Requires permission: accounts:write.

POST /api/org/orgId/accounts

Raises on 400: Bad request

Raises on 402: Payment required — the organization's plan does not include this

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 CreateAccountRequest & Hash.

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

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

  • body: (create_account_request & { ?"pluginId" => plugin_id })
  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

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

Raises:



154
155
156
157
158
159
160
161
162
 
# File 'lib/infrawrench/client.rb', line 154

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

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

Delete an account

Requires permission: accounts:delete.

DELETE /api/org/orgId/accounts/id

Parameters:

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

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

  • id (String)
  • 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:



176
177
178
179
180
181
182
183
 
# File 'lib/infrawrench/client.rb', line 176

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

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

Account metadata + resource type list

Requires permission: accounts:read.

GET /api/org/orgId/accounts/id/detail

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)
  • 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 AccountDetail — see sig/infrawrench/sdk.rbs.

Raises:



199
200
201
202
203
204
205
206
 
# File 'lib/infrawrench/client.rb', line 199

def detail(id:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/accounts/{id}/detail",
    path_params: { "orgId" => org_id, "id" => id },
    request_options: request_options
  )
end

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

List accounts in this organization

Requires permission: accounts:read.

GET /api/org/orgId/accounts

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<Account> — see sig/infrawrench/sdk.rbs.

Raises:



220
221
222
223
224
225
226
227
 
# File 'lib/infrawrench/client.rb', line 220

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

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

List installed plugins and their credential fields

Requires permission: accounts:read.

GET /api/org/orgId/accounts/plugins

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<PluginSummary> — see sig/infrawrench/sdk.rbs.

Raises:



241
242
243
244
245
246
247
248
 
# File 'lib/infrawrench/client.rb', line 241

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

#resources(id:, org_id: nil, top_level_only: nil, request_options: nil) ⇒ Array<Hash>

List cached resources for an account

Requires permission: resources:read.

GET /api/org/orgId/accounts/id/resources

Parameters:

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

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

  • id (String)
  • top_level_only (String, nil) (defaults to: nil) —

    If true, only resources with no parentResourceId are returned.

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

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

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

Returns:

  • (Array<Hash>) —

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

Raises:



265
266
267
268
269
270
271
272
273
 
# File 'lib/infrawrench/client.rb', line 265

def resources(id:, org_id: nil, top_level_only: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/accounts/{id}/resources",
    path_params: { "orgId" => org_id, "id" => id },
    query: { "topLevelOnly" => top_level_only },
    request_options: request_options
  )
end

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

Sync all resource types for an account

Requires permission: resources:read.

POST /api/org/orgId/accounts/id/sync

Parameters:

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

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

  • id (String)
  • 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 SyncResponse — see sig/infrawrench/sdk.rbs.

Raises:



287
288
289
290
291
292
293
294
 
# File 'lib/infrawrench/client.rb', line 287

def sync(id:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "POST",
    path: "/api/org/{orgId}/accounts/{id}/sync",
    path_params: { "orgId" => org_id, "id" => id },
    request_options: request_options
  )
end

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

Update an account (rename and/or change bastion binding)

Requires permission: accounts:write.

PATCH /api/org/orgId/accounts/id

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)
  • body (Hash) —

    Request body, shaped as UpdateAccountRequest.

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

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

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

Returns:

  • (Hash) —

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

Raises:



313
314
315
316
317
318
319
320
321
 
# File 'lib/infrawrench/client.rb', line 313

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