com.mambu.apisdk.services

Class DocumentTemplatesService

java.lang.Object

com.mambu.apisdk.services.DocumentTemplatesService

public class DocumentTemplatesService
extends java.lang.Object

Service class which handles API operations for retrieving document templates for Mambu Entities. Getting Templates for the following entities is currently supported: LoanAccount and SavingsAccount Document Templates API currently supports: GET Populated Account Templates (see MBU-10631 - As a Developer, I want to get populated Account Document Templates via APIs) and GET Populated Transaction Templates (see MBU-10632 - As a Developer, I want to get populated Transaction Document Templates via API )

Field Summary

Fields

Modifier and Type	Field and Description
protected ServiceExecutor	serviceExecutor

Constructor Summary

Constructors

Constructor and Description
DocumentTemplatesService(MambuAPIService mambuAPIService) Create a new service

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPopulatedEntityTemplate(MambuEntityType parentEntity, java.lang.String entityId, java.lang.String templateKey, java.lang.String startDate, java.lang.String endDate) Convenience method to get populated document template for a given parent entity and a given template id
java.lang.String	getPopulatedEntityTransactionTemplate(MambuEntityType parentEntity, java.lang.String entityId, java.lang.String templateKey, java.lang.String transactionId) Convenience method to get populated transaction document template for a given parent entity (LoanAccount or SavingsAccont)
java.lang.String	getPopulatedLoanTemplate(java.lang.String loanAccountId, java.lang.String templateKey, java.lang.String startDate, java.lang.String endDate) Get populated account document template for a loan account and a given template key
java.lang.String	getPopulatedLoanTransactionTemplate(java.lang.String loanAccountId, java.lang.String templateKey, java.lang.String transactionId) Get populated transaction document template for a loan account
java.lang.String	getPopulatedSavingsTemplate(java.lang.String savingsAccountId, java.lang.String templateKey, java.lang.String startDate, java.lang.String endDate) Get populated account document template for a savings account and a given template key
java.lang.String	getPopulatedSavingsTransactionTemplate(java.lang.String savingsAccountId, java.lang.String templateKey, java.lang.String transactionId) Get populated transaction document template for a savings account
static MambuEntityType[]	getSupportedEntities() Get supported entity types
static boolean	isSupported(MambuEntityType entityType) Is parent entity type supported by the Document Templates API

Methods inherited from class java.lang.Object

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

Field Detail

serviceExecutor

protected ServiceExecutor serviceExecutor

Constructor Detail

DocumentTemplatesService

@Inject
public DocumentTemplatesService(MambuAPIService mambuAPIService)

Create a new service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

getPopulatedLoanTemplate

public java.lang.String getPopulatedLoanTemplate(java.lang.String loanAccountId,
                                                 java.lang.String templateKey,
                                                 java.lang.String startDate,
                                                 java.lang.String endDate)
                                          throws MambuApiException

Get populated account document template for a loan account and a given template key

Parameters:

loanAccountId - id or encoded key for the loan account. Must not be null

templateKey - template encoded key. Should be a valid product document template encoded key. Must not be null

startDate - Start date. Mandatory for product documents that "Include Transactions History" (i.e. documents of DocumentTemplateType.ACCOUNT_WITH_TRANSACTIONS type) and can be only specified for documents of this type. If specified, must be less or equal to endDate

endDate - End date. Mandatory for product documents that "Include Transactions History" (i.e. documents of DocumentTemplateType.ACCOUNT_WITH_TRANSACTIONS type) and can be only specified for documents of this type.

Returns:

populated HTML template for the loan account

Throws:

MambuApiException

getPopulatedSavingsTemplate

public java.lang.String getPopulatedSavingsTemplate(java.lang.String savingsAccountId,
                                                    java.lang.String templateKey,
                                                    java.lang.String startDate,
                                                    java.lang.String endDate)
                                             throws MambuApiException

Get populated account document template for a savings account and a given template key

Parameters:

savingsAccountId - id or encoded key for the savings account. Must not be null

templateKey - template encoded key. Should be a valid product document template encoded key. Must not be null

