airbyte-agent-zendesk-support 0.18.48__tar.gz → 0.18.58__tar.gz

airbyte_agent_zendesk_support-0.18.58/AUTH.md

@@ -0,0 +1,127 @@
+# Zendesk-Support authentication and configuration
+
+This page documents the authentication and configuration options for the Zendesk-Support 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 | OAuth 2.0 access token |
+| `refresh_token` | `str` | No | OAuth 2.0 refresh token (optional) |
+
+```python
+from airbyte_agent_zendesk-support import ZendeskSupportConnector
+from airbyte_agent_zendesk-support.models import ZendeskSupportOauth20AuthConfig
+
+connector = ZendeskSupportConnector(
+    auth_config=ZendeskSupportOauth20AuthConfig(
+        access_token="<OAuth 2.0 access token>",
+        refresh_token="<OAuth 2.0 refresh token (optional)>"
+    )
+)
+```
+
+#### Token
+
+| Field Name | Type | Required | Description |
+|------------|------|----------|-------------|
+| `email` | `str` | Yes | Your Zendesk account email address |
+| `api_token` | `str` | Yes | Your Zendesk API token from Admin Center |
+
+```python
+from airbyte_agent_zendesk-support import ZendeskSupportConnector
+from airbyte_agent_zendesk-support.models import ZendeskSupportApiTokenAuthConfig
+
+connector = ZendeskSupportConnector(
+    auth_config=ZendeskSupportApiTokenAuthConfig(
+        email="<Your Zendesk account email address>",
+        api_token="<Your Zendesk API token from Admin Center>"
+    )
+)
+```
+
+### 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-Support",
+    "name": "My Zendesk-Support Connector",
+    "credentials": {
+      "access_token": "<OAuth 2.0 access token>",
+      "refresh_token": "<OAuth 2.0 refresh token (optional)>"
+    }
+  }'
+```
+
+#### Token
+
+Create a connector with Token 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-Support",
+    "credentials": {
+      "email": "<Your Zendesk account email address>",
+      "api_token": "<Your Zendesk API token from Admin Center>"
+    }
+  }'
+```
+
+#### Execution
+
+After creating the connector, execute operations using either the Python SDK or API.
+
+**Python SDK**
+
+```python
+from airbyte_agent_zendesk-support import ZendeskSupportConnector
+
+connector = ZendeskSupportConnector(
+    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
+@ZendeskSupportConnector.describe
+async def zendesk-support_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-Support 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 |

{airbyte_agent_zendesk_support-0.18.48 → airbyte_agent_zendesk_support-0.18.58}/CHANGELOG.md

@@ -1,5 +1,55 @@
 # Zendesk Support changelog
 
+## [0.18.58] - 2026-01-23
+- Updated connector definition (YAML version 0.1.7)
+- Source commit: f17cdd8c
+- SDK version: 0.1.0
+
+## [0.18.57] - 2026-01-22
+- Updated connector definition (YAML version 0.1.7)
+- Source commit: 49e6dfe9
+- SDK version: 0.1.0
+
+## [0.18.56] - 2026-01-22
+- Updated connector definition (YAML version 0.1.7)
+- Source commit: b27328e2
+- SDK version: 0.1.0
+
+## [0.18.55] - 2026-01-22
+- Updated connector definition (YAML version 0.1.7)
+- Source commit: 1da193dd
+- SDK version: 0.1.0
+
+## [0.18.54] - 2026-01-22
+- Updated connector definition (YAML version 0.1.7)
+- Source commit: c713ec48
+- SDK version: 0.1.0
+
+## [0.18.53] - 2026-01-21
+- Updated connector definition (YAML version 0.1.7)
+- Source commit: 6fbe49cd
+- SDK version: 0.1.0
+
+## [0.18.52] - 2026-01-21
+- Updated connector definition (YAML version 0.1.6)
+- Source commit: c7dab975
+- SDK version: 0.1.0
+
+## [0.18.51] - 2026-01-19
+- Updated connector definition (YAML version 0.1.6)
+- Source commit: 529cebb7
+- SDK version: 0.1.0
+
+## [0.18.50] - 2026-01-16
+- Updated connector definition (YAML version 0.1.6)
+- Source commit: a50c8f71
+- SDK version: 0.1.0
+
+## [0.18.49] - 2026-01-16
+- Updated connector definition (YAML version 0.1.6)
+- Source commit: 49673b7b
+- SDK version: 0.1.0
+
 ## [0.18.48] - 2026-01-16
 - Updated connector definition (YAML version 0.1.6)
 - Source commit: 05c940e3

{airbyte_agent_zendesk_support-0.18.48 → airbyte_agent_zendesk_support-0.18.58}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: airbyte-agent-zendesk-support
-Version: 0.18.48
+Version: 0.18.58
 Summary: Airbyte Zendesk-Support Connector for AI platforms
 Project-URL: Homepage, https://github.com/airbytehq/airbyte-agent-connectors
 Project-URL: Documentation, https://docs.airbyte.com/ai-agents/
@@ -71,38 +71,49 @@ uv pip install airbyte-agent-zendesk-support
 
 ## Usage
 
-This connector supports multiple authentication methods:
+Connectors can run in open source or hosted mode.
 
-### OAuth 2.0
+### Open source
+
+In open source mode, you provide API credentials directly to the connector.
 
 ```python
