com.genesys.workspace.TargetsApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of workspace Show documentation
Show all versions of workspace Show documentation
A Java library to interface to Genesys Workspace public API
package com.genesys.workspace;
import com.genesys.internal.common.ApiClient;
import com.genesys.internal.common.ApiException;
import com.genesys.internal.common.ApiResponse;
import com.genesys.internal.common.StringUtil;
import com.genesys.workspace.models.targets.TargetsSearchOptions;
import com.genesys.internal.workspace.model.ApiSuccessResponse;
import com.genesys.internal.workspace.model.PersonalFavoriteData;
import com.genesys.internal.workspace.model.RecentData;
import com.genesys.internal.workspace.model.RecentTargetData;
import com.genesys.internal.workspace.model.TargetsResponse;
import com.genesys.internal.workspace.model.TargetsResponseData;
import com.genesys.internal.workspace.model.TargetInformation;
import com.genesys.internal.workspace.model.TargetspersonalfavoritessaveData;
import com.genesys.internal.workspace.model.TargetsrecentsaddData;
import com.genesys.workspace.common.WorkspaceApiException;
import com.genesys.workspace.models.targets.AgentTarget;
import com.genesys.workspace.models.targets.Target;
import com.genesys.workspace.models.targets.SearchResult;
import com.genesys.workspace.models.targets.TargetType;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
public class TargetsApi {
private com.genesys.internal.workspace.api.TargetsApi targetsApi;
void initialize(ApiClient client) {
this.targetsApi = new com.genesys.internal.workspace.api.TargetsApi(client);
}
void setTargetsApi(com.genesys.internal.workspace.api.TargetsApi targetsApi) {
this.targetsApi = targetsApi;
}
/**
* Search for targets by the specified search term.
* @param searchTerm The text to search for in targets.
* @return SearchResult
*/
public SearchResult search(String searchTerm) throws WorkspaceApiException {
return search(searchTerm, new TargetsSearchOptions());
}
/**
* Search for targets by the specified search term.
* @param searchTerm The text to search for in targets.
* @param options Options used to refine the search. (optional)
* @return SearchResult
*/
public SearchResult search(String searchTerm, TargetsSearchOptions options) throws WorkspaceApiException {
try {
String types = null;
List typesArray = null;
if(options.getTypes() != null){
typesArray = new ArrayList<>(10);
for(TargetType targetType: options.getTypes()){
typesArray.add(targetType.getValue());
}
types = StringUtil.join(typesArray.toArray(new String[typesArray.size()]),",");
}
String excludeGroups = options.getExcludeGroups() !=null? StringUtil.join(options.getExcludeGroups(),","):null;
String excludeFromGroups = options.getExcludeFromGroups() !=null? StringUtil.join(options.getExcludeFromGroups(),","): null;
String restrictToGroups = options.getRestrictToGroups() !=null? StringUtil.join (options.getRestrictToGroups(),","): null;
TargetsResponse response = this.targetsApi.get(searchTerm,
options.getFilterName(),
types,
excludeGroups,
excludeFromGroups,
restrictToGroups,
options.isDesc()? "desc": null,
options.getLimit() < 1? null: new BigDecimal(options.getLimit()),
options.isExact()? "exact": null);
TargetsResponseData data = response.getData();
List targets = new ArrayList<>();
if (data.getTargets() != null) {
for (com.genesys.internal.workspace.model.Target t : data.getTargets()) {
Target target = Target.fromTarget(t);
targets.add(target);
}
}
return new SearchResult<>(data.getTotalMatches(), targets);
} catch (ApiException e) {
throw new WorkspaceApiException("searchTargets failed.", e);
}
}
/**
* Add a target that was recently used.
* @param target The target to add.
* @param media The media channel on which the target was used.
*/
public void addRecentTarget(Target target, String media) throws WorkspaceApiException {
addRecentTarget(target,media,System.currentTimeMillis());
}
/**
* Add a target that was recently used.
* @param target The target to add.
* @param media The media channel the where the target was recently used.
* @param timestamp The timestamp for when the target was used. This value should be a number representing the
* milliseconds elapsed since the UNIX epoch. (optional)
*/
public void addRecentTarget(Target target, String media, long timestamp) throws WorkspaceApiException {
try {
TargetsrecentsaddData data = new TargetsrecentsaddData();
data.setTarget(toInformation(target));
RecentData recentData = new RecentData();
recentData.setMedia(media);
recentData.setTimeStamp(new BigDecimal(timestamp));
data.setRecentInformation(recentData);
RecentTargetData recentTargetData = new RecentTargetData();
recentTargetData.setData(data);
ApiSuccessResponse resp = targetsApi.addRecentTarget(recentTargetData);
Util.throwIfNotOk(resp);
}
catch(ApiException ex) {
throw new WorkspaceApiException("Cannot add recent target", ex);
}
}
private TargetInformation toInformation(Target target) {
TargetInformation information = new TargetInformation();
if(target instanceof AgentTarget) {
information.setFirstName(((AgentTarget)target).getFirstName());
information.setLastName(((AgentTarget)target).getLastName());
information.setEmailAddresses(Arrays.asList(((AgentTarget)target).getEmailAddress()));
}
information.setNumbers(Arrays.asList(target.getNumber()));
information.setType(target.getType().getValue());
return information;
}
/**
* Get a user's recently used targets.
* @return SearchResult
*/
public SearchResult getRecentTargets() throws WorkspaceApiException {
return getRecentTargets(0);
}
/**
* Get a user's recently used targets.
* @param limit Specify the number of results to return. The default value is 50. (optional)
* @return SearchResult
*/
public SearchResult getRecentTargets(int limit) throws WorkspaceApiException {
try {
TargetsResponse resp = targetsApi.getRecentTargets(limit > 0? new BigDecimal(limit): null);
Util.throwIfNotOk(resp.getStatus());
TargetsResponseData data = resp.getData();
int total = 0;
List list = new ArrayList<>();
if(data != null) {
total = data.getTotalMatches();
if(data.getTargets() != null) {
for (com.genesys.internal.workspace.model.Target t : data.getTargets()) {
Target target = Target.fromTarget(t);
list.add(target);
}
}
}
return new SearchResult<>(total, list);
}
catch(ApiException ex) {
throw new WorkspaceApiException("Cannot get recent targets", ex);
}
}
/**
* Get a specific target by ID and type.
* @param id The ID for the target.
* @param type The type of target to retrieve. The possible values are AGENT, AGENT_GROUP, ACD_QUEUE,
* ROUTE_POINT, SKILL, and CUSTOM_CONTACT.
* @return Target
*/
public Target getTarget(long id, TargetType type) throws WorkspaceApiException {
try {
TargetsResponse resp = targetsApi.getTarget(new BigDecimal(id), type.getValue());
Util.throwIfNotOk(resp.getStatus());
Target target = null;
if(resp.getData() != null) {
List targets = resp.getData().getTargets();
if(targets != null && targets.size() > 0) {
target = Target.fromTarget(targets.get(0));
}
}
return target;
}
catch(ApiException ex) {
throw new WorkspaceApiException("Cannot get target", ex);
}
}
/**
* Delete the target from the user's personal favorites.
* @param target The target to delete.
*/
public void deletePersonalFavorite(Target target) throws WorkspaceApiException {
try {
ApiSuccessResponse resp = targetsApi.deletePersonalFavorite(String.valueOf(target.getId()), target.getType().getValue());
Util.throwIfNotOk(resp);
}
catch(ApiException ex) {
throw new WorkspaceApiException("Cannot delete personal favorite", ex);
}
}
/**
* Return the user's personal favorites.
* @return SearchResult
*/
public SearchResult getPersonalFavorites() throws WorkspaceApiException {
return getPersonalFavorites(0);
}
/**
* Return the user's personal favorites.
* @param limit Specify the number of results to return. The default value is 50. (optional)
* @return SearchResult
*/
public SearchResult getPersonalFavorites(int limit) throws WorkspaceApiException {
try {
TargetsResponse resp = targetsApi.getPersonalFavorites(limit > 0? new BigDecimal(limit): null);
Util.throwIfNotOk(resp.getStatus());
TargetsResponseData data = resp.getData();
int total = 0;
List list = new ArrayList<>();
if(data != null) {
total = data.getTotalMatches();
if(data.getTargets() != null) {
for (com.genesys.internal.workspace.model.Target t : data.getTargets()) {
Target target = Target.fromTarget(t);
list.add(target);
}
}
}
return new SearchResult<>(total, list);
}
catch(ApiException ex) {
throw new WorkspaceApiException("Cannot personal favorites", ex);
}
}
/**
* Save a target to the user's personal favorites in the specified category.
* @param target The target to save.
* @param category The user's personal favorites category.
*/
public void savePersonalFavorite(Target target, String category) throws WorkspaceApiException {
TargetspersonalfavoritessaveData data = new TargetspersonalfavoritessaveData();
data.setCategory(category);
data.setTarget(toInformation(target));
PersonalFavoriteData favData = new PersonalFavoriteData();
favData.setData(data);
try {
ApiSuccessResponse resp = targetsApi.savePersonalFavorite(favData);
Util.throwIfNotOk(resp);
}
catch(ApiException ex) {
throw new WorkspaceApiException("Cannot save personal favorites", ex);
}
}
/**
* Acknowledge missed calls in the list of recent targets.
*/
public void ackRecentMissedCalls() throws WorkspaceApiException {
try {
ApiSuccessResponse resp = targetsApi.ackRecentMissedCalls();
Util.throwIfNotOk(resp);
}
catch(ApiException ex) {
throw new WorkspaceApiException("Cannot ack recent missed calls", ex);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy