IncidentIo.SeveritiesV1 (IncidentIo v0.3.1)

Manage severities.

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

Severities help categorise incidents, and communicate urgency/impact. You can use severities when filtering incidents in the dashboard, and in workflows and announcement rules.

Summary

Functions

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

Create a new severity.

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

Delete an existing severity.

list(client \\ %Client{})

List all severities for an organisation.

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

Get a single severity.

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

Update an existing severity.

Functions

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

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

Create a new severity.

Severity body example:

%{
  description: "Issues with **low impact**.",
  name: "Minor",
  rank: 1
}

Example

IncidentIo.SeveritiesV1.create(client, body)

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

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

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

Delete an existing severity.

Example

IncidentIo.SeveritiesV1.destroy(client, "some-severity-id")

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

list(client \\ %Client{})

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

List all severities for an organisation.

Example

IncidentIo.SeveritiesV1.list(client)

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

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

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

Get a single severity.

Example

IncidentIo.SeveritiesV1.show(client, "some-severity-id")

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

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

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

Update an existing severity.

Severity body example:

%{
  description: "Issues with **low impact**.",
  name: "Morris Minor",
  rank: 2
}

Example

IncidentIo.SeveritiesV1.update(client, "some-severity-id", body)

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