Lettermint.Suppressions (Lettermint v2.1.0)

The suppression list. Needs :team_token.

Every function takes the options timeout: (milliseconds) last.

Summary

Types

result(value)

Functions

create(client, body, options \\ [])

Adds a suppression.

delete(client, suppression_id, options \\ [])

Removes a suppression. Some removals are reviewed first: then status is not "removed" and ticket_identifier names the review.

iterate(client, query \\ %{}, options \\ [])

Streams every suppression, following next_cursor. Raises the error of a failed page request.

list(client, query \\ %{}, options \\ [])

Lists suppressions, one page at a time. query: Lettermint.Types.ListSuppressionsQuery.t/0.

Types

result(value)

@type result(value) :: {:ok, value} | {:error, Lettermint.Error.t()}

Functions

create(client, body, options \\ [])

@spec create(
  Lettermint.Client.t(),
  Lettermint.Types.StoreSuppressionData.t() | map(),
  keyword()
) ::
  result(Lettermint.Types.SuppressionStoreResponse.t())

Adds a suppression.

delete(client, suppression_id, options \\ [])

@spec delete(Lettermint.Client.t(), String.t(), keyword()) ::
  result(Lettermint.Types.DeleteSuppressionResponse.t())

Removes a suppression. Some removals are reviewed first: then status is not "removed" and ticket_identifier names the review.

iterate(client, query \\ %{}, options \\ [])

@spec iterate(
  Lettermint.Client.t(),
  Lettermint.Types.ListSuppressionsQuery.t(),
  keyword()
) ::
  Enumerable.t(Lettermint.Types.SuppressedRecipientData.t())

Streams every suppression, following next_cursor. Raises the error of a failed page request.

list(client, query \\ %{}, options \\ [])

@spec list(
  Lettermint.Client.t(),
  Lettermint.Types.ListSuppressionsQuery.t(),
  keyword()
) ::
  result(Lettermint.Types.ListSuppressionsResponse.t())

Lists suppressions, one page at a time. query: Lettermint.Types.ListSuppressionsQuery.t/0.