ApolloSignal.Domains.Segments (apollo_signal v1.0.5)

Copy Markdown View Source

segments API operations.

Summary

Types

t()

Functions

create_segment(domain, project_id, body, options \\ [])
delete_segment(domain, project_id, segment_id, options \\ [])
get_segment(domain, project_id, segment_id, options \\ [])
list_contacts_in_segment(domain, project_id, segment_id, options \\ [])
list_segments(domain, project_id, options \\ [])
new(client)

Types

t()

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

Functions

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

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

delete_segment(domain, project_id, segment_id, options \\ [])

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

get_segment(domain, project_id, segment_id, options \\ [])

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

list_contacts_in_segment(domain, project_id, segment_id, options \\ [])

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

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

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

new(client)

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