Package com.zendesk.sunshine_conversations_client.api

Class CustomIntegrationApiKeysApi

java.lang.Object

com.zendesk.sunshine_conversations_client.api.CustomIntegrationApiKeysApi

public class CustomIntegrationApiKeysApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
CustomIntegrationApiKeysApi()
CustomIntegrationApiKeysApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
IntegrationApiKeyResponse	createCustomIntegrationKey(IntegrationApiKey integrationApiKey, java.lang.String appId, java.lang.String integrationId)	Create Integration Key Creates an API key for the specified custom integration.
IntegrationApiKeyResponse	createCustomIntegrationKey(java.lang.String bearerToken, IntegrationApiKey integrationApiKey, java.lang.String appId, java.lang.String integrationId)	Create Integration Key Creates an API key for the specified custom integration.
java.lang.Object	deleteCustomIntegrationKey(java.lang.String appId, java.lang.String integrationId, java.lang.String keyId)	Delete Integration Key Removes an API key.
java.lang.Object	deleteCustomIntegrationKey(java.lang.String bearerToken, java.lang.String appId, java.lang.String integrationId, java.lang.String keyId)	Delete Integration Key Removes an API key.
ApiClient	getApiClient()
IntegrationApiKeyResponse	getCustomIntegrationKey(java.lang.String appId, java.lang.String integrationId, java.lang.String keyId)	Get Integration Key Get the specified API key.
IntegrationApiKeyResponse	getCustomIntegrationKey(java.lang.String bearerToken, java.lang.String appId, java.lang.String integrationId, java.lang.String keyId)	Get Integration Key Get the specified API key.
IntegrationApiKeyListResponse	listCustomIntegrationKeys(java.lang.String appId, java.lang.String integrationId)	List Integration Keys Lists all API keys for a given integration.
IntegrationApiKeyListResponse	listCustomIntegrationKeys(java.lang.String bearerToken, java.lang.String appId, java.lang.String integrationId)	List Integration Keys Lists all API keys for a given integration.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomIntegrationApiKeysApi

public CustomIntegrationApiKeysApi()

CustomIntegrationApiKeysApi

public CustomIntegrationApiKeysApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createCustomIntegrationKey

public IntegrationApiKeyResponse createCustomIntegrationKey(IntegrationApiKey integrationApiKey,
                                                            java.lang.String appId,
                                                            java.lang.String integrationId)
                                                     throws ApiException

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

Parameters:

integrationApiKey - (required)

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

Returns:

a IntegrationApiKeyResponse

Throws:

ApiException - if fails to make API call

deleteCustomIntegrationKey

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

Delete Integration Key Removes an API key.

Parameters:

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

keyId - The id of the key. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

getCustomIntegrationKey

public IntegrationApiKeyResponse getCustomIntegrationKey(java.lang.String appId,
                                                         java.lang.String integrationId,
                                                         java.lang.String keyId)
                                                  throws ApiException

Get Integration Key Get the specified API key.

Parameters:

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

keyId - The id of the key. (required)

Returns:

a IntegrationApiKeyResponse

Throws:

ApiException - if fails to make API call

listCustomIntegrationKeys

public IntegrationApiKeyListResponse listCustomIntegrationKeys(java.lang.String appId,
                                                               java.lang.String integrationId)
                                                        throws ApiException

List Integration Keys Lists all API keys for a given integration.

Parameters:

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

Returns:

a IntegrationApiKeyListResponse

Throws:

ApiException - if fails to make API call

createCustomIntegrationKey

public IntegrationApiKeyResponse createCustomIntegrationKey(java.lang.String bearerToken,
                                                            IntegrationApiKey integrationApiKey,
                                                            java.lang.String appId,
                                                            java.lang.String integrationId)
                                                     throws ApiException

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

Parameters:

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

integrationApiKey - (required)

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

Returns:

a IntegrationApiKeyResponse

Throws:

ApiException - if fails to make API call

deleteCustomIntegrationKey

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

Delete Integration Key Removes an API key.

Parameters:

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

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

keyId - The id of the key. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

getCustomIntegrationKey

public IntegrationApiKeyResponse getCustomIntegrationKey(java.lang.String bearerToken,
                                                         java.lang.String appId,
                                                         java.lang.String integrationId,
                                                         java.lang.String keyId)
                                                  throws ApiException

Get Integration Key Get the specified API key.

Parameters:

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

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

keyId - The id of the key. (required)

Returns:

a IntegrationApiKeyResponse

Throws:

ApiException - if fails to make API call

listCustomIntegrationKeys

public IntegrationApiKeyListResponse listCustomIntegrationKeys(java.lang.String bearerToken,
                                                               java.lang.String appId,
                                                               java.lang.String integrationId)
                                                        throws ApiException

List Integration Keys Lists all API keys for a given integration.

Parameters:

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

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

Returns:

a IntegrationApiKeyListResponse

Throws:

ApiException - if fails to make API call