ApolloSignal.Domains.Projects (apollo_signal v1.0.5)

Copy Markdown View Source

projects API operations.

Summary

Types

t()

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

Functions

get_email_timeline(domain, project_id, email_id, options \\ [])

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

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

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

get_project_email(domain, project_id, email_id, options \\ [])

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

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

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

list_projects(domain, options \\ [])

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

new(client)

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

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

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