ApolloSignal.Domains.Contacts (apollo_signal v1.0.5)

Copy Markdown View Source

contacts API operations.

Summary

Types

t()

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

Functions

add_contact_to_segment(domain, project_id, contact_id, body, options \\ [])

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

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

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

delete_contact(domain, project_id, contact_id, options \\ [])

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

delete_contact_image(domain, project_id, contact_id, options \\ [])

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

get_contact(domain, project_id, contact_id, options \\ [])

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

get_contact_activity(domain, project_id, contact_id, options \\ [])

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

get_contact_email_validation_status(domain, project_id, contact_id, options \\ [])

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

get_contact_engagement_score(domain, project_id, contact_id, options \\ [])

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

get_contact_topics(domain, project_id, contact_id, options \\ [])

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

list_contact_segments(domain, project_id, contact_id, options \\ [])

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

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

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

new(client)

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

record_contact_email_validation(domain, project_id, contact_id, body, options \\ [])

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

refresh_contact_engagement_score(domain, project_id, contact_id, options \\ [])

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

remove_contact_from_segment(domain, project_id, contact_id, segment_id, options \\ [])

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

set_contact_image_url(domain, project_id, contact_id, body, options \\ [])

@spec set_contact_image_url(
  domain :: t(),
  project_id :: String.t(),
  contact_id :: String.t(),
  body :: ApolloSignal.Types.SetImageUrlBody.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.ContactResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

update_contact(domain, project_id, contact_id, body, options \\ [])

@spec update_contact(
  domain :: t(),
  project_id :: String.t(),
  contact_id :: String.t(),
  body :: ApolloSignal.Types.UpdateContactBody.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.ContactResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

update_contact_topics(domain, project_id, contact_id, body, options \\ [])

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

upload_contact_image(domain, project_id, contact_id, options \\ [])

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