IncidentIo.ActionsV2 (IncidentIo v0.3.1)

Manage actions attached to incidents.

Actions are tasks that responders create during an incident to track work that needs to be done. This module covers the v2 Actions API, supporting full CRUD operations.

Summary

Functions

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

Create an action for an incident.

list(client \\ %Client{}, incident_id, incident_mode \\ :standard)

List all actions for an organisation.

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

Get a single incident action.

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

Update an existing action.

Functions

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

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

Create an action for an incident.

Example

IncidentIo.ActionsV2.create(client, %{
  assignee_id: "01FCNDV6P870EA6S7TK1DSYDG0",
  description: "Call the fire brigade",
  incident_id: "01FCNDV6P870EA6S7TK1DSYDG0",
  status: "outstanding"
})

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

list(client \\ %Client{}, incident_id, incident_mode \\ :standard)

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

List all actions for an organisation.

Example

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

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

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

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

Get a single incident action.

Example

IncidentIo.ActionsV2.show(client, "some-action-id")

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

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

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

Update an existing action.

Example

IncidentIo.ActionsV2.update(client, "some-action-id", %{status: "completed"})

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