Package org.apache.fineract.client.services

Interface FundsApi

public interface FundsApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostFundsResponse>	createFund(FundRequest fundRequest)	Create a Fund Creates a Fund
retrofit2.Call<PostFundsResponse>	createFund(FundRequest fundRequest, Map<String,String> headers)	Create a Fund Creates a Fund
retrofit2.Call<FundData>	retrieveFund(Long fundId)	Retrieve a Fund Returns the details of a Fund.
retrofit2.Call<FundData>	retrieveFund(Long fundId, Map<String,String> headers)	Retrieve a Fund Returns the details of a Fund.
retrofit2.Call<List<FundData>>	retrieveFunds()	Retrieve Funds Returns the list of funds.
retrofit2.Call<List<FundData>>	retrieveFunds(Map<String,String> headers)	Retrieve Funds Returns the list of funds.
retrofit2.Call<PutFundsFundIdResponse>	updateFund(Long fundId, FundRequest fundRequest)	Update a Fund Updates the details of a fund.
retrofit2.Call<PutFundsFundIdResponse>	updateFund(Long fundId, FundRequest fundRequest, Map<String,String> headers)	Update a Fund Updates the details of a fund.

Method Details

createFund

@Headers("Content-Type:application/json")
@POST("v1/funds")
retrofit2.Call<PostFundsResponse> createFund(@Body
 FundRequest fundRequest)

Create a Fund Creates a Fund

Parameters:

fundRequest - (required)

Returns:

Call<PostFundsResponse>

retrieveFund

@GET("v1/funds/{fundId}")
retrofit2.Call<FundData> retrieveFund(@Path("fundId")
 Long fundId)

Retrieve a Fund Returns the details of a Fund. Example Requests: funds/1

Parameters:

fundId - fundId (required)

Returns:

Call<FundData>

retrieveFunds

@GET("v1/funds")
retrofit2.Call<List<FundData>> retrieveFunds()

Retrieve Funds Returns the list of funds. Example Requests: funds

Returns:

Call<List<FundData>>

updateFund

@Headers("Content-Type:application/json")
@PUT("v1/funds/{fundId}")
retrofit2.Call<PutFundsFundIdResponse> updateFund(@Path("fundId")
 Long fundId,
 @Body
 FundRequest fundRequest)

Update a Fund Updates the details of a fund.

Parameters:

fundId - fundId (required)

fundRequest - (required)

Returns:

Call<PutFundsFundIdResponse>

createFund

@Headers("Content-Type:application/json")
@POST("v1/funds")
retrofit2.Call<PostFundsResponse> createFund(@Body
 FundRequest fundRequest,
 @HeaderMap
 Map<String,String> headers)

Create a Fund Creates a Fund

Parameters:

fundRequest - (required)

Returns:

Call<PostFundsResponse>

retrieveFund

@GET("v1/funds/{fundId}")
retrofit2.Call<FundData> retrieveFund(@Path("fundId")
 Long fundId,
 @HeaderMap
 Map<String,String> headers)

Retrieve a Fund Returns the details of a Fund. Example Requests: funds/1

Parameters:

fundId - fundId (required)

Returns:

Call<FundData>

retrieveFunds

@GET("v1/funds")
retrofit2.Call<List<FundData>> retrieveFunds(@HeaderMap
 Map<String,String> headers)

Retrieve Funds Returns the list of funds. Example Requests: funds

Returns:

Call<List<FundData>>

updateFund

@Headers("Content-Type:application/json")
@PUT("v1/funds/{fundId}")
retrofit2.Call<PutFundsFundIdResponse> updateFund(@Path("fundId")
 Long fundId,
 @Body
 FundRequest fundRequest,
 @HeaderMap
 Map<String,String> headers)

Update a Fund Updates the details of a fund.

Parameters:

fundId - fundId (required)

fundRequest - (required)

Returns:

Call<PutFundsFundIdResponse>