View Source Novu.Subscribers (Novu v0.2.0)
Provide access to the Novu Subscribers API
Link to this section Summary
Functions
Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.
Deletes a subscriber entity from the Novu platform
Get subscriber by your internal id used to identify the subscriber
Returns a list of subscribers paginated using the page query parameter
Used to update the subscriber entity with new information
Subscriber credentials associated to the delivery methods such as slack and push tokens.
Link to this section Functions
@spec create_subscriber(subscriber_id :: String.t(), opts :: Keyword.t()) :: Novu.Http.response()
Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.
@spec delete_subscriber(subscriber_id :: String.t()) :: Novu.Http.response()
Deletes a subscriber entity from the Novu platform
@spec get_notification_feed(subscriber_id :: String.t(), opts :: Keyword.t()) :: Novu.Http.response()
@spec get_subscriber(subscriber_id :: String.t()) :: Novu.Http.response()
Get subscriber by your internal id used to identify the subscriber
@spec get_subscriber_preferences(subscriber_id :: String.t()) :: Novu.Http.response()
@spec get_subscribers(opts :: Keyword.t()) :: Novu.Http.response()
Returns a list of subscribers paginated using the page query parameter
@spec get_unseen_count(subscriber_id :: String.t(), opts :: Keyword.t()) :: Novu.Http.response()
@spec mark_action_as_seen( subscriber_id :: String.t(), message_id :: String.t(), type :: String.t() ) :: Novu.Http.response()
@spec mark_message_as_seen(subscriber_id :: String.t(), message_id :: String.t()) :: Novu.Http.response()
@spec update_subscriber(subscriber_id :: String.t(), opts :: Keyword.t()) :: Novu.Http.response()
Used to update the subscriber entity with new information
update_subscriber_credentials(subscriber_id, provider_id, opts \\ [])
View SourceSubscriber credentials associated to the delivery methods such as slack and push tokens.
update_subscriber_preferences(subscriber_id, template_id, type, enabled)
View Source@spec update_subscriber_preferences( subscriber_id :: String.t(), template_id :: String.t(), type :: String.t(), enabled :: boolean() ) :: Novu.Http.response()