Package org.apache.fineract.infrastructure.campaigns.sms.api

Class SmsCampaignApiResource

java.lang.Object

org.apache.fineract.infrastructure.campaigns.sms.api.SmsCampaignApiResource

@Path("/v1/smscampaigns")
@Component
public class SmsCampaignApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
SmsCampaignApiResource()

Method Summary

Modifier and Type	Method	Description
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	createCampaign(SmsCampaignCreationDto smsCampaignCreationDto)
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	delete(Long campaignId)
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	handleCommands(Long campaignId, String commandParam, SmsCampaignHandlerDto campaignHandlerDto)
CampaignPreviewData	preview(SmsCampaignPreviewDto previewDto)
org.apache.fineract.infrastructure.core.service.Page<SmsCampaignData>	retrieveAllEmails(Integer offset, Integer limit, String orderBy, String sortOrder)
SmsCampaignData	retrieveCampaign(Long resourceId)
SmsCampaignData	template()
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	updateCampaign(Long campaignId, SmsCampaignUpdateDto smsCampaignUpdateDto)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SmsCampaignApiResource

public SmsCampaignApiResource()

Method Details

template

@GET
@Path("template")
public SmsCampaignData template()

createCampaign

@POST
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult createCampaign(SmsCampaignCreationDto smsCampaignCreationDto)

retrieveCampaign

@GET
@Path("{resourceId}")
@Produces("application/json")
public SmsCampaignData retrieveCampaign(@PathParam("resourceId")
 Long resourceId)

retrieveAllEmails

@GET
@Produces("application/json")
public org.apache.fineract.infrastructure.core.service.Page<SmsCampaignData> retrieveAllEmails(@QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("orderBy")
 String orderBy,
 @QueryParam("sortOrder")
 String sortOrder)

updateCampaign

@PUT
@Path("{campaignId}")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult updateCampaign(@PathParam("campaignId")
 Long campaignId,
 SmsCampaignUpdateDto smsCampaignUpdateDto)

handleCommands

@POST
@Path("{campaignId}")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult handleCommands(@PathParam("campaignId")
 Long campaignId,
 @QueryParam("command")
 String commandParam,
 SmsCampaignHandlerDto campaignHandlerDto)

preview

@POST
@Path("preview")
@Consumes("application/json")
@Produces("application/json")
public CampaignPreviewData preview(SmsCampaignPreviewDto previewDto)

delete

@DELETE
@Path("{campaignId}")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult delete(@PathParam("campaignId")
 Long campaignId)