com.mambu.apisdk.util

Class ServiceHelper

java.lang.Object

com.mambu.apisdk.util.ServiceHelper

public class ServiceHelper
extends java.lang.Object

ServiceHelper class provides helper methods for validating and building parameters and API definitions required for executing API requests common across different services. For example, there might be common operations required to build transaction parameters for both LoanService and SavingsService, or for API requests which are supported by multiple services (such as getting a list of entities for a Custom View, updating custom field value for an entity, etc.)

Constructor Summary

Constructors

Constructor and Description
ServiceHelper()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	addAppkeyValueToJson(java.lang.String appKey, java.lang.String jsonString) Add appKey value to the json string.
static java.lang.String	getContentForBase64EncodedMessage(java.lang.String apiResponse) Get Base64 encoded content from the API message containing bas64 encoding indicator and base64 encoded content Mambu API returns encoded files in the following format: "data:image/jpg;base64,/9j...." The encoded string is base64 encoded with CRLFs, E.g.
static java.lang.Class<?>	getFullDetailsClass(MambuEntityType entityType) Get class corresponding to the "full details" class for a Mambu Entity.
static java.lang.String	getKeyForAccount(com.mambu.accounts.shared.model.Account account) Gets the encodedKey or the ID from the account passed as parameter in a call to this method.
static java.lang.String	getUndoCloserTransactionType(com.mambu.loans.shared.model.LoanAccount account) Helper to determine the type of the Undo Closer Transaction for a closed loan account.
static java.lang.String	getUndoCloserTransactionType(com.mambu.savings.shared.model.SavingsAccount account) Helper to determine the type of the Undo Closer Transaction for a closed savings account.
static <T> java.lang.String	makeApiJson(T object) Generate a JSON string for an object using Mambu's default date time format ("yyyy-MM-dd'T'HH:mm:ssZ")
static <T> java.lang.String	makeApiJson(T object, ApiDefinition apiDefinition) Generate a JSON string for an object and with the specified ApiDefinition
static <T> java.lang.String	makeApiJson(T object, java.lang.String dateTimeFormat) Generate a JSON string for an object and with the specified format for date fields
static <T> com.google.gson.JsonElement	makeApiJsonElement(T object, ApiDefinition apiDefinition) Generate a JsonElement for an object and with the specified ApiDefinition
static com.mambu.api.server.handler.loan.model.JSONApplyManualFee	makeJSONApplyManualFeeRequest(java.util.List<com.mambu.loans.shared.model.CustomPredefinedFee> transactionFees, java.lang.Integer repaymentNumber, java.lang.String notes) Create JSON Transaction request for submitting applying predefined fee and specifying repayment number Available since Mambu 4.1.
static com.mambu.api.server.handler.loan.model.JSONTransactionRequest	makeJSONTransactionRequest(com.mambu.core.shared.model.Money amount, java.util.Date backDate, java.util.Date firstRepaymentDate, com.mambu.accounts.shared.model.TransactionDetails transactionDetails, java.util.List<com.mambu.loans.shared.model.CustomPredefinedFee> transactionFees, java.util.List<com.mambu.core.shared.model.CustomFieldValue> customInformation, java.lang.String notes) Create JSONTransactionRequest for submitting JSON transaction API requests
static com.mambu.api.server.handler.loan.model.JSONTransactionRequest	makeJSONTransactionRequest(com.mambu.core.shared.model.Money amount, com.mambu.loans.shared.model.DisbursementDetails disbursementDetails, java.util.List<com.mambu.core.shared.model.CustomFieldValue> customInformation, java.lang.String notes) Convenience method to create JSONTransactionRequest specifying disbursement details
static ParamsMap	makePaginationParams(java.lang.String offset, java.lang.String limit) Convenience helper to make parameters map which contains only pagination parameters: offset and limit
static ParamsMap	makeParamsForDocumentJson(com.mambu.api.server.handler.documents.model.JSONDocument document) Create ParamsMap with a JSON string for the JSONDocument object
static ParamsMap	makeParamsForLoanSchedule(com.mambu.loans.shared.model.LoanAccount account, ApiDefinition apiDefinition) Create ParamsMap with a map of fields for the GET loan schedule for the product API.
static ParamsMap	makeParamsForTransactionRequest(java.lang.String transactionType, com.mambu.api.server.handler.loan.model.JSONTransactionRequest transactionRequest) Create params map with as JSON request message for a transaction type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceHelper

