ApolloSignal.Domains.Emails (apollo_signal v4.0.1)

Copy Markdown View Source

emails API operations.

Summary

Types

t()

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

Functions

batch_send_emails(domain, body, options \\ [])

@spec batch_send_emails(
  domain :: t(),
  body :: ApolloSignal.Types.BatchSendRequest.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.BatchSendResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

bulk_cancel_emails(domain, options \\ [])

@spec bulk_cancel_emails(domain :: t(), options :: keyword()) ::
  {:ok, ApolloSignal.Types.BulkCancelResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

cancel_email(domain, email_id, options \\ [])

@spec cancel_email(domain :: t(), email_id :: String.t(), options :: keyword()) ::
  {:ok, ApolloSignal.Types.CancelResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

get_email(domain, email_id, options \\ [])

@spec get_email(domain :: t(), email_id :: String.t(), options :: keyword()) ::
  {:ok, ApolloSignal.Types.EmailDetailResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

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

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

new(client)

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

send_email(domain, body, options \\ [])

@spec send_email(
  domain :: t(),
  body :: ApolloSignal.Types.SendEmailRequest.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.SendEmailResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

stream_email_events(domain, options \\ [])

@spec stream_email_events(domain :: t(), options :: keyword()) ::
  {:ok,
   ApolloSignal.Transport.SSEStream.t(
     ApolloSignal.Types.StreamEventResponse.t()
   )}
  | {:error, ApolloSignal.Errors.t()}

validate_links(domain, body, options \\ [])

@spec validate_links(
  domain :: t(),
  body :: ApolloSignal.Types.ValidateLinksRequest.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.ValidateLinksResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}