Class: Infrawrench::DashboardsNamespace

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

Overview

client.dashboards

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ DashboardsNamespace

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

Parameters:



6228
6229
6230
6231
6232
6233
 
# File 'lib/infrawrench/client.rb', line 6228

def initialize(transport)
  @transport = transport
  @default = DashboardsDefaultNamespace.new(@transport)
  @pin = DashboardsPinNamespace.new(@transport)
  @widgets = DashboardsWidgetsNamespace.new(@transport)
end

Instance Attribute Details

#default ⇒ DashboardsDefaultNamespace (readonly)

Returns client.dashboards.default.

Returns:



6220
6221
6222
 
# File 'lib/infrawrench/client.rb', line 6220

def default
  @default
end

#pin ⇒ DashboardsPinNamespace (readonly)

Returns client.dashboards.pin.

Returns:



6222
6223
6224
 
# File 'lib/infrawrench/client.rb', line 6222

def pin
  @pin
end

#widgets ⇒ DashboardsWidgetsNamespace (readonly)

Returns client.dashboards.widgets.

Returns:



6224
6225
6226
 
# File 'lib/infrawrench/client.rb', line 6224

def widgets
  @widgets
end

Instance Method Details

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

Create a dashboard

Requires permission: dashboards:write.

POST /api/org/orgId/dashboards

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

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

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

  • body: ({ "name" => String })
  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

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

Raises:



6247
6248
6249
6250
6251
6252
6253
6254
6255
 
# File 'lib/infrawrench/client.rb', line 6247

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

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

Delete a dashboard

Cannot delete the default dashboard.

Requires permission: dashboards:write.

DELETE /api/org/orgId/dashboards/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)
  • 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:



6275
6276
6277
6278
6279
6280
6281
6282
 
# File 'lib/infrawrench/client.rb', line 6275

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

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

Get a dashboard with its pins

Requires permission: dashboards:read.

GET /api/org/orgId/dashboards/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)
  • 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 DashboardWithPins — see sig/infrawrench/sdk.rbs.

Raises:



6298
6299
6300
6301
6302
6303
6304
6305
 
# File 'lib/infrawrench/client.rb', line 6298

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

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

List dashboards

Requires permission: dashboards:read.

GET /api/org/orgId/dashboards

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

Raises:



6319
6320
6321
6322
6323
6324
6325
6326
 
# File 'lib/infrawrench/client.rb', line 6319

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

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

Read cached stats/metrics for dashboard cards

Requires permission: dashboards:read.

POST /api/org/orgId/dashboards/probe

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

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

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

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

Returns:

  • (Hash) —

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

Raises:



6340
6341
6342
6343
6344
6345
6346
6347
6348
 
# File 'lib/infrawrench/client.rb', line 6340

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

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

Rename a dashboard

Requires permission: dashboards:write.

POST /api/org/orgId/dashboards/id/rename

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

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

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

  • id: (String)
  • body: ({ "name" => 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:



6363
6364
6365
6366
6367
6368
6369
6370
6371
 
# File 'lib/infrawrench/client.rb', line 6363

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

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

Reorder dashboard cards

Persists the order of a dashboard's grid. Pass cards to order resource pins, workflow pins, and widgets as one sequence; resourceIds orders resource pins alone.

Requires permission: dashboards:write.

POST /api/org/orgId/dashboards/id/reorder

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

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

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

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



6392
6393
6394
6395
6396
6397
6398
6399
6400
 
# File 'lib/infrawrench/client.rb', line 6392

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

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

Unpin a resource

Requires permission: dashboards:write.

POST /api/org/orgId/dashboards/unpin

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.

  • body (Hash) —

    Request body, shaped as UnpinRequest.

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

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

  • body: (unpin_request)
  • 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:



6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/infrawrench/client.rb', line 6416

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

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

Validate workspace tab targets still exist

Requires permission: dashboards:read.

POST /api/org/orgId/dashboards/validate-tabs

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

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

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

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

Returns:

  • (Hash) —

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

Raises:



6439
6440
6441
6442
6443
6444
6445
6446
6447
 
# File 'lib/infrawrench/client.rb', line 6439

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

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

Pin a workflow's metrics to a dashboard

POST /api/org/orgId/dashboards/workflow-pin

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.

  • body (Hash) —

    Request body, shaped as WorkflowPinRequest.

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

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

  • body: (workflow_pin_request)
  • 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:



6461
6462
6463
6464
6465
6466
6467
6468
6469
 
# File 'lib/infrawrench/client.rb', line 6461

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

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

Unpin a workflow from a dashboard

POST /api/org/orgId/dashboards/workflow-unpin

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.

  • body (Hash) —

    Request body, shaped as WorkflowPinRequest.

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

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

  • body: (workflow_pin_request)
  • 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:



6483
6484
6485
6486
6487
6488
6489
6490
6491
 
# File 'lib/infrawrench/client.rb', line 6483

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