@spec apply_template(
  Dnsimple.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  String.t() | integer(),
  Keyword.t()
) :: {:ok | :error, Dnsimple.Response.t()}

Applies a template to a domain.

See:

• https://developer.dnsimple.com/v2/templates/domains/#apply

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Templates.apply_template(client, account_id = 1010, domain_id = "example.com", template_id = "alpha")

@spec create_template(Dnsimple.Client.t(), String.t() | integer(), map(), Keyword.t()) ::
  {:ok | :error, Dnsimple.Response.t()}

Creates a new template.

See:

• https://developer.dnsimple.com/v2/templates/#create

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Templates.create_template(client, account_id = 1010, %{
  name: "Beta",
  short_name: "beta",
  description: "A beta template.",
})

@spec create_template_record(
  Dnsimple.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  map(),
  Keyword.t()
) :: {:ok | :error, Dnsimple.Response.t()}

Creates a new record in the template.

See:

• https://developer.dnsimple.com/v2/templates/records/#create

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Templates.create_template_record(client, account_id = 1010, template_id = "alpha" %{
  name: "",
  type: "mx",
  content: "mx.example.com",
  ttl: 600,
  prio: 10,
})

@spec delete_template(
  Dnsimple.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  Keyword.t()
) ::
  {:ok | :error, Dnsimple.Response.t()}

Deletes a template.

Warning: this is a destructive operation.

See:

• https://developer.dnsimple.com/v2/templates/#delete

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Templates.delete_template(client, account_id = 1010, template_id = "alpha")

@spec delete_template_record(
  Dnsimple.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  integer(),
  Keyword.t()
) :: {:ok | :error, Dnsimple.Response.t()}

Deletes a record from a template.

Warning: this is a destructive operation.

See:

• https://developer.dnsimple.com/v2/templates/records/#delete

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Templates.delete_template_record(client, account_id = 1010, template_id = "alpha", record_id = 1)

@spec get_template(
  Dnsimple.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  Keyword.t()
) ::
  {:ok | :error, Dnsimple.Response.t()}

Returns a template.

See:

• https://developer.dnsimple.com/v2/templates/#get

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Templates.get_template(client, account_id = 1010, template_id = "alpha")

@spec get_template_record(
  Dnsimple.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  integer(),
  Keyword.t()
) :: {:ok | :error, Dnsimple.Response.t()}

Returns a record of the template.

See:

• https://developer.dnsimple.com/v2/templates/records/#get

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Templates.get_template_record(client, account_id = 1010, template_id = "alpha", record_id = 123)

@spec list_template_records(
  Dnsimple.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  Keyword.t()
) :: {:ok | :error, Dnsimple.Response.t()}

Returns the list of records in the template.

See:

• https://developer.dnsimple.com/v2/templates/records/#list

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Templates.list_template_records(client, account_id = 1010, template_id = 1)
Dnsimple.Templates.list_template_records(client, account_id = 1010, template_id = 1, sort: "type:asc")

@spec list_templates(Dnsimple.Client.t(), String.t() | integer(), Keyword.t()) ::
  {:ok | :error, Dnsimple.Response.t()}

Returns the list of existing templates in the account.

See:

• https://developer.dnsimple.com/v2/templates/#list

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Templates.list_templates(client, account_id = 1010)
{:ok, response} = Dnsimple.Templates.list_templates(client, account_id = 1010, sort: "name:asc")

@spec update_template(
  Dnsimple.Client.t(),
  String.t() | integer(),
  String.t() | integer(),
  map(),
  Keyword.t()
) :: {:ok | :error, Dnsimple.Response.t()}

Updates an existing template.

See:

• https://developer.dnsimple.com/v2/templates/#update

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Templates.update_template(client, account_id = 1010, template_id = 1, %{
  name: "Beta",
  short_name: "beta",
  description: "A beta template.",
})