Class: Infrawrench::CostAlertsNamespace

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

Overview

client.cost_alerts

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ CostAlertsNamespace

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

Parameters:



3457
3458
3459
3460
 
# File 'lib/infrawrench/client.rb', line 3457

def initialize(transport)
  @transport = transport
  @get = CostAlertsGetNamespace.new(@transport)
end

Instance Attribute Details

#get ⇒ CostAlertsGetNamespace (readonly)

Returns client.cost_alerts.get.

Returns:



3453
3454
3455
 
# File 'lib/infrawrench/client.rb', line 3453

def get
  @get
end

Instance Method Details

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

Create a change-based cost alert

Requires permission: costs:write.

POST /api/org/orgId/cost-alerts

Raises on 400: Bad request

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

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

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

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

Returns:

  • (Hash) —

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

Raises:



3476
3477
3478
3479
3480
3481
3482
3483
3484
 
# File 'lib/infrawrench/client.rb', line 3476

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

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

Delete a cost alert

Soft delete. Fired events disappear from the org-wide event feed with it.

Requires permission: costs:write.

DELETE /api/org/orgId/cost-alerts/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 Ok — see sig/infrawrench/sdk.rbs.

Raises:



3502
3503
3504
3505
3506
3507
3508
3509
 
# File 'lib/infrawrench/client.rb', line 3502

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

#events(org_id: nil, alert_id: nil, limit: nil, request_options: nil) ⇒ Hash

List recently fired cost-alert events

Newest first. Optionally scoped to one alert with ?alertId=; an unknown alertId is a 404, distinct from an alert that simply has no events yet.

Requires permission: costs:read.

GET /api/org/orgId/cost-alerts/events

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.

  • alert_id (String, nil) (defaults to: nil)
  • limit (Integer, nil) (defaults to: nil)
  • request_options (Hash, nil) (defaults to: nil) —

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

  • org_id: (String, nil) (defaults to: nil)
  • alert_id: (String, nil) (defaults to: nil)
  • limit: (Integer, 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:



3531
3532
3533
3534
3535
3536
3537
3538
3539
 
# File 'lib/infrawrench/client.rb', line 3531

def events(org_id: nil, alert_id: nil, limit: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/cost-alerts/events",
    path_params: { "orgId" => org_id },
    query: { "alertId" => alert_id, "limit" => limit },
    request_options: request_options
  )
end

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

Update a cost alert

Requires permission: costs:write.

PUT /api/org/orgId/cost-alerts/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 CostAlertInput.

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

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

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

Returns:

  • (Hash) —

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

Raises:



3558
3559
3560
3561
3562
3563
3564
3565
3566
 
# File 'lib/infrawrench/client.rb', line 3558

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