Package org.apache.fineract.client.services

Interface ProductsApi

public interface ProductsApi

  • Method Details

    • createProduct

      @Headers("Content-Type:application/json") @POST("v1/products/{type}") retrofit2.Call<PostProductsTypeResponse> createProduct(@Path("type") String type, @Body PostProductsTypeRequest postProductsTypeRequest)
      Create a Share Product Creates a Share Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, locale, totalShares, unitPrice, nominalShares,allowDividendCalculationForInactiveClients,accountingRule Mandatory Fields for Cash based accounting (accountingRule = 2): shareReferenceId, shareSuspenseId, shareEquityId, incomeFromFeeAccountId Optional Fields: sharesIssued, minimumShares, maximumShares, minimumActivePeriodForDividends, minimumactiveperiodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType, marketPricePeriods, chargesSelected
      Parameters:
      type - type (required)
      postProductsTypeRequest - (required)
      Returns:
      Call<PostProductsTypeResponse>

    • handleCommands3

      @POST("v1/products/{type}/{productId}") retrofit2.Call<String> handleCommands3(@Path("type") String type, @Path("productId") Long productId, @Query("command") String command)
      Parameters:
      type - type (required)
      productId - productId (required)
      command - command (optional)
      Returns:
      Call<String>

    • retrieveAllProducts

      @GET("v1/products/{type}") retrofit2.Call<GetProductsTypeResponse> retrieveAllProducts(@Path("type") String type, @Query("offset") Integer offset, @Query("limit") Integer limit)
      List Share Products Lists Share Products Mandatory Fields: limit, offset Example Requests: shareproducts
      Parameters:
      type - type (required)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<GetProductsTypeResponse>

    • retrieveProduct

      @GET("v1/products/{type}/{productId}") retrofit2.Call<GetProductsTypeProductIdResponse> retrieveProduct(@Path("productId") Long productId, @Path("type") String type)
      Retrieve a Share Product Retrieves a Share Product Example Requests: products/share/1 products/share/1?template=true
      Parameters:
      productId - productId (required)
      type - type (required)
      Returns:
      Call<GetProductsTypeProductIdResponse>

    • retrieveTemplate13

      @GET("v1/products/{type}/template") retrofit2.Call<String> retrieveTemplate13(@Path("type") String type)
      Parameters:
      type - type (required)
      Returns:
      Call<String>

    • updateProduct

      @Headers("Content-Type:application/json") @PUT("v1/products/{type}/{productId}") retrofit2.Call<PutProductsTypeProductIdResponse> updateProduct(@Path("type") String type, @Path("productId") Long productId, @Body PutProductsTypeProductIdRequest putProductsTypeProductIdRequest)
      Update a Share Product Updates a Share Product
      Parameters:
      type - type (required)
      productId - productId (required)
      putProductsTypeProductIdRequest - (required)
      Returns:
      Call<PutProductsTypeProductIdResponse>

    • createProduct

      @Headers("Content-Type:application/json") @POST("v1/products/{type}") retrofit2.Call<PostProductsTypeResponse> createProduct(@Path("type") String type, @Body PostProductsTypeRequest postProductsTypeRequest, @HeaderMap Map<String,String> headers)
      Create a Share Product Creates a Share Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, locale, totalShares, unitPrice, nominalShares,allowDividendCalculationForInactiveClients,accountingRule Mandatory Fields for Cash based accounting (accountingRule = 2): shareReferenceId, shareSuspenseId, shareEquityId, incomeFromFeeAccountId Optional Fields: sharesIssued, minimumShares, maximumShares, minimumActivePeriodForDividends, minimumactiveperiodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType, marketPricePeriods, chargesSelected
      Parameters:
      type - type (required)
      postProductsTypeRequest - (required)
      Returns:
      Call<PostProductsTypeResponse>

    • handleCommands3

      @POST("v1/products/{type}/{productId}") retrofit2.Call<String> handleCommands3(@Path("type") String type, @Path("productId") Long productId, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Parameters:
      type - type (required)
      productId - productId (required)
      command - command (optional)
      Returns:
      Call<String>

    • retrieveAllProducts

      @GET("v1/products/{type}") retrofit2.Call<GetProductsTypeResponse> retrieveAllProducts(@Path("type") String type, @Query("offset") Integer offset, @Query("limit") Integer limit, @HeaderMap Map<String,String> headers)
      List Share Products Lists Share Products Mandatory Fields: limit, offset Example Requests: shareproducts
      Parameters:
      type - type (required)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<GetProductsTypeResponse>

    • retrieveProduct

      @GET("v1/products/{type}/{productId}") retrofit2.Call<GetProductsTypeProductIdResponse> retrieveProduct(@Path("productId") Long productId, @Path("type") String type, @HeaderMap Map<String,String> headers)
      Retrieve a Share Product Retrieves a Share Product Example Requests: products/share/1 products/share/1?template=true
      Parameters:
      productId - productId (required)
      type - type (required)
      Returns:
      Call<GetProductsTypeProductIdResponse>

    • retrieveTemplate13

      @GET("v1/products/{type}/template") retrofit2.Call<String> retrieveTemplate13(@Path("type") String type, @HeaderMap Map<String,String> headers)
      Parameters:
      type - type (required)
      Returns:
      Call<String>

    • updateProduct

      @Headers("Content-Type:application/json") @PUT("v1/products/{type}/{productId}") retrofit2.Call<PutProductsTypeProductIdResponse> updateProduct(@Path("type") String type, @Path("productId") Long productId, @Body PutProductsTypeProductIdRequest putProductsTypeProductIdRequest, @HeaderMap Map<String,String> headers)
      Update a Share Product Updates a Share Product
      Parameters:
      type - type (required)
      productId - productId (required)
      putProductsTypeProductIdRequest - (required)
      Returns:
      Call<PutProductsTypeProductIdResponse>