airbyte-agent-zendesk-support 0.18.44__py3-none-any.whl → 0.18.49__py3-none-any.whl

airbyte_agent_zendesk_support/__init__.py

@@ -72,7 +72,33 @@ from .models import (
     SlaPoliciesListResult,
     TicketFormsListResult,
     ArticlesListResult,
-    ArticleAttachmentsListResult
+    ArticleAttachmentsListResult,
+    SearchHit,
+    SearchResult,
+    BrandsSearchData,
+    BrandsSearchResult,
+    GroupsSearchData,
+    GroupsSearchResult,
+    OrganizationsSearchData,
+    OrganizationsSearchResult,
+    SatisfactionRatingsSearchData,
+    SatisfactionRatingsSearchResult,
+    TagsSearchData,
+    TagsSearchResult,
+    TicketAuditsSearchData,
+    TicketAuditsSearchResult,
+    TicketCommentsSearchData,
+    TicketCommentsSearchResult,
+    TicketFieldsSearchData,
+    TicketFieldsSearchResult,
+    TicketFormsSearchData,
+    TicketFormsSearchResult,
+    TicketMetricsSearchData,
+    TicketMetricsSearchResult,
+    TicketsSearchData,
+    TicketsSearchResult,
+    UsersSearchData,
+    UsersSearchResult
 )
 from .types import (
     TicketsListParams,
@@ -114,7 +140,45 @@ from .types import (
     ArticlesGetParams,
     ArticleAttachmentsListParams,
     ArticleAttachmentsGetParams,
-    ArticleAttachmentsDownloadParams
+    ArticleAttachmentsDownloadParams,
+    SearchParams,
+    SortOrder,
+    BrandsSearchFilter,
+    BrandsSearchQuery,
+    BrandsCondition,
+    GroupsSearchFilter,
+    GroupsSearchQuery,
+    GroupsCondition,
+    OrganizationsSearchFilter,
+    OrganizationsSearchQuery,
+    OrganizationsCondition,
+    SatisfactionRatingsSearchFilter,
+    SatisfactionRatingsSearchQuery,
+    SatisfactionRatingsCondition,
+    TagsSearchFilter,
+    TagsSearchQuery,
+    TagsCondition,
+    TicketAuditsSearchFilter,
+    TicketAuditsSearchQuery,
+    TicketAuditsCondition,
+    TicketCommentsSearchFilter,
+    TicketCommentsSearchQuery,
+    TicketCommentsCondition,
+    TicketFieldsSearchFilter,
+    TicketFieldsSearchQuery,
+    TicketFieldsCondition,
+    TicketFormsSearchFilter,
+    TicketFormsSearchQuery,
+    TicketFormsCondition,
+    TicketMetricsSearchFilter,
+    TicketMetricsSearchQuery,
+    TicketMetricsCondition,
+    TicketsSearchFilter,
+    TicketsSearchQuery,
+    TicketsCondition,
+    UsersSearchFilter,
+    UsersSearchQuery,
+    UsersCondition
 )
 
 __all__ = [
@@ -186,6 +250,32 @@ __all__ = [
     "TicketFormsListResult",
     "ArticlesListResult",
     "ArticleAttachmentsListResult",
+    "SearchHit",
+    "SearchResult",
+    "BrandsSearchData",
+    "BrandsSearchResult",
+    "GroupsSearchData",
+    "GroupsSearchResult",
+    "OrganizationsSearchData",
+    "OrganizationsSearchResult",
+    "SatisfactionRatingsSearchData",
+    "SatisfactionRatingsSearchResult",
+    "TagsSearchData",
+    "TagsSearchResult",
+    "TicketAuditsSearchData",
+    "TicketAuditsSearchResult",
+    "TicketCommentsSearchData",
+    "TicketCommentsSearchResult",
+    "TicketFieldsSearchData",
+    "TicketFieldsSearchResult",
+    "TicketFormsSearchData",
+    "TicketFormsSearchResult",
+    "TicketMetricsSearchData",
+    "TicketMetricsSearchResult",
+    "TicketsSearchData",
+    "TicketsSearchResult",
+    "UsersSearchData",
+    "UsersSearchResult",
     "TicketsListParams",
     "TicketsGetParams",
     "UsersListParams",
@@ -226,4 +316,42 @@ __all__ = [
     "ArticleAttachmentsListParams",
     "ArticleAttachmentsGetParams",
     "ArticleAttachmentsDownloadParams",
+    "SearchParams",
+    "SortOrder",
+    "BrandsSearchFilter",
+    "BrandsSearchQuery",
+    "BrandsCondition",
+    "GroupsSearchFilter",
+    "GroupsSearchQuery",
+    "GroupsCondition",
+    "OrganizationsSearchFilter",
+    "OrganizationsSearchQuery",
+    "OrganizationsCondition",
+    "SatisfactionRatingsSearchFilter",
+    "SatisfactionRatingsSearchQuery",
+    "SatisfactionRatingsCondition",
+    "TagsSearchFilter",
+    "TagsSearchQuery",
+    "TagsCondition",
+    "TicketAuditsSearchFilter",
+    "TicketAuditsSearchQuery",
+    "TicketAuditsCondition",
+    "TicketCommentsSearchFilter",
+    "TicketCommentsSearchQuery",
+    "TicketCommentsCondition",
+    "TicketFieldsSearchFilter",
+    "TicketFieldsSearchQuery",
+    "TicketFieldsCondition",
+    "TicketFormsSearchFilter",
+    "TicketFormsSearchQuery",
+    "TicketFormsCondition",
+    "TicketMetricsSearchFilter",
+    "TicketMetricsSearchQuery",
+    "TicketMetricsCondition",
+    "TicketsSearchFilter",
+    "TicketsSearchQuery",
+    "TicketsCondition",
+    "UsersSearchFilter",
+    "UsersSearchQuery",
+    "UsersCondition",
 ]

airbyte_agent_zendesk_support/_vendored/connector_sdk/connector_model_loader.py

@@ -519,13 +519,14 @@ def _parse_oauth2_config(scheme: Any) -> dict[str, str]:
                 config["refresh_url"] = refresh_url
 
     # Extract custom refresh configuration from x-airbyte-token-refresh extension
+    # Note: x_token_refresh is a Dict[str, Any], not a Pydantic model, so use .get()
     x_token_refresh = getattr(scheme, "x_token_refresh", None)
     if x_token_refresh:
-        auth_style = getattr(x_token_refresh, "auth_style", None)
+        auth_style = x_token_refresh.get("auth_style")
         if auth_style:
             config["auth_style"] = auth_style
 
-        body_format = getattr(x_token_refresh, "body_format", None)
+        body_format = x_token_refresh.get("body_format")
         if body_format:
             config["body_format"] = body_format
 

airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/local_executor.py

@@ -495,6 +495,14 @@ class LocalExecutor:
                 print(result.data)
         """
         try:
+            # Check for hosted-only actions before converting to Action enum
+            if config.action == "search":
+                raise NotImplementedError(
+                    "search is only available in hosted execution mode. "
+                    "Initialize the connector with external_user_id, airbyte_client_id, "
+                    "and airbyte_client_secret to use this feature."
+                )
+
             # Convert config to internal format
             action = Action(config.action) if isinstance(config.action, str) else config.action
             params = config.params or {}
@@ -1214,15 +1222,22 @@ class LocalExecutor:
     def _extract_metadata(
         self,
         response_data: dict[str, Any],
+        response_headers: dict[str, str],
         endpoint: EndpointDefinition,
     ) -> dict[str, Any] | None:
         """Extract metadata from response using meta extractor.
 
-        Each field in meta_extractor dict is independently extracted using JSONPath.
+        Each field in meta_extractor dict is independently extracted using JSONPath
+        for body extraction, or special prefixes for header extraction:
+        - @link.{rel}: Extract URL from RFC 5988 Link header by rel type
+        - @header.{name}: Extract raw header value by header name
+        - Otherwise: JSONPath expression for body extraction
+
         Missing or invalid paths result in None for that field (no crash).
 
         Args:
             response_data: Full API response (before record extraction)
+            response_headers: HTTP response headers
             endpoint: Endpoint with optional meta extractor configuration
 
         Returns:
@@ -1233,11 +1248,15 @@ class LocalExecutor:
         Example:
             meta_extractor = {
                 "pagination": "$.records",
-                "request_id": "$.requestId"
+                "request_id": "$.requestId",
+                "next_page_url": "@link.next",
+                "rate_limit": "@header.X-RateLimit-Remaining"
             }
             Returns: {
                 "pagination": {"cursor": "abc", "total": 100},
-                "request_id": "xyz123"
+                "request_id": "xyz123",
+                "next_page_url": "https://api.example.com/data?cursor=abc",
+                "rate_limit": "99"
             }
         """
         # Check if endpoint has meta extractor
@@ -1247,26 +1266,96 @@ class LocalExecutor:
         extracted_meta: dict[str, Any] = {}
 
         # Extract each field independently
-        for field_name, jsonpath_expr_str in endpoint.meta_extractor.items():
+        for field_name, extractor_expr in endpoint.meta_extractor.items():
             try:
-                # Parse and apply JSONPath expression
-                jsonpath_expr = parse_jsonpath(jsonpath_expr_str)
-                matches = [match.value for match in jsonpath_expr.find(response_data)]
-
-                if matches:
-                    # Return first match (most common case)
-                    extracted_meta[field_name] = matches[0]
+                if extractor_expr.startswith("@link."):
+                    # RFC 5988 Link header extraction
+                    rel = extractor_expr[6:]
+                    extracted_meta[field_name] = self._extract_link_url(response_headers, rel)
+                elif extractor_expr.startswith("@header."):
+                    # Raw header value extraction (case-insensitive lookup)
+                    header_name = extractor_expr[8:]
+                    extracted_meta[field_name] = self._get_header_value(response_headers, header_name)
                 else:
-                    # Path not found - set to None
-                    extracted_meta[field_name] = None
+                    # JSONPath body extraction
+                    jsonpath_expr = parse_jsonpath(extractor_expr)
+                    matches = [match.value for match in jsonpath_expr.find(response_data)]
+
+                    if matches:
+                        # Return first match (most common case)
+                        extracted_meta[field_name] = matches[0]
+                    else:
+                        # Path not found - set to None
+                        extracted_meta[field_name] = None
 
             except Exception as e:
                 # Log error but continue with other fields
-                logging.warning(f"Failed to apply meta extractor for field '{field_name}' with path '{jsonpath_expr_str}': {e}. Setting to None.")
+                logging.warning(f"Failed to apply meta extractor for field '{field_name}' with expression '{extractor_expr}': {e}. Setting to None.")
                 extracted_meta[field_name] = None
 
         return extracted_meta
 
+    @staticmethod
+    def _extract_link_url(headers: dict[str, str], rel: str) -> str | None:
+        """Extract URL from RFC 5988 Link header by rel type.
+
+        Parses Link header format: <url>; param1="value1"; rel="next"; param2="value2"
+
+        Supports:
+        - Multiple parameters per link in any order
+        - Both quoted and unquoted rel values
+        - Multiple links separated by commas
+
+        Args:
+            headers: Response headers dict
+            rel: The rel type to extract (e.g., "next", "prev", "first", "last")
+
+        Returns:
+            The URL for the specified rel type, or None if not found
+        """
+        link_header = headers.get("Link") or headers.get("link", "")
+        if not link_header:
+            return None
+
+        for link_segment in re.split(r",(?=\s*<)", link_header):
+            link_segment = link_segment.strip()
+
+            url_match = re.match(r"<([^>]+)>", link_segment)
+            if not url_match:
+                continue
+
+            url = url_match.group(1)
+            params_str = link_segment[url_match.end() :]
+
+            rel_match = re.search(r';\s*rel="?([^";,]+)"?', params_str, re.IGNORECASE)
+            if rel_match and rel_match.group(1).strip() == rel:
+                return url
+
+        return None
+
+    @staticmethod
+    def _get_header_value(headers: dict[str, str], header_name: str) -> str | None:
+        """Get header value with case-insensitive lookup.
+
+        Args:
+            headers: Response headers dict
+            header_name: Header name to look up
+
+        Returns:
+            Header value or None if not found
+        """
+        # Try exact match first
+        if header_name in headers:
+            return headers[header_name]
+
+        # Case-insensitive lookup
+        header_name_lower = header_name.lower()
+        for key, value in headers.items():
+            if key.lower() == header_name_lower:
+                return value
+
+        return None
+
     def _validate_required_body_fields(self, endpoint: Any, params: dict[str, Any], action: Action, entity: str) -> None:
         """Validate that required body fields are present for CREATE/UPDATE operations.
 
@@ -1394,7 +1483,7 @@ class _StandardOperationHandler:
                 request_kwargs = self.ctx.determine_request_format(endpoint, body)
 
                 # Execute async HTTP request
-                response = await self.ctx.http_client.request(
+                response_data, response_headers = await self.ctx.http_client.request(
                     method=endpoint.method,
                     path=path,
                     params=query_params if query_params else None,
@@ -1403,10 +1492,10 @@ class _StandardOperationHandler:
                 )
 
                 # Extract metadata from original response (before record extraction)
-                metadata = self.ctx.executor._extract_metadata(response, endpoint)
+                metadata = self.ctx.executor._extract_metadata(response_data, response_headers, endpoint)
 
                 # Extract records if extractor configured
-                response = self.ctx.extract_records(response, endpoint)
+                response = self.ctx.extract_records(response_data, endpoint)
 
                 # Assume success with 200 status code if no exception raised
                 status_code = 200
@@ -1532,7 +1621,7 @@ class _DownloadOperationHandler:
                     request_format = self.ctx.determine_request_format(operation, request_body)
                     self.ctx.validate_required_body_fields(operation, params, action, entity)
 
-                    metadata_response = await self.ctx.http_client.request(
+                    metadata_response, _ = await self.ctx.http_client.request(
                         method=operation.method,
                         path=path,
                         params=query_params,
@@ -1547,7 +1636,7 @@ class _DownloadOperationHandler:
                     )
 
                     # Step 3: Stream file from extracted URL
-                    file_response = await self.ctx.http_client.request(
+                    file_response, _ = await self.ctx.http_client.request(
                         method="GET",
                         path=file_url,
                         headers=headers,
@@ -1555,7 +1644,7 @@ class _DownloadOperationHandler:
                     )
                 else:
                     # One-step direct download: stream file directly from endpoint
-                    file_response = await self.ctx.http_client.request(
+                    file_response, _ = await self.ctx.http_client.request(
                         method=operation.method,
                         path=path,
                         params=query_params,

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()
@@ -475,7 +479,7 @@ class HTTPClient:
                     status_code=status_code,
                     response_body=f"<binary content, {response.headers.get('content-length', 'unknown')} bytes>",
                 )
-                return response
+                return response, dict(response.headers)
 
             # Parse response - handle non-JSON responses gracefully
             content_type = response.headers.get("content-type", "")
@@ -501,7 +505,7 @@ class HTTPClient:
                 status_code=status_code,
                 response_body=response_data,
             )
-            return response_data
+            return response_data, dict(response.headers)
 
         except AuthenticationError as e:
             # Auth error (401, 403) - handle token refresh
@@ -631,7 +635,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 +648,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/schema/extensions.py

@@ -109,6 +109,30 @@ class RetryConfig(BaseModel):
     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.
@@ -116,6 +140,9 @@ class CacheFieldConfig(BaseModel):
     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.
     """
 
@@ -125,6 +152,7 @@ class CacheFieldConfig(BaseModel):
     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: