Package co.novu.api.subscribers
Interface SubscribersApi
-
public interface SubscribersApi
-
-
Method Summary
-
-
-
Field Detail
-
ENDPOINT
static final String ENDPOINT
- See Also:
- Constant Field Values
-
-
Method Detail
-
getSubscribers
@GET("subscribers") retrofit2.Call<BulkSubscriberResponse> getSubscribers(@QueryMap Map<String,Object> options)
-
createSubscriber
@POST("subscribers") retrofit2.Call<CreateSubscriberResponse> createSubscriber(@Body SubscriberRequest request)
-
createBulkSubscriber
@POST("subscribers/bulk") retrofit2.Call<CreateBulkSubscriberResponse> createBulkSubscriber(@Body BulkSubscriberRequest request)
-
getSubscriber
@GET("subscribers/{subscriberId}") retrofit2.Call<SingleSubscriberResponse> getSubscriber(@Path("subscriberId") String subscriberId)
-
updateSubscriber
@PUT("subscribers/{subscriberId}") retrofit2.Call<SingleSubscriberResponse> updateSubscriber(@Body UpdateSubscriberRequest request, @Path("subscriberId") String subscriberId)
-
deleteSubscriber
@DELETE("subscribers/{subscriberId}") retrofit2.Call<SubscriberDeleteResponse> deleteSubscriber(@Path("subscriberId") String subscriberId)
-
updateSubscriberCredentials
@PUT("subscribers/{subscriberId}/credentials") retrofit2.Call<SingleSubscriberResponse> updateSubscriberCredentials(@Body UpdateSubscriberCredentialsRequest request, @Path("subscriberId") String subscriberId)
-
deleteSubscriberCredentials
@DELETE("subscribers/{subscriberId}/credentials/{providerId}") retrofit2.Call<Void> deleteSubscriberCredentials(@Path("subscriberId") String subscriberId, @Path("providerId") String providerId)
-
updateSubscriberOnlineStatus
@PATCH("subscribers/{subscriberId}/online-status") retrofit2.Call<SingleSubscriberResponse> updateSubscriberOnlineStatus(@Body UpdateSubscriberOnlineStatusRequest request, @Path("subscriberId") String subscriberId)
-
getSubscriberPreferences
@GET("subscribers/{subscriberId}/preferences") retrofit2.Call<SubscriberPreferenceResponse> getSubscriberPreferences(@Path("subscriberId") String subscriberId)
-
updateSubscriberPreferences
@PATCH("subscribers/{subscriberId}/preferences/{templateId}") retrofit2.Call<SingleSubscriberPrefResponse> updateSubscriberPreferences(@Body UpdateSubscriberPreferenceRequest request, @Path("subscriberId") String subscriberId, @Path("templateId") String templateId)
-
getSubscriberNotificationsFeed
@GET("subscribers/{subscriberId}/notifications/feed") retrofit2.Call<SubscriberNotificationResponse> getSubscriberNotificationsFeed(@Path("subscriberId") String subscriberId)
-
getSubscriberUnseenNotificationsCount
@GET("subscribers/{subscriberId}/notifications/unseen") retrofit2.Call<UnseenNotificationsCountResponse> getSubscriberUnseenNotificationsCount(@Path("subscriberId") String subscriberId)
-
markSubscriberMessageFeedAs
@POST("subscribers/{subscriberId}/messages/markAs") retrofit2.Call<SubscriberNotificationResponse> markSubscriberMessageFeedAs(@Body MarkSubscriberFeedAsRequest request, @Path("subscriberId") String subscriberId)
-
markAllSubscriberMessagesFeedAs
@POST("subscribers/{subscriberId}/messages/mark-all") retrofit2.Call<Long> markAllSubscriberMessagesFeedAs(@Body MarkAllMessagesRequest request, @Path("subscriberId") String subscriberId)
-
markMessageActionAsSeen
@POST("subscribers/{subscriberId}/messages/{messageId}/actions/{type}") retrofit2.Call<SubscriberNotificationResponse> markMessageActionAsSeen(@Body MarkMessageActionAsSeenRequest request, @Path("subscriberId") String subscriberId, @Path("messageId") String messageId, @Path("type") String type)
-
-