-from airbyte_agent_zendesk_support import ZendeskSupportConnector
-from airbyte_agent_zendesk_support.models import ZendeskSupportOauth20AuthConfig
+from airbyte_agent_zendesk-support import ZendeskSupportConnector
+from airbyte_agent_zendesk_support.models import ZendeskSupportApiTokenAuthConfig
 
 connector = ZendeskSupportConnector(
-  auth_config=ZendeskSupportOauth20AuthConfig(
-    access_token="...",
-    refresh_token="..."
-  )
+    auth_config=ZendeskSupportApiTokenAuthConfig(
+        email="<Your Zendesk account email address>",
+        api_token="<Your Zendesk API token from Admin Center>"
+    )
 )
-result = await connector.tickets.list()
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@ZendeskSupportConnector.describe
+async def zendesk-support_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
 ```
 
-### API Token
+### 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_support import ZendeskSupportConnector
-from airbyte_agent_zendesk_support.models import ZendeskSupportApiTokenAuthConfig
+from airbyte_agent_zendesk-support import ZendeskSupportConnector
 
 connector = ZendeskSupportConnector(
-  auth_config=ZendeskSupportApiTokenAuthConfig(
-    email="...",
-    api_token="..."
-  )
+    external_user_id="<your-scoped-token>",
+    airbyte_client_id="<your-client-id>",
+    airbyte_client_secret="<your-client-secret>"
 )
-result = await connector.tickets.list()
-```
 
+@agent.tool_plain # assumes you're using Pydantic AI
+@ZendeskSupportConnector.describe
+async def zendesk-support_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
+```
 
 ## Full documentation
 
@@ -134,12 +145,14 @@ This connector supports the following entities and actions.
 | Article Attachments | [List](./REFERENCE.md#article-attachments-list), [Get](./REFERENCE.md#article-attachments-get), [Download](./REFERENCE.md#article-attachments-download) |
 
 
+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-Support API reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
 
 ## Version information
 
-- **Package version:** 0.18.48
-- **Connector version:** 0.1.6
-- **Generated with Connector SDK commit SHA:** 05c940e318ec945d474b4d7de78273000604608c
+- **Package version:** 0.18.58
+- **Connector version:** 0.1.7
+- **Generated with Connector SDK commit SHA:** f17cdd8c92950751a75daff9c6bf74df05774ede

{airbyte_agent_zendesk_support-0.18.48 → airbyte_agent_zendesk_support-0.18.58}/README.md

@@ -38,38 +38,49 @@ uv pip install airbyte-agent-zendesk-support
 
 ## Usage
 
-This connector supports multiple authentication methods:
+Connectors can run in open source or hosted mode.
 
-### OAuth 2.0
+### Open source
+
+In open source mode, you provide API credentials directly to the connector.
 
 ```python
-from airbyte_agent_zendesk_support import ZendeskSupportConnector
-from airbyte_agent_zendesk_support.models import ZendeskSupportOauth20AuthConfig
+from airbyte_agent_zendesk-support import ZendeskSupportConnector
+from airbyte_agent_zendesk_support.models import ZendeskSupportApiTokenAuthConfig
 
 connector = ZendeskSupportConnector(
-  auth_config=ZendeskSupportOauth20AuthConfig(
-    access_token="...",
-    refresh_token="..."
-  )
+    auth_config=ZendeskSupportApiTokenAuthConfig(
+        email="<Your Zendesk account email address>",
+        api_token="<Your Zendesk API token from Admin Center>"
+    )
 )
-result = await connector.tickets.list()
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@ZendeskSupportConnector.describe
+async def zendesk-support_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
 ```
 
-### API Token
+### 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_support import ZendeskSupportConnector
-from airbyte_agent_zendesk_support.models import ZendeskSupportApiTokenAuthConfig
+from airbyte_agent_zendesk-support import ZendeskSupportConnector
 
 connector = ZendeskSupportConnector(
-  auth_config=ZendeskSupportApiTokenAuthConfig(
-    email="...",
-    api_token="..."
-  )
+    external_user_id="<your-scoped-token>",
+    airbyte_client_id="<your-client-id>",
+    airbyte_client_secret="<your-client-secret>"
 )
-result = await connector.tickets.list()
-```
 
+@agent.tool_plain # assumes you're using Pydantic AI
+@ZendeskSupportConnector.describe
+async def zendesk-support_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
+```
 
 ## Full documentation
 
@@ -101,12 +112,14 @@ This connector supports the following entities and actions.
 | Article Attachments | [List](./REFERENCE.md#article-attachments-list), [Get](./REFERENCE.md#article-attachments-get), [Download](./REFERENCE.md#article-attachments-download) |
 
 
+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-Support API reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
 
 ## Version information
 
-- **Package version:** 0.18.48
-- **Connector version:** 0.1.6
-- **Generated with Connector SDK commit SHA:** 05c940e318ec945d474b4d7de78273000604608c
+- **Package version:** 0.18.58
+- **Connector version:** 0.1.7
+- **Generated with Connector SDK commit SHA:** f17cdd8c92950751a75daff9c6bf74df05774ede