Package org.apache.fineract.client.services

Interface SmsApi

public interface SmsApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<CommandProcessingResult>	create2()
retrofit2.Call<CommandProcessingResult>	create2(Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	create2(SmsCreationRequest smsCreationRequest)
retrofit2.Call<CommandProcessingResult>	create2(SmsCreationRequest smsCreationRequest, Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	delete5(Long resourceId)
retrofit2.Call<CommandProcessingResult>	delete5(Long resourceId, Map<String,String> headers)
retrofit2.Call<List<SmsData>>	retrieveAll10()
retrofit2.Call<List<SmsData>>	retrieveAll10(Map<String,String> headers)
retrofit2.Call<PageSmsData>	retrieveAllSmsByStatus(Long campaignId, Long status, Object fromDate, Object toDate, String locale, String dateFormat, Integer offset, Integer limit, String orderBy, String sortOrder)
retrofit2.Call<PageSmsData>	retrieveAllSmsByStatus(Long campaignId, Long status, Object fromDate, Object toDate, String locale, String dateFormat, Integer offset, Integer limit, String orderBy, String sortOrder, Map<String,String> headers)
retrofit2.Call<SmsData>	retrieveOne6(Long resourceId)
retrofit2.Call<SmsData>	retrieveOne6(Long resourceId, Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	update3(Long resourceId)
retrofit2.Call<CommandProcessingResult>	update3(Long resourceId, Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	update3(Long resourceId, SmsUpdateRequest smsUpdateRequest)
retrofit2.Call<CommandProcessingResult>	update3(Long resourceId, SmsUpdateRequest smsUpdateRequest, Map<String,String> headers)

Method Details

create2

@Headers("Content-Type:application/json")
@POST("v1/sms")
retrofit2.Call<CommandProcessingResult> create2(@Body
 SmsCreationRequest smsCreationRequest)

Parameters:

smsCreationRequest - (optional)

Returns:

Call<CommandProcessingResult>

delete5

@DELETE("v1/sms/{resourceId}")
retrofit2.Call<CommandProcessingResult> delete5(@Path("resourceId")
 Long resourceId)

Parameters:

resourceId - (required)

Returns:

Call<CommandProcessingResult>

retrieveAll10

@GET("v1/sms")
retrofit2.Call<List<SmsData>> retrieveAll10()

Returns:

Call<List<SmsData>>

retrieveAllSmsByStatus

@GET("v1/sms/{campaignId}/messageByStatus")
retrofit2.Call<PageSmsData> retrieveAllSmsByStatus(@Path("campaignId")
 Long campaignId,
 @Query("status")
 Long status,
 @Query("fromDate")
 Object fromDate,
 @Query("toDate")
 Object toDate,
 @Query("locale")
 String locale,
 @Query("dateFormat")
 String dateFormat,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("orderBy")
 String orderBy,
 @Query("sortOrder")
 String sortOrder)

Parameters:

campaignId - (required)

status - (optional)

fromDate - (optional)

toDate - (optional)

locale - (optional)

dateFormat - (optional)

offset - (optional)

limit - (optional)

orderBy - (optional)

sortOrder - (optional)

Returns:

Call<PageSmsData>

retrieveOne6

@GET("v1/sms/{resourceId}")
retrofit2.Call<SmsData> retrieveOne6(@Path("resourceId")
 Long resourceId)

Parameters:

resourceId - (required)

Returns:

Call<SmsData>

update3

@Headers("Content-Type:application/json")
@PUT("v1/sms/{resourceId}")
retrofit2.Call<CommandProcessingResult> update3(@Path("resourceId")
 Long resourceId,
 @Body
 SmsUpdateRequest smsUpdateRequest)

Parameters:

resourceId - (required)

smsUpdateRequest - (optional)

Returns:

Call<CommandProcessingResult>

create2

@Headers("Content-Type:application/json")
@POST("v1/sms")
retrofit2.Call<CommandProcessingResult> create2()

Parameters:

smsCreationRequest - (optional)

Returns:

Call<CommandProcessingResult>

update3

@Headers("Content-Type:application/json")
@PUT("v1/sms/{resourceId}")
retrofit2.Call<CommandProcessingResult> update3(@Path("resourceId")
 Long resourceId)

Parameters:

resourceId - (required)

smsUpdateRequest - (optional)

Returns:

Call<CommandProcessingResult>

create2

@Headers("Content-Type:application/json")
@POST("v1/sms")
retrofit2.Call<CommandProcessingResult> create2(@Body
 SmsCreationRequest smsCreationRequest,
 @HeaderMap
 Map<String,String> headers)

Parameters:

smsCreationRequest - (optional)

Returns:

Call<CommandProcessingResult>

delete5

@DELETE("v1/sms/{resourceId}")
retrofit2.Call<CommandProcessingResult> delete5(@Path("resourceId")
 Long resourceId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

resourceId - (required)

Returns:

Call<CommandProcessingResult>

retrieveAll10

@GET("v1/sms")
retrofit2.Call<List<SmsData>> retrieveAll10(@HeaderMap
 Map<String,String> headers)

Returns:

Call<List<SmsData>>

retrieveAllSmsByStatus

@GET("v1/sms/{campaignId}/messageByStatus")
retrofit2.Call<PageSmsData> retrieveAllSmsByStatus(@Path("campaignId")
 Long campaignId,
 @Query("status")
 Long status,
 @Query("fromDate")
 Object fromDate,
 @Query("toDate")
 Object toDate,
 @Query("locale")
 String locale,
 @Query("dateFormat")
 String dateFormat,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("orderBy")
 String orderBy,
 @Query("sortOrder")
 String sortOrder,
 @HeaderMap
 Map<String,String> headers)

Parameters:

campaignId - (required)

status - (optional)

fromDate - (optional)

toDate - (optional)

locale - (optional)

dateFormat - (optional)

offset - (optional)

limit - (optional)

orderBy - (optional)

sortOrder - (optional)

Returns:

Call<PageSmsData>

retrieveOne6

@GET("v1/sms/{resourceId}")
retrofit2.Call<SmsData> retrieveOne6(@Path("resourceId")
 Long resourceId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

resourceId - (required)

Returns:

Call<SmsData>

update3

@Headers("Content-Type:application/json")
@PUT("v1/sms/{resourceId}")
retrofit2.Call<CommandProcessingResult> update3(@Path("resourceId")
 Long resourceId,
 @Body
 SmsUpdateRequest smsUpdateRequest,
 @HeaderMap
 Map<String,String> headers)

Parameters:

resourceId - (required)

smsUpdateRequest - (optional)

Returns:

Call<CommandProcessingResult>

create2

@Headers("Content-Type:application/json")
@POST("v1/sms")
retrofit2.Call<CommandProcessingResult> create2(@HeaderMap
 Map<String,String> headers)

Parameters:

smsCreationRequest - (optional)

Returns:

Call<CommandProcessingResult>

update3

@Headers("Content-Type:application/json")
@PUT("v1/sms/{resourceId}")
retrofit2.Call<CommandProcessingResult> update3(@Path("resourceId")
 Long resourceId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

resourceId - (required)

smsUpdateRequest - (optional)

Returns:

Call<CommandProcessingResult>