Package org.apache.fineract.client.services

Interface MeetingsApi

public interface MeetingsApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<String>	createMeeting(String entityType, Long entityId)
retrofit2.Call<String>	createMeeting(String entityType, Long entityId, String body)
retrofit2.Call<String>	createMeeting(String entityType, Long entityId, String body, Map<String,String> headers)
retrofit2.Call<String>	createMeeting(String entityType, Long entityId, Map<String,String> headers)
retrofit2.Call<String>	deleteMeeting(String entityType, Long entityId, Long meetingId)
retrofit2.Call<String>	deleteMeeting(String entityType, Long entityId, Long meetingId, Map<String,String> headers)
retrofit2.Call<String>	performMeetingCommands(String entityType, Long entityId, Long meetingId, String command)
retrofit2.Call<String>	performMeetingCommands(String entityType, Long entityId, Long meetingId, String command, String body)
retrofit2.Call<String>	performMeetingCommands(String entityType, Long entityId, Long meetingId, String command, String body, Map<String,String> headers)
retrofit2.Call<String>	performMeetingCommands(String entityType, Long entityId, Long meetingId, String command, Map<String,String> headers)
retrofit2.Call<String>	retrieveMeeting(Long meetingId, String entityType, Long entityId)
retrofit2.Call<String>	retrieveMeeting(Long meetingId, String entityType, Long entityId, Map<String,String> headers)
retrofit2.Call<String>	retrieveMeetings(String entityType, Long entityId, Integer limit)
retrofit2.Call<String>	retrieveMeetings(String entityType, Long entityId, Integer limit, Map<String,String> headers)
retrofit2.Call<String>	template11(String entityType, Long entityId, Long calendarId)
retrofit2.Call<String>	template11(String entityType, Long entityId, Long calendarId, Map<String,String> headers)
retrofit2.Call<String>	updateMeeting(String entityType, Long entityId, Long meetingId)
retrofit2.Call<String>	updateMeeting(String entityType, Long entityId, Long meetingId, String body)
retrofit2.Call<String>	updateMeeting(String entityType, Long entityId, Long meetingId, String body, Map<String,String> headers)
retrofit2.Call<String>	updateMeeting(String entityType, Long entityId, Long meetingId, Map<String,String> headers)

Method Details

createMeeting

@Headers("Content-Type:application/json")
@POST("v1/{entityType}/{entityId}/meetings")
retrofit2.Call<String> createMeeting(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Body
 String body)

Parameters:

entityType - (required)

entityId - (required)

body - (optional)

Returns:

Call<String>

deleteMeeting

@DELETE("v1/{entityType}/{entityId}/meetings/{meetingId}")
retrofit2.Call<String> deleteMeeting(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("meetingId")
 Long meetingId)

Parameters:

entityType - (required)

entityId - (required)

meetingId - (required)

Returns:

Call<String>

performMeetingCommands

@Headers("Content-Type:application/json")
@POST("v1/{entityType}/{entityId}/meetings/{meetingId}")
retrofit2.Call<String> performMeetingCommands(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("meetingId")
 Long meetingId,
 @Query("command")
 String command,
 @Body
 String body)

Parameters:

entityType - (required)

entityId - (required)

meetingId - (required)

command - (optional)

body - (optional)

Returns:

Call<String>

retrieveMeeting

@GET("v1/{entityType}/{entityId}/meetings/{meetingId}")
retrofit2.Call<String> retrieveMeeting(@Path("meetingId")
 Long meetingId,
 @Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId)

Parameters:

meetingId - (required)

entityType - (required)

entityId - (required)

Returns:

Call<String>

retrieveMeetings

@GET("v1/{entityType}/{entityId}/meetings")
retrofit2.Call<String> retrieveMeetings(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Query("limit")
 Integer limit)

Parameters:

entityType - (required)

entityId - (required)

limit - (optional)

Returns:

Call<String>

template11

@GET("v1/{entityType}/{entityId}/meetings/template")
retrofit2.Call<String> template11(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Query("calendarId")
 Long calendarId)

Parameters:

entityType - (required)

entityId - (required)

calendarId - (optional)

Returns:

Call<String>

updateMeeting

