airbyte-agent-zendesk-chat 0.1.3__tar.gz → 0.1.10__tar.gz

airbyte_agent_zendesk_chat-0.1.10/AUTH.md

@@ -0,0 +1,93 @@
+# Zendesk-Chat authentication and configuration
+
+This page documents the authentication and configuration options for the Zendesk-Chat agent connector.
+
+## Authentication
+
+### Open source execution
+
+In open source mode, you provide API credentials directly to the connector.
+
+#### OAuth
+
+| Field Name | Type | Required | Description |
+|------------|------|----------|-------------|
+| `access_token` | `str` | Yes | Your Zendesk Chat OAuth 2.0 access token |
+
+```python
+from airbyte_agent_zendesk-chat import ZendeskChatConnector
+from airbyte_agent_zendesk-chat.models import ZendeskChatAuthConfig
+
+connector = ZendeskChatConnector(
+    auth_config=ZendeskChatAuthConfig(
+        access_token="<Your Zendesk Chat OAuth 2.0 access token>"
+    )
+)
+```
+
+#### Token
+This authentication method isn't available for this connector.
+
+### Hosted execution
+
+In hosted mode, you first create a connector via the Airbyte API (providing your OAuth or Token credentials), then execute operations using either the Python SDK or API. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
+
+#### OAuth
+
+Create a connector with OAuth credentials:
+
+```bash
+curl -X POST 'https://api.airbyte.ai/v1/integrations/connectors' \
+  -H 'Authorization: Bearer <SCOPED_TOKEN>' \
+  -H 'Content-Type: application/json' \
+  -d '{
+    "external_user_id": "<EXTERNAL_USER_ID>",
+    "connector_type": "Zendesk-Chat",
+    "name": "My Zendesk-Chat Connector",
+    "credentials": {
+      "access_token": "<Your Zendesk Chat OAuth 2.0 access token>"
+    }
+  }'
+```
+
+#### Token
+This authentication method isn't available for this connector.
+
+#### Execution
+
+After creating the connector, execute operations using either the Python SDK or API.
+
+**Python SDK**
+
+```python
+from airbyte_agent_zendesk-chat import ZendeskChatConnector
+
+connector = ZendeskChatConnector(
+    external_user_id="<your-scoped-token>",
+    airbyte_client_id="<your-client-id>",
+    airbyte_client_secret="<your-client-secret>"
+)
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@ZendeskChatConnector.describe
+async def zendesk-chat_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
+```
+
+**API**
+
+```bash
+curl -X POST 'https://api.airbyte.ai/api/v1/connectors/sources/<connector_id>/execute' \
+  -H 'Authorization: Bearer <SCOPED_TOKEN>' \
+  -H 'Content-Type: application/json' \
+  -d '{"entity": "<entity>", "action": "<action>", "params": {}}'
+```
+
+
+## Configuration
+
+The Zendesk-Chat connector requires the following configuration variables. These variables are used to construct the base API URL. Pass them via the `config` parameter when initializing the connector.
+
+| Variable | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `subdomain` | `string` | Yes | your-subdomain | Your Zendesk subdomain (the part before .zendesk.com in your Zendesk URL) |

airbyte_agent_zendesk_chat-0.1.10/CHANGELOG.md

@@ -0,0 +1,56 @@
+# Zendesk Chat changelog
+
+## [0.1.10] - 2026-01-23
+- Updated connector definition (YAML version 0.1.4)
+- Source commit: 049f6ad5
+- SDK version: 0.1.0
+
+## [0.1.9] - 2026-01-23
+- Updated connector definition (YAML version 0.1.3)
+- Source commit: 416466da
+- SDK version: 0.1.0
+
+## [0.1.8] - 2026-01-23
+- Updated connector definition (YAML version 0.1.3)
+- Source commit: f17cdd8c
+- SDK version: 0.1.0
+
+## [0.1.7] - 2026-01-22
+- Updated connector definition (YAML version 0.1.3)
+- Source commit: 49e6dfe9
+- SDK version: 0.1.0
+
+## [0.1.6] - 2026-01-22
+- Updated connector definition (YAML version 0.1.3)
+- Source commit: b27328e2
+- SDK version: 0.1.0
+
+## [0.1.5] - 2026-01-22
+- Updated connector definition (YAML version 0.1.3)
+- Source commit: 1da193dd
+- SDK version: 0.1.0
+
+## [0.1.4] - 2026-01-22
+- Updated connector definition (YAML version 0.1.3)
+- Source commit: c713ec48
+- SDK version: 0.1.0
+
+## [0.1.3] - 2026-01-21
+- Updated connector definition (YAML version 0.1.3)
+- Source commit: 6fbe49cd
+- SDK version: 0.1.0
+
+## [0.1.2] - 2026-01-21
+- Updated connector definition (YAML version 0.1.2)
+- Source commit: c7dab975
+- SDK version: 0.1.0
+
+## [0.1.1] - 2026-01-20
+- Updated connector definition (YAML version 0.1.2)
+- Source commit: d6d31592
+- SDK version: 0.1.0
+
+## [0.1.0] - 2026-01-19
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: cbdcf8d3
+- SDK version: 0.1.0

