Package org.apache.fineract.client.services

Interface ImagesApi

public interface ImagesApi

Client API (Retrofit) for /images. This class entirely hand-written, inspired by DocumentsApiFixed, and from /images methods which currently end up in DefaultApi (see FINERACT-1222), but fixed for bugs in the code generation (see FINERACT-1227).

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	create(String entityType, Long entityId, okhttp3.MultipartBody.Part file)
retrofit2.Call<Void>	delete(String entityType, Long entityId)
retrofit2.Call<okhttp3.ResponseBody>	get(String entityType, Long entityId, Integer maxWidth, Integer maxHeight, String output)
retrofit2.Call<Void>	update(String entityType, Long entityId, okhttp3.MultipartBody.Part file)

Method Details

create

@POST("v1/{entityType}/{entityId}/images")
@Multipart
retrofit2.Call<Void> create(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Part
 okhttp3.MultipartBody.Part file)

get

@GET("v1/{entityType}/{entityId}/images")
retrofit2.Call<okhttp3.ResponseBody> get(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Query("maxWidth")
 Integer maxWidth,
 @Query("maxHeight")
 Integer maxHeight,
 @Query("output")
 String output)

update

@PUT("v1/{entityType}/{entityId}/images")
@Multipart
retrofit2.Call<Void> update(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Part
 okhttp3.MultipartBody.Part file)

delete

@DELETE("v1/{entityType}/{entityId}/images")
retrofit2.Call<Void> delete(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId)