Package org.apache.fineract.client.services

Interface ExternalServicesApi

public interface ExternalServicesApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<ExternalServicesPropertiesData>	retrieveOne2(String servicename)	Retrieve External Services Configuration Returns a external Service configurations based on the Service Name.
retrofit2.Call<ExternalServicesPropertiesData>	retrieveOne2(String servicename, Map<String,String> headers)	Retrieve External Services Configuration Returns a external Service configurations based on the Service Name.
retrofit2.Call<Void>	updateExternalServiceProperties(String servicename, PutExternalServiceRequest putExternalServiceRequest)	Update External Service Updates the external Service Configuration for a Service Name.
retrofit2.Call<Void>	updateExternalServiceProperties(String servicename, PutExternalServiceRequest putExternalServiceRequest, Map<String,String> headers)	Update External Service Updates the external Service Configuration for a Service Name.

Method Details

retrieveOne2

@GET("v1/externalservice/{servicename}")
retrofit2.Call<ExternalServicesPropertiesData> retrieveOne2(@Path("servicename")
 String servicename)

Retrieve External Services Configuration Returns a external Service configurations based on the Service Name. Service Names supported are S3 and SMTP. Example Requests: externalservice/SMTP

Parameters:

servicename - servicename (required)

Returns:

Call<ExternalServicesPropertiesData>

updateExternalServiceProperties

@Headers("Content-Type:application/json")
@PUT("v1/externalservice/{servicename}")
retrofit2.Call<Void> updateExternalServiceProperties(@Path("servicename")
 String servicename,
 @Body
 PutExternalServiceRequest putExternalServiceRequest)

Update External Service Updates the external Service Configuration for a Service Name. Example: externalservice/S3

Parameters:

servicename - servicename (required)

putExternalServiceRequest - (required)

Returns:

Call<Void>

retrieveOne2

@GET("v1/externalservice/{servicename}")
retrofit2.Call<ExternalServicesPropertiesData> retrieveOne2(@Path("servicename")
 String servicename,
 @HeaderMap
 Map<String,String> headers)

Retrieve External Services Configuration Returns a external Service configurations based on the Service Name. Service Names supported are S3 and SMTP. Example Requests: externalservice/SMTP

Parameters:

servicename - servicename (required)

Returns:

Call<ExternalServicesPropertiesData>

updateExternalServiceProperties

@Headers("Content-Type:application/json")
@PUT("v1/externalservice/{servicename}")
retrofit2.Call<Void> updateExternalServiceProperties(@Path("servicename")
 String servicename,
 @Body
 PutExternalServiceRequest putExternalServiceRequest,
 @HeaderMap
 Map<String,String> headers)

Update External Service Updates the external Service Configuration for a Service Name. Example: externalservice/S3

Parameters:

servicename - servicename (required)

putExternalServiceRequest - (required)

Returns:

Call<Void>