Package org.apache.fineract.client.services

Interface HooksApi

public interface HooksApi

  • Method Details

    • createHook

      @Headers("Content-Type:application/json") @POST("v1/hooks") retrofit2.Call<PostHookResponse> createHook(@Body PostHookRequest postHookRequest)
      Create a Hook The following parameters can be passed for the creation of a hook :- name - string - Required. The name of the template that is being called. (See /hooks/template for the list of valid hook names.) isActive - boolean - Determines whether the hook is actually triggered. events - array - Determines what events the hook is triggered for. config - hash - Required. Key/value pairs to provide settings for this hook. These settings vary between the templates. templateId - Optional. The UGD template ID associated with the same entity (client or loan).
      Parameters:
      postHookRequest - (required)
      Returns:
      Call<PostHookResponse>

    • deleteHook

      @DELETE("v1/hooks/{hookId}") retrofit2.Call<DeleteHookResponse> deleteHook(@Path("hookId") Long hookId)
      Delete a Hook Deletes a hook.
      Parameters:
      hookId - hookId (required)
      Returns:
      Call<DeleteHookResponse>

    • retrieveHook

      @GET("v1/hooks/{hookId}") retrofit2.Call<GetHookResponse> retrieveHook(@Path("hookId") Long hookId)
      Retrieve a Hook Returns the details of a Hook. Example Requests: hooks/1
      Parameters:
      hookId - hookId (required)
      Returns:
      Call<GetHookResponse>

    • retrieveHooks

      @GET("v1/hooks") retrofit2.Call<List<GetHookResponse>> retrieveHooks()
      Retrieve Hooks Returns the list of hooks. Example Requests: hooks
      Returns:
      Call<List<GetHookResponse>>

    • template3

      @GET("v1/hooks/template") retrofit2.Call<GetHookTemplateResponse> template3()
      Retrieve Hooks Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: hooks/template
      Returns:
      Call<GetHookTemplateResponse>

    • updateHook

      @Headers("Content-Type:application/json") @PUT("v1/hooks/{hookId}") retrofit2.Call<PutHookResponse> updateHook(@Path("hookId") Long hookId, @Body PutHookRequest putHookRequest)
      Update a Hook Updates the details of a hook.
      Parameters:
      hookId - hookId (required)
      putHookRequest - (required)
      Returns:
      Call<PutHookResponse>

    • createHook

      @Headers("Content-Type:application/json") @POST("v1/hooks") retrofit2.Call<PostHookResponse> createHook(@Body PostHookRequest postHookRequest, @HeaderMap Map<String,String> headers)
      Create a Hook The following parameters can be passed for the creation of a hook :- name - string - Required. The name of the template that is being called. (See /hooks/template for the list of valid hook names.) isActive - boolean - Determines whether the hook is actually triggered. events - array - Determines what events the hook is triggered for. config - hash - Required. Key/value pairs to provide settings for this hook. These settings vary between the templates. templateId - Optional. The UGD template ID associated with the same entity (client or loan).
      Parameters:
      postHookRequest - (required)
      Returns:
      Call<PostHookResponse>

    • deleteHook

      @DELETE("v1/hooks/{hookId}") retrofit2.Call<DeleteHookResponse> deleteHook(@Path("hookId") Long hookId, @HeaderMap Map<String,String> headers)
      Delete a Hook Deletes a hook.
      Parameters:
      hookId - hookId (required)
      Returns:
      Call<DeleteHookResponse>

    • retrieveHook

      @GET("v1/hooks/{hookId}") retrofit2.Call<GetHookResponse> retrieveHook(@Path("hookId") Long hookId, @HeaderMap Map<String,String> headers)
      Retrieve a Hook Returns the details of a Hook. Example Requests: hooks/1
      Parameters:
      hookId - hookId (required)
      Returns:
      Call<GetHookResponse>

    • retrieveHooks

      @GET("v1/hooks") retrofit2.Call<List<GetHookResponse>> retrieveHooks(@HeaderMap Map<String,String> headers)
      Retrieve Hooks Returns the list of hooks. Example Requests: hooks
      Returns:
      Call<List<GetHookResponse>>

    • template3

      @GET("v1/hooks/template") retrofit2.Call<GetHookTemplateResponse> template3(@HeaderMap Map<String,String> headers)
      Retrieve Hooks Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: hooks/template
      Returns:
      Call<GetHookTemplateResponse>

    • updateHook

      @Headers("Content-Type:application/json") @PUT("v1/hooks/{hookId}") retrofit2.Call<PutHookResponse> updateHook(@Path("hookId") Long hookId, @Body PutHookRequest putHookRequest, @HeaderMap Map<String,String> headers)
      Update a Hook Updates the details of a hook.
      Parameters:
      hookId - hookId (required)
      putHookRequest - (required)
      Returns:
      Call<PutHookResponse>