com.mambu.apisdk.services

Class ClientsService

java.lang.Object

com.mambu.apisdk.services.ClientsService

public class ClientsService
extends java.lang.Object

Service class which handles API operations like getting and creating clients and groups of clients

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CENTRE_ID

Constructor Summary

Constructors

Constructor and Description
ClientsService(MambuAPIService mambuAPIService) Create a new client service

Method Summary

Modifier and Type	Method and Description
com.mambu.clients.shared.model.ClientExpanded	createClient(com.mambu.clients.shared.model.ClientExpanded clientDetails) Create a new client (expanded) using ClientExpanded object and sending it as a JSON api.
com.mambu.clients.shared.model.GroupExpanded	createGroup(com.mambu.clients.shared.model.GroupExpanded groupDetails) Create a new group using GroupExpanded object and sending it as a JSON api.
boolean	deleteClient(java.lang.String clientId) Delete Client.
boolean	deleteClientProfilePicture(java.lang.String clientId) Delete client profile picture file
boolean	deleteClientSignatureFile(java.lang.String clientId) Delete client signature file
com.mambu.clients.shared.model.Client	getClient(java.lang.String clientId) Requests a client by their Mambu ID
java.util.List<com.mambu.clients.shared.model.Client>	getClientByFullName(java.lang.String clientLastName, java.lang.String clientFirstName) Requests a client by their Last name and first name
java.util.List<com.mambu.clients.shared.model.Client>	getClientByLastNameBirthday(java.lang.String clientLastName, java.lang.String birthDay) Requests a client by their Last name and Birth date
java.util.List<com.mambu.clients.shared.model.Client>	getClientByLastNameDocId(java.lang.String clientLastName, java.lang.String documentId) Requests a client by their Document ID and Last name
com.mambu.clients.shared.model.ClientExpanded	getClientDetails(java.lang.String clientId) Returns a client with their full details such as addresses or custom fields
java.lang.String	getClientProfilePicture(java.lang.String clientId) Get client profile picture API response message containing image type indicator and the base64 encoded picture file API response message format: "data:image/jpg;base64,/9j/4AAQSkZJRgABAgAA..."
java.lang.String	getClientProfilePictureFile(java.lang.String clientId) Convenience method to get get client profile picture file content only (base64 encoded)
java.util.List<com.mambu.clients.shared.model.Client>	getClients(boolean active, java.lang.Integer offset, java.lang.Integer limit) Requests a list of clients, limited by offset/limit
java.util.List<com.mambu.clients.shared.model.Client>	getClients(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Get clients by specifying filter constraints
java.util.List<com.mambu.clients.shared.model.Client>	getClientsByBranchCentreOfficerState(java.lang.String branchId, java.lang.String centreId, java.lang.String creditOfficerUserName, java.lang.String clientState, java.lang.String offset, java.lang.String limit) Get Clients by branch id, centre id, credit officer, clientState
java.util.List<com.mambu.clients.shared.model.Client>	getClientsByBranchOfficerState(java.lang.String branchId, java.lang.String creditOfficerUserName, java.lang.String clientState, java.lang.String offset, java.lang.String limit) Get Clients by branch id, credit officer, clientState
java.lang.String	getClientSignature(java.lang.String clientId) Get client signature API response message containing image type indicator and the base64 encoded signature file API response message format: "data:image/PNG;base64,iVBORw0KGgoAAAANSUhE..."
java.lang.String	getClientSignatureFile(java.lang.String clientId) Convenience method to get get client signature file content only (base64 encoded)
java.util.List<com.mambu.core.shared.model.ClientRole>	getClientTypes() Get client types for both clients and groups
java.util.List<com.mambu.core.shared.model.ClientRole>	getClientTypes(com.mambu.accounts.shared.model.AccountHolderType clientType) Get client types for clients or for groups
com.mambu.clients.shared.model.Group	getGroup(java.lang.String groupId) Requests a group by it's Mambu ID
com.mambu.clients.shared.model.GroupExpanded	getGroupDetails(java.lang.String groupId) Requests the details about a group
com.mambu.clients.shared.model.GroupRoleName	getGroupRoleName(java.lang.String groupRoleNameId) Requests details for the group role name by id
java.util.List<com.mambu.clients.shared.model.GroupRoleName>	getGroupRoleNames() Requests a list of group role names This API doesn't accept pagination parameters (offset and limit ) and returns all group role names
java.util.List<com.mambu.clients.shared.model.Group>	getGroups(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Get groups by specifying filter constraints
java.util.List<com.mambu.clients.shared.model.Group>	getGroupsByBranchCentreOfficer(java.lang.String branchId, java.lang.String centreId, java.lang.String creditOfficerUserName, java.lang.String offset, java.lang.String limit) Get Groups by branch id, credit officer
java.util.List<com.mambu.clients.shared.model.Group>	getGroupsByBranchOfficer(java.lang.String branchId, java.lang.String creditOfficerUserName, java.lang.String offset, java.lang.String limit) Get Groups by branch id, credit officer
boolean	patchClient(com.mambu.clients.shared.model.Client client) Patch client fields
boolean	patchClient(com.mambu.clients.shared.model.Client client, java.lang.String clientId) Patch client fields
boolean	patchClientState(java.lang.String clientId, com.mambu.clients.shared.model.ClientState clientState) Convenience method to Patch client state
boolean	patchGroup(com.mambu.clients.shared.model.Group group) Patch Group fields.
boolean	patchGroup(com.mambu.clients.shared.model.GroupExpanded groupExpanded) Patches Group fields through GroupExpanded.
com.mambu.clients.shared.model.ClientExpanded	updateClient(com.mambu.clients.shared.model.ClientExpanded clientDetails) Update an existent client (expanded) using ClientExpanded object and send it as a JSON api.
com.mambu.clients.shared.model.GroupExpanded	updateGroup(com.mambu.clients.shared.model.GroupExpanded groupDetails) Update an existent group using GroupExpanded object and send it as a JSON api.
boolean	uploadClientProfilePicture(java.lang.String clientId, com.mambu.api.server.handler.documents.model.JSONDocument pictureDocument) Upload client profile picture file
boolean	uploadClientSignatureFile(java.lang.String clientId, com.mambu.api.server.handler.documents.model.JSONDocument signatureDocument) Upload client signature file

Methods inherited from class java.lang.Object

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

Field Detail

CENTRE_ID

public static final java.lang.String CENTRE_ID

See Also:

Constant Field Values

Constructor Detail

ClientsService

@Inject
public ClientsService(MambuAPIService mambuAPIService)

Create a new client service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

getClient

public com.mambu.clients.shared.model.Client getClient(java.lang.String clientId)
                                                throws MambuApiException

Requests a client by their Mambu ID

Parameters:

clientId -

Returns:

the Mambu client model

Throws:

MambuApiException

getClientByFullName

public java.util.List<com.mambu.clients.shared.model.Client> getClientByFullName(java.lang.String clientLastName,
                                                                                 java.lang.String clientFirstName)
                                                                          throws MambuApiException

Requests a client by their Last name and first name

Parameters:

clientLastName -

clientFirstName -

Returns:

list of Mambu clients

Throws:

MambuApiException

getClientByLastNameBirthday

public java.util.List<com.mambu.clients.shared.model.Client> getClientByLastNameBirthday(java.lang.String clientLastName,
                                                                                         java.lang.String birthDay)
                                                                                  throws MambuApiException

Requests a client by their Last name and Birth date

Parameters:

clientLastName -

birthDay - ("yyyy-MM-dd")

Returns:

list of Mambu clients

Throws:

MambuApiException

getClients

public java.util.List<com.mambu.clients.shared.model.Client> getClients(boolean active,
                                                                        java.lang.Integer offset,
                                                                        java.lang.Integer limit)
                                                                 throws MambuApiException

Requests a list of clients, limited by offset/limit

Parameters:

active - True if active Clients should retrieved, false for inactive Clients

offset - Offset to start loading Clients, has to be >= 0 if not null. If null, Mambu default will be used

limit - Limit of Clients to load, has to be > 0 if not null. If null, Mambu default will be used

Returns:

the list of Mambu clients

Throws:

MambuApiException

getClientByLastNameDocId

public java.util.List<com.mambu.clients.shared.model.Client> getClientByLastNameDocId(java.lang.String clientLastName,
                                                                                      java.lang.String documentId)
                                                                               throws MambuApiException

Requests a client by their Document ID and Last name

Parameters:

clientLastName -

documentId -

Returns:

the list of Mambu clients

Throws:

MambuApiException

getClientDetails

public com.mambu.clients.shared.model.ClientExpanded getClientDetails(java.lang.String clientId)
                                                               throws MambuApiException

Returns a client with their full details such as addresses or custom fields

Parameters:

clientId - the id of the client

Returns:

the retrieved expanded client

Throws:

MambuApiException

getGroup

public com.mambu.clients.shared.model.Group getGroup(java.lang.String groupId)
                                              throws MambuApiException

Requests a group by it's Mambu ID

Parameters:

groupId - the id of the group

Returns:

the retrieved group

Throws:

MambuApiException

getGroupDetails

public com.mambu.clients.shared.model.GroupExpanded getGroupDetails(java.lang.String groupId)
                                                             throws MambuApiException

Requests the details about a group

Parameters:

groupId - the id of the group

Returns:

the retrieved expanded group

Throws:

MambuApiException

createClient

public com.mambu.clients.shared.model.ClientExpanded createClient(com.mambu.clients.shared.model.ClientExpanded clientDetails)
                                                           throws MambuApiException

Create a new client (expanded) using ClientExpanded object and sending it as a JSON api. This API allows creating Client with more details, including creating custom fields.

Parameters:

clientDetails - The encodedKey for the clientExpanded object must be null to create a new client

Returns:

clientDetails for the newly created client.

Throws:

MambuApiException

java.lang.IllegalArgumentException

updateClient

public com.mambu.clients.shared.model.ClientExpanded updateClient(com.mambu.clients.shared.model.ClientExpanded clientDetails)
                                                           throws MambuApiException

Update an existent client (expanded) using ClientExpanded object and send it as a JSON api. This API allows updating Client with new details, including modifying client details, custom fields, address, contacts and document IDs Note: Available since Mambu 3.4

Parameters:

clientDetails - client details to be updated. See MBU-3603 for full details. The encodedKey for the clientExpanded object must be NOT null to update an existent client. Client ID and Client Assignment are not modifiable

Returns:

updated clientDetails

Throws:

MambuApiException

java.lang.IllegalArgumentException

patchClientState

public boolean patchClientState(java.lang.String clientId,
                                com.mambu.clients.shared.model.ClientState clientState)
                         throws MambuApiException

Convenience method to Patch client state

Parameters:

clientId - the id or the encoded key of a client. Must not be null

clientState - new client state. Must not be null. Allowed states: BLACKLISTED, REJECTED, EXITED, INACTIVE (approved), PENDING_APPROVAL (undo approval). See MBU-11443 for more details

Throws:

MambuApiException

patchClient

public boolean patchClient(com.mambu.clients.shared.model.Client client)
                    throws MambuApiException

Patch client fields

Parameters:

client - client. Must not be null and client's encoded key or its id must not be null. As of Mambu 4.1 the following fields can be patched: id, clientRoleId, firstName, lastName, middleName, homePhone, mobilePhone1, birthDate, emailAddress, gender, state, notes, preferredLanguage As of Mambu 4.5 the following fields can be patched: assignedBranchKey, assignedCentreKey, assignedUserId (credit officer)

Returns:

true if client was updated successfully, false otherwise

Throws:

MambuApiException

patchClient

public boolean patchClient(com.mambu.clients.shared.model.Client client,
                           java.lang.String clientId)
                    throws MambuApiException

Patch client fields

Parameters:

client - client. Must not be null

clientId - client id or encoded key. Must not be null

Returns:

true if client was patched successfully

Throws:

MambuApiException

deleteClient

public boolean deleteClient(java.lang.String clientId)
                     throws MambuApiException

Delete Client. Note, clients which have open accounts, have assigned tasks, or are assigned to groups, to linked custom fields or are guarantors cannot be deleted. Requires "Delete Clients" permission

Parameters:

clientId - client id or encoded key. Must not be null

Returns:

status returns true if client was deleted successfully

Throws:

MambuApiException

createGroup

public com.mambu.clients.shared.model.GroupExpanded createGroup(com.mambu.clients.shared.model.GroupExpanded groupDetails)
                                                         throws MambuApiException

Create a new group using GroupExpanded object and sending it as a JSON api. This API allows creating a new Group with group details, group members, group roles, custom fields, and group address Available since Mambu 3.8.10. See MBU-7336

Parameters:

groupDetails - The encodedKey for the groupDetails must be null to create a new group

Returns:

group details for the newly created group

Throws:

MambuApiException

java.lang.IllegalArgumentException

updateGroup

public com.mambu.clients.shared.model.GroupExpanded updateGroup(com.mambu.clients.shared.model.GroupExpanded groupDetails)
                                                         throws MambuApiException

Update an existent group using GroupExpanded object and send it as a JSON api. This API allows updating Group with new details, including modifying group details, group members, group roles, custom fields and group address

Parameters:

groupDetails - group details to be updated. The encodedKey for the groupDetails object must be NOT null to update an existent group.

Returns:

updated group details

Throws:

MambuApiException

java.lang.IllegalArgumentException

getClientsByBranchCentreOfficerState

public java.util.List<com.mambu.clients.shared.model.Client> getClientsByBranchCentreOfficerState(java.lang.String branchId,
                                                                                                  java.lang.String centreId,
                                                                                                  java.lang.String creditOfficerUserName,
                                                                                                  java.lang.String clientState,
                                                                                                  java.lang.String offset,
                                                                                                  java.lang.String limit)
                                                                                           throws MambuApiException

Get Clients by branch id, centre id, credit officer, clientState

Parameters:

branchId - the ID of the Client's branch

centreId - The ID of the centre to which the loan accounts are assigned to. If both branchId and centreId are provided then this centre must be assigned to the branchId

creditOfficerUserName - the username of the credit officer to whom the CLients are assigned to

clientState - the desired state of a Client to filter on (eg: ACTIVE)

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

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

Returns:

the list of Clients matching these parameters

Throws:

MambuApiException

getClientsByBranchOfficerState

public java.util.List<com.mambu.clients.shared.model.Client> getClientsByBranchOfficerState(java.lang.String branchId,
                                                                                            java.lang.String creditOfficerUserName,
                                                                                            java.lang.String clientState,
                                                                                            java.lang.String offset,
                                                                                            java.lang.String limit)
                                                                                     throws MambuApiException

Get Clients by branch id, credit officer, clientState

Parameters:

branchId - the ID of the Client's branch

creditOfficerUserName - the username of the credit officer to whom the CLients are assigned to

clientState - the desired state of a Client to filter on (eg: ACTIVE)

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

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

Returns:

the list of Clients matching these parameters

Throws:

MambuApiException

getClients

public java.util.List<com.mambu.clients.shared.model.Client> getClients(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                                        java.lang.String offset,
                                                                        java.lang.String limit)
                                                                 throws MambuApiException

Get clients by specifying filter constraints

Parameters:

filterConstraints - filter constraints. Must not be null

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

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

Returns:

list of clients matching filter constraint

Throws:

MambuApiException

getGroups

public java.util.List<com.mambu.clients.shared.model.Group> getGroups(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                                      java.lang.String offset,
                                                                      java.lang.String limit)
                                                               throws MambuApiException

Get groups by specifying filter constraints

Parameters:

filterConstraints - filter constraints. Must not be null

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

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

Returns:

list of groups matching filter constraint.

Throws:

MambuApiException

getGroupRoleNames

public java.util.List<com.mambu.clients.shared.model.GroupRoleName> getGroupRoleNames()
                                                                               throws MambuApiException

Requests a list of group role names This API doesn't accept pagination parameters (offset and limit ) and returns all group role names

Returns:

the list of Mambu group role names

Throws:

MambuApiException

getGroupRoleName

public com.mambu.clients.shared.model.GroupRoleName getGroupRoleName(java.lang.String groupRoleNameId)
                                                              throws MambuApiException

Requests details for the group role name by id

Parameters:

groupRoleNameId - group role name id or encoded key. Must be not null

Returns:

group role details

Throws:

MambuApiException

getGroupsByBranchCentreOfficer

public java.util.List<com.mambu.clients.shared.model.Group> getGroupsByBranchCentreOfficer(java.lang.String branchId,
                                                                                           java.lang.String centreId,
                                                                                           java.lang.String creditOfficerUserName,
                                                                                           java.lang.String offset,
                                                                                           java.lang.String limit)
                                                                                    throws MambuApiException

Get Groups by branch id, credit officer

Parameters:

branchId - the ID of the Group's branch

centreId - The ID of the centre to which the loan accounts are assigned to. If both branchId and centreId are provided then this centre must be assigned to the branchId

creditOfficerUserName - the username of the credit officer to whom the Groups are assigned to

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

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

Returns:

the list of Groups matching these parameters

Throws:

MambuApiException

getGroupsByBranchOfficer

public java.util.List<com.mambu.clients.shared.model.Group> getGroupsByBranchOfficer(java.lang.String branchId,
                                                                                     java.lang.String creditOfficerUserName,
                                                                                     java.lang.String offset,
                                                                                     java.lang.String limit)
                                                                              throws MambuApiException

Get Groups by branch id, credit officer

Parameters:

branchId - the ID of the Group's branch

creditOfficerUserName - the username of the credit officer to whom the Groups are assigned to

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

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

Returns:

the list of Groups matching these parameters

Throws:

MambuApiException

getClientTypes

public java.util.List<com.mambu.core.shared.model.ClientRole> getClientTypes(com.mambu.accounts.shared.model.AccountHolderType clientType)
                                                                      throws MambuApiException

Get client types for clients or for groups

Parameters:

clientType - the account holder type (CLIENT or GROUP). Must be not null

Returns:

client types

Throws:

MambuApiException

getClientTypes

public java.util.List<com.mambu.core.shared.model.ClientRole> getClientTypes()
                                                                      throws MambuApiException

Get client types for both clients and groups

Returns:

all client types defined in Mambu for both clients and groups

Throws:

MambuApiException

getClientProfilePicture

public java.lang.String getClientProfilePicture(java.lang.String clientId)
                                         throws MambuApiException

Get client profile picture API response message containing image type indicator and the base64 encoded picture file API response message format: "data:image/jpg;base64,/9j/4AAQSkZJRgABAgAA..."

Parameters:

clientId - the encoded key or id of the Mambu Client

Returns:

API response string

Throws:

MambuApiException

getClientProfilePictureFile

public java.lang.String getClientProfilePictureFile(java.lang.String clientId)
                                             throws MambuApiException

Convenience method to get get client profile picture file content only (base64 encoded)

Parameters:

clientId - the encoded key or id of the Mambu Client

Returns:

picture file as a Base64 string

Throws:

MambuApiException

getClientSignature

public java.lang.String getClientSignature(java.lang.String clientId)
                                    throws MambuApiException

Get client signature API response message containing image type indicator and the base64 encoded signature file API response message format: "data:image/PNG;base64,iVBORw0KGgoAAAANSUhE..."

Parameters:

clientId - the encoded key or id of the Mambu Client

Returns:

API response string

Throws:

MambuApiException

getClientSignatureFile

public java.lang.String getClientSignatureFile(java.lang.String clientId)
                                        throws MambuApiException

Convenience method to get get client signature file content only (base64 encoded)

Parameters:

clientId - the encoded key or id of the Mambu Client

Returns:

signature file as a Base64 string

Throws:

MambuApiException

uploadClientProfilePicture

public boolean uploadClientProfilePicture(java.lang.String clientId,
                                          com.mambu.api.server.handler.documents.model.JSONDocument pictureDocument)
                                   throws MambuApiException

Upload client profile picture file

Parameters:

pictureDocument - JSON document whose content is base64 encoded profile picture file

Returns:

success or failure

Throws:

MambuApiException

uploadClientSignatureFile

public boolean uploadClientSignatureFile(java.lang.String clientId,
                                         com.mambu.api.server.handler.documents.model.JSONDocument signatureDocument)
                                  throws MambuApiException

Upload client signature file

Parameters:

signatureDocument - JSON document whose content is base64 encoded signature file

Returns:

success or failure

Throws:

MambuApiException

deleteClientProfilePicture

public boolean deleteClientProfilePicture(java.lang.String clientId)
                                   throws MambuApiException

Delete client profile picture file

Parameters:

clientId - the encoded key or id of the Mambu Client

Returns:

success or failure

Throws:

MambuApiException

deleteClientSignatureFile

public boolean deleteClientSignatureFile(java.lang.String clientId)
                                  throws MambuApiException

Delete client signature file

Parameters:

clientId - the encoded key or id of the Mambu Client

Returns:

a boolean indicating if deletion was successful

Throws:

MambuApiException

patchGroup

public boolean patchGroup(com.mambu.clients.shared.model.Group group)
                   throws MambuApiException

Patch Group fields.

Parameters:

group - the Group to be patched. The Group and its encoded key or id must not be Null.

Returns:

a boolean indicating if the patch was successful

Throws:

MambuApiException

patchGroup

public boolean patchGroup(com.mambu.clients.shared.model.GroupExpanded groupExpanded)
                   throws MambuApiException

Patches Group fields through GroupExpanded. Pay attention, only the group information gets patched, the other properties on the GroupExpanded like group members and group roles are replaced if they are supplied.

Parameters:

groupExpanded - the GroupExpanded to be patched. The GroupExpanded and its encoded key or id must not be null.

Returns:

a boolean indicating if the patch was successful

Throws:

MambuApiException