ApolloSignal.Domains.SendingDomains (apollo_signal v1.0.5)

sendingDomains API operations.

Summary

Types

t()

Functions

delete_domain(domain, project_id, domain_id, options \\ [])

get_domain(domain, project_id, domain_id, options \\ [])

list_domains(domain, project_id, options \\ [])

new(client)

register_domain(domain, project_id, body, options \\ [])

update_bimi(domain, project_id, domain_id, body, options \\ [])

verify_bimi(domain, project_id, domain_id, options \\ [])

verify_domain(domain, project_id, domain_id, options \\ [])

Types

t()

@type t() :: %ApolloSignal.Domains.SendingDomains{client: ApolloSignal.Client.t()}

Functions

delete_domain(domain, project_id, domain_id, options \\ [])

@spec delete_domain(
  domain :: t(),
  project_id :: String.t(),
  domain_id :: String.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Transport.metadata()} | {:error, ApolloSignal.Errors.t()}

get_domain(domain, project_id, domain_id, options \\ [])

@spec get_domain(
  domain :: t(),
  project_id :: String.t(),
  domain_id :: String.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.DomainResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

list_domains(domain, project_id, options \\ [])

@spec list_domains(domain :: t(), project_id :: String.t(), options :: keyword()) ::
  {:ok, ApolloSignal.Types.DomainListPageResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

new(client)

@spec new(ApolloSignal.Client.t()) :: t()

register_domain(domain, project_id, body, options \\ [])

@spec register_domain(
  domain :: t(),
  project_id :: String.t(),
  body :: ApolloSignal.Types.RegisterDomainRequest.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.DomainResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

update_bimi(domain, project_id, domain_id, body, options \\ [])

@spec update_bimi(
  domain :: t(),
  project_id :: String.t(),
  domain_id :: String.t(),
  body :: ApolloSignal.Types.UpdateBimiRequest.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.DomainResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

verify_bimi(domain, project_id, domain_id, options \\ [])

@spec verify_bimi(
  domain :: t(),
  project_id :: String.t(),
  domain_id :: String.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.DomainResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

verify_domain(domain, project_id, domain_id, options \\ [])

@spec verify_domain(
  domain :: t(),
  project_id :: String.t(),
  domain_id :: String.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.DomainResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}