ApolloSignal.Domains.Topics (apollo_signal v1.0.5)

Copy Markdown View Source

topics API operations.

Summary

Types

t()

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

Functions

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

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

delete_topic(domain, project_id, topic_id, options \\ [])

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

get_topic(domain, project_id, topic_id, options \\ [])

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

list_contacts_in_topic(domain, project_id, topic_id, options \\ [])

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

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

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

new(client)

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

update_topic(domain, project_id, topic_id, body, options \\ [])

@spec update_topic(
  domain :: t(),
  project_id :: String.t(),
  topic_id :: String.t(),
  body :: ApolloSignal.Types.UpdateTopicBody.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.TopicResponse.t(), ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}