Lettermint.Types.ListWebhookDeliveriesQuery (Lettermint v2.1.0)

Copy Markdown View Source

Query parameters of GET /webhooks/{webhookId}/deliveries (listWebhookDeliveries).

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

  • cursor (optional): Cursor for the next or previous page.
  • sort (optional)
  • filter[status] (optional): Filter by delivery status
  • filter[event_type] (optional): Filter by event type
  • filter[from_date] (optional): Filter deliveries from this date (Y-m-d format)
  • filter[to_date] (optional): Filter deliveries to this date (Y-m-d format)

Summary

Types

t()

Functions

__params__()

The wire names of the parameters with their decode specs.

Types

t()

@type t() :: %{
  optional(:cursor) => String.t(),
  optional(:sort) => [Lettermint.Types.ListWebhookDeliveriesQuerySortItem.t()],
  optional(:filter) => %{
    optional(:status) => Lettermint.Types.WebhookDeliveryStatus.t(),
    optional(:event_type) => String.t(),
    optional(:from_date) => String.t(),
    optional(:to_date) => String.t()
  }
}

Functions

__params__()

The wire names of the parameters with their decode specs.