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

airbyte_agent_zendesk_support/__init__.py

@@ -73,8 +73,8 @@ from .models import (
     TicketFormsListResult,
     ArticlesListResult,
     ArticleAttachmentsListResult,
-    SearchHit,
-    SearchResult,
+    AirbyteSearchHit,
+    AirbyteSearchResult,
     BrandsSearchData,
     BrandsSearchResult,
     GroupsSearchData,
@@ -141,8 +141,8 @@ from .types import (
     ArticleAttachmentsListParams,
     ArticleAttachmentsGetParams,
     ArticleAttachmentsDownloadParams,
-    SearchParams,
-    SortOrder,
+    AirbyteSearchParams,
+    AirbyteSortOrder,
     BrandsSearchFilter,
     BrandsSearchQuery,
     BrandsCondition,
@@ -250,8 +250,8 @@ __all__ = [
     "TicketFormsListResult",
     "ArticlesListResult",
     "ArticleAttachmentsListResult",
-    "SearchHit",
-    "SearchResult",
+    "AirbyteSearchHit",
+    "AirbyteSearchResult",
     "BrandsSearchData",
     "BrandsSearchResult",
     "GroupsSearchData",
@@ -316,8 +316,8 @@ __all__ = [
     "ArticleAttachmentsListParams",
     "ArticleAttachmentsGetParams",
     "ArticleAttachmentsDownloadParams",
-    "SearchParams",
-    "SortOrder",
+    "AirbyteSearchParams",
+    "AirbyteSortOrder",
     "BrandsSearchFilter",
     "BrandsSearchQuery",
     "BrandsCondition",

airbyte_agent_zendesk_support/_vendored/connector_sdk/auth_strategies.py

@@ -152,6 +152,11 @@ class OAuth2AuthConfig(TypedDict, total=False):
             Note: Any config key can be used as a template variable in refresh_url.
             Common patterns: subdomain (Zendesk), shop (Shopify), region (AWS-style APIs).
 
+        additional_headers: Extra headers to inject alongside the OAuth2 Bearer token.
+            Useful for APIs that require both OAuth and an API key/client ID header.
+            Values support Jinja2 {{ variable }} template syntax to reference secrets.
+            Example: {"Amazon-Advertising-API-ClientId": "{{ client_id }}"}
+
     Examples:
         GitHub (simple):
             {"header": "Authorization", "prefix": "Bearer"}
@@ -169,6 +174,14 @@ class OAuth2AuthConfig(TypedDict, total=False):
                 "auth_style": "basic",
                 "body_format": "json"
             }
+
+        Amazon Ads (OAuth + additional client ID header):
+            {
+                "refresh_url": "https://api.amazon.com/auth/o2/token",
+                "additional_headers": {
+                    "Amazon-Advertising-API-ClientId": "{{ client_id }}"
+                }
+            }
     """
 
     header: str
@@ -177,6 +190,7 @@ class OAuth2AuthConfig(TypedDict, total=False):
     auth_style: AuthStyle
     body_format: BodyFormat
     subdomain: str
+    additional_headers: dict[str, str]
 
 
 class OAuth2AuthSecrets(TypedDict):
@@ -552,9 +566,10 @@ class OAuth2AuthStrategy(AuthStrategy):
         config: OAuth2AuthConfig,
         secrets: OAuth2AuthSecrets,
     ) -> dict[str, str]:
-        """Inject OAuth2 access token into headers.
+        """Inject OAuth2 access token and additional headers.
 
-        Creates a copy of the headers dict with the OAuth2 token added.
+        Creates a copy of the headers dict with the OAuth2 token added,
+        plus any additional headers configured via additional_headers.
         The original headers dict is not modified.
 
         Args:
@@ -563,7 +578,7 @@ class OAuth2AuthStrategy(AuthStrategy):
             secrets: OAuth2 credentials including access_token
 
         Returns:
-            New headers dict with OAuth2 token authentication injected
+            New headers dict with OAuth2 token and additional headers injected
 
         Raises:
             AuthenticationError: If access_token is missing
@@ -589,8 +604,44 @@ class OAuth2AuthStrategy(AuthStrategy):
         # Extract secret value (handle both SecretStr and plain str)
         token_value = extract_secret_value(access_token)
 
-        # Inject into headers
+        # Inject OAuth2 Bearer token
         headers[header_name] = f"{prefix} {token_value}"
+
+        # Inject additional headers if configured
+        additional_headers = config.get("additional_headers")
+        if additional_headers:
+            headers = self._inject_additional_headers(headers, additional_headers, secrets)
+
+        return headers
+
+    def _inject_additional_headers(
+        self,
+        headers: dict[str, str],
+        additional_headers: dict[str, str],
+        secrets: dict[str, Any],
+    ) -> dict[str, str]:
+        """Inject additional headers with Jinja2 template variable substitution.
+
+        Processes additional_headers config, substituting {{ variable }} patterns
+        with values from secrets using Jinja2 templating.
+
+        Args:
+            headers: Headers dict to add to (modified in place)
+            additional_headers: Header name -> value template mapping
+            secrets: Secrets dict for variable substitution
+
+        Returns:
+            Headers dict with additional headers added
+        """
+        # Build template context with extracted secret values
+        template_context = {key: extract_secret_value(value) for key, value in secrets.items()}
+
+        for header_name, value_template in additional_headers.items():
+            # Use Jinja2 templating for variable substitution
+            template = Template(value_template)
+            header_value = template.render(**template_context)
+            headers[header_name] = header_value
+
         return headers
 
     def validate_credentials(self, secrets: OAuth2AuthSecrets) -> None:  # type: ignore[override]

airbyte_agent_zendesk_support/_vendored/connector_sdk/connector_model_loader.py

@@ -188,7 +188,7 @@ def parse_openapi_spec(raw_config: dict) -> OpenAPIConnector:
 
 def _extract_request_body_config(
     request_body: RequestBody | None, spec_dict: dict[str, Any]
-) -> tuple[list[str], dict[str, Any] | None, dict[str, Any] | None]:
+) -> tuple[list[str], dict[str, Any] | None, dict[str, Any] | None, dict[str, Any]]:
     """Extract request body configuration (GraphQL or standard).
 
     Args:
@@ -196,17 +196,19 @@ def _extract_request_body_config(
         spec_dict: Full OpenAPI spec dict for $ref resolution
 
     Returns:
-        Tuple of (body_fields, request_schema, graphql_body)
+        Tuple of (body_fields, request_schema, graphql_body, request_body_defaults)
         - body_fields: List of field names for standard JSON/form bodies
         - request_schema: Resolved request schema dict (for standard bodies)
         - graphql_body: GraphQL body configuration dict (for GraphQL bodies)
+        - request_body_defaults: Default values for request body fields
     """
     body_fields: list[str] = []
     request_schema: dict[str, Any] | None = None
     graphql_body: dict[str, Any] | None = None
+    request_body_defaults: dict[str, Any] = {}
 
     if not request_body:
-        return body_fields, request_schema, graphql_body
+        return body_fields, request_schema, graphql_body, request_body_defaults
 
     # Check for GraphQL extension and extract GraphQL body configuration
     if request_body.x_airbyte_body_type:
@@ -216,7 +218,7 @@ def _extract_request_body_config(
         if isinstance(body_type_config, GraphQLBodyConfig):
             # Convert Pydantic model to dict, excluding None values
             graphql_body = body_type_config.model_dump(exclude_none=True, by_alias=False)
-            return body_fields, request_schema, graphql_body
+            return body_fields, request_schema, graphql_body, request_body_defaults
 
     # Parse standard request body
     for content_type_key, media_type in request_body.content.items():
@@ -226,11 +228,15 @@ def _extract_request_body_config(
         # Resolve all $refs in the schema using jsonref
         request_schema = resolve_schema_refs(schema, spec_dict)
 
-        # Extract body field names from resolved schema
+        # Extract body field names and defaults from resolved schema
         if isinstance(request_schema, dict) and "properties" in request_schema:
             body_fields = list(request_schema["properties"].keys())
+            # Extract default values for each property
+            for field_name, field_schema in request_schema["properties"].items():
+                if isinstance(field_schema, dict) and "default" in field_schema:
+                    request_body_defaults[field_name] = field_schema["default"]
 
-    return body_fields, request_schema, graphql_body
+    return body_fields, request_schema, graphql_body, request_body_defaults
 
 
 def convert_openapi_to_connector_model(spec: OpenAPIConnector) -> ConnectorModel:
@@ -315,6 +321,8 @@ def convert_openapi_to_connector_model(spec: OpenAPIConnector) -> ConnectorModel
             query_params: list[str] = []
             query_params_schema: dict[str, dict[str, Any]] = {}
             deep_object_params: list[str] = []
+            header_params: list[str] = []
+            header_params_schema: dict[str, dict[str, Any]] = {}
 
             if operation.parameters:
                 for param in operation.parameters:
@@ -336,9 +344,12 @@ def convert_openapi_to_connector_model(spec: OpenAPIConnector) -> ConnectorModel
                         # Check if this is a deepObject style parameter
                         if hasattr(param, "style") and param.style == "deepObject":
                             deep_object_params.append(param.name)
+                    elif param.in_ == "header":
+                        header_params.append(param.name)
+                        header_params_schema[param.name] = schema_info
 
-            # Extract body fields from request schema
-            body_fields, request_schema, graphql_body = _extract_request_body_config(operation.request_body, spec_dict)
+            # Extract body fields and defaults from request schema
+            body_fields, request_schema, graphql_body, request_body_defaults = _extract_request_body_config(operation.request_body, spec_dict)
 
             # Extract response schema
             response_schema = None
@@ -372,6 +383,9 @@ def convert_openapi_to_connector_model(spec: OpenAPIConnector) -> ConnectorModel
                 deep_object_params=deep_object_params,
                 path_params=path_params,
                 path_params_schema=path_params_schema,
+                header_params=header_params,
+                header_params_schema=header_params_schema,
+                request_body_defaults=request_body_defaults,
                 content_type=content_type,
                 request_schema=request_schema,
                 response_schema=response_schema,
@@ -535,6 +549,13 @@ def _parse_oauth2_config(scheme: Any) -> dict[str, str]:
     if x_token_extract:
         config["token_extract"] = x_token_extract
 
+    # Extract additional_headers from x-airbyte-auth-config extension
+    x_auth_config = getattr(scheme, "x_airbyte_auth_config", None)
+    if x_auth_config:
+        additional_headers = getattr(x_auth_config, "additional_headers", None)
+        if additional_headers:
+            config["additional_headers"] = additional_headers
+
     return config
 
 

airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/local_executor.py

@@ -64,6 +64,7 @@ class _OperationContext:
         self.build_path = executor._build_path
         self.extract_query_params = executor._extract_query_params
         self.extract_body = executor._extract_body
+        self.extract_header_params = executor._extract_header_params
         self.build_request_body = executor._build_request_body
         self.determine_request_format = executor._determine_request_format
         self.validate_required_body_fields = executor._validate_required_body_fields
@@ -693,6 +694,40 @@ class LocalExecutor:
         """
         return {key: value for key, value in params.items() if key in allowed_fields and value is not None}
 
+    def _extract_header_params(self, endpoint: EndpointDefinition, params: dict[str, Any], body: dict[str, Any] | None = None) -> dict[str, str]:
+        """Extract header parameters from params and schema defaults.
+
+        Also adds Content-Type header when there's a request body (unless already specified
+        as a header parameter in the OpenAPI spec).
+
+        Args:
+            endpoint: Endpoint definition with header_params and header_params_schema
+            params: All parameters
+            body: Request body (if any) - used to determine if Content-Type should be added
+
+        Returns:
+            Dictionary of header name -> value
+        """
+        headers: dict[str, str] = {}
+
+        for header_name in endpoint.header_params:
+            # Check if value is provided in params
+            if header_name in params and params[header_name] is not None:
+                headers[header_name] = str(params[header_name])
+            # Otherwise, use default from schema if available
+            elif header_name in endpoint.header_params_schema:
+                default_value = endpoint.header_params_schema[header_name].get("default")
+                if default_value is not None:
+                    headers[header_name] = str(default_value)
+
+        # Add Content-Type header when there's a request body, but only if not already
+        # specified as a header parameter (which allows custom content types like
+        # application/vnd.spCampaign.v3+json)
+        if body is not None and endpoint.content_type and "Content-Type" not in headers:
+            headers["Content-Type"] = endpoint.content_type.value
+
+        return headers
+
     def _serialize_deep_object_params(self, params: dict[str, Any], deep_object_param_names: list[str]) -> dict[str, Any]:
         """Serialize deepObject parameters to bracket notation format.
 
@@ -848,7 +883,15 @@ class LocalExecutor:
             param_defaults = {name: schema.get("default") for name, schema in endpoint.query_params_schema.items() if "default" in schema}
             return self._build_graphql_body(endpoint.graphql_body, params, param_defaults)
         elif endpoint.body_fields:
-            return self._extract_body(endpoint.body_fields, params)
+            # Start with defaults from request body schema
+            body = dict(endpoint.request_body_defaults)
+            # Override with user-provided params (filtering out None values)
+            user_body = self._extract_body(endpoint.body_fields, params)
+            body.update(user_body)
+            return body if body else None
+        elif endpoint.request_body_defaults:
+            # If no body_fields but we have defaults, return the defaults
+            return dict(endpoint.request_body_defaults)
         return None
 
     def _flatten_form_data(self, data: dict[str, Any], parent_key: str = "") -> dict[str, Any]:
@@ -987,7 +1030,9 @@ class LocalExecutor:
 
         # Substitute variables from params
         if "variables" in graphql_config and graphql_config["variables"]:
-            body["variables"] = self._interpolate_variables(graphql_config["variables"], params, param_defaults)
+            variables = self._interpolate_variables(graphql_config["variables"], params, param_defaults)
+            # Filter out None values (optional fields not provided) - matches REST _extract_body() behavior
+            body["variables"] = {k: v for k, v in variables.items() if v is not None}
 
         # Add operation name if specified
         if "operationName" in graphql_config:
@@ -1482,6 +1527,9 @@ class _StandardOperationHandler:
                 # Determine request format (json/data parameters)
                 request_kwargs = self.ctx.determine_request_format(endpoint, body)
 
+                # Extract header parameters from OpenAPI operation (pass body to add Content-Type)
+                header_params = self.ctx.extract_header_params(endpoint, params, body)
+
                 # Execute async HTTP request
                 response_data, response_headers = await self.ctx.http_client.request(
                     method=endpoint.method,
@@ -1489,6 +1537,7 @@ class _StandardOperationHandler:
                     params=query_params if query_params else None,
                     json=request_kwargs.get("json"),
                     data=request_kwargs.get("data"),
+                    headers=header_params if header_params else None,
                 )
 
                 # Extract metadata from original response (before record extraction)

airbyte_agent_zendesk_support/_vendored/connector_sdk/http_client.py

@@ -478,6 +478,7 @@ 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, dict(response.headers)
 
@@ -504,6 +505,7 @@ class HTTPClient:
                 request_id=request_id,
                 status_code=status_code,
                 response_body=response_data,
+                response_headers=dict(response.headers),
             )
             return response_data, dict(response.headers)
 

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

@@ -7,7 +7,7 @@ References:
 """
 
 from enum import StrEnum
-from typing import Dict
+from typing import Any, Dict
 from uuid import UUID
 
 from pydantic import BaseModel, ConfigDict, Field, field_validator
@@ -152,7 +152,12 @@ 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")
+    x_airbyte_replication_environment_mapping: Dict[str, str] | None = Field(default=None, alias="x-airbyte-replication-environment-mapping")
+    x_airbyte_replication_environment_constants: Dict[str, Any] | None = Field(
+        default=None,
+        alias="x-airbyte-replication-environment-constants",
+        description="Constant values to always inject at environment config paths (e.g., 'region': 'us-east-1')",
+    )
 
     @field_validator("url")
     @classmethod

airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/security.py

@@ -109,6 +109,20 @@ class AirbyteAuthConfig(BaseModel):
         description="Mapping from source config paths (e.g., 'credentials.api_key') to auth config keys for direct connectors",
     )
 
+    # Additional headers to inject alongside OAuth2 Bearer token
+    additional_headers: Dict[str, str] | None = Field(
+        None,
+        description=(
+            "Extra headers to inject with auth. Values support Jinja2 {{ variable }} template syntax "
+            "to reference secrets. Example: {'Amazon-Advertising-API-ClientId': '{{ client_id }}'}"
+        ),
+    )
+
+    # Replication connector auth constants
+    replication_auth_key_constants: Dict[str, Any] | None = Field(
+        None,
+        description="Constant values to always inject at source config paths (e.g., 'credentials.auth_type': 'OAuth2.0')",
+    )
     # Multiple options (oneOf)
     one_of: List[AuthConfigOption] | None = Field(None, alias="oneOf")
 

airbyte_agent_zendesk_support/_vendored/connector_sdk/types.py

@@ -180,6 +180,15 @@ class EndpointDefinition(BaseModel):
         default_factory=dict,
         description="Schema for path params including defaults: {name: {type, default, required}}",
     )
+    header_params: list[str] = Field(default_factory=list)  # Header parameters from OpenAPI
+    header_params_schema: dict[str, dict[str, Any]] = Field(
+        default_factory=dict,
+        description="Schema for header params including defaults: {name: {type, default, required}}",
+    )
+    request_body_defaults: dict[str, Any] = Field(
+        default_factory=dict,
+        description="Default values for request body fields from OpenAPI schema",
+    )
     content_type: ContentType = ContentType.JSON
     request_schema: dict[str, Any] | None = None
     response_schema: dict[str, Any] | None = 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: