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:



5973
5974
5975
5976
5977
5978
 
# File 'lib/infrawrench/client.rb', line 5973

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:



5965
5966
5967
 
# File 'lib/infrawrench/client.rb', line 5965

def default
  @default
end

#pin ⇒ DashboardsPinNamespace (readonly)

Returns client.dashboards.pin.

Returns:



5967
5968
5969
 
# File 'lib/infrawrench/client.rb', line 5967

def pin
  @pin
end

#widgets ⇒ DashboardsWidgetsNamespace (readonly)

Returns client.dashboards.widgets.

Returns:



5969
5970
5971
 
# File 'lib/infrawrench/client.rb', line 5969

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:



5992
5993
5994
5995
5996
5997
5998
5999
6000
 
# File 'lib/infrawrench/client.rb', line 5992

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:



6020
6021
6022
6023
6024
6025
6026
6027
 
# File 'lib/infrawrench/client.rb', line 6020

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:



6043
6044
6045
6046
6047
6048
6049
6050
 
# File 'lib/infrawrench/client.rb', line 6043

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:



6064
6065
6066
6067
6068
6069
6070
6071
 
# File 'lib/infrawrench/client.rb', line 6064

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:



6085
6086
6087
6088
6089
6090
6091
6092
6093
 
# File 'lib/infrawrench/client.rb', line 6085

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:



6108
6109
6110
6111
6112
6113
6114
6115
6116
 
# File 'lib/infrawrench/client.rb', line 6108

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:



6137
6138
6139
6140
6141
6142
6143
6144
6145
 
# File 'lib/infrawrench/client.rb', line 6137

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:



6161
6162
6163
6164
6165
6166
6167
6168
6169
 
# File 'lib/infrawrench/client.rb', line 6161

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:



6184
6185
6186
6187
6188
6189
6190
6191
6192
 
# File 'lib/infrawrench/client.rb', line 6184

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:



6206
6207
6208
6209
6210
6211
6212
6213
6214
 
# File 'lib/infrawrench/client.rb', line 6206

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:



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

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