Package com.mypurecloud.sdk.v2.api

Class MobileDevicesApi

java.lang.Object

com.mypurecloud.sdk.v2.api.MobileDevicesApi

public class MobileDevicesApi
extends Object

Constructor Summary

Constructors

Constructor	Description
MobileDevicesApi()
MobileDevicesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteMobiledevice(DeleteMobiledeviceRequest request)	Delete device
ApiResponse<Void>	deleteMobiledevice(ApiRequest<Void> request)	Delete device
void	deleteMobiledevice(String deviceId)	Delete device
ApiResponse<Void>	deleteMobiledeviceWithHttpInfo(String deviceId)	Delete device
UserDevice	getMobiledevice(GetMobiledeviceRequest request)	Get device
ApiResponse<UserDevice>	getMobiledevice(ApiRequest<Void> request)	Get device
UserDevice	getMobiledevice(String deviceId)	Get device
DirectoryUserDevicesListing	getMobiledevices(GetMobiledevicesRequest request)	Get a list of all devices.
ApiResponse<DirectoryUserDevicesListing>	getMobiledevices(ApiRequest<Void> request)	Get a list of all devices.
DirectoryUserDevicesListing	getMobiledevices(Integer pageSize, Integer pageNumber, String sortOrder)	Get a list of all devices.
ApiResponse<DirectoryUserDevicesListing>	getMobiledevicesWithHttpInfo(Integer pageSize, Integer pageNumber, String sortOrder)	Get a list of all devices.
ApiResponse<UserDevice>	getMobiledeviceWithHttpInfo(String deviceId)	Get device
UserDevice	postMobiledevices(PostMobiledevicesRequest request)	Create User device
ApiResponse<UserDevice>	postMobiledevices(ApiRequest<UserDevice> request)	Create User device
UserDevice	postMobiledevices(UserDevice body)	Create User device
ApiResponse<UserDevice>	postMobiledevicesWithHttpInfo(UserDevice body)	Create User device
UserDevice	putMobiledevice(PutMobiledeviceRequest request)	Update device
ApiResponse<UserDevice>	putMobiledevice(ApiRequest<UserDevice> request)	Update device
UserDevice	putMobiledevice(String deviceId, UserDevice body)	Update device
ApiResponse<UserDevice>	putMobiledeviceWithHttpInfo(String deviceId, UserDevice body)	Update device

Methods inherited from class java.lang.Object

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

Constructor Details

MobileDevicesApi

public MobileDevicesApi()

MobileDevicesApi

public MobileDevicesApi(ApiClient apiClient)

Method Details

deleteMobiledevice

public void deleteMobiledevice(String deviceId)
                        throws IOException,
ApiException

Delete device

Parameters:

deviceId - Device ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteMobiledeviceWithHttpInfo

public ApiResponse<Void> deleteMobiledeviceWithHttpInfo(String deviceId)
                                                 throws IOException

Delete device

Parameters:

deviceId - Device ID (required)

Throws:

IOException - if the request fails to be processed

deleteMobiledevice

public void deleteMobiledevice(DeleteMobiledeviceRequest request)
                        throws IOException,
ApiException

Delete device

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteMobiledevice

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

Delete device

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getMobiledevice

public UserDevice getMobiledevice(String deviceId)
                           throws IOException,
ApiException

Get device

Parameters:

deviceId - Device ID (required)

Returns:

UserDevice

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getMobiledeviceWithHttpInfo

public ApiResponse<UserDevice> getMobiledeviceWithHttpInfo(String deviceId)
                                                    throws IOException

Get device

Parameters:

deviceId - Device ID (required)

Returns:

UserDevice

Throws:

IOException - if the request fails to be processed

getMobiledevice

public UserDevice getMobiledevice(GetMobiledeviceRequest request)
                           throws IOException,
ApiException

Get device

Parameters:

request - The request object

Returns:

UserDevice

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getMobiledevice

public ApiResponse<UserDevice> getMobiledevice(ApiRequest<Void> request)
                                        throws IOException

Get device

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getMobiledevices

public DirectoryUserDevicesListing getMobiledevices(Integer pageSize,
 Integer pageNumber,
 String sortOrder)
                                             throws IOException,
ApiException

Get a list of all devices.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

sortOrder - Ascending or descending sort order (optional, default to ascending)

Returns:

DirectoryUserDevicesListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getMobiledevicesWithHttpInfo

public ApiResponse<DirectoryUserDevicesListing> getMobiledevicesWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String sortOrder)
                                                                      throws IOException

Get a list of all devices.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

sortOrder - Ascending or descending sort order (optional, default to ascending)

Returns:

DirectoryUserDevicesListing

Throws:

IOException - if the request fails to be processed

getMobiledevices

public DirectoryUserDevicesListing getMobiledevices(GetMobiledevicesRequest request)
                                             throws IOException,
ApiException

Get a list of all devices.

Parameters:

request - The request object

Returns:

DirectoryUserDevicesListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getMobiledevices

public ApiResponse<DirectoryUserDevicesListing> getMobiledevices(ApiRequest<Void> request)
                                                          throws IOException

Get a list of all devices.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postMobiledevices

public UserDevice postMobiledevices(UserDevice body)
                             throws IOException,
ApiException

Create User device

Parameters:

body - Device (required)

Returns:

UserDevice

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postMobiledevicesWithHttpInfo

public ApiResponse<UserDevice> postMobiledevicesWithHttpInfo(UserDevice body)
                                                      throws IOException

Create User device

Parameters:

body - Device (required)

Returns:

UserDevice

Throws:

IOException - if the request fails to be processed

postMobiledevices

public UserDevice postMobiledevices(PostMobiledevicesRequest request)
                             throws IOException,
ApiException

Create User device

Parameters:

request - The request object

Returns:

UserDevice

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postMobiledevices

public ApiResponse<UserDevice> postMobiledevices(ApiRequest<UserDevice> request)
                                          throws IOException

Create User device

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putMobiledevice

public UserDevice putMobiledevice(String deviceId,
 UserDevice body)
                           throws IOException,
ApiException

Update device

Parameters:

deviceId - Device ID (required)

body - Device (optional)

Returns:

UserDevice

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putMobiledeviceWithHttpInfo

public ApiResponse<UserDevice> putMobiledeviceWithHttpInfo(String deviceId,
 UserDevice body)
                                                    throws IOException

Update device

Parameters:

deviceId - Device ID (required)

body - Device (optional)

Returns:

UserDevice

Throws:

IOException - if the request fails to be processed

putMobiledevice

public UserDevice putMobiledevice(PutMobiledeviceRequest request)
                           throws IOException,
ApiException

Update device

Parameters:

request - The request object

Returns:

UserDevice

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putMobiledevice

public ApiResponse<UserDevice> putMobiledevice(ApiRequest<UserDevice> request)
                                        throws IOException

Update device

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed