Package com.mypurecloud.sdk.v2.api

Class TeamsApi

java.lang.Object

com.mypurecloud.sdk.v2.api.TeamsApi

public class TeamsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
TeamsApi()
TeamsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteTeam(DeleteTeamRequest request)	Delete team
ApiResponse<Void>	deleteTeam(ApiRequest<Void> request)	Delete team
void	deleteTeam(String teamId)	Delete team
void	deleteTeamMembers(DeleteTeamMembersRequest request)	Delete team members
ApiResponse<Void>	deleteTeamMembers(ApiRequest<Void> request)	Delete team members
void	deleteTeamMembers(String teamId, String id)	Delete team members
ApiResponse<Void>	deleteTeamMembersWithHttpInfo(String teamId, String id)	Delete team members
ApiResponse<Void>	deleteTeamWithHttpInfo(String teamId)	Delete team
Team	getTeam(GetTeamRequest request)	Get team
ApiResponse<Team>	getTeam(ApiRequest<Void> request)	Get team
Team	getTeam(String teamId, String expand)	Get team
TeamMemberEntityListing	getTeamMembers(GetTeamMembersRequest request)	Get team membership
ApiResponse<TeamMemberEntityListing>	getTeamMembers(ApiRequest<Void> request)	Get team membership
TeamMemberEntityListing	getTeamMembers(String teamId, Integer pageSize, String before, String after, String expand)	Get team membership
ApiResponse<TeamMemberEntityListing>	getTeamMembersWithHttpInfo(String teamId, Integer pageSize, String before, String after, String expand)	Get team membership
TeamEntityListing	getTeams(GetTeamsRequest request)	Get Team listing
ApiResponse<TeamEntityListing>	getTeams(ApiRequest<Void> request)	Get Team listing
TeamEntityListing	getTeams(Integer pageSize, String name, String after, String before, String expand)	Get Team listing
ApiResponse<TeamEntityListing>	getTeamsWithHttpInfo(Integer pageSize, String name, String after, String before, String expand)	Get Team listing
ApiResponse<Team>	getTeamWithHttpInfo(String teamId, String expand)	Get team
Team	patchTeam(PatchTeamRequest request)	Update team
ApiResponse<Team>	patchTeam(ApiRequest<Team> request)	Update team
Team	patchTeam(String teamId, Team body)	Update team
ApiResponse<Team>	patchTeamWithHttpInfo(String teamId, Team body)	Update team
TeamActivityResponse	postAnalyticsTeamsActivityQuery(PostAnalyticsTeamsActivityQueryRequest request)	Query for team activity observations
ApiResponse<TeamActivityResponse>	postAnalyticsTeamsActivityQuery(ApiRequest<TeamActivityQuery> request)	Query for team activity observations
TeamActivityResponse	postAnalyticsTeamsActivityQuery(TeamActivityQuery body, Integer pageSize, Integer pageNumber)	Query for team activity observations
ApiResponse<TeamActivityResponse>	postAnalyticsTeamsActivityQueryWithHttpInfo(TeamActivityQuery body, Integer pageSize, Integer pageNumber)	Query for team activity observations
TeamMemberAddListingResponse	postTeamMembers(PostTeamMembersRequest request)	Add team members
ApiResponse<TeamMemberAddListingResponse>	postTeamMembers(ApiRequest<TeamMembers> request)	Add team members
TeamMemberAddListingResponse	postTeamMembers(String teamId, TeamMembers body)	Add team members
ApiResponse<TeamMemberAddListingResponse>	postTeamMembersWithHttpInfo(String teamId, TeamMembers body)	Add team members
Team	postTeams(PostTeamsRequest request)	Create a team
ApiResponse<Team>	postTeams(ApiRequest<Team> request)	Create a team
Team	postTeams(Team body)	Create a team
TeamsSearchResponse	postTeamsSearch(PostTeamsSearchRequest request)	Search resources.
ApiResponse<TeamsSearchResponse>	postTeamsSearch(ApiRequest<TeamSearchRequest> request)	Search resources.
TeamsSearchResponse	postTeamsSearch(TeamSearchRequest body)	Search resources.
ApiResponse<TeamsSearchResponse>	postTeamsSearchWithHttpInfo(TeamSearchRequest body)	Search resources.
ApiResponse<Team>	postTeamsWithHttpInfo(Team body)	Create a team

Methods inherited from class java.lang.Object

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

Constructor Details

TeamsApi

public TeamsApi()

TeamsApi

public TeamsApi(ApiClient apiClient)

Method Details

deleteTeam

public void deleteTeam(String teamId)
                throws IOException,
ApiException

Delete team

Parameters:

teamId - Team ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteTeamWithHttpInfo

public ApiResponse<Void> deleteTeamWithHttpInfo(String teamId)
                                         throws IOException

Delete team

Parameters:

teamId - Team ID (required)

Throws:

