Package com.zendesk.sunshine_conversations_client.api

Class AppKeysApi

java.lang.Object

com.zendesk.sunshine_conversations_client.api.AppKeysApi

public class AppKeysApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
AppKeysApi()
AppKeysApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AppKeyResponse	createAppKey(AppKeyCreateBody appKeyCreateBody, java.lang.String appId)	Create App Key Creates an API key for the specified app.
AppKeyResponse	createAppKey(java.lang.String bearerToken, AppKeyCreateBody appKeyCreateBody, java.lang.String appId)	Create App Key Creates an API key for the specified app.
java.lang.Object	deleteAppKey(java.lang.String appId, java.lang.String keyId)	Delete App Key Removes an API key.
java.lang.Object	deleteAppKey(java.lang.String bearerToken, java.lang.String appId, java.lang.String keyId)	Delete App Key Removes an API key.
ApiClient	getApiClient()
AppKeyResponse	getAppKey(java.lang.String appId, java.lang.String keyId)	Get App Key Returns an API key.
AppKeyResponse	getAppKey(java.lang.String bearerToken, java.lang.String appId, java.lang.String keyId)	Get App Key Returns an API key.
AppKeyListResponse	listAppKeys(java.lang.String appId)	List App Keys Lists all API keys for a given app.
AppKeyListResponse	listAppKeys(java.lang.String bearerToken, java.lang.String appId)	List App Keys Lists all API keys for a given app.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

AppKeysApi

public AppKeysApi()

AppKeysApi

public AppKeysApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createAppKey

public AppKeyResponse createAppKey(AppKeyCreateBody appKeyCreateBody,
                                   java.lang.String appId)
                            throws ApiException

Create App Key Creates an API key for the specified app. The response body will include a secret as well as its corresponding id, which you can use to generate JSON Web Tokens to securely make API calls on behalf of the app.

Parameters:

appKeyCreateBody - (required)

appId - Identifies the app. (required)

Returns:

a AppKeyResponse

Throws:

ApiException - if fails to make API call

deleteAppKey

public java.lang.Object deleteAppKey(java.lang.String appId,
                                     java.lang.String keyId)
                              throws ApiException

Delete App Key Removes an API key.

Parameters:

appId - Identifies the app. (required)

keyId - The id of the key. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

getAppKey

public AppKeyResponse getAppKey(java.lang.String appId,
                                java.lang.String keyId)
                         throws ApiException

Get App Key Returns an API key.

Parameters:

appId - Identifies the app. (required)

keyId - The id of the key. (required)

Returns:

a AppKeyResponse

Throws:

ApiException - if fails to make API call

listAppKeys

public AppKeyListResponse listAppKeys(java.lang.String appId)
                               throws ApiException

List App Keys Lists all API keys for a given app.

Parameters:

appId - Identifies the app. (required)

Returns:

a AppKeyListResponse

Throws:

ApiException - if fails to make API call

createAppKey

public AppKeyResponse createAppKey(java.lang.String bearerToken,
                                   AppKeyCreateBody appKeyCreateBody,
                                   java.lang.String appId)
                            throws ApiException

Create App Key Creates an API key for the specified app. The response body will include a secret as well as its corresponding id, which you can use to generate JSON Web Tokens to securely make API calls on behalf of the app.

Parameters:

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

appKeyCreateBody - (required)

appId - Identifies the app. (required)

Returns:

a AppKeyResponse

Throws:

ApiException - if fails to make API call

deleteAppKey

public java.lang.Object deleteAppKey(java.lang.String bearerToken,
                                     java.lang.String appId,
                                     java.lang.String keyId)
                              throws ApiException

Delete App Key Removes an API key.

Parameters:

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

appId - Identifies the app. (required)

keyId - The id of the key. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

getAppKey

public AppKeyResponse getAppKey(java.lang.String bearerToken,
                                java.lang.String appId,
                                java.lang.String keyId)
                         throws ApiException

Get App Key Returns an API key.

Parameters:

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

appId - Identifies the app. (required)

keyId - The id of the key. (required)

Returns:

a AppKeyResponse

Throws:

ApiException - if fails to make API call

listAppKeys

public AppKeyListResponse listAppKeys(java.lang.String bearerToken,
                                      java.lang.String appId)
                               throws ApiException

List App Keys Lists all API keys for a given app.

Parameters:

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

appId - Identifies the app. (required)

Returns:

a AppKeyListResponse

Throws:

ApiException - if fails to make API call