Lettermint.Domains (Lettermint v2.0.0)

Sending domains. Needs :team_token.

Every function takes the options timeout: (milliseconds) last. Query arguments are maps with nested maps for bracketed names; see Lettermint.Query.

Summary

Types

result(value)

Functions

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

Adds a domain.

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

Deletes a domain.

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

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

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

Lists domains, one page at a time. query: Lettermint.Types.ListDomainsQuery.t/0.

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

Retrieves a domain. query: %{include: ["dnsRecords"]} and so on.

update_projects(client, domain_id, body, options \\ [])

Replaces the projects that may send from the domain.

verify_dns_record(client, domain_id, record_id, options \\ [])

Checks one DNS record of the domain.

verify_dns_records(client, domain_id, options \\ [])

Checks every DNS record of the domain.

Types

result(value)

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

Functions

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

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

Adds a domain.

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

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

Deletes a domain.

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

@spec iterate(Lettermint.Client.t(), Lettermint.Types.ListDomainsQuery.t(), keyword()) ::
  Enumerable.t(Lettermint.Types.DomainListData.t())

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

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

@spec list(Lettermint.Client.t(), Lettermint.Types.ListDomainsQuery.t(), keyword()) ::
  result(Lettermint.Types.ListDomainsResponse.t())

Lists domains, one page at a time. query: Lettermint.Types.ListDomainsQuery.t/0.

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

@spec retrieve(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.GetDomainQuery.t(),
  keyword()
) ::
  result(Lettermint.Types.DomainData.t())

Retrieves a domain. query: %{include: ["dnsRecords"]} and so on.

update_projects(client, domain_id, body, options \\ [])

@spec update_projects(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.UpdateDomainProjectsData.t() | map(),
  keyword()
) :: result(Lettermint.Types.DomainMutationResponse.t())

Replaces the projects that may send from the domain.

verify_dns_record(client, domain_id, record_id, options \\ [])

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

Checks one DNS record of the domain.

verify_dns_records(client, domain_id, options \\ [])

@spec verify_dns_records(Lettermint.Client.t(), String.t(), keyword()) ::
  result(Lettermint.Types.DnsVerificationSuccessResponse.t())

Checks every DNS record of the domain.