airbyte-agent-zendesk-support 0.18.67__tar.gz → 0.18.69__tar.gz

{airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.69}/AUTH.md

@@ -10,11 +10,16 @@ In open source mode, you provide API credentials directly to the connector.
 
 #### OAuth
 
+`credentials` fields you need:
+
+
 | Field Name | Type | Required | Description |
 |------------|------|----------|-------------|
 | `access_token` | `str` | Yes | OAuth 2.0 access token |
 | `refresh_token` | `str` | No | OAuth 2.0 refresh token (optional) |
 
+Example request:
+
 ```python
 from airbyte_agent_zendesk-support import ZendeskSupportConnector
 from airbyte_agent_zendesk-support.models import ZendeskSupportOauth20AuthConfig
@@ -29,11 +34,15 @@ connector = ZendeskSupportConnector(
 
 #### Token
 
+`credentials` fields you need:
+
 | Field Name | Type | Required | Description |
 |------------|------|----------|-------------|
 | `email` | `str` | Yes | Your Zendesk account email address |
 | `api_token` | `str` | Yes | Your Zendesk API token from Admin Center |
 
+Example request:
+
 ```python
 from airbyte_agent_zendesk-support import ZendeskSupportConnector
 from airbyte_agent_zendesk-support.models import ZendeskSupportApiTokenAuthConfig
@@ -51,13 +60,22 @@ connector = ZendeskSupportConnector(
 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.
+
+`credentials` fields you need:
 
-Create a connector with OAuth credentials:
+
+| Field Name | Type | Required | Description |
+|------------|------|----------|-------------|
+| `access_token` | `str` | Yes | OAuth 2.0 access token |
+| `refresh_token` | `str` | No | OAuth 2.0 refresh token (optional) |
+
+Example request:
 
 ```bash
-curl -X POST 'https://api.airbyte.ai/v1/integrations/connectors' \
-  -H 'Authorization: Bearer <SCOPED_TOKEN>' \
-  -H 'Content-Type: application/json' \
+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",
@@ -70,16 +88,27 @@ curl -X POST 'https://api.airbyte.ai/v1/integrations/connectors' \
 ```
 
 #### Token
+Create a connector with Token credentials.
+
+
+`credentials` fields you need:
+
+| Field Name | Type | Required | Description |
+|------------|------|----------|-------------|
+| `email` | `str` | Yes | Your Zendesk account email address |
+| `api_token` | `str` | Yes | Your Zendesk API token from Admin Center |
+
+Example request:
 
-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' \
+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": {
       "email": "<Your Zendesk account email address>",
       "api_token": "<Your Zendesk API token from Admin Center>"

{airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.69}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Zendesk Support changelog
 
+## [0.18.69] - 2026-01-28
+- Updated connector definition (YAML version 0.1.9)
+- Source commit: f6c6fca2
+- SDK version: 0.1.0
+
+## [0.18.68] - 2026-01-28
+- Updated connector definition (YAML version 0.1.9)
+- Source commit: 71f48c10
+- SDK version: 0.1.0
+
 ## [0.18.67] - 2026-01-27
 - Updated connector definition (YAML version 0.1.9)
 - Source commit: 0f5e1914

{airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.69}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: airbyte-agent-zendesk-support
-Version: 0.18.67
+Version: 0.18.69
 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/
@@ -115,10 +115,11 @@ async def zendesk-support_execute(entity: str, action: str, params: dict | None
     return await connector.execute(entity, action, params or {})
 ```
 
-
 ## Full documentation
 
-This connector supports the following entities and actions.
+### Entities and actions
+
+This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
 
 | Entity | Actions |
 |--------|---------|
@@ -146,14 +147,16 @@ 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).
+### Authentication and configuration
+
+For all authentication and configuration 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).
+### Zendesk-Support API docs
 
-For the service's official API docs, see the [Zendesk-Support API reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
+See the official [Zendesk-Support API reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
 
 ## Version information
 
-- **Package version:** 0.18.67
+- **Package version:** 0.18.69
 - **Connector version:** 0.1.9
-- **Generated with Connector SDK commit SHA:** 0f5e1914fa0d7d52de7bc0018afab712184a0847
+- **Generated with Connector SDK commit SHA:** f6c6fca292b291b200b31e4056856465129ae703

{airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.69}/README.md

@@ -82,10 +82,11 @@ async def zendesk-support_execute(entity: str, action: str, params: dict | None
     return await connector.execute(entity, action, params or {})
 ```
 
-
 ## Full documentation
 
-This connector supports the following entities and actions.
+### Entities and actions
+
+This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
 
 | Entity | Actions |
 |--------|---------|
@@ -113,14 +114,16 @@ 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).
+### Authentication and configuration
+
+For all authentication and configuration 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).
+### Zendesk-Support API docs
 
