airbyte-agent-zendesk-support 0.18.39__py3-none-any.whl → 0.18.51__py3-none-any.whl

airbyte_agent_zendesk_support/_vendored/connector_sdk/http_client.py

@@ -421,10 +421,14 @@ class HTTPClient:
         headers: dict[str, str] | None = None,
         *,
         stream: bool = False,
-    ):
+    ) -> tuple[dict[str, Any], dict[str, str]]:
         """Execute a single HTTP request attempt (no retries).
 
         This is the core request logic, separated from retry handling.
+
+        Returns:
+            Tuple of (response_data, response_headers) for non-streaming requests.
+            For streaming requests, returns (response_object, response_headers).
         """
         # Ensure auth credentials are initialized (proactive refresh if needed)
         await self._ensure_auth_initialized()
@@ -474,8 +478,9 @@ class HTTPClient:
                     request_id=request_id,
                     status_code=status_code,
                     response_body=f"<binary content, {response.headers.get('content-length', 'unknown')} bytes>",
+                    response_headers=dict(response.headers),
                 )
-                return response
+                return response, dict(response.headers)
 
             # Parse response - handle non-JSON responses gracefully
             content_type = response.headers.get("content-type", "")
@@ -500,8 +505,9 @@ class HTTPClient:
                 request_id=request_id,
                 status_code=status_code,
                 response_body=response_data,
+                response_headers=dict(response.headers),
             )
-            return response_data
+            return response_data, dict(response.headers)
 
         except AuthenticationError as e:
             # Auth error (401, 403) - handle token refresh
@@ -631,7 +637,7 @@ class HTTPClient:
         *,
         stream: bool = False,
         _auth_retry_attempted: bool = False,
-    ):
+    ) -> tuple[dict[str, Any], dict[str, str]]:
         """Make an async HTTP request with optional streaming and automatic retries.
 
         Args:
@@ -644,8 +650,9 @@ class HTTPClient:
             stream: If True, do not eagerly read the body (useful for downloads)
 
         Returns:
-            - If stream=False: Parsed JSON (dict) or empty dict
-            - If stream=True: Response object suitable for streaming
+            Tuple of (response_data, response_headers):
+            - If stream=False: (parsed JSON dict or empty dict, response headers dict)
+            - If stream=True: (response object suitable for streaming, response headers dict)
 
         Raises:
             HTTPStatusError: If request fails with 4xx/5xx status after all retries

airbyte_agent_zendesk_support/_vendored/connector_sdk/logging/logger.py

@@ -134,6 +134,7 @@ class RequestLogger:
         request_id: str,
         status_code: int,
         response_body: Any | None = None,
+        response_headers: Dict[str, str] | None = None,
     ) -> None:
         """
         Log a successful HTTP response.
@@ -142,6 +143,7 @@ class RequestLogger:
             request_id: ID returned from log_request
             status_code: HTTP status code
             response_body: Response body
+            response_headers: Response headers
         """
         if request_id not in self._active_requests:
             return
@@ -166,6 +168,7 @@ class RequestLogger:
             body=request_data["body"],
             response_status=status_code,
             response_body=serializable_body,
+            response_headers=response_headers or {},
             timing_ms=timing_ms,
         )
 
@@ -243,7 +246,13 @@ class NullLogger:
         """No-op log_request."""
         return ""
 
-    def log_response(self, *args, **kwargs) -> None:
+    def log_response(
+        self,
+        request_id: str,
+        status_code: int,
+        response_body: Any | None = None,
+        response_headers: Dict[str, str] | None = None,
+    ) -> None:
         """No-op log_response."""
         pass
 

airbyte_agent_zendesk_support/_vendored/connector_sdk/logging/types.py

@@ -31,6 +31,7 @@ class RequestLog(BaseModel):
     body: Any | None = None
     response_status: int | None = None
     response_body: Any | None = None
+    response_headers: Dict[str, str] = Field(default_factory=dict)
     timing_ms: float | None = None
     error: str | None = None
 

airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/base.py

@@ -13,7 +13,7 @@ from uuid import UUID
 from pydantic import BaseModel, ConfigDict, Field, field_validator
 from pydantic_core import Url
 
-from .extensions import RetryConfig
+from .extensions import CacheConfig, RetryConfig
 
 
 class ExampleQuestions(BaseModel):
@@ -105,6 +105,7 @@ class Info(BaseModel):
     - x-airbyte-external-documentation-urls: List of external documentation URLs (Airbyte extension)
     - x-airbyte-retry-config: Retry configuration for transient errors (Airbyte extension)
     - x-airbyte-example-questions: Example questions for AI connector README (Airbyte extension)
+    - x-airbyte-cache: Cache configuration for field mapping between API and cache schemas (Airbyte extension)
     """
 
     model_config = ConfigDict(populate_by_name=True, extra="forbid")
