Package org.apache.fineract.client.services

Interface ExternalEventConfigurationApi

public interface ExternalEventConfigurationApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<ExternalEventConfigurationResponse>	getExternalEventConfigurations()	List all external event configurations
retrofit2.Call<ExternalEventConfigurationResponse>	getExternalEventConfigurations(Map<String,String> headers)	List all external event configurations
retrofit2.Call<ExternalEventConfigurationUpdateResponse>	updateExternalEventConfigurations(String idempotencyKey)	Enable/Disable external events posting
retrofit2.Call<ExternalEventConfigurationUpdateResponse>	updateExternalEventConfigurations(String idempotencyKey, Map<String,String> headers)	Enable/Disable external events posting
retrofit2.Call<ExternalEventConfigurationUpdateResponse>	updateExternalEventConfigurations(String idempotencyKey, ExternalEventConfigurationUpdateRequest externalEventConfigurationUpdateRequest)	Enable/Disable external events posting
retrofit2.Call<ExternalEventConfigurationUpdateResponse>	updateExternalEventConfigurations(String idempotencyKey, ExternalEventConfigurationUpdateRequest externalEventConfigurationUpdateRequest, Map<String,String> headers)	Enable/Disable external events posting

Method Details

getExternalEventConfigurations

@GET("v1/externalevents/configuration")
retrofit2.Call<ExternalEventConfigurationResponse> getExternalEventConfigurations()

List all external event configurations

Returns:

Call<ExternalEventConfigurationResponse>

updateExternalEventConfigurations

@Headers("Content-Type:application/json")
@PUT("v1/externalevents/configuration")
retrofit2.Call<ExternalEventConfigurationUpdateResponse> updateExternalEventConfigurations(@Header("Idempotency-Key")
 String idempotencyKey,
 @Body
 ExternalEventConfigurationUpdateRequest externalEventConfigurationUpdateRequest)

Enable/Disable external events posting

Parameters:

idempotencyKey - (optional)

externalEventConfigurationUpdateRequest - (optional)

Returns:

Call<ExternalEventConfigurationUpdateResponse>

updateExternalEventConfigurations

@Headers("Content-Type:application/json")
@PUT("v1/externalevents/configuration")
retrofit2.Call<ExternalEventConfigurationUpdateResponse> updateExternalEventConfigurations(@Header("Idempotency-Key")
 String idempotencyKey)

Enable/Disable external events posting

Parameters:

idempotencyKey - (optional)

externalEventConfigurationUpdateRequest - (optional)

Returns:

Call<ExternalEventConfigurationUpdateResponse>

getExternalEventConfigurations

@GET("v1/externalevents/configuration")
retrofit2.Call<ExternalEventConfigurationResponse> getExternalEventConfigurations(@HeaderMap
 Map<String,String> headers)

List all external event configurations

Returns:

Call<ExternalEventConfigurationResponse>

updateExternalEventConfigurations

@Headers("Content-Type:application/json")
@PUT("v1/externalevents/configuration")
retrofit2.Call<ExternalEventConfigurationUpdateResponse> updateExternalEventConfigurations(@Header("Idempotency-Key")
 String idempotencyKey,
 @Body
 ExternalEventConfigurationUpdateRequest externalEventConfigurationUpdateRequest,
 @HeaderMap
 Map<String,String> headers)

Enable/Disable external events posting

Parameters:

idempotencyKey - (optional)

externalEventConfigurationUpdateRequest - (optional)

Returns:

Call<ExternalEventConfigurationUpdateResponse>

updateExternalEventConfigurations

@Headers("Content-Type:application/json")
@PUT("v1/externalevents/configuration")
retrofit2.Call<ExternalEventConfigurationUpdateResponse> updateExternalEventConfigurations(@Header("Idempotency-Key")
 String idempotencyKey,
 @HeaderMap
 Map<String,String> headers)

Enable/Disable external events posting

Parameters:

idempotencyKey - (optional)

externalEventConfigurationUpdateRequest - (optional)

Returns:

Call<ExternalEventConfigurationUpdateResponse>