Package co.novu.api.topics
Interface TopicApi
-
public interface TopicApi
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description retrofit2.Call<SubscriberAdditionResponse>addSubscriberToTopic(String topicKey, SubscriberAdditionRequest subscriberAdditionRequest)retrofit2.Call<CheckTopicSubscriberResponse>checkTopicSubscriber(String topicKey, String externalSubscriberId)retrofit2.Call<TopicResponse>createTopic(TopicRequest topicRequest)retrofit2.Call<Void>deleteTopic(String topicKey)retrofit2.Call<FilterTopicsResponse>filterTopics(Map<String,Object> options)retrofit2.Call<TopicResponse>getTopic(String topicKey)retrofit2.Call<Void>removeSubscriberFromTopic(String topicKey, SubscriberAdditionRequest subscriberAdditionRequest)retrofit2.Call<TopicResponse>renameTopic(String topicKey, RenameTopicRequest request)
-
-
-
Field Detail
-
ENDPOINT
static final String ENDPOINT
- See Also:
- Constant Field Values
-
-
Method Detail
-
createTopic
@POST("topics") retrofit2.Call<TopicResponse> createTopic(@Body TopicRequest topicRequest)
-
filterTopics
@GET("topics") retrofit2.Call<FilterTopicsResponse> filterTopics(@QueryMap Map<String,Object> options)
-
addSubscriberToTopic
@POST("topics/{topicKey}/subscribers") retrofit2.Call<SubscriberAdditionResponse> addSubscriberToTopic(@Path("topicKey") String topicKey, @Body SubscriberAdditionRequest subscriberAdditionRequest)
-
checkTopicSubscriber
@GET("topics/{topicKey}/subscribers/{externalSubscriberId}") retrofit2.Call<CheckTopicSubscriberResponse> checkTopicSubscriber(@Path("topicKey") String topicKey, @Path("externalSubscriberId") String externalSubscriberId)
-
removeSubscriberFromTopic
@POST("topics/{topicKey}/subscribers/removal") retrofit2.Call<Void> removeSubscriberFromTopic(@Path("topicKey") String topicKey, @Body SubscriberAdditionRequest subscriberAdditionRequest)
-
deleteTopic
@DELETE("topics/{topicKey}") retrofit2.Call<Void> deleteTopic(@Path("topicKey") String topicKey)
-
getTopic
@GET("topics/{topicKey}") retrofit2.Call<TopicResponse> getTopic(@Path("topicKey") String topicKey)
-
renameTopic
@PATCH("topics/{topicKey}") retrofit2.Call<TopicResponse> renameTopic(@Path("topicKey") String topicKey, @Body RenameTopicRequest request)
-
-