IncidentIo.IncidentStatusesV1 (IncidentIo v0.3.1)

Manage incident statuses.

Each incident has a status, picked from one of the statuses configured in your organisation's settings.

Statuses help communicate where an incident is in its lifecycle. You can use statuses when filtering incidents in the dashboard, and in workflows and announcement rules.

Summary

Functions

create(client \\ %Client{}, body)

Create a new incident status.

destroy(client \\ %Client{}, id)

Removes an existing incident status.

list(client \\ %Client{})

List all incident statuses for an organisation.

show(client \\ %Client{}, id)

Get a single incident status.

update(client \\ %Client{}, id, body)

Update an existing incident status.

Functions

create(client \\ %Client{}, body)

@spec create(IncidentIo.Client.t(), create_request_body()) :: IncidentIo.response()

Create a new incident status.

incident status body example:

%{
  category: "live",
  description: "Impact has been **fully mitigated**, and we're ready to learn from this incident.",
  name: "Closed"
}

Example

IncidentIo.IncidentStatusesV1.create(client, body)

More information at: https://api-docs.incident.io/tag/Incident-Statuses-V1#operation/Incident-Statuses%20V1_Create

destroy(client \\ %Client{}, id)

@spec destroy(IncidentIo.Client.t(), binary()) :: IncidentIo.response()

Removes an existing incident status.

Example

IncidentIo.IncidentStatusesV1.destroy(client, "some-incident-status-id")

More information at: https://api-docs.incident.io/tag/Incident-Statuses-V1#operation/Incident-Statuses%20V1_Delete

list(client \\ %Client{})

@spec list(IncidentIo.Client.t()) :: IncidentIo.response()

List all incident statuses for an organisation.

Example

IncidentIo.IncidentStatusesV1.list(client)

More information at: https://api-docs.incident.io/tag/Incident-Statuses-V1#operation/Incident-Statuses%20V1_List

show(client \\ %Client{}, id)

@spec show(IncidentIo.Client.t(), binary()) :: IncidentIo.response()

Get a single incident status.

Example

IncidentIo.IncidentStatusesV1.show(client, "some-incident-status-id")

More information at: https://api-docs.incident.io/tag/Incident-Statuses-V1#operation/Incident-Statuses%20V1_Show

update(client \\ %Client{}, id, body)

@spec update(IncidentIo.Client.t(), binary(), update_request_body()) ::
  IncidentIo.response()

Update an existing incident status.

incident status body example:

%{
  description: "Impact has been **fully mitigated**, and we're ready to learn from this incident.",
  name: "Closed"
}

Example

IncidentIo.IncidentStatusesV1.update(client, "some-incident-status-id", body)

More information at: https://api-docs.incident.io/tag/Incident-Statuses-V1#operation/Incident-Statuses%20V1_Update