contacts API operations.
Summary
Types
@type t() :: %ApolloSignal.Domains.Contacts{client: ApolloSignal.Client.t()}
Functions
@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()}
@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()}
@spec delete_contact( domain :: t(), project_id :: String.t(), contact_id :: String.t(), options :: keyword() ) :: {:ok, ApolloSignal.Transport.metadata()} | {:error, ApolloSignal.Errors.t()}
@spec delete_contact_image( domain :: t(), project_id :: String.t(), contact_id :: String.t(), options :: keyword() ) :: {:ok, ApolloSignal.Transport.metadata()} | {:error, ApolloSignal.Errors.t()}
@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()}
@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()}
@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()}
@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()}
@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()}
@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()}
@spec list_contacts(domain :: t(), project_id :: String.t(), options :: keyword()) :: {:ok, ApolloSignal.Types.ContactPageResponse.t(), ApolloSignal.Transport.metadata()} | {:error, ApolloSignal.Errors.t()}
@spec new(ApolloSignal.Client.t()) :: t()
@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()}
@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()}
@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()}
@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()}
@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()}
@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()}
@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()}