@Headers("Content-Type:application/json")
@PUT("v1/{entityType}/{entityId}/meetings/{meetingId}")
retrofit2.Call<String> updateMeeting(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("meetingId")
 Long meetingId,
 @Body
 String body)

Parameters:

entityType - (required)

entityId - (required)

meetingId - (required)

body - (optional)

Returns:

Call<String>

createMeeting

@Headers("Content-Type:application/json")
@POST("v1/{entityType}/{entityId}/meetings")
retrofit2.Call<String> createMeeting(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId)

Parameters:

entityType - (required)

entityId - (required)

body - (optional)

Returns:

Call<String>

performMeetingCommands

@Headers("Content-Type:application/json")
@POST("v1/{entityType}/{entityId}/meetings/{meetingId}")
retrofit2.Call<String> performMeetingCommands(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("meetingId")
 Long meetingId,
 @Query("command")
 String command)

Parameters:

entityType - (required)

entityId - (required)

meetingId - (required)

command - (optional)

body - (optional)

Returns:

Call<String>

updateMeeting

@Headers("Content-Type:application/json")
@PUT("v1/{entityType}/{entityId}/meetings/{meetingId}")
retrofit2.Call<String> updateMeeting(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("meetingId")
 Long meetingId)

Parameters:

entityType - (required)

entityId - (required)

meetingId - (required)

body - (optional)

Returns:

Call<String>

createMeeting

@Headers("Content-Type:application/json")
@POST("v1/{entityType}/{entityId}/meetings")
retrofit2.Call<String> createMeeting(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Body
 String body,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

body - (optional)

Returns:

Call<String>

deleteMeeting

@DELETE("v1/{entityType}/{entityId}/meetings/{meetingId}")
retrofit2.Call<String> deleteMeeting(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("meetingId")
 Long meetingId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

meetingId - (required)

Returns:

Call<String>

performMeetingCommands

@Headers("Content-Type:application/json")
@POST("v1/{entityType}/{entityId}/meetings/{meetingId}")
retrofit2.Call<String> performMeetingCommands(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("meetingId")
 Long meetingId,
 @Query("command")
 String command,
 @Body
 String body,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

meetingId - (required)

command - (optional)

body - (optional)

Returns:

Call<String>

retrieveMeeting

@GET("v1/{entityType}/{entityId}/meetings/{meetingId}")
retrofit2.Call<String> retrieveMeeting(@Path("meetingId")
 Long meetingId,
 @Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

meetingId - (required)

entityType - (required)

entityId - (required)

Returns:

Call<String>

retrieveMeetings

@GET("v1/{entityType}/{entityId}/meetings")
retrofit2.Call<String> retrieveMeetings(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Query("limit")
 Integer limit,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

limit - (optional)

Returns:

Call<String>

template11

@GET("v1/{entityType}/{entityId}/meetings/template")
retrofit2.Call<String> template11(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Query("calendarId")
 Long calendarId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

calendarId - (optional)

Returns:

Call<String>

updateMeeting

@Headers("Content-Type:application/json")
@PUT("v1/{entityType}/{entityId}/meetings/{meetingId}")
retrofit2.Call<String> updateMeeting(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("meetingId")
 Long meetingId,
 @Body
 String body,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

meetingId - (required)

body - (optional)

Returns:

Call<String>

createMeeting

@Headers("Content-Type:application/json")
@POST("v1/{entityType}/{entityId}/meetings")
retrofit2.Call<String> createMeeting(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

body - (optional)

Returns:

Call<String>

performMeetingCommands

@Headers("Content-Type:application/json")
@POST("v1/{entityType}/{entityId}/meetings/{meetingId}")
retrofit2.Call<String> performMeetingCommands(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("meetingId")
 Long meetingId,
 @Query("command")
 String command,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

meetingId - (required)

command - (optional)

body - (optional)

Returns:

Call<String>

updateMeeting

@Headers("Content-Type:application/json")
@PUT("v1/{entityType}/{entityId}/meetings/{meetingId}")
retrofit2.Call<String> updateMeeting(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("meetingId")
 Long meetingId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

meetingId - (required)

body - (optional)

Returns:

Call<String>