startDate - Start date. Mandatory for product documents that "Include Transactions History" (i.e. documents of DocumentTemplateType.ACCOUNT_WITH_TRANSACTIONS type) and can be only specified for documents of this type. If specified, must be less or equal to endDate

endDate - End date. Mandatory for product documents that "Include Transactions History".(i.e. documents of DocumentTemplateType.ACCOUNT_WITH_TRANSACTIONS type) and can be only specified for documents of this type.

Returns:

populated HTML template for the savings account

Throws:

MambuApiException

getPopulatedLoanTransactionTemplate

public java.lang.String getPopulatedLoanTransactionTemplate(java.lang.String loanAccountId,
                                                            java.lang.String templateKey,
                                                            java.lang.String transactionId)
                                                     throws MambuApiException

Get populated transaction document template for a loan account

Parameters:

loanAccountId - id or encoded key for the loan account. Must not be null

templateKey - template encoded key. Should be a valid product document template encoded key. Must not be null

transactionId - a valid transaction ID or encoded key. Must not be null

Returns:

populated HTML template for the transaction

Throws:

MambuApiException

getPopulatedSavingsTransactionTemplate

public java.lang.String getPopulatedSavingsTransactionTemplate(java.lang.String savingsAccountId,
                                                               java.lang.String templateKey,
                                                               java.lang.String transactionId)
                                                        throws MambuApiException

Get populated transaction document template for a savings account

Parameters:

savingsAccountId - entity id or encoded key for the savings account. Must not be null

templateKey - template encoded key. Should be a valid product document template encoded key. Must not be null

transactionId - a valid transaction ID or encoded key. Must not be null

Returns:

populated HTML template for the transaction

Throws:

MambuApiException

getSupportedEntities

public static MambuEntityType[] getSupportedEntities()

Get supported entity types

Returns:

all supported entities

isSupported

public static boolean isSupported(MambuEntityType entityType)

Is parent entity type supported by the Document Templates API

Parameters:

entityType - Mambu Entity type

Returns:

true if supported

getPopulatedEntityTemplate

public java.lang.String getPopulatedEntityTemplate(MambuEntityType parentEntity,
                                                   java.lang.String entityId,
                                                   java.lang.String templateKey,
                                                   java.lang.String startDate,
                                                   java.lang.String endDate)
                                            throws MambuApiException

Convenience method to get populated document template for a given parent entity and a given template id

Parameters:

parentEntity - MambuEntityType for which document templates are retrieved. Example, MambuEntityType.LOAN_ACCOUNT. Must not be null. Currently can be only MambuEntityType.LOAN_ACCOUNT or MambuEntityType.SAVINGS_ACCOUNT

entityId - entity id or encoded key for the parent entity. Example, loan account id for a MambuEntityType.LOAN_ACCOUNT. Must not be null

templateKey - template encoded key. Should be a valid product document template encoded key. Must not be null

startDate - Start date. Mandatory for product documents that "Include Transactions History". Can only be be specified for documents that "Include Transactions History". startDate <= endDate

endDate - End date. Mandatory for product documents that "Include Transactions History". Can only be be specified for documents that "Include Transactions History". startDate <= endDate

Returns:

populated HTML template for the parent entity

Throws:

MambuApiException

getPopulatedEntityTransactionTemplate

public java.lang.String getPopulatedEntityTransactionTemplate(MambuEntityType parentEntity,
                                                              java.lang.String entityId,
                                                              java.lang.String templateKey,
                                                              java.lang.String transactionId)
                                                       throws MambuApiException

Convenience method to get populated transaction document template for a given parent entity (LoanAccount or SavingsAccont)

Parameters:

parentEntity - MambuEntityType for which document templates are retrieved. Example, MambuEntityType.LOAN_ACCOUNT. Must not be null. Currently can be only MambuEntityType.LOAN_ACCOUNT or MambuEntityType.SAVINGS_ACCOUNT

entityId - entity id or encoded key for the parent entity. Example, loan account id for a MambuEntityType.LOAN_ACCOUNT. Must not be null

templateKey - template encoded key. Should be a valid product document template encoded key. Must not be null

transactionId - a valid transaction ID or encoded key. Must not be null

Returns:

populated HTML template for the transaction

Throws:

MambuApiException