Sunshine Conversations Client

Warnings

• breaking Zendesk has officially deprecated the auto-generated Python SDKs for Sunshine Conversations. While existing implementations will continue to function, there will be no new feature development or automatic updates to these libraries based on OpenAPI specification changes. Future API changes may not be reflected in this SDK.
  Fix: Users are encouraged to use the Sunshine Conversations OpenAPI specification directly, or generate their own client libraries using community tools like OpenAPI Generator, for future compatibility and new features.
• gotcha Authentication can be done using Basic Authentication (API Key ID and Secret) or JSON Web Tokens (JWTs). Basic authentication is generally recommended for server-to-server calls unless specific JWT use cases are required.
  Fix: Ensure `configuration.username` is set to your API Key ID and `configuration.password` to your API Secret for Basic Authentication. Refer to Zendesk documentation for JWT authentication if needed.
• gotcha The default API region is US. If your Sunshine Conversations app is hosted in a different region (e.g., EU), you must explicitly configure the `host` in the `Configuration` object.
  Fix: Set `configuration.host = "https://api.eu-1.smooch.io"` (or the appropriate regional host) if your app is not in the US region.
• gotcha Sunshine Conversations APIs are subject to rate limiting. Exceeding limits will result in a 429 Too Many Requests HTTP status code.
  Fix: Implement retry logic with exponential backoff and jitter to handle 429 responses in your application.
• breaking For legacy Sunshine Conversations subscriptions, Zendesk is migrating administration to Zendesk Admin Center or shutting down accounts by February 1, 2027. This could lead to loss of access and service disruption for unmigrated or unsupported accounts.
  Fix: Affected users must follow instructions in their direct email from Zendesk, which may include migrating to Zendesk Admin Center, resetting account-level keys, or removing Sunshine Conversations dependencies before February 1, 2027.

Install

• pip install sunshine-conversations-client Install stable version

Imports

• sunshine_conversations_client

  import sunshine_conversations_client

• Configuration

  from sunshine_conversations_client import Configuration

• ApiClient

  from sunshine_conversations_client import ApiClient

• ApiException

  from sunshine_conversations_client.rest import ApiException

Quickstart

This quickstart demonstrates how to configure the client for basic authentication using environment variables for API Key ID and Secret, and then how to make a sample API call (listing app keys). Replace 'YOUR_API_KEY_ID', 'YOUR_API_SECRET', and 'YOUR_APP_ID' or set them as environment variables. Ensure you have an App ID from your Sunshine Conversations (Zendesk Admin Center) account.

import sunshine_conversations_client
from sunshine_conversations_client.rest import ApiException
import os

# Configure HTTP basic authorization (recommended)
configuration = sunshine_conversations_client.Configuration()
configuration.username = os.environ.get('SC_API_KEY_ID', 'YOUR_API_KEY_ID')
configuration.password = os.environ.get('SC_API_SECRET', 'YOUR_API_SECRET')

# Optionally, set a non-US region host (e.g., for EU)
# configuration.host = "https://api.eu-1.smooch.io"

# Create an instance of the API client
api_client = sunshine_conversations_client.ApiClient(configuration)

# Create an instance of a specific API, e.g., AppKeysApi
api_instance = sunshine_conversations_client.AppKeysApi(api_client)

app_id = os.environ.get('SC_APP_ID', 'YOUR_APP_ID')  # Replace with your App ID

try:
    # Example: List App Keys for your app
    api_response = api_instance.list_app_keys(app_id)
    print("Successfully listed App Keys:")
    for key in api_response.app_keys:
        print(f"  Key ID: {key.id}, Secret: {key.secret}")
except ApiException as e:
    print(f"Exception when calling AppKeysApi->list_app_keys: {e}")
except Exception as e:
    print(f"An unexpected error occurred: {e}")