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:



2024
2025
2026
2027
2028
2029
 
# File 'lib/infrawrench/client.rb', line 2024

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:



2016
2017
2018
 
# File 'lib/infrawrench/client.rb', line 2016

def default
  @default
end

#pin ⇒ DashboardsPinNamespace (readonly)

Returns client.dashboards.pin.

Returns:



2018
2019
2020
 
# File 'lib/infrawrench/client.rb', line 2018

def pin
  @pin
end

#widgets ⇒ DashboardsWidgetsNamespace (readonly)

Returns client.dashboards.widgets.

Returns:



2020
2021
2022
 
# File 'lib/infrawrench/client.rb', line 2020

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:



2043
2044
2045
2046
2047
2048
2049
2050
2051
 
# File 'lib/infrawrench/client.rb', line 2043

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:



2071
2072
2073
2074
2075
2076
2077
2078
 
# File 'lib/infrawrench/client.rb', line 2071

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:



2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'lib/infrawrench/client.rb', line 2094

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:



2115
2116
2117
2118
2119
2120
2121
2122
 
# File 'lib/infrawrench/client.rb', line 2115

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:



2136
2137
2138
2139
2140
2141
2142
2143
2144
 
# File 'lib/infrawrench/client.rb', line 2136

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:



2159
2160
2161
2162
2163
2164
2165
2166
2167
 
# File 'lib/infrawrench/client.rb', line 2159

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:



2188
2189
2190
2191
2192
2193
2194
2195
2196
 
# File 'lib/infrawrench/client.rb', line 2188

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:



2212
2213
2214
2215
2216
2217
2218
2219
2220
 
# File 'lib/infrawrench/client.rb', line 2212

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:



2235
2236
2237
2238
2239
2240
2241
2242
2243
 
# File 'lib/infrawrench/client.rb', line 2235

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:



2257
2258
2259
2260
2261
2262
2263
2264
2265
 
# File 'lib/infrawrench/client.rb', line 2257

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:



2279
2280
2281
2282
2283
2284
2285
2286
2287
 
# File 'lib/infrawrench/client.rb', line 2279

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