ApolloSignal.Domains.ContactProperties (apollo_signal v1.0.5)

Copy Markdown View Source

contactProperties API operations.

Summary

Types

t()

Functions

create_contact_property(domain, project_id, body, options \\ [])
delete_contact_property(domain, project_id, property_id, options \\ [])
get_contact_property(domain, project_id, property_id, options \\ [])
list_contact_properties(domain, project_id, options \\ [])
new(client)
update_contact_property(domain, project_id, property_id, body, options \\ [])

Types

t()

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

Functions

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

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

delete_contact_property(domain, project_id, property_id, options \\ [])

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

get_contact_property(domain, project_id, property_id, options \\ [])

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

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

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

new(client)

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

update_contact_property(domain, project_id, property_id, body, options \\ [])

@spec update_contact_property(
  domain :: t(),
  project_id :: String.t(),
  property_id :: String.t(),
  body :: ApolloSignal.Types.UpdateContactPropertyBody.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.ContactPropertyResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}