Package com.zendesk.sunshine_conversations_client.api

Class AppsApi

java.lang.Object

com.zendesk.sunshine_conversations_client.api.AppsApi

public class AppsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
AppsApi()
AppsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AppResponse	createApp(AppCreateBody appCreateBody)	Create App Creates a new app.
AppResponse	createApp(java.lang.String bearerToken, AppCreateBody appCreateBody)	Create App Creates a new app.
java.lang.Object	deleteApp(java.lang.String appId)	Delete App Removes the specified app, including all its enabled integrations.
java.lang.Object	deleteApp(java.lang.String bearerToken, java.lang.String appId)	Delete App Removes the specified app, including all its enabled integrations.
ApiClient	getApiClient()
AppResponse	getApp(java.lang.String appId)	Get App Fetches an individual app.
AppResponse	getApp(java.lang.String bearerToken, java.lang.String appId)	Get App Fetches an individual app.
AppListResponse	listApps(Page page, AppListFilter filter)	List Apps Lists all apps that a user is part of.
AppListResponse	listApps(java.lang.String bearerToken, Page page, AppListFilter filter)	List Apps Lists all apps that a user is part of.
void	setApiClient(ApiClient apiClient)
AppResponse	updateApp(AppUpdateBody appUpdateBody, java.lang.String appId)	Update App Updates an app.
AppResponse	updateApp(java.lang.String bearerToken, AppUpdateBody appUpdateBody, java.lang.String appId)	Update App Updates an app.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppsApi

public AppsApi()

AppsApi

public AppsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createApp

public AppResponse createApp(AppCreateBody appCreateBody)
                      throws ApiException

Create App Creates a new app. When using [service account](#service-accounts) credentials, the service account is automatically granted access to the app.

Parameters:

appCreateBody - (required)

Returns:

a AppResponse

Throws:

ApiException - if fails to make API call

deleteApp

public java.lang.Object deleteApp(java.lang.String appId)
                           throws ApiException

Delete App Removes the specified app, including all its enabled integrations.

Parameters:

appId - Identifies the app. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

getApp

public AppResponse getApp(java.lang.String appId)
                   throws ApiException

Get App Fetches an individual app.

Parameters:

appId - Identifies the app. (required)

Returns:

a AppResponse

Throws:

ApiException - if fails to make API call

listApps

public AppListResponse listApps(Page page,
                                AppListFilter filter)
                         throws ApiException

List Apps Lists all apps that a user is part of. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits). ```shell /v2/apps?page[after]=5e1606762556d93e9c176f69&page[size]=10 ```

Parameters:

page - Contains parameters for applying cursor pagination. (optional)

filter - Contains parameters for filtering the results. (optional)

Returns:

a AppListResponse

Throws:

ApiException - if fails to make API call

updateApp

public AppResponse updateApp(AppUpdateBody appUpdateBody,
                             java.lang.String appId)
                      throws ApiException

Update App Updates an app.

Parameters:

appUpdateBody - (required)

appId - Identifies the app. (required)

Returns:

a AppResponse

Throws:

ApiException - if fails to make API call

createApp

public AppResponse createApp(java.lang.String bearerToken,
                             AppCreateBody appCreateBody)
                      throws ApiException

Create App Creates a new app. When using [service account](#service-accounts) credentials, the service account is automatically granted access to the app.

Parameters:

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

appCreateBody - (required)

Returns:

a AppResponse

Throws:

ApiException - if fails to make API call

deleteApp

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

Delete App Removes the specified app, including all its enabled integrations.

Parameters:

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

appId - Identifies the app. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

getApp

public AppResponse getApp(java.lang.String bearerToken,
                          java.lang.String appId)
                   throws ApiException

Get App Fetches an individual app.

Parameters:

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

appId - Identifies the app. (required)

Returns:

a AppResponse

Throws:

ApiException - if fails to make API call

listApps

public AppListResponse listApps(java.lang.String bearerToken,
                                Page page,
                                AppListFilter filter)
                         throws ApiException

List Apps Lists all apps that a user is part of. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits). ```shell /v2/apps?page[after]=5e1606762556d93e9c176f69&page[size]=10 ```

Parameters:

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

page - Contains parameters for applying cursor pagination. (optional)

filter - Contains parameters for filtering the results. (optional)

Returns:

a AppListResponse

Throws:

ApiException - if fails to make API call

updateApp

public AppResponse updateApp(java.lang.String bearerToken,
                             AppUpdateBody appUpdateBody,
                             java.lang.String appId)
                      throws ApiException

Update App Updates an app.

Parameters:

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

appUpdateBody - (required)

appId - Identifies the app. (required)

Returns:

a AppResponse

Throws:

ApiException - if fails to make API call