Package co.novu.api.workflows

Interface WorkflowApi

public interface WorkflowApi

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENDPOINT

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<SingleWorkflowResponse>	createWorkflow(WorkflowRequest request)
retrofit2.Call<DeleteWorkflowResponse>	deleteWorkflow(String workflowId)
retrofit2.Call<SingleWorkflowResponse>	getWorkflow(String workflowId)
retrofit2.Call<BulkWorkflowResponse>	getWorkflows(Map<String,Object> params)
retrofit2.Call<SingleWorkflowResponse>	updateWorkflow(String workflowId, UpdateWorkflowRequest request)
retrofit2.Call<SingleWorkflowResponse>	updateWorkflowStatus(String workflowId, UpdateWorkflowStatusRequest request)

Field Detail

ENDPOINT

static final String ENDPOINT

See Also:

Constant Field Values

Method Detail

getWorkflows

@GET("workflows")
retrofit2.Call<BulkWorkflowResponse> getWorkflows(@QueryMap
                                                  Map<String,Object> params)

createWorkflow

@POST("workflows")
retrofit2.Call<SingleWorkflowResponse> createWorkflow(@Body
                                                      WorkflowRequest request)

updateWorkflow

@PUT("workflows/{workflowId}")
retrofit2.Call<SingleWorkflowResponse> updateWorkflow(@Path("workflowId")
                                                      String workflowId,
                                                      @Body
                                                      UpdateWorkflowRequest request)

deleteWorkflow

@DELETE("workflows/{workflowId}")
retrofit2.Call<DeleteWorkflowResponse> deleteWorkflow(@Path("workflowId")
                                                      String workflowId)

getWorkflow

@GET("workflows/{workflowId}")
retrofit2.Call<SingleWorkflowResponse> getWorkflow(@Path("workflowId")
                                                   String workflowId)

updateWorkflowStatus

@PUT("workflows/{workflowId}/status")
retrofit2.Call<SingleWorkflowResponse> updateWorkflowStatus(@Path("workflowId")
                                                            String workflowId,
                                                            @Body
                                                            UpdateWorkflowStatusRequest request)