@@ -122,6 +123,7 @@ class Info(BaseModel):
     x_airbyte_external_documentation_urls: list[DocUrl] = Field(..., alias="x-airbyte-external-documentation-urls")
     x_airbyte_retry_config: RetryConfig | None = Field(None, alias="x-airbyte-retry-config")
     x_airbyte_example_questions: ExampleQuestions | None = Field(None, alias="x-airbyte-example-questions")
+    x_airbyte_cache: CacheConfig | None = Field(None, alias="x-airbyte-cache")
 
 
 class ServerVariable(BaseModel):
@@ -150,6 +152,7 @@ class Server(BaseModel):
     url: str
     description: str | None = None
     variables: Dict[str, ServerVariable] = Field(default_factory=dict)
+    x_airbyte_replication_user_config_mapping: Dict[str, str] | None = Field(default=None, alias="x-airbyte-replication-user-config-mapping")
 
     @field_validator("url")
     @classmethod

airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/connector.py

@@ -7,6 +7,7 @@ References:
 
 from __future__ import annotations
 
+from collections.abc import Iterator
 from typing import Any
 
 from pydantic import BaseModel, ConfigDict, Field, field_validator
@@ -15,7 +16,7 @@ from ..constants import OPENAPI_VERSION_PREFIX
 
 from .base import Info, Server
 from .components import Components
-from .operations import PathItem
+from .operations import Operation, PathItem
 from .security import SecurityRequirement
 
 
@@ -33,6 +34,10 @@ class Tag(BaseModel):
     external_docs: dict[str, Any] | None = Field(None, alias="externalDocs")
 
 
+# HTTP methods supported by OpenAPI operations
+HTTP_METHODS = frozenset({"get", "post", "put", "patch", "delete", "options", "head", "trace"})
+
+
 class ExternalDocs(BaseModel):
     """
     External documentation reference.
@@ -79,7 +84,7 @@ class OpenAPIConnector(BaseModel):
             raise ValueError(f"OpenAPI version must be {OPENAPI_VERSION_PREFIX}x, got: {v}")
         return v
 
-    def get_entity_operations(self, entity_name: str) -> list[tuple[str, str, Any]]:
+    def get_entity_operations(self, entity_name: str) -> list[tuple[str, str, Operation]]:
         """
         Get all operations for a specific entity.
 
@@ -89,22 +94,7 @@ class OpenAPIConnector(BaseModel):
         Returns:
             List of tuples: (path, method, operation)
         """
-        results = []
-        for path, path_item in self.paths.items():
-            for method in [
-                "get",
-                "post",
-                "put",
-                "patch",
-                "delete",
-                "options",
-                "head",
-                "trace",
-            ]:
-                operation = getattr(path_item, method, None)
-                if operation and operation.x_airbyte_entity == entity_name:
-                    results.append((path, method, operation))
-        return results
+        return [(path, method, op) for path, method, op in self._iter_operations() if op.x_airbyte_entity == entity_name]
 
     def list_entities(self) -> list[str]:
         """