public ServiceHelper()

Method Detail

makeJSONTransactionRequest

public static com.mambu.api.server.handler.loan.model.JSONTransactionRequest makeJSONTransactionRequest(com.mambu.core.shared.model.Money amount,
                                                                                                        java.util.Date backDate,
                                                                                                        java.util.Date firstRepaymentDate,
                                                                                                        com.mambu.accounts.shared.model.TransactionDetails transactionDetails,
                                                                                                        java.util.List<com.mambu.loans.shared.model.CustomPredefinedFee> transactionFees,
                                                                                                        java.util.List<com.mambu.core.shared.model.CustomFieldValue> customInformation,
                                                                                                        java.lang.String notes)

Create JSONTransactionRequest for submitting JSON transaction API requests

Parameters:

amount - transaction amount

backDate - transaction back date

firstRepaymentDate - first repayment date

transactionDetails - transaction details

transactionFees - transaction fees

customInformation - transaction custom fields

notes - transaction notes

Returns:

JSON Transaction Request

makeJSONTransactionRequest

public static com.mambu.api.server.handler.loan.model.JSONTransactionRequest makeJSONTransactionRequest(com.mambu.core.shared.model.Money amount,
                                                                                                        com.mambu.loans.shared.model.DisbursementDetails disbursementDetails,
                                                                                                        java.util.List<com.mambu.core.shared.model.CustomFieldValue> customInformation,
                                                                                                        java.lang.String notes)

Convenience method to create JSONTransactionRequest specifying disbursement details

Parameters:

amount - transaction amount

disbursementDetails - disbursement details

customInformation - transaction custom fields

notes - transaction notes

Returns:

JSON Transaction Request

makeJSONApplyManualFeeRequest

public static com.mambu.api.server.handler.loan.model.JSONApplyManualFee makeJSONApplyManualFeeRequest(java.util.List<com.mambu.loans.shared.model.CustomPredefinedFee> transactionFees,
                                                                                                       java.lang.Integer repaymentNumber,
                                                                                                       java.lang.String notes)

Create JSON Transaction request for submitting applying predefined fee and specifying repayment number Available since Mambu 4.1. See MBU-12271, MBU-12272 (loan fees), MBU-12273 (savings fees)

Parameters:

transactionFees - transaction fees

repaymentNumber - repayment number. Applicable only for loan transactions. Must be set to null for savings apply fee transaction

notes - transaction notes

Returns:

JSON Apply Manual Fee Request

makeParamsForTransactionRequest

public static ParamsMap makeParamsForTransactionRequest(java.lang.String transactionType,
                                                        com.mambu.api.server.handler.loan.model.JSONTransactionRequest transactionRequest)

Create params map with as JSON request message for a transaction type

Parameters:

transactionType - transaction type string. Example: "DISBURSEMENT"

transactionRequest - jSON transaction request. If null then the JSON string with only the transactionType is returned.

Returns:

params map with a JSON_OBJECT included

makeParamsForDocumentJson

public static ParamsMap makeParamsForDocumentJson(com.mambu.api.server.handler.documents.model.JSONDocument document)

Create ParamsMap with a JSON string for the JSONDocument object

Parameters:

document - JSONDocument document containing Document object and documentContent string

Returns:

params map with the document JSON string

getContentForBase64EncodedMessage

public static java.lang.String getContentForBase64EncodedMessage(java.lang.String apiResponse)

Get Base64 encoded content from the API message containing bas64 encoding indicator and base64 encoded content Mambu API returns encoded files in the following format: "data:image/jpg;base64,/9j...." The encoded string is base64 encoded with CRLFs, E.g. 9j/4AAQSkZJR...\r\nnHBwgJC4nICIsIxwcKDcpL... This methods returns just the content part without the base64 indicator

Parameters:

apiResponse - api response message containing base64 indicator and base64 encoded string

Returns:

base64 encoded message content

makeParamsForLoanSchedule

public static ParamsMap makeParamsForLoanSchedule(com.mambu.loans.shared.model.LoanAccount account,
                                                  ApiDefinition apiDefinition)