IOException - if the request fails to be processed

deleteTeam

public void deleteTeam(DeleteTeamRequest request)
                throws IOException,
ApiException

Delete team

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteTeam

public ApiResponse<Void> deleteTeam(ApiRequest<Void> request)
                             throws IOException

Delete team

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteTeamMembers

public void deleteTeamMembers(String teamId,
 String id)
                       throws IOException,
ApiException

Delete team members

Parameters:

teamId - Team ID (required)

id - Comma separated list of member ids to remove (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteTeamMembersWithHttpInfo

public ApiResponse<Void> deleteTeamMembersWithHttpInfo(String teamId,
 String id)
                                                throws IOException

Delete team members

Parameters:

teamId - Team ID (required)

id - Comma separated list of member ids to remove (required)

Throws:

IOException - if the request fails to be processed

deleteTeamMembers

public void deleteTeamMembers(DeleteTeamMembersRequest request)
                       throws IOException,
ApiException

Delete team members

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteTeamMembers

public ApiResponse<Void> deleteTeamMembers(ApiRequest<Void> request)
                                    throws IOException

Delete team members

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getTeam

public Team getTeam(String teamId,
 String expand)
             throws IOException,
ApiException

Get team

Parameters:

teamId - Team ID (required)

expand - Expand the division name (optional)

Returns:

Team

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getTeamWithHttpInfo

public ApiResponse<Team> getTeamWithHttpInfo(String teamId,
 String expand)
                                      throws IOException

Get team

Parameters:

teamId - Team ID (required)

expand - Expand the division name (optional)

Returns:

Team

Throws:

IOException - if the request fails to be processed

getTeam

public Team getTeam(GetTeamRequest request)
             throws IOException,
ApiException

Get team

Parameters:

request - The request object

Returns:

Team

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getTeam

public ApiResponse<Team> getTeam(ApiRequest<Void> request)
                          throws IOException

Get team

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getTeamMembers

public TeamMemberEntityListing getTeamMembers(String teamId,
 Integer pageSize,
 String before,
 String after,
 String expand)
                                       throws IOException,
ApiException

Get team membership

Parameters:

teamId - Team ID (required)

pageSize - Page size (optional, default to 25)

before - The cursor that points to the previous item in the complete list of teams (optional)

after - The cursor that points to the next item in the complete list of teams (optional)

expand - Expand the name on each user (optional)

Returns:

TeamMemberEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getTeamMembersWithHttpInfo

public ApiResponse<TeamMemberEntityListing> getTeamMembersWithHttpInfo(String teamId,
 Integer pageSize,
 String before,
 String after,
 String expand)
                                                                throws IOException

Get team membership

Parameters:

teamId - Team ID (required)

pageSize - Page size (optional, default to 25)

before - The cursor that points to the previous item in the complete list of teams (optional)

after - The cursor that points to the next item in the complete list of teams (optional)

expand - Expand the name on each user (optional)

Returns:

TeamMemberEntityListing

Throws:

IOException - if the request fails to be processed

getTeamMembers

public TeamMemberEntityListing getTeamMembers(GetTeamMembersRequest request)
                                       throws IOException,
ApiException

Get team membership

Parameters:

request - The request object

Returns:

TeamMemberEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getTeamMembers

public ApiResponse<TeamMemberEntityListing> getTeamMembers(ApiRequest<Void> request)
                                                    throws IOException

Get team membership

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getTeams

public TeamEntityListing getTeams(Integer pageSize,
 String name,
 String after,
 String before,
 String expand)
                           throws IOException,
ApiException

Get Team listing

Parameters:

pageSize - Page size (optional, default to 25)

name - Return only teams whose names start with this value (case-insensitive matching) (optional)

after - The cursor that points to the next item in the complete list of teams (optional)

before - The cursor that points to the previous item in the complete list of teams (optional)

expand - Expand the division on each team (optional)

Returns:

TeamEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getTeamsWithHttpInfo

public ApiResponse<TeamEntityListing> getTeamsWithHttpInfo(Integer pageSize,
 String name,
 String after,
 String before,
 String expand)
                                                    throws IOException

Get Team listing

Parameters:

pageSize - Page size (optional, default to 25)

name - Return only teams whose names start with this value (case-insensitive matching) (optional)

after - The cursor that points to the next item in the complete list of teams (optional)

before - The cursor that points to the previous item in the complete list of teams (optional)

expand - Expand the division on each team (optional)

Returns:

TeamEntityListing

Throws:

IOException - if the request fails to be processed

getTeams

public TeamEntityListing getTeams(GetTeamsRequest request)
                           throws IOException,
ApiException

Get Team listing

Parameters:

request - The request object

Returns:

TeamEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getTeams

public ApiResponse<TeamEntityListing> getTeams(ApiRequest<Void> request)
                                        throws IOException

Get Team listing

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchTeam

public Team patchTeam(String teamId,
 Team body)
               throws IOException,
ApiException

Update team

Parameters:

teamId - Team ID (required)

body - Team (required)

Returns:

Team

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchTeamWithHttpInfo

public ApiResponse<Team> patchTeamWithHttpInfo(String teamId,
 Team body)
                                        throws IOException

Update team

Parameters:

teamId - Team ID (required)

body - Team (required)

Returns:

Team

Throws:

IOException - if the request fails to be processed

patchTeam

public Team patchTeam(PatchTeamRequest request)
               throws IOException,
ApiException

Update team

Parameters:

request - The request object

Returns:

Team

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchTeam

public ApiResponse<Team> patchTeam(ApiRequest<Team> request)
                            throws IOException

Update team

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAnalyticsTeamsActivityQuery

public TeamActivityResponse postAnalyticsTeamsActivityQuery(TeamActivityQuery body,
 Integer pageSize,
 Integer pageNumber)
                                                     throws IOException,
ApiException

Query for team activity observations

Parameters:

body - query (required)

pageSize - The desired page size (optional)

pageNumber - The desired page number (optional)

Returns:

TeamActivityResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsTeamsActivityQueryWithHttpInfo

public ApiResponse<TeamActivityResponse> postAnalyticsTeamsActivityQueryWithHttpInfo(TeamActivityQuery body,
 Integer pageSize,
 Integer pageNumber)
                                                                              throws IOException

Query for team activity observations

Parameters:

body - query (required)

pageSize - The desired page size (optional)

pageNumber - The desired page number (optional)

Returns:

TeamActivityResponse

Throws:

IOException - if the request fails to be processed

postAnalyticsTeamsActivityQuery

public TeamActivityResponse postAnalyticsTeamsActivityQuery(PostAnalyticsTeamsActivityQueryRequest request)
                                                     throws IOException,
ApiException

Query for team activity observations

Parameters:

request - The request object

Returns:

TeamActivityResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsTeamsActivityQuery

public ApiResponse<TeamActivityResponse> postAnalyticsTeamsActivityQuery(ApiRequest<TeamActivityQuery> request)
                                                                  throws IOException

Query for team activity observations

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postTeamMembers

public TeamMemberAddListingResponse postTeamMembers(String teamId,
 TeamMembers body)
                                             throws IOException,
ApiException

Add team members

Parameters:

teamId - Team ID (required)

body - TeamMembers (required)

Returns:

TeamMemberAddListingResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postTeamMembersWithHttpInfo

public ApiResponse<TeamMemberAddListingResponse> postTeamMembersWithHttpInfo(String teamId,
 TeamMembers body)
                                                                      throws IOException

Add team members

Parameters:

teamId - Team ID (required)

body - TeamMembers (required)

Returns:

TeamMemberAddListingResponse

Throws:

IOException - if the request fails to be processed

postTeamMembers

public TeamMemberAddListingResponse postTeamMembers(PostTeamMembersRequest request)
                                             throws IOException,
ApiException

Add team members

Parameters:

request - The request object

Returns:

TeamMemberAddListingResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postTeamMembers

public ApiResponse<TeamMemberAddListingResponse> postTeamMembers(ApiRequest<TeamMembers> request)
                                                          throws IOException

Add team members

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postTeams

public Team postTeams(Team body)
               throws IOException,
ApiException

Create a team

Parameters:

body - Team (required)

Returns:

Team

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postTeamsWithHttpInfo

public ApiResponse<Team> postTeamsWithHttpInfo(Team body)
                                        throws IOException

Create a team

Parameters:

body - Team (required)

Returns:

Team

Throws:

IOException - if the request fails to be processed

postTeams

public Team postTeams(PostTeamsRequest request)
               throws IOException,
ApiException

Create a team

Parameters:

request - The request object

Returns:

Team

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postTeams

public ApiResponse<Team> postTeams(ApiRequest<Team> request)
                            throws IOException

Create a team

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postTeamsSearch

public TeamsSearchResponse postTeamsSearch(TeamSearchRequest body)
                                    throws IOException,
ApiException

Search resources.

Parameters:

body - Search request options (required)

Returns:

TeamsSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postTeamsSearchWithHttpInfo

public ApiResponse<TeamsSearchResponse> postTeamsSearchWithHttpInfo(TeamSearchRequest body)
                                                             throws IOException

Search resources.

Parameters:

body - Search request options (required)

Returns:

TeamsSearchResponse

Throws:

IOException - if the request fails to be processed

postTeamsSearch

public TeamsSearchResponse postTeamsSearch(PostTeamsSearchRequest request)
                                    throws IOException,
ApiException

Search resources.

Parameters:

request - The request object

Returns:

TeamsSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postTeamsSearch

public ApiResponse<TeamsSearchResponse> postTeamsSearch(ApiRequest<TeamSearchRequest> request)
                                                 throws IOException

Search resources.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed