Package co.novu.api.layouts

Interface LayoutApi

public interface LayoutApi

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENDPOINT

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<CreateLayoutResponse>	createLayout(LayoutRequest request)
retrofit2.Call<Void>	deleteLayout(String layoutId)
retrofit2.Call<FilterLayoutResponse>	filterLayouts(Map<String,Object> options)
retrofit2.Call<GetLayoutResponse>	getLayout(String layoutId)
retrofit2.Call<Void>	setDefaultLayout(String layoutId)
retrofit2.Call<GetLayoutResponse>	updateLayout(String layoutId, LayoutRequest request)

Field Detail

ENDPOINT

static final String ENDPOINT

See Also:

Constant Field Values

Method Detail

createLayout

@POST("layouts")
retrofit2.Call<CreateLayoutResponse> createLayout(@Body
                                                  LayoutRequest request)

filterLayouts

@GET("layouts")
retrofit2.Call<FilterLayoutResponse> filterLayouts(@QueryMap
                                                   Map<String,Object> options)

getLayout

@GET("layouts/{layoutId}")
retrofit2.Call<GetLayoutResponse> getLayout(@Path("layoutId")
                                            String layoutId)

deleteLayout

@DELETE("layouts/{layoutId}")
retrofit2.Call<Void> deleteLayout(@Path("layoutId")
                                  String layoutId)

updateLayout

@PATCH("layouts/{layoutId}")
retrofit2.Call<GetLayoutResponse> updateLayout(@Path("layoutId")
                                               String layoutId,
                                               @Body
                                               LayoutRequest request)

setDefaultLayout

@POST("layouts/{layoutId}/default")
retrofit2.Call<Void> setDefaultLayout(@Path("layoutId")
                                      String layoutId)