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:



6567
6568
6569
6570
6571
6572
 
# File 'lib/infrawrench/client.rb', line 6567

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:



6559
6560
6561
 
# File 'lib/infrawrench/client.rb', line 6559

def default
  @default
end

#pin ⇒ DashboardsPinNamespace (readonly)

Returns client.dashboards.pin.

Returns:



6561
6562
6563
 
# File 'lib/infrawrench/client.rb', line 6561

def pin
  @pin
end

#widgets ⇒ DashboardsWidgetsNamespace (readonly)

Returns client.dashboards.widgets.

Returns:



6563
6564
6565
 
# File 'lib/infrawrench/client.rb', line 6563

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:



6586
6587
6588
6589
6590
6591
6592
6593
6594
 
# File 'lib/infrawrench/client.rb', line 6586

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:



6614
6615
6616
6617
6618
6619
6620
6621
 
# File 'lib/infrawrench/client.rb', line 6614

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:



6637
6638
6639
6640
6641
6642
6643
6644
 
# File 'lib/infrawrench/client.rb', line 6637

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:



6658
6659
6660
6661
6662
6663
6664
6665
 
# File 'lib/infrawrench/client.rb', line 6658

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:



6679
6680
6681
6682
6683
6684
6685
6686
6687
 
# File 'lib/infrawrench/client.rb', line 6679

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:



6702
6703
6704
6705
6706
6707
6708
6709
6710
 
# File 'lib/infrawrench/client.rb', line 6702

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:



6731
6732
6733
6734
6735
6736
6737
6738
6739
 
# File 'lib/infrawrench/client.rb', line 6731

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:



6755
6756
6757
6758
6759
6760
6761
6762
6763
 
# File 'lib/infrawrench/client.rb', line 6755

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:



6778
6779
6780
6781
6782
6783
6784
6785
6786
 
# File 'lib/infrawrench/client.rb', line 6778

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:



6800
6801
6802
6803
6804
6805
6806
6807
6808
 
# File 'lib/infrawrench/client.rb', line 6800

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:



6822
6823
6824
6825
6826
6827
6828
6829
6830
 
# File 'lib/infrawrench/client.rb', line 6822

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