IncidentIo.IncidentTypesV1 (IncidentIo v0.3.1)

View Source

Manage incident types.

With incident types enabled, you can tailor your process to the situation you're responding to with different custom fields and roles for each incident type.

Summary

Functions

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

Create a new incident type.

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

Archives a single incident type.

list(client \\ %Client{})

List all incident types for an organisation.

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

Get a single incident type.

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

Update an existing incident type.

Functions

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

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

Create a new incident type.

Example

IncidentIo.IncidentTypesV1.create(client, %{
  description: "Customer facing production outages",
  name: "Production Outage"
})

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

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

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

Archives a single incident type.

Example

IncidentIo.IncidentTypesV1.destroy(client, "some-incident-type-id")

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

list(client \\ %Client{})

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

List all incident types for an organisation.

Example

IncidentIo.IncidentTypesV1.list(client)

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

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

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

Get a single incident type.

Example

IncidentIo.IncidentTypesV1.show(client, "some-incident-type-id")

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

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

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

Update an existing incident type.

Example

IncidentIo.IncidentTypesV1.update(client, "some-incident-type-id", %{
  name: "Updated Production Outage"
})

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