@@ -113,19 +103,18 @@ class OpenAPIConnector(BaseModel):
         Returns:
             Sorted list of unique entity names
         """
-        entities = set()
-        for path_item in self.paths.values():
-            for method in [
-                "get",
-                "post",
-                "put",
-                "patch",
-                "delete",
-                "options",
-                "head",
-                "trace",
-            ]:
-                operation = getattr(path_item, method, None)
-                if operation and operation.x_airbyte_entity:
-                    entities.add(operation.x_airbyte_entity)
+        entities = {op.x_airbyte_entity for _, _, op in self._iter_operations() if op.x_airbyte_entity}
         return sorted(entities)
+
+    def _iter_operations(self) -> Iterator[tuple[str, str, Operation]]:
+        """
+        Iterate over all operations in the spec.
+
+        Yields:
+            Tuples of (path, method, operation) for each defined operation
+        """
+        for path, path_item in self.paths.items():
+            for method in HTTP_METHODS:
+                operation = getattr(path_item, method, None)
+                if operation:
+                    yield path, method, operation

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
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class PaginationConfig(BaseModel):
@@ -107,3 +107,124 @@ class RetryConfig(BaseModel):
     # Header-based delay extraction
     retry_after_header: str = "Retry-After"
     retry_after_format: Literal["seconds", "milliseconds", "unix_timestamp"] = "seconds"
+
+
+class CacheFieldProperty(BaseModel):
+    """
+    Nested property definition for object-type cache fields.
+
+    Supports recursive nesting to represent complex nested schemas in cache field definitions.
+    Used when a cache field has type 'object' and needs to define its internal structure.
+
+    Example YAML usage:
+        - name: collaboration
+          type: ['null', 'object']
+          description: "Collaboration data"
+          properties:
+            brief:
+              type: ['null', 'string']
+            comments:
+              type: ['null', 'array']
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    type: str | list[str]
+    properties: dict[str, "CacheFieldProperty"] | None = None
+
+
+class CacheFieldConfig(BaseModel):
+    """
+    Field configuration for cache mapping.
+
+    Defines a single field in a cache entity, with optional name aliasing
+    to map between user-facing field names and cache storage names.
+
+    For object-type fields, supports nested properties to define the internal structure
+    of complex nested schemas.
+
+    Used in x-airbyte-cache extension for api_search operations.
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    name: str
+    x_airbyte_name: str | None = Field(default=None, alias="x-airbyte-name")
+    type: str | list[str]
+    description: str
+    properties: dict[str, CacheFieldProperty] | None = None
+
+    @property
+    def cache_name(self) -> str:
+        """Return cache name, falling back to name if alias not specified."""
+        return self.x_airbyte_name or self.name
+
+
+class CacheEntityConfig(BaseModel):
+    """
+    Entity configuration for cache mapping.
+
+    Defines a cache-enabled entity with its fields and optional name aliasing
+    to map between user-facing entity names and cache storage names.
+
+    Used in x-airbyte-cache extension for api_search operations.
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    entity: str
+    x_airbyte_name: str | None = Field(default=None, alias="x-airbyte-name")
+    fields: list[CacheFieldConfig]
+
+    @property
+    def cache_name(self) -> str:
+        """Return cache entity name, falling back to entity if alias not specified."""
+        return self.x_airbyte_name or self.entity
+
+
+class CacheConfig(BaseModel):
+    """
+    Cache configuration extension (x-airbyte-cache).
+
+    Defines cache-enabled entities and their field mappings for api_search operations.
+    Supports optional name aliasing via x-airbyte-name for both entities and fields,
+    enabling bidirectional mapping between user-facing names and cache storage names.
+
+    This extension is added to the Info model and provides field-level mapping for
+    search operations that use cached data.
+
+    Example YAML usage:
+        info:
+          title: Stripe API
+          x-airbyte-cache:
+            entities:
+              - entity: customers
+                stream: customers
+                fields:
+                  - name: email
+                    type: ["null", "string"]
+                    description: "Customer email address"
+                  - name: customer_name
+                    x-airbyte-name: name
+                    type: ["null", "string"]
+                    description: "Customer full name"
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    entities: list[CacheEntityConfig]
+
+    def get_entity_mapping(self, user_entity: str) -> CacheEntityConfig | None:
+        """
+        Get entity config by user-facing name.
+
+        Args:
+            user_entity: User-facing entity name to look up
+
+        Returns:
+            CacheEntityConfig if found, None otherwise
+        """
+        for entity in self.entities:
+            if entity.entity == user_entity:
+                return entity
+        return None

airbyte_agent_zendesk_support/_vendored/connector_sdk/validation.py

@@ -486,30 +486,36 @@ def validate_meta_extractor_fields(
         response_body = spec.captured_response.body
 
         # Validate each meta extractor field
-        for field_name, jsonpath_expr in endpoint.meta_extractor.items():
+        for field_name, extractor_expr in endpoint.meta_extractor.items():
+            # Skip header-based extractors - they extract from headers, not response body
+            # @link.next extracts from RFC 5988 Link header
+            # @header.X-Name extracts raw header value
+            if extractor_expr.startswith("@link.") or extractor_expr.startswith("@header."):
+                continue
+
             # Check 1: Does the JSONPath find data in the actual response?
             try:
-                parsed_expr = parse_jsonpath(jsonpath_expr)
+                parsed_expr = parse_jsonpath(extractor_expr)
                 matches = [match.value for match in parsed_expr.find(response_body)]
 
                 if not matches:
                     warnings.append(
                         f"{entity_name}.{action}: x-airbyte-meta-extractor field '{field_name}' "
-                        f"with JSONPath '{jsonpath_expr}' found no matches in cassette response"
+                        f"with JSONPath '{extractor_expr}' found no matches in cassette response"
                     )
             except Exception as e:
                 warnings.append(
-                    f"{entity_name}.{action}: x-airbyte-meta-extractor field '{field_name}' has invalid JSONPath '{jsonpath_expr}': {str(e)}"
+                    f"{entity_name}.{action}: x-airbyte-meta-extractor field '{field_name}' has invalid JSONPath '{extractor_expr}': {str(e)}"
                 )
 
             # Check 2: Is this field path declared in the response schema?
             if endpoint.response_schema:
-                field_in_schema = _check_field_in_schema(jsonpath_expr, endpoint.response_schema)
+                field_in_schema = _check_field_in_schema(extractor_expr, endpoint.response_schema)
 
                 if not field_in_schema:
                     warnings.append(
                         f"{entity_name}.{action}: x-airbyte-meta-extractor field '{field_name}' "
-                        f"extracts from '{jsonpath_expr}' but this path is not declared in response schema"
+                        f"extracts from '{extractor_expr}' but this path is not declared in response schema"
                     )
 
     except Exception as e: