Package org.apache.fineract.client.services

Interface UserGeneratedDocumentsApi

public interface UserGeneratedDocumentsApi

  • Method Details

    • createTemplate

      @Headers("Content-Type:application/json") @POST("v1/templates") retrofit2.Call<PostTemplatesResponse> createTemplate(@Body PostTemplatesRequest postTemplatesRequest)
      Add a UGD Adds a new UGD. Mandatory Fields name Example Requests: templates/1
      Parameters:
      postTemplatesRequest - (required)
      Returns:
      Call<PostTemplatesResponse>

    • deleteTemplate

      @DELETE("v1/templates/{templateId}") retrofit2.Call<DeleteTemplatesTemplateIdResponse> deleteTemplate(@Path("templateId") Long templateId)
      Delete a UGD
      Parameters:
      templateId - templateId (required)
      Returns:
      Call<DeleteTemplatesTemplateIdResponse>

    • getTemplateByTemplate

      @GET("v1/templates/{templateId}/template") retrofit2.Call<String> getTemplateByTemplate(@Path("templateId") Long templateId)
      Parameters:
      templateId - (required)
      Returns:
      Call<String>

    • mergeTemplate

      @Headers("Content-Type:application/json") @POST("v1/templates/{templateId}") retrofit2.Call<String> mergeTemplate(@Path("templateId") Long templateId, @Body String body)
      Parameters:
      templateId - (required)
      body - (optional)
      Returns:
      Call<String>

    • retrieveAll40

      @GET("v1/templates") retrofit2.Call<GetTemplatesResponse> retrieveAll40(@Query("typeId") Integer typeId, @Query("entityId") Integer entityId)
      Retrieve all UGDs Example Requests: templates It is also possible to get specific UGDs by entity and type: templates?type=0&entity=0 [Entity: Id] client: 0, loan: 1 [Type: Id] Document: 0, E-Mail (not yet): 1, SMS: 2
      Parameters:
      typeId - typeId (optional, default to -1)
      entityId - entityId (optional, default to -1)
      Returns:
      Call<GetTemplatesResponse>

    • retrieveOne30

      @GET("v1/templates/{templateId}") retrofit2.Call<GetTemplatesTemplateIdResponse> retrieveOne30(@Path("templateId") Long templateId)
      Retrieve a UGD Example Requests: templates/1
      Parameters:
      templateId - templateId (required)
      Returns:
      Call<GetTemplatesTemplateIdResponse>

    • saveTemplate

      @Headers("Content-Type:application/json") @PUT("v1/templates/{templateId}") retrofit2.Call<PutTemplatesTemplateIdResponse> saveTemplate(@Path("templateId") Long templateId, @Body PutTemplatesTemplateIdRequest putTemplatesTemplateIdRequest)
      Update a UGD
      Parameters:
      templateId - templateId (required)
      putTemplatesTemplateIdRequest - (required)
      Returns:
      Call<PutTemplatesTemplateIdResponse>

    • template20

      @GET("v1/templates/template") retrofit2.Call<GetTemplatesTemplateResponse> template20()
      Retrieve UGD Details Template This is a convenience resource. It can be useful when building maintenance user interface screens for UGDs. The UGD data returned consists of any or all of: ARGUMENTS name String entity String type String text String optional mappers Mapper optional Example Request: templates/template
      Returns:
      Call<GetTemplatesTemplateResponse>

    • mergeTemplate

      @Headers("Content-Type:application/json") @POST("v1/templates/{templateId}") retrofit2.Call<String> mergeTemplate(@Path("templateId") Long templateId)
      Parameters:
      templateId - (required)
      body - (optional)
      Returns:
      Call<String>

    • createTemplate

      @Headers("Content-Type:application/json") @POST("v1/templates") retrofit2.Call<PostTemplatesResponse> createTemplate(@Body PostTemplatesRequest postTemplatesRequest, @HeaderMap Map<String,String> headers)
      Add a UGD Adds a new UGD. Mandatory Fields name Example Requests: templates/1
      Parameters:
      postTemplatesRequest - (required)
      Returns:
      Call<PostTemplatesResponse>

    • deleteTemplate

      @DELETE("v1/templates/{templateId}") retrofit2.Call<DeleteTemplatesTemplateIdResponse> deleteTemplate(@Path("templateId") Long templateId, @HeaderMap Map<String,String> headers)
      Delete a UGD
      Parameters:
      templateId - templateId (required)
      Returns:
      Call<DeleteTemplatesTemplateIdResponse>

    • getTemplateByTemplate

      @GET("v1/templates/{templateId}/template") retrofit2.Call<String> getTemplateByTemplate(@Path("templateId") Long templateId, @HeaderMap Map<String,String> headers)
      Parameters:
      templateId - (required)
      Returns:
      Call<String>

    • mergeTemplate

      @Headers("Content-Type:application/json") @POST("v1/templates/{templateId}") retrofit2.Call<String> mergeTemplate(@Path("templateId") Long templateId, @Body String body, @HeaderMap Map<String,String> headers)
      Parameters:
      templateId - (required)
      body - (optional)
      Returns:
      Call<String>

    • retrieveAll40

      @GET("v1/templates") retrofit2.Call<GetTemplatesResponse> retrieveAll40(@Query("typeId") Integer typeId, @Query("entityId") Integer entityId, @HeaderMap Map<String,String> headers)
      Retrieve all UGDs Example Requests: templates It is also possible to get specific UGDs by entity and type: templates?type=0&entity=0 [Entity: Id] client: 0, loan: 1 [Type: Id] Document: 0, E-Mail (not yet): 1, SMS: 2
      Parameters:
      typeId - typeId (optional, default to -1)
      entityId - entityId (optional, default to -1)
      Returns:
      Call<GetTemplatesResponse>

    • retrieveOne30

      @GET("v1/templates/{templateId}") retrofit2.Call<GetTemplatesTemplateIdResponse> retrieveOne30(@Path("templateId") Long templateId, @HeaderMap Map<String,String> headers)
      Retrieve a UGD Example Requests: templates/1
      Parameters:
      templateId - templateId (required)
      Returns:
      Call<GetTemplatesTemplateIdResponse>

    • saveTemplate

      @Headers("Content-Type:application/json") @PUT("v1/templates/{templateId}") retrofit2.Call<PutTemplatesTemplateIdResponse> saveTemplate(@Path("templateId") Long templateId, @Body PutTemplatesTemplateIdRequest putTemplatesTemplateIdRequest, @HeaderMap Map<String,String> headers)
      Update a UGD
      Parameters:
      templateId - templateId (required)
      putTemplatesTemplateIdRequest - (required)
      Returns:
      Call<PutTemplatesTemplateIdResponse>

    • template20

      @GET("v1/templates/template") retrofit2.Call<GetTemplatesTemplateResponse> template20(@HeaderMap Map<String,String> headers)
      Retrieve UGD Details Template This is a convenience resource. It can be useful when building maintenance user interface screens for UGDs. The UGD data returned consists of any or all of: ARGUMENTS name String entity String type String text String optional mappers Mapper optional Example Request: templates/template
      Returns:
      Call<GetTemplatesTemplateResponse>

    • mergeTemplate

      @Headers("Content-Type:application/json") @POST("v1/templates/{templateId}") retrofit2.Call<String> mergeTemplate(@Path("templateId") Long templateId, @HeaderMap Map<String,String> headers)
      Parameters:
      templateId - (required)
      body - (optional)
      Returns:
      Call<String>