Package com.zendesk.sunshine_conversations_client.api

Class DevicesApi

java.lang.Object

com.zendesk.sunshine_conversations_client.api.DevicesApi

public class DevicesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
DevicesApi()
DevicesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
DeviceResponse	getDevice(java.lang.String appId, java.lang.String userIdOrExternalId, java.lang.String deviceId)	Get Device Fetches a specific Device.
DeviceResponse	getDevice(java.lang.String bearerToken, java.lang.String appId, java.lang.String userIdOrExternalId, java.lang.String deviceId)	Get Device Fetches a specific Device.
ClientListResponse	listDevices(java.lang.String appId, java.lang.String userIdOrExternalId)	List Devices Get all the devices for a particular user.
ClientListResponse	listDevices(java.lang.String bearerToken, java.lang.String appId, java.lang.String userIdOrExternalId)	List Devices Get all the devices for a particular user.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

DevicesApi

public DevicesApi()

DevicesApi

public DevicesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getDevice

public DeviceResponse getDevice(java.lang.String appId,
                                java.lang.String userIdOrExternalId,
                                java.lang.String deviceId)
                         throws ApiException

Get Device Fetches a specific Device. ```shell /v2/apps/:appId/users/:userId ```

Parameters:

appId - Identifies the app. (required)

userIdOrExternalId - The user's id or externalId. (required)

deviceId - The device's id. (required)

Returns:

a DeviceResponse

Throws:

ApiException - if fails to make API call

listDevices

public ClientListResponse listDevices(java.lang.String appId,
                                      java.lang.String userIdOrExternalId)
                               throws ApiException

List Devices Get all the devices for a particular user. The Devices are sorted based on last seen time. ```shell /v2/apps/:appId/users/:userId/devices ```

Parameters:

appId - Identifies the app. (required)

userIdOrExternalId - The user's id or externalId. (required)

Returns:

a ClientListResponse

Throws:

ApiException - if fails to make API call

getDevice

public DeviceResponse getDevice(java.lang.String bearerToken,
                                java.lang.String appId,
                                java.lang.String userIdOrExternalId,
                                java.lang.String deviceId)
                         throws ApiException

Get Device Fetches a specific Device. ```shell /v2/apps/:appId/users/:userId ```

Parameters:

bearerToken - a token to be used for this request (required)

appId - Identifies the app. (required)

userIdOrExternalId - The user's id or externalId. (required)

deviceId - The device's id. (required)

Returns:

a DeviceResponse

Throws:

ApiException - if fails to make API call

listDevices

public ClientListResponse listDevices(java.lang.String bearerToken,
                                      java.lang.String appId,
                                      java.lang.String userIdOrExternalId)
                               throws ApiException

List Devices Get all the devices for a particular user. The Devices are sorted based on last seen time. ```shell /v2/apps/:appId/users/:userId/devices ```

Parameters:

bearerToken - a token to be used for this request (required)

appId - Identifies the app. (required)

userIdOrExternalId - The user's id or externalId. (required)

Returns:

a ClientListResponse

Throws:

ApiException - if fails to make API call