IncidentIo.IncidentRolesV2 (IncidentIo v0.3.1)

Manage incident roles.

During an incident, you can assign responders to one of the incident roles that are configured in your organisation settings.

Every organisation will have a special 'lead' role, which signifies the incident lead or commander. This role cannot be deleted, but can be renamed in the incident.io dashboard.

Summary

Functions

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

Create a new incident role.

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

Removes an existing incident role.

list(client \\ %Client{})

List all incident roles for an organisation.

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

Get a single incident role.

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

Update an existing incident role.

Functions

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

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

Create a new incident role.

Incident role body example:

%{
  description: "The person currently coordinating the incident",
  instructions: "Take point on the incident; Make sure people are clear on responsibilities",
  name: "Incident Lead",
  shortform: "lead"
}

Example

IncidentIo.IncidentRolesV2.create(client, body)

More information at: https://api-docs.incident.io/tag/Incident-Roles-V2#operation/Incident-Roles%20V2_Create

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

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

Removes an existing incident role.

Example

IncidentIo.IncidentRolesV2.destroy(client, "some-incident-role-id")

More information at: https://api-docs.incident.io/tag/Incident-Roles-V2#operation/Incident-Roles%20V2_Delete

list(client \\ %Client{})

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

List all incident roles for an organisation.

Example

IncidentIo.IncidentRolesV2.list(client, "some-incident-id")

More information at: https://api-docs.incident.io/tag/Incident-Roles-V2#operation/Incident-Roles%20V2_List

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

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

Get a single incident role.

Example

IncidentIo.IncidentRolesV2.show(client, "some-incident-role-id")

More information at: https://api-docs.incident.io/tag/Incident-Roles-V2#operation/Incident-Roles%20V2_Show

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

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

Update an existing incident role.

Incident role body example:

%{
  description: "The person currently coordinating the incident",
  instructions: "Take point on the incident; Make sure people are clear on responsibilities",
  name: "Incident Lead",
  shortform: "lead"
}

Example

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

More information at: https://api-docs.incident.io/tag/Incident-Roles-V2#operation/Incident-Roles%20V2_Update