ApolloSignal.Domains.Suppressions (apollo_signal v4.0.0)

Copy Markdown View Source

suppressions API operations.

Summary

Types

t()

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

Functions

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

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

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

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

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

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

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

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

new(client)

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

remove_suppression(domain, project_id, email, options \\ [])

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