Lettermint.Types.ListSuppressionsQuery (Lettermint v2.0.0)

Copy Markdown View Source

Query parameters of GET /suppressions (listSuppressions).

Pass them as a map with nested maps for bracketed names: %{page: %{size: 10}} is sent as page[size]=10. Lists of values are joined with commas, lists of maps are indexed and booleans are sent as 1 or 0.

Parameters

  • page[size] (optional): The number of results that will be returned per page.
  • page[cursor] (optional): The cursor to start the pagination from.
  • sort (optional)
  • filter[scope] (optional): Filter by scope (team, project, route)
  • filter[route_id] (optional): Filter by route ID
  • filter[project_id] (optional): Filter by project ID
  • filter[value] (optional): Search by email/domain value (partial match)
  • filter[reason] (optional)
  • filter[startDate] (optional): Filter suppressions created or updated on or after this ISO 8601 date or datetime
  • filter[endDate] (optional): Filter suppressions created or updated on or before this ISO 8601 date or datetime

Summary

Types

t()

Functions

__params__()

The wire names of the parameters with their decode specs.

Types

t()

@type t() :: %{
  optional(:sort) => [Lettermint.Types.ListSuppressionsQuerySortItem.t()],
  optional(:page) => %{
    optional(:size) => integer(),
    optional(:cursor) => String.t()
  },
  optional(:filter) => %{
    optional(:scope) => String.t(),
    optional(:route_id) => String.t(),
    optional(:project_id) => String.t(),
    optional(:value) => String.t(),
    optional(:reason) => Lettermint.Types.SuppressionReason.t(),
    optional(:startDate) => String.t(),
    optional(:endDate) => String.t()
  }
}

Functions

__params__()

The wire names of the parameters with their decode specs.