-For the service's official API docs, see the [Zendesk-Support API reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
+See the official [Zendesk-Support API reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
 
 ## Version information
 
-- **Package version:** 0.18.67
+- **Package version:** 0.18.69
 - **Connector version:** 0.1.9
-- **Generated with Connector SDK commit SHA:** 0f5e1914fa0d7d52de7bc0018afab712184a0847
+- **Generated with Connector SDK commit SHA:** f6c6fca292b291b200b31e4056856465129ae703

{airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.69}/REFERENCE.md

@@ -3748,4 +3748,3 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_i
 | `range_header` | `string` | No | Optional Range header for partial downloads (e.g., 'bytes=0-99') |
 
 
-

{airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.69}/airbyte_agent_zendesk_support/_vendored/connector_sdk/introspection.py

@@ -380,7 +380,11 @@ def describe_entities(model: ConnectorModelProtocol) -> list[dict[str, Any]]:
     return entities
 
 
-def generate_tool_description(model: ConnectorModelProtocol) -> str:
+def generate_tool_description(
+    model: ConnectorModelProtocol,
+    *,
+    enable_hosted_mode_features: bool = True,
+) -> str:
     """Generate AI tool description from connector metadata.
 
     Produces a detailed description that includes:
@@ -393,6 +397,7 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
 
     Args:
         model: Object conforming to ConnectorModelProtocol (e.g., ConnectorModel)
+        enable_hosted_mode_features: When False, omit hosted-mode search guidance from the docstring.
 
     Returns:
         Formatted description string suitable for AI tool documentation
@@ -402,8 +407,9 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
     # at the first empty line and only keeps the initial section.
 
     # Entity/action parameter details (including pagination params like limit, starting_after)
-    search_field_paths = _collect_search_field_paths(model)
-    lines.append("ENTITIES AND PARAMETERS:")
+    search_field_paths = _collect_search_field_paths(model) if enable_hosted_mode_features else {}
+    # Avoid a "PARAMETERS:" header because some docstring parsers treat it as a params section marker.
+    lines.append("ENTITIES (ACTIONS + PARAMS):")
     for entity in model.entities:
         lines.append(f"  {entity.name}:")
         actions = getattr(entity, "actions", []) or []
@@ -427,8 +433,9 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
     lines.append("  To paginate: pass starting_after=<last_id> while has_more is true")
 
     lines.append("GUIDELINES:")
-    lines.append('  - Prefer cached search over direct API calls when using execute(): action="search" whenever possible.')
-    lines.append("  - Direct API actions (list/get/download) are slower and should be used only if search cannot answer the query.")
+    if enable_hosted_mode_features:
+        lines.append('  - Prefer cached search over direct API calls when using execute(): action="search" whenever possible.')
+        lines.append("  - Direct API actions (list/get/download) are slower and should be used only if search cannot answer the query.")
     lines.append("  - Keep results small: use params.fields, params.query.filter, small params.limit, and cursor pagination.")
     lines.append("  - If output is too large, refine the query with tighter filters/fields/limit.")
 

{airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.69}/airbyte_agent_zendesk_support/connector.py

@@ -817,6 +817,7 @@ class ZendeskSupportConnector:
         func: _F | None = None,
         *,
         update_docstring: bool = True,
+        enable_hosted_mode_features: bool = True,
         max_output_chars: int | None = DEFAULT_MAX_OUTPUT_CHARS,
     ) -> _F | Callable[[_F], _F]:
         """
@@ -835,12 +836,16 @@ class ZendeskSupportConnector:
 
         Args:
             update_docstring: When True, append connector capabilities to __doc__.
+            enable_hosted_mode_features: When False, omit hosted-mode search sections from docstrings.
             max_output_chars: Max serialized output size before raising. Use None to disable.
         """
 
         def decorate(inner: _F) -> _F:
             if update_docstring:
-                description = generate_tool_description(ZendeskSupportConnectorModel)
+                description = generate_tool_description(
+                    ZendeskSupportConnectorModel,
+                    enable_hosted_mode_features=enable_hosted_mode_features,
+                )
                 original_doc = inner.__doc__ or ""
                 if original_doc.strip():
                     full_doc = f"{original_doc.strip()}\n{description}"

{airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.69}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "airbyte-agent-zendesk-support"
-version = "0.18.67"
+version = "0.18.69"
 description = "Airbyte Zendesk-Support Connector for AI platforms"
 readme = "README.md"
 requires-python = ">=3.13"