Create ParamsMap with a map of fields for the GET loan schedule for the product API. Only fields applicable to the API are added to the params map

Parameters:

account - input loan account

apiDefinition - api definition containing custom serializer for loan account to support generating request only with those fields required by the GET schedule API

Returns:

params map with fields for an API request

makeApiJson

public static <T> java.lang.String makeApiJson(T object)

Generate a JSON string for an object using Mambu's default date time format ("yyyy-MM-dd'T'HH:mm:ssZ")

Parameters:

object - object

Returns:

JSON string for the object

makeApiJson

public static <T> java.lang.String makeApiJson(T object,
                                               java.lang.String dateTimeFormat)

Generate a JSON string for an object and with the specified format for date fields

Parameters:

object - object

dateTimeFormat - date time format string. Example: "yyyy-MM-dd". If null then the default date time format is used ("yyyy-MM-dd'T'HH:mm:ssZ")

Returns:

JSON string for the object

makeApiJson

public static <T> java.lang.String makeApiJson(T object,
                                               ApiDefinition apiDefinition)

Generate a JSON string for an object and with the specified ApiDefinition

Parameters:

object - object

apiDefinition - API definition

Returns:

JSON string for the object

makeApiJsonElement

public static <T> com.google.gson.JsonElement makeApiJsonElement(T object,
                                                                 ApiDefinition apiDefinition)

Generate a JsonElement for an object and with the specified ApiDefinition

Parameters:

object - object

apiDefinition - API definition

Returns:

JsonElement for an object

makePaginationParams

public static ParamsMap makePaginationParams(java.lang.String offset,
                                             java.lang.String limit)

Convenience helper to make parameters map which contains only pagination parameters: offset and limit

Parameters:

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null the must be an integer greater than zero

Returns:

ParamsMap

addAppkeyValueToJson

public static java.lang.String addAppkeyValueToJson(java.lang.String appKey,
                                                    java.lang.String jsonString)

Add appKey value to the json string.

Parameters:

appKey - app key value. Can be null

jsonString - json string.

Returns:

json string with the appKey parameter added. If the appKey parameter is already present then the jsonString is not modified. See MBU-3892

getFullDetailsClass

public static java.lang.Class<?> getFullDetailsClass(MambuEntityType entityType)

Get class corresponding to the "full details" class for a Mambu Entity. For example, ClientExpanded.class for MambuEntityType.CLIENT;

Parameters:

entityType - entity type. Must not be null

Returns:

class representing full details class for the Mambu Entity or null if no such class exists

getUndoCloserTransactionType

public static java.lang.String getUndoCloserTransactionType(com.mambu.loans.shared.model.LoanAccount account)

Helper to determine the type of the Undo Closer Transaction for a closed loan account. The transaction type needed in UNDO closer API transactions. Can be also used to determine ahead of time if the UNDO Closer transaction can be performed via API for the specified account See MBU-13190. As of Mambu 4.2 the following UNDO closer types are supported "UNDO_REJECT", "UNDO_WITHDRAWN", "UNDO_CLOSE"

Parameters:

account - loan account. Must not be null and its state must not be null.

Returns:

UNDO close transaction type. Return null if account is not closed or if its closer type is not supported by Mambu API

getUndoCloserTransactionType

public static java.lang.String getUndoCloserTransactionType(com.mambu.savings.shared.model.SavingsAccount account)

Helper to determine the type of the Undo Closer Transaction for a closed savings account. The transaction type needed in UNDO closer API transactions. Can be also used to determine ahead of time if the UNDO Closer transaction can be performed via API for the specified account See MBU-13193. As of Mambu 4.2 the following UNDO closer types are supported "UNDO_REJECT", "UNDO_WITHDRAWN", "UNDO_CLOSE"

Parameters:

account - savings account. Must not be null and its state must not be null.

Returns:

UNDO close transaction type. Return null if account is not closed or if its closer type is not supported by Mambu API

getKeyForAccount

public static java.lang.String getKeyForAccount(com.mambu.accounts.shared.model.Account account)

Gets the encodedKey or the ID from the account passed as parameter in a call to this method.

Parameters:

account - The account used to obtain the ID or the encoded key from.

Returns:

a String key representing the encodedKey or the ID or null if both are null.