airbyte-agent-zendesk-support 0.18.61__py3-none-any.whl → 0.18.70__py3-none-any.whl

airbyte_agent_zendesk_support/_vendored/connector_sdk/connector_model_loader.py

@@ -62,6 +62,53 @@ class TokenExtractValidationError(ConnectorModelLoaderError):
     pass
 
 
+# Expected auth_mapping keys for each auth type.
+# These are the auth parameters that each security scheme expects, NOT the user's credential field names.
+EXPECTED_AUTH_MAPPING_KEYS: dict[AuthType, set[str]] = {
+    AuthType.BEARER: {"token"},
+    AuthType.BASIC: {"username", "password"},
+    AuthType.API_KEY: {"api_key"},
+    AuthType.OAUTH2: {"access_token", "refresh_token", "client_id", "client_secret"},
+}
+
+
+def _validate_auth_mapping_keys(
+    auth_type: AuthType,
+    auth_config: AirbyteAuthConfig | None,
+    scheme_name: str = "default",
+) -> None:
+    """Validate that auth_mapping keys match expected parameters for the auth type.
+
+    The auth_mapping keys must be the parameters expected by the security scheme
+    (e.g., "token" for bearer), not the user's credential field names.
+
+    Args:
+        auth_type: The authentication type
+        auth_config: The x-airbyte-auth-config containing auth_mapping
+        scheme_name: Name of the security scheme for error messages
+
+    Raises:
+        InvalidOpenAPIError: If auth_mapping keys don't match expected parameters
+    """
+    if auth_config is None or auth_config.auth_mapping is None:
+        return  # No explicit auth_mapping, will use defaults
+
+    expected_keys = EXPECTED_AUTH_MAPPING_KEYS.get(auth_type)
+    if expected_keys is None:
+        return  # Unknown auth type, skip validation
+
+    actual_keys = set(auth_config.auth_mapping.keys())
+    invalid_keys = actual_keys - expected_keys
+
+    if invalid_keys:
+        raise InvalidOpenAPIError(
+            f"Invalid auth_mapping keys for {auth_type.value} auth in scheme '{scheme_name}': {invalid_keys}. "
+            f"Expected keys for {auth_type.value}: {sorted(expected_keys)}. "
+            f"Note: auth_mapping keys must be the auth parameters (e.g., 'token' for bearer), "
+            f'not your credential field names. Use template syntax to map: token: "${{your_field}}"'
+        )
+
+
 def extract_path_params(path: str) -> list[str]:
     """Extract parameter names from path template.
 
@@ -711,7 +758,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
                     description="Authentication bearer token",
                     format=None,
                     pattern=None,
-                    airbyte_secret=False,
                     default=None,
                 )
             },
@@ -731,7 +777,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
                     description="Authentication username",
                     format=None,
                     pattern=None,
-                    airbyte_secret=False,
                     default=None,
                 ),
                 "password": AuthConfigFieldSpec(
@@ -740,7 +785,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
                     description="Authentication password",
                     format=None,
                     pattern=None,
-                    airbyte_secret=False,
                     default=None,
                 ),
             },
@@ -760,7 +804,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
                     description="API authentication key",
                     format=None,
                     pattern=None,
-                    airbyte_secret=False,
                     default=None,
                 )
             },
@@ -785,7 +828,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
                     description="OAuth2 access token",
                     format=None,
                     pattern=None,
-                    airbyte_secret=False,
                     default=None,
                 ),
                 "refresh_token": AuthConfigFieldSpec(
@@ -794,7 +836,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
                     description="OAuth2 refresh token (optional)",
                     format=None,
                     pattern=None,
-                    airbyte_secret=False,
                     default=None,
                 ),
                 "client_id": AuthConfigFieldSpec(
@@ -803,7 +844,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
                     description="OAuth2 client ID (optional)",
                     format=None,
                     pattern=None,
-                    airbyte_secret=False,
                     default=None,
                 ),
                 "client_secret": AuthConfigFieldSpec(
@@ -812,7 +852,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
                     description="OAuth2 client secret (optional)",
                     format=None,
                     pattern=None,
-                    airbyte_secret=False,
                     default=None,
                 ),
             },
@@ -924,6 +963,9 @@ def _parse_single_security_scheme(scheme: Any) -> AuthConfig:
         oauth2_config = _parse_oauth2_config(scheme)
         # Use explicit x-airbyte-auth-config if present, otherwise generate default
         auth_config_obj = scheme.x_airbyte_auth_config or _generate_default_auth_config(AuthType.OAUTH2)
+        # Validate auth_mapping keys if explicitly provided
+        if scheme.x_airbyte_auth_config:
+            _validate_auth_mapping_keys(AuthType.OAUTH2, scheme.x_airbyte_auth_config)
         return AuthConfig(
             type=AuthType.OAUTH2,
             config=oauth2_config,
@@ -934,6 +976,10 @@ def _parse_single_security_scheme(scheme: Any) -> AuthConfig:
     # Use explicit x-airbyte-auth-config if present, otherwise generate default
     auth_config_obj = scheme.x_airbyte_auth_config or _generate_default_auth_config(auth_type)
 
+    # Validate auth_mapping keys if explicitly provided
+    if scheme.x_airbyte_auth_config:
+        _validate_auth_mapping_keys(auth_type, scheme.x_airbyte_auth_config)
+
     return AuthConfig(
         type=auth_type,
         config=auth_config,

airbyte_agent_zendesk_support/_vendored/connector_sdk/http_client.py

@@ -490,7 +490,7 @@ class HTTPClient:
 
                 if not response_text.strip():
                     response_data = {}
-                elif "application/json" in content_type or not content_type:
+                elif "application/json" in content_type or "+json" in content_type or not content_type:
                     response_data = await response.json()
                 else:
                     error_msg = f"Expected JSON response for {method.upper()} {url}, got content-type: {content_type}"

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/_vendored/connector_sdk/schema/security.py

@@ -55,7 +55,6 @@ class AuthConfigFieldSpec(BaseModel):
     description: str | None = None
     format: str | None = None  # e.g., "email", "uri"
     pattern: str | None = None  # Regex validation
-    airbyte_secret: bool = Field(False, alias="airbyte_secret")
     default: Any | None = None
 
 

airbyte_agent_zendesk_support/connector.py

@@ -207,7 +207,7 @@ class ZendeskSupportConnector:
     """
 
     connector_name = "zendesk-support"
