Package com.mypurecloud.sdk.v2.api

Class LocationsApi

java.lang.Object

com.mypurecloud.sdk.v2.api.LocationsApi

public class LocationsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
LocationsApi()
LocationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteLocation(DeleteLocationRequest request)	Delete a location
ApiResponse<Void>	deleteLocation(ApiRequest<Void> request)	Delete a location
void	deleteLocation(String locationId)	Delete a location
ApiResponse<Void>	deleteLocationWithHttpInfo(String locationId)	Delete a location
LocationDefinition	getLocation(GetLocationRequest request)	Get Location by ID.
ApiResponse<LocationDefinition>	getLocation(ApiRequest<Void> request)	Get Location by ID.
LocationDefinition	getLocation(String locationId, List<String> expand)	Get Location by ID.
LocationEntityListing	getLocations(GetLocationsRequest request)	Get a list of all locations.
ApiResponse<LocationEntityListing>	getLocations(ApiRequest<Void> request)	Get a list of all locations.
LocationEntityListing	getLocations(Integer pageSize, Integer pageNumber, List<String> id, String sortOrder)	Get a list of all locations.
LocationsSearchResponse	getLocationsSearch(GetLocationsSearchRequest request)	Search locations using the q64 value returned from a previous search
ApiResponse<LocationsSearchResponse>	getLocationsSearch(ApiRequest<Void> request)	Search locations using the q64 value returned from a previous search
LocationsSearchResponse	getLocationsSearch(String q64, List<String> expand)	Search locations using the q64 value returned from a previous search
ApiResponse<LocationsSearchResponse>	getLocationsSearchWithHttpInfo(String q64, List<String> expand)	Search locations using the q64 value returned from a previous search
LocationEntityListing	getLocationSublocations(GetLocationSublocationsRequest request)	Get sublocations for location ID.
ApiResponse<LocationEntityListing>	getLocationSublocations(ApiRequest<Void> request)	Get sublocations for location ID.
LocationEntityListing	getLocationSublocations(String locationId)	Get sublocations for location ID.
ApiResponse<LocationEntityListing>	getLocationSublocationsWithHttpInfo(String locationId)	Get sublocations for location ID.
ApiResponse<LocationEntityListing>	getLocationsWithHttpInfo(Integer pageSize, Integer pageNumber, List<String> id, String sortOrder)	Get a list of all locations.
ApiResponse<LocationDefinition>	getLocationWithHttpInfo(String locationId, List<String> expand)	Get Location by ID.
LocationDefinition	patchLocation(PatchLocationRequest request)	Update a location
ApiResponse<LocationDefinition>	patchLocation(ApiRequest<LocationUpdateDefinition> request)	Update a location
LocationDefinition	patchLocation(String locationId, LocationUpdateDefinition body)	Update a location
ApiResponse<LocationDefinition>	patchLocationWithHttpInfo(String locationId, LocationUpdateDefinition body)	Update a location
LocationDefinition	postLocations(PostLocationsRequest request)	Create a location
ApiResponse<LocationDefinition>	postLocations(ApiRequest<LocationCreateDefinition> request)	Create a location
LocationDefinition	postLocations(LocationCreateDefinition body)	Create a location
LocationsSearchResponse	postLocationsSearch(PostLocationsSearchRequest request)	Search locations
ApiResponse<LocationsSearchResponse>	postLocationsSearch(ApiRequest<LocationSearchRequest> request)	Search locations
LocationsSearchResponse	postLocationsSearch(LocationSearchRequest body)	Search locations
ApiResponse<LocationsSearchResponse>	postLocationsSearchWithHttpInfo(LocationSearchRequest body)	Search locations
ApiResponse<LocationDefinition>	postLocationsWithHttpInfo(LocationCreateDefinition body)	Create a location

Methods inherited from class java.lang.Object

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

Constructor Details

LocationsApi

public LocationsApi()

LocationsApi

public LocationsApi(ApiClient apiClient)

Method Details

deleteLocation

public void deleteLocation(String locationId)
                    throws IOException,
ApiException

Delete a location

Parameters:

locationId - Location ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteLocationWithHttpInfo

public ApiResponse<Void> deleteLocationWithHttpInfo(String locationId)
                                             throws IOException

Delete a location

Parameters:

locationId - Location ID (required)

Throws:

IOException - if the request fails to be processed

deleteLocation

public void deleteLocation(DeleteLocationRequest request)
                    throws IOException,
ApiException

Delete a location

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteLocation

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

Delete a location

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getLocation

public LocationDefinition getLocation(String locationId,
 List<String> expand)
                               throws IOException,
ApiException

Get Location by ID.

Parameters:

locationId - Location ID (required)

expand - Which fields, if any, to expand (optional)

Returns:

LocationDefinition

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getLocationWithHttpInfo

public ApiResponse<LocationDefinition> getLocationWithHttpInfo(String locationId,
 List<String> expand)
                                                        throws IOException

Get Location by ID.

Parameters:

locationId - Location ID (required)

expand - Which fields, if any, to expand (optional)

Returns:

LocationDefinition

Throws:

IOException - if the request fails to be processed

getLocation

public LocationDefinition getLocation(GetLocationRequest request)
                               throws IOException,
ApiException

Get Location by ID.

Parameters:

request - The request object

Returns:

LocationDefinition

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getLocation

public ApiResponse<LocationDefinition> getLocation(ApiRequest<Void> request)
                                            throws IOException

Get Location by ID.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getLocationSublocations

public LocationEntityListing getLocationSublocations(String locationId)
                                              throws IOException,
ApiException

Get sublocations for location ID.

Parameters:

locationId - Location ID (required)

Returns:

LocationEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getLocationSublocationsWithHttpInfo

public ApiResponse<LocationEntityListing> getLocationSublocationsWithHttpInfo(String locationId)
                                                                       throws IOException

Get sublocations for location ID.

Parameters:

locationId - Location ID (required)

Returns:

LocationEntityListing

Throws:

IOException - if the request fails to be processed

getLocationSublocations

public LocationEntityListing getLocationSublocations(GetLocationSublocationsRequest request)
                                              throws IOException,
ApiException

Get sublocations for location ID.

Parameters:

request - The request object

Returns:

LocationEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getLocationSublocations

public ApiResponse<LocationEntityListing> getLocationSublocations(ApiRequest<Void> request)
                                                           throws IOException

Get sublocations for location ID.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getLocations

public LocationEntityListing getLocations(Integer pageSize,
 Integer pageNumber,
 List<String> id,
 String sortOrder)
                                   throws IOException,
ApiException

Get a list of all locations.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

id - id (optional)

sortOrder - Sort order (optional)

Returns:

LocationEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getLocationsWithHttpInfo

public ApiResponse<LocationEntityListing> getLocationsWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 List<String> id,
 String sortOrder)
                                                            throws IOException

Get a list of all locations.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

id - id (optional)

sortOrder - Sort order (optional)

Returns:

LocationEntityListing

Throws:

IOException - if the request fails to be processed

getLocations

public LocationEntityListing getLocations(GetLocationsRequest request)
                                   throws IOException,
ApiException

Get a list of all locations.

Parameters:

request - The request object

Returns:

LocationEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getLocations

public ApiResponse<LocationEntityListing> getLocations(ApiRequest<Void> request)
                                                throws IOException

Get a list of all locations.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getLocationsSearch

public LocationsSearchResponse getLocationsSearch(String q64,
 List<String> expand)
                                           throws IOException,
ApiException

Search locations using the q64 value returned from a previous search

Parameters:

q64 - q64 (required)

expand - Provides more details about a specified resource (optional)

Returns:

LocationsSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getLocationsSearchWithHttpInfo

public ApiResponse<LocationsSearchResponse> getLocationsSearchWithHttpInfo(String q64,
 List<String> expand)
                                                                    throws IOException

Search locations using the q64 value returned from a previous search

Parameters:

q64 - q64 (required)

expand - Provides more details about a specified resource (optional)

Returns:

LocationsSearchResponse

Throws:

IOException - if the request fails to be processed

getLocationsSearch

public LocationsSearchResponse getLocationsSearch(GetLocationsSearchRequest request)
                                           throws IOException,
ApiException

Search locations using the q64 value returned from a previous search

Parameters:

request - The request object

Returns:

LocationsSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getLocationsSearch

public ApiResponse<LocationsSearchResponse> getLocationsSearch(ApiRequest<Void> request)
                                                        throws IOException

Search locations using the q64 value returned from a previous search

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchLocation

public LocationDefinition patchLocation(String locationId,
 LocationUpdateDefinition body)
                                 throws IOException,
ApiException

Update a location

Parameters:

locationId - Location ID (required)

body - Location (required)

Returns:

LocationDefinition

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchLocationWithHttpInfo

public ApiResponse<LocationDefinition> patchLocationWithHttpInfo(String locationId,
 LocationUpdateDefinition body)
                                                          throws IOException

Update a location

Parameters:

locationId - Location ID (required)

body - Location (required)

Returns:

LocationDefinition

Throws:

IOException - if the request fails to be processed

patchLocation

public LocationDefinition patchLocation(PatchLocationRequest request)
                                 throws IOException,
ApiException

Update a location

Parameters:

request - The request object

Returns:

LocationDefinition

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchLocation

public ApiResponse<LocationDefinition> patchLocation(ApiRequest<LocationUpdateDefinition> request)
                                              throws IOException

Update a location

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postLocations

public LocationDefinition postLocations(LocationCreateDefinition body)
                                 throws IOException,
ApiException

Create a location

Parameters:

body - Location (required)

Returns:

LocationDefinition

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postLocationsWithHttpInfo

public ApiResponse<LocationDefinition> postLocationsWithHttpInfo(LocationCreateDefinition body)
                                                          throws IOException

Create a location

Parameters:

body - Location (required)

Returns:

LocationDefinition

Throws:

IOException - if the request fails to be processed

postLocations

public LocationDefinition postLocations(PostLocationsRequest request)
                                 throws IOException,
ApiException

Create a location

Parameters:

request - The request object

Returns:

LocationDefinition

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postLocations

public ApiResponse<LocationDefinition> postLocations(ApiRequest<LocationCreateDefinition> request)
                                              throws IOException

Create a location

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postLocationsSearch

public LocationsSearchResponse postLocationsSearch(LocationSearchRequest body)
                                            throws IOException,
ApiException

Search locations

Parameters:

body - Search request options (required)

Returns:

LocationsSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postLocationsSearchWithHttpInfo

public ApiResponse<LocationsSearchResponse> postLocationsSearchWithHttpInfo(LocationSearchRequest body)
                                                                     throws IOException

Search locations

Parameters:

body - Search request options (required)

Returns:

LocationsSearchResponse

Throws:

IOException - if the request fails to be processed

postLocationsSearch

public LocationsSearchResponse postLocationsSearch(PostLocationsSearchRequest request)
                                            throws IOException,
ApiException

Search locations

Parameters:

request - The request object

Returns:

LocationsSearchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postLocationsSearch

public ApiResponse<LocationsSearchResponse> postLocationsSearch(ApiRequest<LocationSearchRequest> request)
                                                         throws IOException

Search locations

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed