Lettermint.Types.ListDomainsQuery (Lettermint v2.1.0)

Query parameters of GET /domains (listDomains).

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[project] (optional): Filter by project ID
filter[status] (optional)
filter[domain] (optional): Search by domain name (partial match, case insensitive)

Summary

Types

t()

Functions

__params__()

The wire names of the parameters with their decode specs.

Types

t()

@type t() :: %{
  optional(:sort) => [Lettermint.Types.ListDomainsQuerySortItem.t()],
  optional(:page) => %{
    optional(:size) => integer(),
    optional(:cursor) => String.t()
  },
  optional(:filter) => %{
    optional(:project) => String.t(),
    optional(:status) => Lettermint.Types.DomainStatus.t(),
    optional(:domain) => String.t()
  }
}

Functions

params()

The wire names of the parameters with their decode specs.