airbyte-agent-zendesk-support 0.18.77__tar.gz → 0.18.79__tar.gz

{airbyte_agent_zendesk_support-0.18.77 → airbyte_agent_zendesk_support-0.18.79}/AUTH.md

@@ -87,6 +87,59 @@ curl -X POST "https://api.airbyte.ai/v1/integrations/connectors" \
   }'
 ```
 
+
+
+#### Bring your own OAuth flow
+To implement your own OAuth flow, use Airbyte's server-side OAuth API endpoints. For a complete guide, see [Implement your own OAuth flow](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-server-side-oauth).
+
+**Step 1: Initiate the OAuth flow**
+
+Request a consent URL for your user.
+
+| Field Name | Type | Required | Description |
+|------------|------|----------|-------------|
+| `external_user_id` | `string` | Yes | Your unique identifier for the end user |
+| `connector_type` | `string` | Yes | The connector type (e.g., "Zendesk-Support") |
+| `redirect_url` | `string` | Yes | URL to redirect to after OAuth authorization |
+
+Example request:
+
+```bash
+curl -X POST "https://api.airbyte.ai/v1/integrations/connectors/oauth/initiate" \
+  -H "Authorization: Bearer <BEARER_TOKEN>" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "external_user_id": "<EXTERNAL_USER_ID>",
+    "connector_type": "Zendesk-Support",
+    "redirect_url": "https://yourapp.com/oauth/callback"
+  }'
+```
+
+Redirect your user to the `consent_url` from the response. After they authorize, they'll be redirected back to your app with a `secret_id` query parameter.
+
+**Step 2: Create a connector with the secret ID**
+
+| Field Name | Type | Required | Description |
+|------------|------|----------|-------------|
+| `external_user_id` | `string` | Yes | Your unique identifier for the end user |
+| `connector_type` | `string` | Yes | The connector type (e.g., "Zendesk-Support") |
+| `name` | `string` | Yes | A name for this connector instance |
+| `server_side_oauth_secret_id` | `string` | Yes | The secret_id from the OAuth callback |
+
+Example request:
+
+```bash
+curl -X POST "https://api.airbyte.ai/v1/integrations/connectors" \
+  -H "Authorization: Bearer <BEARER_TOKEN>" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "external_user_id": "<EXTERNAL_USER_ID>",
+    "connector_type": "Zendesk-Support",
+    "name": "My Zendesk-Support Connector",
+    "server_side_oauth_secret_id": "<secret_id_from_callback>"
+  }'
+```
+
 #### Token
 Create a connector with Token credentials.
 

{airbyte_agent_zendesk_support-0.18.77 → airbyte_agent_zendesk_support-0.18.79}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Zendesk Support changelog
 
+## [0.18.79] - 2026-02-02
+- Updated connector definition (YAML version 0.1.11)
+- Source commit: 94024675
+- SDK version: 0.1.0
+
+## [0.18.78] - 2026-02-02
+- Updated connector definition (YAML version 0.1.11)
+- Source commit: 9d9866b0
+- SDK version: 0.1.0
+
 ## [0.18.77] - 2026-01-30
 - Updated connector definition (YAML version 0.1.11)
 - Source commit: b184da3e

{airbyte_agent_zendesk_support-0.18.77 → airbyte_agent_zendesk_support-0.18.79}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: airbyte-agent-zendesk-support
-Version: 0.18.77
+Version: 0.18.79
 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/
@@ -157,7 +157,7 @@ See the official [Zendesk-Support API reference](https://developer.zendesk.com/a
 
 ## Version information
 
-- **Package version:** 0.18.77
+- **Package version:** 0.18.79
 - **Connector version:** 0.1.11
-- **Generated with Connector SDK commit SHA:** b184da3e22ef8521d2eeebf3c96a0fe8da2424f5
+- **Generated with Connector SDK commit SHA:** 940246757c7476ed4edd7d16b873ebe54ea2b456
 - **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/zendesk-support/CHANGELOG.md)

{airbyte_agent_zendesk_support-0.18.77 → airbyte_agent_zendesk_support-0.18.79}/README.md

@@ -124,7 +124,7 @@ See the official [Zendesk-Support API reference](https://developer.zendesk.com/a
 
 ## Version information
 
-- **Package version:** 0.18.77
+- **Package version:** 0.18.79
 - **Connector version:** 0.1.11
-- **Generated with Connector SDK commit SHA:** b184da3e22ef8521d2eeebf3c96a0fe8da2424f5
+- **Generated with Connector SDK commit SHA:** 940246757c7476ed4edd7d16b873ebe54ea2b456
 - **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/zendesk-support/CHANGELOG.md)

{airbyte_agent_zendesk_support-0.18.77 → airbyte_agent_zendesk_support-0.18.79}/airbyte_agent_zendesk_support/_vendored/connector_sdk/cloud_utils/client.py

@@ -161,24 +161,80 @@ class AirbyteCloudClient:
         connector_id = connectors[0]["id"]
         return connector_id
 
+    async def initiate_oauth(
+        self,
+        definition_id: str,
+        external_user_id: str,
+        redirect_url: str,
+    ) -> str:
+        """Initiate a server-side OAuth flow.
+
+        Starts the OAuth flow for a connector. Returns a consent URL where the
+        end user should be redirected to grant access. After completing consent,
+        they'll be redirected to your redirect_url with a `server_side_oauth_secret_id`
+        query parameter that can be used with `create_source()`.
+
+        Args:
+            definition_id: Connector definition UUID
+            external_user_id: Workspace identifier
+            redirect_url: URL where users will be redirected after OAuth consent
+
+        Returns:
+            The OAuth consent URL
+
+        Raises:
+            httpx.HTTPStatusError: If the request fails
+
+        Example:
+            consent_url = await client.initiate_oauth(
+                definition_id="d8313939-3782-41b0-be29-b3ca20d8dd3a",
+                external_user_id="my-workspace",
+                redirect_url="https://myapp.com/oauth/callback",
+            )
+            # Redirect user to: consent_url
+            # After consent: https://myapp.com/oauth/callback?server_side_oauth_secret_id=...
+        """
+        token = await self.get_bearer_token()
+        url = f"{self.API_BASE_URL}/api/v1/integrations/connectors/oauth/initiate"
+        headers = {"Authorization": f"Bearer {token}"}
+        request_body = {
+            "external_user_id": external_user_id,
+            "definition_id": definition_id,
+            "redirect_url": redirect_url,
+        }
+
+        response = await self._http_client.post(url, json=request_body, headers=headers)
+        response.raise_for_status()
+        return response.json()["consent_url"]
+
     async def create_source(
         self,
         name: str,
         connector_definition_id: str,
         external_user_id: str,
-        credentials: dict[str, Any],
+        credentials: dict[str, Any] | None = None,
         replication_config: dict[str, Any] | None = None,
+        server_side_oauth_secret_id: str | None = None,
+        source_template_id: str | None = None,
     ) -> str:
-        """Create a new source on Airbyte Agent Platform.
+        """Create a new source on Airbyte Cloud.
+
+        Supports two authentication modes:
+        1. Direct credentials: Provide `credentials` dict
+        2. Server-side OAuth: Provide `server_side_oauth_secret_id` from OAuth flow
 
         Args:
             name: Source name
             connector_definition_id: UUID of the connector definition
             external_user_id: User identifier
-            credentials: Connector auth config dict
+            credentials: Connector auth config dict. Required unless using OAuth.
             replication_config: Optional replication settings (e.g., start_date for
                 connectors with x-airbyte-replication-config). Required for REPLICATION
                 mode sources like Intercom.
+            server_side_oauth_secret_id: OAuth secret ID from initiate_oauth redirect.
+                When provided, credentials are not required.
+            source_template_id: Source template ID. Required when organization has
+                multiple source templates for this connector type.
 
         Returns:
             The created source ID (UUID string)
@@ -187,19 +243,21 @@ class AirbyteCloudClient:
             httpx.HTTPStatusError: If creation fails
 
         Example:
+            # With direct credentials:
             source_id = await client.create_source(
-                name="My Gong Source",
-                connector_definition_id="32382e40-3b49-4b99-9c5c-4076501914e7",
+                name="My Intercom Source",
+                connector_definition_id="d8313939-3782-41b0-be29-b3ca20d8dd3a",
                 external_user_id="my-workspace",
-                credentials={"access_key": "...", "access_key_secret": "..."}
+                credentials={"access_token": "..."},
+                replication_config={"start_date": "2024-01-01T00:00:00Z"}
             )
 
-            # For REPLICATION mode sources (e.g., Intercom):
+            # With server-side OAuth:
             source_id = await client.create_source(
                 name="My Intercom Source",
                 connector_definition_id="d8313939-3782-41b0-be29-b3ca20d8dd3a",
                 external_user_id="my-workspace",
-                credentials={"access_token": "..."},
+                server_side_oauth_secret_id="airbyte_oauth_..._secret_...",
                 replication_config={"start_date": "2024-01-01T00:00:00Z"}
             )
         """
@@ -211,11 +269,16 @@ class AirbyteCloudClient:
             "name": name,
             "definition_id": connector_definition_id,
             "external_user_id": external_user_id,
-            "credentials": credentials,
         }
 
+        if credentials is not None:
+            request_body["credentials"] = credentials
         if replication_config is not None:
             request_body["replication_config"] = replication_config
+        if server_side_oauth_secret_id is not None:
+            request_body["server_side_oauth_secret_id"] = server_side_oauth_secret_id
+        if source_template_id is not None:
+            request_body["source_template_id"] = source_template_id
 
         response = await self._http_client.post(url, json=request_body, headers=headers)
         response.raise_for_status()

{airbyte_agent_zendesk_support-0.18.77 → airbyte_agent_zendesk_support-0.18.79}/airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/base.py

@@ -10,7 +10,7 @@ from enum import StrEnum
 from typing import Any, Dict
 from uuid import UUID
 
-from pydantic import BaseModel, ConfigDict, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
 from pydantic_core import Url
 
 from .extensions import CacheConfig, ReplicationConfig, RetryConfig
@@ -210,3 +210,34 @@ class Server(BaseModel):
             raise ValueError("Server URL cannot be empty")
         # Allow both absolute URLs and relative paths
         return v
+
+    @model_validator(mode="after")
+    def validate_replication_environment_mapping(self) -> "Server":
+        """Validate that x-airbyte-replication-environment-mapping sources exist in variables.
+
+        For simple mappings like {"subdomain": "subdomain"}, the key is the source variable.
+        For transform mappings like {"domain": {"source": "subdomain", "format": "..."}},
+        the "source" field is the source variable.
+        """
+        env_mapping = self.x_airbyte_replication_environment_mapping
+        if not env_mapping or not self.variables:
+            return self
+
+        variable_names = set(self.variables.keys())
+
+        for env_key, mapping_value in env_mapping.items():
+            if isinstance(mapping_value, str):
+                source_var = env_key
+            elif isinstance(mapping_value, EnvironmentMappingTransform):
+                source_var = mapping_value.source
+            else:
+                continue
+
+            if source_var not in variable_names:
+                available = ", ".join(sorted(variable_names)) if variable_names else "(none)"
+                raise ValueError(
+                    f"x-airbyte-replication-environment-mapping: source variable '{source_var}' "
+                    f"not found in server variables. Available: {available}"
+                )
+
+        return self

{airbyte_agent_zendesk_support-0.18.77 → airbyte_agent_zendesk_support-0.18.79}/airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/extensions.py

@@ -14,7 +14,7 @@ are implemented.
 
 from typing import Literal
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, model_validator
 
 
 class PaginationConfig(BaseModel):
@@ -252,6 +252,24 @@ class ReplicationConfig(BaseModel):
         description="Mapping from replication_config field names to source_config field names",
     )
 
+    @model_validator(mode="after")
+    def validate_replication_config_key_mapping(self) -> "ReplicationConfig":
+        """Validate that replication_config_key_mapping keys exist in properties.
+
+        The mapping is: {local_key: airbyte_path}
+        We validate that local_key exists in our properties.
+        """
+        if self.replication_config_key_mapping and self.properties:
+            property_names = set(self.properties.keys())
+            for local_key, airbyte_path in self.replication_config_key_mapping.items():
+                if local_key not in property_names:
+                    available = ", ".join(sorted(property_names)) if property_names else "(none)"
+                    raise ValueError(
+                        f"replication_config_key_mapping: local key '{local_key}' "
+                        f"(mapped to '{airbyte_path}') not found in properties. Available: {available}"
+                    )
+        return self
+
 
 class CacheConfig(BaseModel):
     """

{airbyte_agent_zendesk_support-0.18.77 → airbyte_agent_zendesk_support-0.18.79}/airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/security.py

@@ -81,6 +81,21 @@ class AuthConfigOption(BaseModel):
         description="Mapping from source config paths (e.g., 'credentials.api_key') to auth config keys for direct connectors",
     )
 
+    @model_validator(mode="after")
+    def validate_replication_auth_key_mapping(self) -> "AuthConfigOption":
+        """Validate that replication_auth_key_mapping target keys exist in properties."""
+        if self.replication_auth_key_mapping and self.properties:
+            property_names = set(self.properties.keys())
+            for airbyte_path, our_key in self.replication_auth_key_mapping.items():
+                if our_key not in property_names:
+                    option_context = f"oneOf option '{self.title}'" if self.title else "oneOf option"
+                    available = ", ".join(sorted(property_names)) if property_names else "(none)"
+                    raise ValueError(
+                        f"replication_auth_key_mapping in {option_context}: target key '{our_key}' "
+                        f"(mapped from '{airbyte_path}') not found in properties. Available: {available}"
+                    )
+        return self
+
 
 class AirbyteAuthConfig(BaseModel):
     """
@@ -146,8 +161,30 @@ class AirbyteAuthConfig(BaseModel):
             if not self.auth_mapping:
                 raise ValueError("Single auth option must have auth_mapping")
 
+            # Validate replication_auth_key_mapping targets exist in properties
+            if self.replication_auth_key_mapping and self.properties:
+                self._validate_replication_auth_key_mapping(self.replication_auth_key_mapping, self.properties, context="x-airbyte-auth-config")
+
         return self
 
+    @staticmethod
+    def _validate_replication_auth_key_mapping(mapping: Dict[str, str], properties: Dict[str, AuthConfigFieldSpec], context: str) -> None:
+        """Validate that replication_auth_key_mapping target keys exist in properties.
+
+        Args:
+            mapping: The replication_auth_key_mapping dict (airbyte_path -> our_key)
+            properties: The properties dict from x-airbyte-auth-config
+            context: Context string for error messages
+        """
+        property_names = set(properties.keys())
+        for airbyte_path, our_key in mapping.items():
+            if our_key not in property_names:
+                available = ", ".join(sorted(property_names)) if property_names else "(none)"
+                raise ValueError(
+                    f"replication_auth_key_mapping in {context}: target key '{our_key}' "
+                    f"(mapped from '{airbyte_path}') not found in properties. Available: {available}"
+                )
+
 
 class SecurityScheme(BaseModel):
     """

{airbyte_agent_zendesk_support-0.18.77 → airbyte_agent_zendesk_support-0.18.79}/airbyte_agent_zendesk_support/connector.py

@@ -987,6 +987,59 @@ class ZendeskSupportConnector:
 
     # ===== HOSTED MODE FACTORY =====
 
+    @classmethod
+    async def initiate_oauth(
+        cls,
+        *,
+        external_user_id: str,
+        redirect_url: str,
+        airbyte_client_id: str,
+        airbyte_client_secret: str,
+    ) -> str:
+        """
+        Initiate server-side OAuth flow for this connector.
+
+        Returns a consent URL where the end user should be redirected to grant access.
+        After completing consent, they'll be redirected to your redirect_url with a
+        `server_side_oauth_secret_id` query parameter that can be used with `create_hosted()`.
+
+        Args:
+            external_user_id: Workspace identifier in Airbyte Cloud
+            redirect_url: URL where users will be redirected after OAuth consent
+            airbyte_client_id: Airbyte OAuth client ID
+            airbyte_client_secret: Airbyte OAuth client secret
+
+        Returns:
+            The OAuth consent URL
+
+        Example:
+            consent_url = await ZendeskSupportConnector.initiate_oauth(
+                external_user_id="my-workspace",
+                redirect_url="https://myapp.com/oauth/callback",
+                airbyte_client_id="client_abc",
+                airbyte_client_secret="secret_xyz",
+            )
+            # Redirect user to: consent_url
+            # After consent, user arrives at: https://myapp.com/oauth/callback?server_side_oauth_secret_id=...
+        """
+        from ._vendored.connector_sdk.cloud_utils import AirbyteCloudClient
+
+        client = AirbyteCloudClient(
+            client_id=airbyte_client_id,
+            client_secret=airbyte_client_secret,
+        )
+
+        try:
+            consent_url = await client.initiate_oauth(
+                definition_id=str(ZendeskSupportConnectorModel.id),
+                external_user_id=external_user_id,
+                redirect_url=redirect_url,
+            )
+        finally:
+            await client.close()
+
+        return consent_url
+
     @classmethod
     async def create_hosted(
         cls,
@@ -994,9 +1047,11 @@ class ZendeskSupportConnector:
         external_user_id: str,
         airbyte_client_id: str,
         airbyte_client_secret: str,
-        auth_config: "ZendeskSupportAuthConfig",
+        auth_config: "ZendeskSupportAuthConfig" | None = None,
+        server_side_oauth_secret_id: str | None = None,
         name: str | None = None,
         replication_config: dict[str, Any] | None = None,
+        source_template_id: str | None = None,
     ) -> "ZendeskSupportConnector":
         """
         Create a new hosted connector on Airbyte Cloud.
@@ -1005,18 +1060,29 @@ class ZendeskSupportConnector:
         1. Creates a source on Airbyte Cloud with the provided credentials
         2. Returns a connector configured with the new connector_id
 
+        Supports two authentication modes:
+        1. Direct credentials: Provide `auth_config` with typed credentials
+        2. Server-side OAuth: Provide `server_side_oauth_secret_id` from OAuth flow
+
         Args:
             external_user_id: Workspace identifier in Airbyte Cloud
             airbyte_client_id: Airbyte OAuth client ID
             airbyte_client_secret: Airbyte OAuth client secret
-            auth_config: Typed auth config (same as local mode)
+            auth_config: Typed auth config. Required unless using server_side_oauth_secret_id.
+            server_side_oauth_secret_id: OAuth secret ID from initiate_oauth redirect.
+                When provided, auth_config is not required.
             name: Optional source name (defaults to connector name + external_user_id)
             replication_config: Optional replication settings dict.
                 Required for connectors with x-airbyte-replication-config (REPLICATION mode sources).
+            source_template_id: Source template ID. Required when organization has
+                multiple source templates for this connector type.
 
         Returns:
             A ZendeskSupportConnector instance configured in hosted mode
 
+        Raises:
+            ValueError: If neither or both auth_config and server_side_oauth_secret_id provided
+
         Example:
             # Create a new hosted connector with API key auth
             connector = await ZendeskSupportConnector.create_hosted(
@@ -1026,9 +1092,27 @@ class ZendeskSupportConnector:
                 auth_config=ZendeskSupportAuthConfig(access_token="...", refresh_token="..."),
             )
 
+            # With server-side OAuth:
+            connector = await ZendeskSupportConnector.create_hosted(
+                external_user_id="my-workspace",
+                airbyte_client_id="client_abc",
+                airbyte_client_secret="secret_xyz",
+                server_side_oauth_secret_id="airbyte_oauth_..._secret_...",
+            )
+
             # Use the connector
             result = await connector.execute("entity", "list", {})
         """
+        # Validate: exactly one of auth_config or server_side_oauth_secret_id required
+        if auth_config is None and server_side_oauth_secret_id is None:
+            raise ValueError(
+                "Either auth_config or server_side_oauth_secret_id must be provided"
+            )
+        if auth_config is not None and server_side_oauth_secret_id is not None:
+            raise ValueError(
+                "Cannot provide both auth_config and server_side_oauth_secret_id"
+            )
+
         from ._vendored.connector_sdk.cloud_utils import AirbyteCloudClient
 
         client = AirbyteCloudClient(
@@ -1037,8 +1121,8 @@ class ZendeskSupportConnector:
         )
 
         try:
-            # Build credentials from auth_config
-            credentials = auth_config.model_dump(exclude_none=True)
+            # Build credentials from auth_config (if provided)
+            credentials = auth_config.model_dump(exclude_none=True) if auth_config else None
             replication_config_dict = replication_config.model_dump(exclude_none=True) if replication_config else None
 
             # Create source on Airbyte Cloud
@@ -1049,6 +1133,8 @@ class ZendeskSupportConnector:
                 external_user_id=external_user_id,
                 credentials=credentials,
                 replication_config=replication_config_dict,
+                server_side_oauth_secret_id=server_side_oauth_secret_id,
+                source_template_id=source_template_id,
             )
         finally:
             await client.close()
@@ -1062,6 +1148,7 @@ class ZendeskSupportConnector:
 
 
 
+
 class TicketsQuery:
     """
     Query class for Tickets entity operations.

{airbyte_agent_zendesk_support-0.18.77 → airbyte_agent_zendesk_support-0.18.79}/pyproject.toml

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