Sunshine Conversations Java

https://github.com/zendesk/sunshine-conversations-java
Admin
The Java package for the Sunshine Conversations API, automatically generated using OpenAPI...
Tokens:204,286
Snippets:505
Trust Score:8.1
License:Apache-2.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get App - Java Example

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/AppsApi.md

Demonstrates how to retrieve a specific app using its ID. It includes setting up the API client, authentication, and handling potential exceptions.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.AppsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        AppsApi apiInstance = new AppsApi(defaultClient);
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
        // Add required body parameters

        try {
            AppResponse result = apiInstance.getApp(appId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppsApi#getApp");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Get App Key - Java Example

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/AppKeysApi.md

Provides a Java code example for retrieving an app key using the Sunshine Conversations client. It covers setting up the API client, authentication, and calling the `getAppKey` method, including error handling.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.AppKeysApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        AppKeysApi apiInstance = new AppKeysApi(defaultClient);
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app. 
        String keyId = "int_5d8cff3cd55b040010928b5b"; // String | The id of the key.
        // Add required body parameters

        try {
            AppKeyResponse result = apiInstance.getAppKey(appId, keyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppKeysApi#getAppKey");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Get Device - Java Example

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/DevicesApi.md

Fetches a specific Device using the DevicesApi. This example demonstrates setting up the API client, authentication, and making the getDevice call.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.DevicesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        DevicesApi apiInstance = new DevicesApi(defaultClient);
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
        String userIdOrExternalId = "42589ad070d43be9b00ff7e5"; // String | The user's id or externalId.
        String deviceId = "5d8cff3cd55b040010928b5b"; // String | The device's id.
        // Add required body parameters

        try {
            DeviceResponse result = apiInstance.getDevice(appId, userIdOrExternalId, deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDevice");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### List Apps Java Example

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/AppsApi.md

Java code example demonstrating how to list apps using the AppsApi. It covers setting up the API client, authentication, and making the API call.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.AppsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        AppsApi apiInstance = new AppsApi(defaultClient);
        Page page = new Page(); // Page | Contains parameters for applying cursor pagination.
        AppListFilter filter = new AppListFilter(); // AppListFilter | Contains parameters for filtering the results.
        // Add required body parameters

        try {
            AppListResponse result = apiInstance.listApps(page, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppsApi#listApps");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Sync User Example

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/UsersApi.md

Example of how to use the syncUser method from the UsersApi class in the Sunshine Conversations Java SDK. It demonstrates setting up the API client, authentication, and making the API call.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.UsersApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        UsersApi apiInstance = new UsersApi(defaultClient);
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
        String zendeskId = "35436"; // String | The ID that links a messaging user to its core Zendesk user counterpart. This ID can be used to fetch the core user record via the Zendesk Support API. 
        SyncUserBody syncUserBody = new SyncUserBody(); // SyncUserBody | 
        // Add required body parameters

        try {
            UserResponse result = apiInstance.syncUser(appId, zendeskId, syncUserBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#syncUser");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Create Switchboard Example

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/SwitchboardsApi.md

Demonstrates how to create a switchboard using the Sunshine Conversations Java SDK. It includes setting up the API client, authentication, and making the API call.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.SwitchboardsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        SwitchboardsApi apiInstance = new SwitchboardsApi(defaultClient);
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
        // Add required body parameters

        try {
            SwitchboardResponse result = apiInstance.createSwitchboard(appId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SwitchboardsApi#createSwitchboard");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Get Integration - Java

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/IntegrationsApi.md

Provides an example of how to retrieve integration details using the Sunshine Conversations Java client. It covers API authentication setup and the invocation of the `getIntegration` method.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.IntegrationsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        IntegrationsApi apiInstance = new IntegrationsApi(defaultClient);
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app. 
        String integrationId = "029c31f25a21b47effd7be90"; // String | The id of the integration.
        // Add required body parameters

        try {
            IntegrationResponse result = apiInstance.getIntegration(appId, integrationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationsApi#getIntegration");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Accept Control Example

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/SwitchboardActionsApi.md

Demonstrates how to use the `acceptControl` method from the `SwitchboardActionsApi` in Java. This includes setting up the API client, authentication, and making the API call with sample parameters.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.SwitchboardActionsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        SwitchboardActionsApi apiInstance = new SwitchboardActionsApi(defaultClient);
        AcceptControlBody acceptControlBody = new AcceptControlBody(); // AcceptControlBody | 
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
        String conversationId = "029c31f25a21b47effd7be90"; // String | Identifies the conversation.
        // Add required body parameters

        try {
            Object result = apiInstance.acceptControl(acceptControlBody, appId, conversationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SwitchboardActionsApi#acceptControl");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Update App Java Example

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/AppsApi.md

Java code example demonstrating how to update an app using the AppsApi. It shows how to instantiate the client, authenticate, and call the updateApp method.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.AppsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        AppsApi apiInstance = new AppsApi(defaultClient);
        AppUpdateBody appUpdateBody = new AppUpdateBody(); // AppUpdateBody | 
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
        // Add required body parameters

        try {
            AppResponse result = apiInstance.updateApp(appUpdateBody, appId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppsApi#updateApp");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Create Conversation Example

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/ConversationsApi.md

Example of how to create a conversation using the ConversationsApi in the Sunshine Conversations Java SDK. It demonstrates setting up the API client, authentication, and making the `createConversation` call.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.ConversationsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        ConversationsApi apiInstance = new ConversationsApi(defaultClient);
        ConversationCreateBody conversationCreateBody = new ConversationCreateBody(); // ConversationCreateBody | 
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
        // Add required body parameters

        try {
            ConversationResponse result = apiInstance.createConversation(conversationCreateBody, appId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#createConversation");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Create Sunshine Conversation Client (Java)

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/ClientsApi.md

Example of how to create a client using the Sunshine Conversations Java SDK. This involves setting up the API client, authentication, and making the `createClient` call.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.ClientsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        ClientsApi apiInstance = new ClientsApi(defaultClient);
        ClientCreate clientCreate = new ClientCreate(); // ClientCreate | 
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
        String userIdOrExternalId = "42589ad070d43be9b00ff7e5"; // String | The user's id or externalId.
        // Add required body parameters

        try {
            ClientResponse result = apiInstance.createClient(clientCreate, appId, userIdOrExternalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientsApi#createClient");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Get Webhook - Java

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/WebhooksApi.md

Provides a Java example for retrieving details of a specific webhook associated with an app and integration. It covers authentication and error handling.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.WebhooksApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        WebhooksApi apiInstance = new WebhooksApi(defaultClient);
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app. 
        String integrationId = "029c31f25a21b47effd7be90"; // String | The id of the integration. 
        String webhookId = "029c31f25a21b47effd7be90"; // String | The id of the webhook. 
        // Add required body parameters

        try {
            WebhookResponse result = apiInstance.getWebhook(appId, integrationId, webhookId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#getWebhook");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Download Message Reference Example

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/ConversationsApi.md

Demonstrates how to download a message reference using the ConversationsApi. This involves setting up the API client, authentication, and providing the necessary request body and path parameters.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.ConversationsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        ConversationsApi apiInstance = new ConversationsApi(defaultClient);
        DownloadMessageRefBody downloadMessageRefBody = new DownloadMessageRefBody(); // DownloadMessageRefBody | 
        downloadMessageRefBody.putPropertiesItem("userId", "6e416caac6a5e9544e3fb6d7");
        downloadMessageRefBody.putPropertiesItem("apple", new AppleMessageAttributes().interactiveDataRef(new AppleMessageAttributes.InteractiveDataRef().url("https://p61-content.icloud.com/M58C0A1A2EB62B6E899B4F28996E8DA229E1914295299C39944B2F2CA7482AE50.C01USN00").bid("com.apple.messages.MSMessageExtensionBalloonPlugin:0000000000:com.apple.icloud.apps.messages.business.extension").key("00c0d1827fdc858fe7b42421de1fb289c2ee0a9463d787ce4f118506f970bd6e38").signature("81a619c81da5a01c6139219a5d20e17430c631e1eb").owner("M58C0A2A1EB62B4E859B4F28996E8DA229E1914295299C39944B2F2CA7482AE50.C01USN00")));
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
        String conversationId = "029c31f25a21b47effd7be90"; // String | Identifies the conversation.
        // Add required body parameters

        try {
            Map<String, Object> result = apiInstance.downloadMessageRef(downloadMessageRefBody, appId, conversationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#downloadMessageRef");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Join Conversation Example

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/ParticipantsApi.md

Demonstrates how to join a conversation using the ParticipantsApi in the Sunshine Conversations Java SDK. Includes setting up the API client, authentication, and making the joinConversation call.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.ParticipantsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        ParticipantsApi apiInstance = new ParticipantsApi(defaultClient);
        ParticipantJoinBody participantJoinBody = new ParticipantJoinBody();
        participantJoinBody.userId("67a11490f0305f4a391e9f8a");
        participantJoinBody.subscribeSDKClient(true);
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
        String conversationId = "029c31f25a21b47effd7be90"; // String | Identifies the conversation.
        // Add required body parameters

        try {
            ParticipantResponse result = apiInstance.joinConversation(participantJoinBody, appId, conversationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ParticipantsApi#joinConversation");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### List Switchboards - Java

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/SwitchboardsApi.md

Provides a Java example for listing all switchboards associated with a specific app in Sunshine Conversations. It covers authentication and API call execution.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.SwitchboardsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        SwitchboardsApi apiInstance = new SwitchboardsApi(defaultClient);
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app. 
        // Add required body parameters

        try {
            SwitchboardListResponse result = apiInstance.listSwitchboards(appId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SwitchboardsApi#listSwitchboards");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Webhooks API Documentation

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/WebhooksApi.md

API documentation for managing webhooks, including details on parameters, authorization, and HTTP response codes for delete and get operations.

```APIDOC
WebhooksApi:
  deleteWebhook(appId, integrationId, webhookId)
    Parameters:
      appId (String): Identifies the app.
      integrationId (String): The id of the integration.
      webhookId (String): The id of the webhook.
    Returns: Object
    HTTP request headers:
      Content-Type: Not defined
      Accept: application/json
    HTTP response details:
      200: Ok
      404: Not found

  getWebhook(appId, integrationId, webhookId)
    Parameters:
      appId (String): Identifies the app.
      integrationId (String): The id of the integration.
      webhookId (String): The id of the webhook.
    Returns: WebhookResponse
    Authorization: [basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
```

--------------------------------

### Integrations API Documentation

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/IntegrationsApi.md

Provides details on the Integrations API endpoints for managing integrations, including methods for creating, deleting, retrieving, listing, and updating integrations. It outlines HTTP methods, request paths, descriptions, and example usage.

```APIDOC
IntegrationsApi:
  All URIs are relative to *https://api.smooch.io*

  Method | HTTP request | Description
  ------------- | ------------- | –------------
  [**createIntegration**](IntegrationsApi.md#createIntegration) | **POST** /v2/apps/{appId}/integrations | Create Integration
  [**deleteIntegration**](IntegrationsApi.md#deleteIntegration) | **DELETE** /v2/apps/{appId}/integrations/{integrationId} | Delete Integration
  [**getIntegration**](IntegrationsApi.md#getIntegration) | **GET** /v2/apps/{appId}/integrations/{integrationId} | Get Integration
  [**listIntegrations**](IntegrationsApi.md#listIntegrations) | **GET** /v2/apps/{appId}/integrations | List Integrations
  [**updateIntegration**](IntegrationsApi.md#updateIntegration) | **PATCH** /v2/apps/{appId}/integrations/{integrationId} | Update Integration

createIntegration:
  > IntegrationResponse createIntegration(integration, appId)
  Create Integration
  The Create Integration endpoint allows you to provision apps with front-end messaging channels. Selecting a `custom` integration allows the creation of webhooks.
  ### Example
  ```java
  import com.zendesk.sunshine_conversations_client.ApiClient;
  import com.zendesk.sunshine_conversations_client.ApiException;
  import com.zendesk.sunshine_conversations_client.Configuration;
  import com.zendesk.sunshine_conversations_client.auth.*;
  import com.zendesk.sunshine_conversations_client.model.*;
  import com.zendesk.sunshine_conversations_client.api.IntegrationsApi;

  public class Example {
      public static void main(String[] args) {
          ApiClient defaultClient = Configuration.getDefaultApiClient();
          defaultClient.setBasePath("https://api.smooch.io");
          
          // Configure HTTP basic authorization: basicAuth
          HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
          basicAuth.setUsername("API_KEY_ID");
          basicAuth.setPassword("API_KEY_SECRET");

          // Uncomment this section to use JWTs instead
          // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
          // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

          IntegrationsApi apiInstance = new IntegrationsApi(defaultClient);
          Integration integration = new Integration(); // Integration | 
          String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app.
          // Add required body parameters

          try {
              IntegrationResponse result = apiInstance.createIntegration(integration, appId);
              System.out.println(result);
          } catch (ApiException e) {
              System.err.println("Exception when calling IntegrationsApi#createIntegration");
              System.err.println("Status code: " + e.getCode());
              System.err.println("Reason: " + e.getResponseBody());
              System.err.println("Response headers: " + e.getResponseHeaders());
              e.printStackTrace();
          }
      }
  }
  ```
  ### Parameters

  Name | Type | Description  | Notes
  ------------- | ------------- | ------------- | –------------
   integration | [**Integration**](Integration.md)|  |
   appId | **String**| Identifies the app. |

  ### Return type

  [**IntegrationResponse**](IntegrationResponse.md)

  ### Authorization

  [basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)

  ### HTTP request headers

  - **Content-Type**: application/json
  - **Accept**: application/json

  ### HTTP response details
  | Status code | Description | Response headers |
  |-------------|-------------|------------------|
  | **201** | Created |  -  |
  | **400** | Bad request |  -  |

deleteIntegration:
  > Object deleteIntegration(appId, integrationId)
  Delete Integration
  Delete the specified integration.

```

--------------------------------

### Get User - Java

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/UsersApi.md

Demonstrates how to fetch an individual user's details using the Sunshine Conversations Java client. This includes setting up the API client, authentication, and calling the getUser method.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.UsersApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        UsersApi apiInstance = new UsersApi(defaultClient);
        String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app. 
        String userIdOrExternalId = "42589ad070d43be9b00ff7e5"; // String | The user's id or externalId. 
        // Add required body parameters

        try {
            UserResponse result = apiInstance.getUser(appId, userIdOrExternalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUser");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Twitter Integration Properties

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/Twitter.md

Defines the properties required for setting up a Twitter integration. This includes authentication credentials, tier information, and default responder settings. Refer to the Twitter Setup Guide for detailed setup instructions.

```APIDOC
Twitter Integration Properties:

- type (String): To set up a Twitter integration, please follow the steps outlined in the [Twitter Setup Guide](https://docs.smooch.io/guide/twitter/#setup). [optional]
- tier (TierEnum): Your Twitter app's tier. Only "enterprise" is supported for new integrations.
- envName (String): The Twitter dev environments label. Only required / used for sandbox and premium tiers. [optional] [readonly]
- consumerKey (String): The consumer key for your Twitter app.
- consumerSecret (String): The consumer key secret for your Twitter app.
- accessTokenKey (String): The access token key obtained from your user via oauth.
- accessTokenSecret (String): The access token secret obtained from your user via oauth.
- defaultResponderId (String): The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href="https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment">Switchboard guide</a>. [optional]
- defaultResponder (DefaultResponderDefaultResponder): [optional]

Enum: TierEnum:
- ENTERPRISE: "enterprise"
```

--------------------------------

### TwitterAllOf Properties

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/TwitterAllOf.md

Defines the properties required for setting up a Twitter integration. This includes authentication credentials, tier information, and environment details. Refer to the Twitter Setup Guide for detailed instructions.

```APIDOC
TwitterAllOf:
  Properties:
    type: String
      Description: To set up a Twitter integration, please follow the steps outlined in the [Twitter Setup Guide](https://docs.smooch.io/guide/twitter/#setup).
      Notes: [optional]
    tier: TierEnum (#TierEnum)
      Description: Your Twitter app's tier. Only "enterprise" is supported for new integrations.
    envName: String
      Description: The Twitter dev environments label. Only required / used for sandbox and premium tiers.
      Notes: [optional] [readonly]
    consumerKey: String
      Description: The consumer key for your Twitter app.
    consumerSecret: String
      Description: The consumer key secret for your Twitter app.
    accessTokenKey: String
      Description: The access token key obtained from your user via oauth.
    accessTokenSecret: String
      Description: The access token secret obtained from your user via oauth.

  Enum: TierEnum:
    Name: ENTERPRISE
    Value: "enterprise"
```

--------------------------------

### Create App using Sunshine Conversations Java SDK

Source: https://github.com/zendesk/sunshine-conversations-java/blob/master/docs/AppsApi.md

Demonstrates how to create a new app using the Sunshine Conversations Java client. It includes setting up the API client, configuring authentication (basic or bearer token), and making the `createApp` call with an `AppCreateBody` object. Error handling for API exceptions is also shown.

```java
import com.zendesk.sunshine_conversations_client.ApiClient;
import com.zendesk.sunshine_conversations_client.ApiException;
import com.zendesk.sunshine_conversations_client.Configuration;
import com.zendesk.sunshine_conversations_client.auth.*;
import com.zendesk.sunshine_conversations_client.model.*;
import com.zendesk.sunshine_conversations_client.api.AppsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.smooch.io");
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("API_KEY_ID");
        basicAuth.setPassword("API_KEY_SECRET");

        // Uncomment this section to use JWTs instead
        // HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        // bearerAuth.setBearerToken("YOUR TOKEN OR JWT");

        AppsApi apiInstance = new AppsApi(defaultClient);
        AppCreateBody appCreateBody = new AppCreateBody(); // AppCreateBody | 
        // Add required body parameters

        try {
            AppResponse result = apiInstance.createApp(appCreateBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppsApi#createApp");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}
```
Tokens:
Raw