Lettermint.Routes (Lettermint v2.1.0)

Routes of a project. Needs :team_token.

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

Summary

Types

result(value)

Functions

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

Creates a route in a project.

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

Deletes a route.

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

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

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

Lists the routes of a project, one page at a time. query: Lettermint.Types.ListRoutesQuery.t/0.

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

Retrieves a route.

update(client, route_id, body, options \\ [])

Updates a route.

verify_inbound_domain(client, route_id, options \\ [])

Checks the inbound domain of a route.

Types

result(value)

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

Functions

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

@spec create(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.StoreRouteData.t() | map(),
  keyword()
) ::
  result(Lettermint.Types.RouteMutationResponse.t())

Creates a route in a project.

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

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

Deletes a route.

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

@spec iterate(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.ListRoutesQuery.t(),
  keyword()
) ::
  Enumerable.t(Lettermint.Types.RouteListData.t())

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

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

@spec list(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.ListRoutesQuery.t(),
  keyword()
) ::
  result(Lettermint.Types.ListRoutesResponse.t())

Lists the routes of a project, one page at a time. query: Lettermint.Types.ListRoutesQuery.t/0.

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

@spec retrieve(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.GetRouteQuery.t(),
  keyword()
) ::
  result(Lettermint.Types.RouteData.t())

Retrieves a route.

update(client, route_id, body, options \\ [])

@spec update(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.UpdateRouteData.t() | map(),
  keyword()
) ::
  result(Lettermint.Types.RouteMutationResponse.t())

Updates a route.

verify_inbound_domain(client, route_id, options \\ [])

@spec verify_inbound_domain(Lettermint.Client.t(), String.t(), keyword()) ::
  result(Lettermint.Types.InboundDomainVerificationResponse.t())

Checks the inbound domain of a route.