{airbyte_agent_zendesk_chat-0.1.3 → airbyte_agent_zendesk_chat-0.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: airbyte-agent-zendesk-chat
-Version: 0.1.3
+Version: 0.1.10
 Summary: Airbyte Zendesk-Chat Connector for AI platforms
 Project-URL: Homepage, https://github.com/airbytehq/airbyte-agent-connectors
 Project-URL: Documentation, https://docs.airbyte.com/ai-agents/
@@ -87,17 +87,52 @@ uv pip install airbyte-agent-zendesk-chat
 
 ## Usage
 
+Connectors can run in open source or hosted mode.
+
+### Open source
+
+In open source mode, you provide API credentials directly to the connector.
+
+```python
+from airbyte_agent_zendesk-chat import ZendeskChatConnector
+from airbyte_agent_zendesk_chat.models import ZendeskChatAuthConfig
+
+connector = ZendeskChatConnector(
+    auth_config=ZendeskChatAuthConfig(
+        access_token="<Your Zendesk Chat OAuth 2.0 access token>"
+    )
+)
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@ZendeskChatConnector.describe
+async def zendesk-chat_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
+```
+
+### Hosted
+
+In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead. 
+
+This example assumes you've already authenticated your connector with Airbyte. See [Authentication](AUTH.md) to learn more about authenticating. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
+
 ```python
-from airbyte_agent_zendesk_chat import ZendeskChatConnector, ZendeskChatAuthConfig
+from airbyte_agent_zendesk-chat import ZendeskChatConnector
 
 connector = ZendeskChatConnector(
-  auth_config=ZendeskChatAuthConfig(
-    access_token="..."
-  )
+    external_user_id="<your-scoped-token>",
+    airbyte_client_id="<your-client-id>",
+    airbyte_client_secret="<your-client-secret>"
 )
-result = await connector.accounts.get()
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@ZendeskChatConnector.describe
+async def zendesk-chat_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
 ```
 
+## Replication Configuration
+
+This connector supports replication configuration for MULTI mode sources. See the [full reference documentation](./REFERENCE.md#replication-configuration) for details on available options like `start_date`.
 
 ## Full documentation
 
@@ -119,12 +154,14 @@ This connector supports the following entities and actions.
 | Triggers | [List](./REFERENCE.md#triggers-list) |
 
 
+For all authentication options, see the connector's [authentication documentation](AUTH.md).
+
 For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
 
 For the service's official API docs, see the [Zendesk-Chat API reference](https://developer.zendesk.com/api-reference/live-chat/chat-api/introduction/).
 
 ## Version information
 
-- **Package version:** 0.1.3
-- **Connector version:** 0.1.3
-- **Generated with Connector SDK commit SHA:** 6fbe49cd29847836209576c7ba21d94aacc1d834
+- **Package version:** 0.1.10
+- **Connector version:** 0.1.4
+- **Generated with Connector SDK commit SHA:** 049f6ad546186bde8303b77e0e1001a831a58654

{airbyte_agent_zendesk_chat-0.1.3 → airbyte_agent_zendesk_chat-0.1.10}/README.md

@@ -54,17 +54,52 @@ uv pip install airbyte-agent-zendesk-chat
 
 ## Usage
 
+Connectors can run in open source or hosted mode.
+
+### Open source
+
+In open source mode, you provide API credentials directly to the connector.
+
+```python
+from airbyte_agent_zendesk-chat import ZendeskChatConnector
+from airbyte_agent_zendesk_chat.models import ZendeskChatAuthConfig
+
+connector = ZendeskChatConnector(
+    auth_config=ZendeskChatAuthConfig(
+        access_token="<Your Zendesk Chat OAuth 2.0 access token>"
+    )
+)
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@ZendeskChatConnector.describe
+async def zendesk-chat_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
+```
+
+### Hosted
+
+In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead. 
+
+This example assumes you've already authenticated your connector with Airbyte. See [Authentication](AUTH.md) to learn more about authenticating. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
+
 ```python
-from airbyte_agent_zendesk_chat import ZendeskChatConnector, ZendeskChatAuthConfig
+from airbyte_agent_zendesk-chat import ZendeskChatConnector
 
 connector = ZendeskChatConnector(
-  auth_config=ZendeskChatAuthConfig(
-    access_token="..."
-  )
+    external_user_id="<your-scoped-token>",
+    airbyte_client_id="<your-client-id>",
+    airbyte_client_secret="<your-client-secret>"
 )
-result = await connector.accounts.get()
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@ZendeskChatConnector.describe
+async def zendesk-chat_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
 ```
 
+## Replication Configuration
+
+This connector supports replication configuration for MULTI mode sources. See the [full reference documentation](./REFERENCE.md#replication-configuration) for details on available options like `start_date`.
 
 ## Full documentation
 
@@ -86,12 +121,14 @@ This connector supports the following entities and actions.
 | Triggers | [List](./REFERENCE.md#triggers-list) |
 
 
+For all authentication options, see the connector's [authentication documentation](AUTH.md).
+
 For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
 
 For the service's official API docs, see the [Zendesk-Chat API reference](https://developer.zendesk.com/api-reference/live-chat/chat-api/introduction/).
 
 ## Version information
 
-- **Package version:** 0.1.3
-- **Connector version:** 0.1.3
-- **Generated with Connector SDK commit SHA:** 6fbe49cd29847836209576c7ba21d94aacc1d834
+- **Package version:** 0.1.10
+- **Connector version:** 0.1.4
+- **Generated with Connector SDK commit SHA:** 049f6ad546186bde8303b77e0e1001a831a58654