-    connector_version = "0.1.8"
+    connector_version = "0.1.9"
     vendored_sdk_version = "0.1.0"  # Version of vendored connector-sdk
 
     # Map of (entity, action) -> needs_envelope for envelope wrapping decision
@@ -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/connector_model.py

@@ -30,7 +30,7 @@ from uuid import (
 ZendeskSupportConnectorModel: ConnectorModel = ConnectorModel(
     id=UUID('79c1aa37-dae3-42ae-b333-d1c105477715'),
     name='zendesk-support',
-    version='0.1.8',
+    version='0.1.9',
     base_url='https://{subdomain}.zendesk.com/api/v2',
     auth=AuthConfig(
         options=[
@@ -51,12 +51,10 @@ ZendeskSupportConnectorModel: ConnectorModel = ConnectorModel(
                         'access_token': AuthConfigFieldSpec(
                             title='Access Token',
                             description='OAuth 2.0 access token',
-                            airbyte_secret=True,
                         ),
                         'refresh_token': AuthConfigFieldSpec(
                             title='Refresh Token',
                             description='OAuth 2.0 refresh token (optional)',
-                            airbyte_secret=True,
                         ),
                     },
                     auth_mapping={'access_token': '${access_token}', 'refresh_token': '${refresh_token}'},
@@ -80,7 +78,6 @@ ZendeskSupportConnectorModel: ConnectorModel = ConnectorModel(
                         'api_token': AuthConfigFieldSpec(
                             title='API Token',
                             description='Your Zendesk API token from Admin Center',
-                            airbyte_secret=True,
                         ),
                     },
                     auth_mapping={'username': '${email}/token', 'password': '${api_token}'},

{airbyte_agent_zendesk_support-0.18.61.dist-info → airbyte_agent_zendesk_support-0.18.70.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: airbyte-agent-zendesk-support
-Version: 0.18.61
+Version: 0.18.70
 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/
@@ -104,7 +104,7 @@ This example assumes you've already authenticated your connector with Airbyte. S
 from airbyte_agent_zendesk-support import ZendeskSupportConnector
 
 connector = ZendeskSupportConnector(
-    external_user_id="<your-scoped-token>",
+    external_user_id="<your_external_user_id>",
     airbyte_client_id="<your-client-id>",
     airbyte_client_secret="<your-client-secret>"
 )
@@ -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.61
-- **Connector version:** 0.1.8
-- **Generated with Connector SDK commit SHA:** 609c1d86c76b36ff699b57123a5a8c2050d958c3
+- **Package version:** 0.18.70
+- **Connector version:** 0.1.9
+- **Generated with Connector SDK commit SHA:** 97007bbdad3a6ac982ee2c0cdd667acdb5c12d3c

{airbyte_agent_zendesk_support-0.18.61.dist-info → airbyte_agent_zendesk_support-0.18.70.dist-info}/RECORD

@@ -1,18 +1,18 @@
 airbyte_agent_zendesk_support/__init__.py,sha256=RRAGu8AUU7OjMyGJvktoZvll1v7qxgw25mzqjBdODy4,9451
-airbyte_agent_zendesk_support/connector.py,sha256=9GH3iQoh0qLuNIniIcsK0NrLtfj74cOgwgw_F9uLDvQ,112326
-airbyte_agent_zendesk_support/connector_model.py,sha256=VzQ5r4qcDwO4DX7kxZ_KvKKUQPkj75XYVorin6ZUkyk,248812
+airbyte_agent_zendesk_support/connector.py,sha256=SUHbKrQDtPMKninrNViyZPo2ilrFbefQCFPJBu4CDjE,112595
+airbyte_agent_zendesk_support/connector_model.py,sha256=XfzcAOuvFimu2t_502eRWeymlCd3z6Ts6oA4xr_WVos,248665
 airbyte_agent_zendesk_support/models.py,sha256=mUZBBOkxmXJWHc-AGTJheWfDQ_I7RiJSddyXp4Di8tI,63349
 airbyte_agent_zendesk_support/types.py,sha256=ZNi-YzBv9K0Tmkm5xfEomuWyG59VG4zxTsxh9q9zcHw,162971
 airbyte_agent_zendesk_support/_vendored/__init__.py,sha256=ILl7AHXMui__swyrjxrh9yRa4dLiwBvV6axPWFWty80,38
 airbyte_agent_zendesk_support/_vendored/connector_sdk/__init__.py,sha256=T5o7roU6NSpH-lCAGZ338sE5dlh4ZU6i6IkeG1zpems,1949
 airbyte_agent_zendesk_support/_vendored/connector_sdk/auth_strategies.py,sha256=5Sb9moUp623o67Q2wMa8iZldJH08y4gQdoutoO_75Iw,42088
 airbyte_agent_zendesk_support/_vendored/connector_sdk/auth_template.py,sha256=nju4jqlFC_KI82ILNumNIyiUtRJcy7J94INIZ0QraI4,4454
-airbyte_agent_zendesk_support/_vendored/connector_sdk/connector_model_loader.py,sha256=nCu6oym6LoKrS94NTivU1vyQE_qnU-rhx8ExpuOX_LU,39544
+airbyte_agent_zendesk_support/_vendored/connector_sdk/connector_model_loader.py,sha256=AW9bsdggzuc3ydy2bYYF33L6LxLKLQer9Wm47IOuQw0,41492
 airbyte_agent_zendesk_support/_vendored/connector_sdk/constants.py,sha256=AtzOvhDMWbRJgpsQNWl5tkogHD6mWgEY668PgRmgtOY,2737
 airbyte_agent_zendesk_support/_vendored/connector_sdk/exceptions.py,sha256=ss5MGv9eVPmsbLcLWetuu3sDmvturwfo6Pw3M37Oq5k,481
 airbyte_agent_zendesk_support/_vendored/connector_sdk/extensions.py,sha256=XWRRoJOOrwUHSKbuQt5DU7CCu8ePzhd_HuP7c_uD77w,21376
-airbyte_agent_zendesk_support/_vendored/connector_sdk/http_client.py,sha256=yucwu3OvJh5wLQa1mk-gTKjtqjKKucMw5ltmlE7mk1c,28000
-airbyte_agent_zendesk_support/_vendored/connector_sdk/introspection.py,sha256=kRVI4TDQDLdcCnTBUML8ycAtdqAQufVh-027sMkb4i8,19165
+airbyte_agent_zendesk_support/_vendored/connector_sdk/http_client.py,sha256=09Fclbq4wrg38EM2Yh2kHiykQVXqdAGby024elcEz8E,28027
+airbyte_agent_zendesk_support/_vendored/connector_sdk/introspection.py,sha256=e9uWn2ofpeehoBbzNgts_bjlKLn8ayA1Y3OpDC3b7ZA,19517
 airbyte_agent_zendesk_support/_vendored/connector_sdk/secrets.py,sha256=J9ezMu4xNnLW11xY5RCre6DHP7YMKZCqwGJfk7ufHAM,6855
 airbyte_agent_zendesk_support/_vendored/connector_sdk/types.py,sha256=in8gHsn5nsScujOfHZmkOgNmqmJKiPyNNjg59m5fGWc,8807
 airbyte_agent_zendesk_support/_vendored/connector_sdk/utils.py,sha256=G4LUXOC2HzPoND2v4tQW68R9uuPX9NQyCjaGxb7Kpl0,1958
@@ -47,11 +47,11 @@ airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/components.py,sha25
 airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/connector.py,sha256=mSZk1wr2YSdRj9tTRsPAuIlCzd_xZLw-Bzl1sMwE0rE,3731
 airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/extensions.py,sha256=5hgpFHK7fzpzegCkJk882DeIP79bCx_qairKJhvPMZ8,9590
 airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/operations.py,sha256=RpzGtAI4yvAtMHAfMUMcUwgHv_qJojnKlNb75_agUF8,5729
-airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/security.py,sha256=6ljzf_JHs4amnQX9AhePcEsT8P3ZnTSC4xeg7-cvsNQ,9100
+airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/security.py,sha256=1CVCavrPdHHyk7B6JtUD75yRS_hWLCemZF1zwGbdqxg,9036
 airbyte_agent_zendesk_support/_vendored/connector_sdk/telemetry/__init__.py,sha256=RaLgkBU4dfxn1LC5Y0Q9rr2PJbrwjxvPgBLmq8_WafE,211
 airbyte_agent_zendesk_support/_vendored/connector_sdk/telemetry/config.py,sha256=tLmQwAFD0kP1WyBGWBS3ysaudN9H3e-3EopKZi6cGKg,885
 airbyte_agent_zendesk_support/_vendored/connector_sdk/telemetry/events.py,sha256=8Y1NbXiwISX-V_wRofY7PqcwEXD0dLMnntKkY6XFU2s,1328
 airbyte_agent_zendesk_support/_vendored/connector_sdk/telemetry/tracker.py,sha256=Ftrk0_ddfM7dZG8hF9xBuPwhbc9D6JZ7Q9qs5o3LEyA,5579
-airbyte_agent_zendesk_support-0.18.61.dist-info/METADATA,sha256=j8Se2o7sc1-FEzhl9DzvDlkceEgVHtCboutoEF_CXvY,7255
-airbyte_agent_zendesk_support-0.18.61.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-airbyte_agent_zendesk_support-0.18.61.dist-info/RECORD,,
+airbyte_agent_zendesk_support-0.18.70.dist-info/METADATA,sha256=zG-4n7FRXUS4Id8KLV-cKy079rPphbup8_3R7CraVeQ,7293
+airbyte_agent_zendesk_support-0.18.70.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+airbyte_agent_zendesk_support-0.18.70.dist-info/RECORD,,