com.mambu.apisdk.services

Class DocumentsService

java.lang.Object

com.mambu.apisdk.services.DocumentsService

public class DocumentsService
extends java.lang.Object

Service class which handles API operations like uploading documents

Constructor Summary

Constructors

Constructor and Description
DocumentsService(MambuAPIService mambuAPIService) Create a new documents service

Method Summary

Modifier and Type	Method and Description
boolean	deleteDocument(java.lang.String documentId) Delete document by its Id
java.lang.String	getDocument(java.lang.String documentId) Get base64 encoded document data by document id.
java.util.List<com.mambu.docs.shared.model.Document>	getDocuments(MambuEntityType parentEntity, java.lang.String parentId, java.lang.Integer offset, java.lang.Integer limit) Get all Documents for a given parent entity
java.lang.String	getImage(java.lang.String imageKey, APIData.IMAGE_SIZE_TYPE sizeType) Get an Image file using file's encoded key and the preferred image size
static MambuEntityType[]	getSupportedEntities() Get supported entity types
static boolean	isSupported(MambuEntityType parentEntityType) Is parent entity type supported by the API
com.mambu.docs.shared.model.Document	uploadDocument(com.mambu.api.server.handler.documents.model.JSONDocument document) Upload new Document using a JSONDocument object and as json request

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentsService

@Inject
public DocumentsService(MambuAPIService mambuAPIService)

Create a new documents service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

uploadDocument

public com.mambu.docs.shared.model.Document uploadDocument(com.mambu.api.server.handler.documents.model.JSONDocument document)
                                                    throws MambuApiException

Upload new Document using a JSONDocument object and as json request

Parameters:

document - the new document object to be uploaded containing all mandatory fields

Returns:

the new document parsed as an object returned from the API call

Throws:

MambuApiException

getDocument

public java.lang.String getDocument(java.lang.String documentId)
                             throws MambuApiException

Get base64 encoded document data by document id. A typical scenario would be getting a list of attachments for a client/group/account via getDocuments() API and then retrieving a specific document (attachment) by its id with this API call.

Parameters:

documentId - the encoded key or id of the document

Returns:

base64 encoded document content

Throws:

MambuApiException

deleteDocument

public boolean deleteDocument(java.lang.String documentId)
                       throws MambuApiException

Delete document by its Id

Parameters:

documentId - document id or encoded key

Returns:

status

Throws:

MambuApiException

getImage

public java.lang.String getImage(java.lang.String imageKey,
                                 APIData.IMAGE_SIZE_TYPE sizeType)
                          throws MambuApiException

Get an Image file using file's encoded key and the preferred image size

Parameters:

imageKey - a key to access image file (e.g. client's profile picture key: client.getProfilePictureKey())

sizeType - a desired size to be returned. E.g LARGE, MEDIUM, SMALL_THUMB, TINY_THUMB. Can be null to get full size

Returns:

a base64 string with encoded image file

Throws:

MambuApiException

getDocuments

public java.util.List<com.mambu.docs.shared.model.Document> getDocuments(MambuEntityType parentEntity,
                                                                         java.lang.String parentId,
                                                                         java.lang.Integer offset,
                                                                         java.lang.Integer limit)
                                                                  throws MambuApiException

Get all Documents for a given parent entity

Parameters:

parentEntity - MambuEntityType for which documents are retrieved. Must not be null. Documents for the following entities are currently supported: Client, Group. LoanAccount, SavingsAccount, LoanProduct, SavingsProduct, Branch, Centre, User

parentId - entity id or encoded key for the parent entity. Example, client id for a MambuEntityType.CLIENT. Must not be null

offset - pagination offset

limit - pagination limit

Returns:

a list of documents for the parent entity

Throws:

MambuApiException

getSupportedEntities

public static MambuEntityType[] getSupportedEntities()

Get supported entity types

Returns:

all supported entities

isSupported

public static boolean isSupported(MambuEntityType parentEntityType)

Is parent entity type supported by the API

Parameters:

parentEntityType - Mambu Entity type

Returns:

true if supported