IncidentIo.IncidentMembershipsV1 (IncidentIo v0.3.1)

View Source

Manage memberships on incidents.

Incident memberships control which users are members of a given incident. Members receive notifications and appear on the incident timeline.

Summary

Functions

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

Makes a user a member of a private incident.

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

Revoke a user's membership of a private incident.

Functions

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

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

Makes a user a member of a private incident.

Incident membership body example:

%{
  incident_id: "01ET65M7ZADYFCKD4K1AE2QNMC",
  user_id: "01FCQSP07Z74QMMYPDDGQB9FTG",
}

Example

IncidentIo.IncidentMembershipsV1.create(client, body)

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

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

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

Revoke a user's membership of a private incident.

Incident membership body example:

%{
  incident_id: "01ET65M7ZADYFCKD4K1AE2QNMC",
  user_id: "01FCQSP07Z74QMMYPDDGQB9FTG",
}

Example

IncidentIo.IncidentMembershipsV1.revoke(client, body)

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