Registry / communication / sunshine-conversations-client

sunshine-conversations-client

JSON →
library17.0.1pypypi✓ verified 21d ago

The `sunshine-conversations-client` is an auto-generated Python SDK for interacting with the Sunshine Conversations API (now part of Zendesk). It provides a programmatic interface to manage conversations, users, messages, and integrations across various messaging channels. While the library is functional and existing implementations will continue to work, Zendesk has deprecated the auto-generation and maintenance of these SDKs, encouraging users to refer directly to the OpenAPI specification or generate their own clients. The current version is 17.0.1.

pip install sunshine-conversations-client
INSTALL
IMPORT
SIG · SUNSHINE-CONVERSAT
S
sunshine-conversations-client
communicationpythonv17.0.1
Install
3.9s avg
Import
3188ms
Disk
32MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v17.0.1 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.95 runs
installs and imports cleanly · install 0.0s · import 3.318s · 33.8MB
glibc
py 3.103.95 runs
installs and imports cleanly · install 3.9s · import 3.058s · 33MB
32MB installed
● package 32MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

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

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}")
Debug
Known issues
breakingZendesk 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.
affects: All versions 17.0.1 and below (as of August 2025 deprecation announcement)
gotchaAuthentication 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.
affects: All versions
gotchaThe 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.
affects: All versions
gotchaSunshine 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.
affects: All versions
breakingFor 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.
affects: Legacy accounts with Sunshine Conversations subscriptions (check direct email from Zendesk for specific details and effective dates)
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'sunshine_conversations_client'
The 'sunshine-conversations-client' package is not installed in your Python environment, or you are trying to import it using a hyphen instead of an underscore.
fix
Install the package using `pip install sunshine-conversations-client` and ensure your import statement is `import sunshine_conversations_client`.
AttributeError: 'Configuration' object has no attribute 'bearer_token'
The `sunshine_conversations_client.Configuration` object uses `access_token` for bearer token authentication, not `bearer_token`.
fix
Use `configuration.access_token = 'YOUR_BEARER_TOKEN'` to set the bearer token for authentication.
sunshine_conversations_client.rest.ApiException: (401) Reason: Unauthorized
The API credentials (API key, basic auth username/password, or access token) provided in the client configuration are incorrect or missing.
fix
Double-check your `sunshine_conversations_client.Configuration` settings to ensure the correct `username`/`password`, `api_key['Authorization']`, or `access_token` is provided.
sunshine_conversations_client.rest.ApiException: (400) Reason: Bad Request
The request body or parameters sent to the API do not conform to the expected format or contain invalid data, as per the API's specification.
fix
Review the API documentation for the specific endpoint to ensure the request payload and parameters are correctly formatted and contain valid values.
sunshine_conversations_client.rest.ApiException: (404) Reason: Not Found
The requested resource (e.g., an app, conversation, or message) with the specified ID does not exist, or the API endpoint path is incorrect.
fix
Verify the resource ID (e.g., `app_id`, `conversation_id`) is correct and exists, and ensure the API endpoint path is accurate.
Upgrade
Version history
17.0.1latest on PyPI · released Sep 4, 2025
Audit
Dependencies

No dependency data recorded yet.

Agent activity
43 hits · last 30 days
node
34
OpenAI (training)
1
Resources
sunshine-conversations-client — pip install sunshine-conversations-client · libregistry