airbyte-agent-zendesk-support 0.18.69__py3-none-any.whl → 0.18.71__py3-none-any.whl

airbyte_agent_zendesk_support/__init__.py

@@ -50,6 +50,7 @@ from .models import (
     TicketFormsListResultMeta,
     ArticlesListResultMeta,
     ArticleAttachmentsListResultMeta,
+    ZendeskSupportCheckResult,
     ZendeskSupportExecuteResult,
     ZendeskSupportExecuteResultWithMeta,
     TicketsListResult,
@@ -227,6 +228,7 @@ __all__ = [
     "TicketFormsListResultMeta",
     "ArticlesListResultMeta",
     "ArticleAttachmentsListResultMeta",
+    "ZendeskSupportCheckResult",
     "ZendeskSupportExecuteResult",
     "ZendeskSupportExecuteResultWithMeta",
     "TicketsListResult",

airbyte_agent_zendesk_support/_vendored/connector_sdk/connector_model_loader.py

@@ -496,6 +496,9 @@ def convert_openapi_to_connector_model(spec: OpenAPIConnector) -> ConnectorModel
             # Extract untested flag
             untested = getattr(operation, "x_airbyte_untested", None) or False
 
+            # Extract preferred_for_check flag
+            preferred_for_check = getattr(operation, "x_airbyte_preferred_for_check", None) or False
+
             # Create endpoint definition
             endpoint = EndpointDefinition(
                 method=method_name.upper(),
@@ -520,6 +523,7 @@ def convert_openapi_to_connector_model(spec: OpenAPIConnector) -> ConnectorModel
                 graphql_body=graphql_body,
                 file_field=file_field,
                 untested=untested,
+                preferred_for_check=preferred_for_check,
             )
 
             # Add to entities map

airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/hosted_executor.py

@@ -164,6 +164,11 @@ class HostedExecutor:
                 span.record_exception(e)
                 raise
 
+    async def check(self) -> ExecutionResult:
+        """Perform a health check via the cloud API."""
+        config = ExecutionConfig(entity="*", action="check", params={})
+        return await self.execute(config)
+
     def _parse_execution_result(self, response: dict) -> ExecutionResult:
         """Parse API response into ExecutionResult.
 

airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/local_executor.py

@@ -70,6 +70,14 @@ class _OperationContext:
         self.validate_required_body_fields = executor._validate_required_body_fields
         self.extract_records = executor._extract_records
 
+    @property
+    def standard_handler(self) -> _StandardOperationHandler | None:
+        """Return the standard operation handler, or None if not registered."""
+        for h in self.executor._operation_handlers:
+            if isinstance(h, _StandardOperationHandler):
+                return h
+        return None
+
 
 class _OperationHandler(Protocol):
     """Protocol for operation handlers."""
@@ -544,6 +552,79 @@ class LocalExecutor:
             # These are "expected" execution errors - return them in ExecutionResult
             return ExecutionResult(success=False, data={}, error=str(e))
 
+    async def check(self) -> ExecutionResult:
+        """Perform a health check by running a lightweight list operation.
+
+        Finds the operation marked with preferred_for_check=True, or falls back
+        to the first list operation. Executes it with limit=1 to verify
+        connectivity and credentials.
+
+        Returns:
+            ExecutionResult with data containing status, error, and checked operation details.
+        """
+        check_entity = None
+        check_endpoint = None
+
+        # Look for preferred check operation
+        for (ent_name, op_action), endpoint in self._operation_index.items():
+            if getattr(endpoint, "preferred_for_check", False):
+                check_entity = ent_name
+                check_endpoint = endpoint
+                break
+
+        # Fallback to first list operation
+        if check_endpoint is None:
+            for (ent_name, op_action), endpoint in self._operation_index.items():
+                if op_action == Action.LIST:
+                    check_entity = ent_name
+                    check_endpoint = endpoint
+                    break
+
+        if check_endpoint is None or check_entity is None:
+            return ExecutionResult(
+                success=True,
+                data={
+                    "status": "unhealthy",
+                    "error": "No list operation available for health check",
+                },
+            )
+
+        # Find the standard handler to execute the list operation
+        standard_handler = next(
+            (h for h in self._operation_handlers if isinstance(h, _StandardOperationHandler)),
+            None,
+        )
+
+        if standard_handler is None:
+            return ExecutionResult(
+                success=True,
+                data={
+                    "status": "unhealthy",
+                    "error": "No standard handler available",
+                },
+            )
+
+        try:
+            await standard_handler.execute_operation(check_entity, Action.LIST, {"limit": 1})
+            return ExecutionResult(
+                success=True,
+                data={
+                    "status": "healthy",
+                    "checked_entity": check_entity,
+                    "checked_action": "list",
+                },
+            )
+        except Exception as e:
+            return ExecutionResult(
+                success=True,
+                data={
+                    "status": "unhealthy",
+                    "error": str(e),
+                    "checked_entity": check_entity,
+                    "checked_action": "list",
+                },
+            )
+
     async def _execute_operation(
         self,
         entity: str,

airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/models.py

@@ -154,6 +154,18 @@ class ExecutorProtocol(Protocol):
         """
         ...
 
+    async def check(self) -> ExecutionResult:
+        """Perform a health check to verify connectivity and credentials.
+
+        Returns:
+            ExecutionResult with data containing:
+                - status: "healthy" or "unhealthy"
+                - error: Error message if unhealthy
+                - checked_entity: Entity used for the check
+                - checked_action: Action used for the check
+        """
+        ...
+
 
 # ============================================================================
 # Executor Exceptions

airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/operations.py

@@ -86,6 +86,16 @@ class Operation(BaseModel):
             "Validation will generate a warning instead of an error when cassettes are missing."
         ),
     )
+    x_airbyte_preferred_for_check: bool | None = Field(
+        None,
+        alias="x-airbyte-preferred-for-check",
+        description=(
+            "Mark this list operation as the preferred operation for health checks. "
+            "When the CHECK action is executed, this operation will be used instead of "
+            "falling back to the first available list operation. Choose a lightweight, "
+            "always-available endpoint (e.g., users, accounts)."
+        ),
+    )
 
     # Future extensions (commented out, defined for future use)
     # from .extensions import PaginationConfig

airbyte_agent_zendesk_support/_vendored/connector_sdk/types.py

@@ -15,7 +15,16 @@ from .schema.security import AirbyteAuthConfig
 
 
 class Action(str, Enum):
-    """Supported actions for Entity operations."""
+    """Supported actions for Entity operations.
+
+    Standard CRUD actions:
+        GET, CREATE, UPDATE, DELETE, LIST
+
+    Special actions:
+        API_SEARCH - Search via API endpoint
+        DOWNLOAD - Download file content
+        AUTHORIZE - OAuth authorization flow
+    """
 
     GET = "get"
     CREATE = "create"
@@ -223,6 +232,12 @@ class EndpointDefinition(BaseModel):
         description="Mark operation as untested to skip cassette validation (from x-airbyte-untested extension)",
     )
 
+    # Health check support (Airbyte extension)
+    preferred_for_check: bool = Field(
+        False,
+        description="Mark this list operation as preferred for health checks (from x-airbyte-preferred-for-check extension)",
+    )
+
 
 class EntityDefinition(BaseModel):
     """Definition of an API entity."""

airbyte_agent_zendesk_support/_vendored/connector_sdk/validation.py

@@ -810,11 +810,31 @@ def validate_connector_readiness(connector_dir: str | Path) -> Dict[str, Any]:
 
     success = operations_missing_cassettes == 0 and cassettes_invalid == 0 and total_operations > 0
 
+    # Check for preferred_for_check on at least one list operation
+    has_preferred_check = False
+    for entity in config.entities:
+        for action_val in entity.actions:
+            endpoint = entity.endpoints.get(action_val)
+            if endpoint and getattr(endpoint, "preferred_for_check", False):
+                has_preferred_check = True
+                break
+        if has_preferred_check:
+            break
+
+    readiness_warnings = []
+    if not has_preferred_check:
+        readiness_warnings.append(
+            "No operation has x-airbyte-preferred-for-check: true. "
+            "Add this extension to a lightweight list operation (e.g., users.list) "
+            "to enable reliable health checks."
+        )
+
     return {
         "success": success,
         "connector_name": config.name,
         "connector_path": str(connector_path),
         "validation_results": validation_results,
+        "readiness_warnings": readiness_warnings,
         "summary": {
             "total_operations": total_operations,
             "operations_with_cassettes": operations_with_cassettes,

airbyte_agent_zendesk_support/connector.py

@@ -88,6 +88,7 @@ if TYPE_CHECKING:
 from .models import ZendeskSupportOauth20AuthConfig, ZendeskSupportApiTokenAuthConfig
 # Import response models and envelope models at runtime
 from .models import (
+    ZendeskSupportCheckResult,
     ZendeskSupportExecuteResult,
     ZendeskSupportExecuteResultWithMeta,
     TicketsListResult,
@@ -809,6 +810,40 @@ class ZendeskSupportConnector:
             # No extractors - return raw response data
             return result.data
 
+    # ===== HEALTH CHECK METHOD =====
+
+    async def check(self) -> ZendeskSupportCheckResult:
+        """
+        Perform a health check to verify connectivity and credentials.
+
+        Executes a lightweight list operation (limit=1) to validate that
+        the connector can communicate with the API and credentials are valid.
+
+        Returns:
+            ZendeskSupportCheckResult with status ("healthy" or "unhealthy") and optional error message
+
+        Example:
+            result = await connector.check()
+            if result.status == "healthy":
+                print("Connection verified!")
+            else:
+                print(f"Check failed: {result.error}")
+        """
+        result = await self._executor.check()
+
+        if result.success and isinstance(result.data, dict):
+            return ZendeskSupportCheckResult(
+                status=result.data.get("status", "unhealthy"),
+                error=result.data.get("error"),
+                checked_entity=result.data.get("checked_entity"),
+                checked_action=result.data.get("checked_action"),
+            )
+        else:
+            return ZendeskSupportCheckResult(
+                status="unhealthy",
+                error=result.error or "Unknown error during health check",
+            )
+
     # ===== INTROSPECTION METHODS =====
 
     @classmethod

airbyte_agent_zendesk_support/connector_model.py

@@ -260,6 +260,7 @@ ZendeskSupportConnectorModel: ConnectorModel = ConnectorModel(
                         'previous_page': '$.previous_page',
                         'count': '$.count',
                     },
+                    preferred_for_check=True,
                 ),
                 Action.GET: EndpointDefinition(
                     method='GET',

airbyte_agent_zendesk_support/models.py

@@ -642,6 +642,25 @@ class ArticleAttachmentsListResultMeta(BaseModel):
     previous_page: Union[str | None, Any] = Field(default=None)
     count: Union[int, Any] = Field(default=None)
 
+# ===== CHECK RESULT MODEL =====
+
+class ZendeskSupportCheckResult(BaseModel):
+    """Result of a health check operation.
+
+    Returned by the check() method to indicate connectivity and credential status.
+    """
+    model_config = ConfigDict(extra="forbid")
+
+    status: str
+    """Health check status: 'healthy' or 'unhealthy'."""
+    error: str | None = None
+    """Error message if status is 'unhealthy', None otherwise."""
+    checked_entity: str | None = None
+    """Entity name used for the health check."""
+    checked_action: str | None = None
+    """Action name used for the health check."""
+
+
 # ===== RESPONSE ENVELOPE MODELS =====
 
 # Type variables for generic envelope models

{airbyte_agent_zendesk_support-0.18.69.dist-info → airbyte_agent_zendesk_support-0.18.71.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: airbyte-agent-zendesk-support
-Version: 0.18.69
+Version: 0.18.71
 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,6 +157,6 @@ See the official [Zendesk-Support API reference](https://developer.zendesk.com/a
 
 ## Version information
 
-- **Package version:** 0.18.69
+- **Package version:** 0.18.71
 - **Connector version:** 0.1.9
-- **Generated with Connector SDK commit SHA:** f6c6fca292b291b200b31e4056856465129ae703
+- **Generated with Connector SDK commit SHA:** c718c683a61ee72524442b7fd5e9ac3a1b94698c

{airbyte_agent_zendesk_support-0.18.69.dist-info → airbyte_agent_zendesk_support-0.18.71.dist-info}/RECORD

@@ -1,28 +1,28 @@
-airbyte_agent_zendesk_support/__init__.py,sha256=RRAGu8AUU7OjMyGJvktoZvll1v7qxgw25mzqjBdODy4,9451
-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/__init__.py,sha256=EPmmOaWdjLG3KwnHva6OL2c7fSxAwr6av_qlnh57S44,9515
+airbyte_agent_zendesk_support/connector.py,sha256=ecCHOMkbIkLTckr0x_QVH2WaPnrXeGoYoO9Ssfc4Q6w,113912
+airbyte_agent_zendesk_support/connector_model.py,sha256=o_ir2azM5qZ9Lgpd6LzpQnZNcDBf_jjzVU1BEta3HyQ,248711
+airbyte_agent_zendesk_support/models.py,sha256=c1vEifMBpVvBhjxXbJEhnEBhM3A_HNNVcfy35CNO8xA,63953
 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=AW9bsdggzuc3ydy2bYYF33L6LxLKLQer9Wm47IOuQw0,41492
+airbyte_agent_zendesk_support/_vendored/connector_sdk/connector_model_loader.py,sha256=ecm0Cdj1SyhDOpEi2wUzzrJNkgt0wViB0Q-YTrDPsjU,41698
 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=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/types.py,sha256=sRZ4rRkJXGfqdjfF3qb0kzrw_tu1cn-CmFSZKMMgF7o,9269
 airbyte_agent_zendesk_support/_vendored/connector_sdk/utils.py,sha256=G4LUXOC2HzPoND2v4tQW68R9uuPX9NQyCjaGxb7Kpl0,1958
-airbyte_agent_zendesk_support/_vendored/connector_sdk/validation.py,sha256=4MPrxYmQh8TbCU0KdvvRKe35Lg1YYLEBd0u4aKySl_E,32122
+airbyte_agent_zendesk_support/_vendored/connector_sdk/validation.py,sha256=2Qof3QiOEEupTsT6F1MvMDCZTPl4IuzkeUUvn_IYFjg,32905
 airbyte_agent_zendesk_support/_vendored/connector_sdk/cloud_utils/__init__.py,sha256=4799Hv9f2zxDVj1aLyQ8JpTEuFTp_oOZMRz-NZCdBJg,134
 airbyte_agent_zendesk_support/_vendored/connector_sdk/cloud_utils/client.py,sha256=YxdRpQr9XjDzih6csSseBVGn9kfMtaqbOCXP0TPuzFY,7189
 airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/__init__.py,sha256=EmG9YQNAjSuYCVB4D5VoLm4qpD1KfeiiOf7bpALj8p8,702
-airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/hosted_executor.py,sha256=ydHcG-biRS1ITT5ELwPShdJW-KYpvK--Fos1ipNgHho,6995
-airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/local_executor.py,sha256=tVbfstxOrm5qJt1NawTwjhIIpDgPCC4wSrKM5eALPSQ,74064
-airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/models.py,sha256=lYVT_bNcw-PoIks4WHNyl2VY-lJVf2FntzINSOBIheE,5845
+airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/hosted_executor.py,sha256=AC5aJtdcMPQfRuam0ZGE4QdhUBu2oGEmNZ6oVQLHTE8,7212
+airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/local_executor.py,sha256=abtQOMZhJBrvE3ioKi-g-R_GZJZozYJNczYySQEEIX8,76981
+airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/models.py,sha256=mUUBnuShKXxVIfsTOhMiI2rn2a-50jJG7SFGKT_P6Jk,6281
 airbyte_agent_zendesk_support/_vendored/connector_sdk/http/__init__.py,sha256=y8fbzZn-3yV9OxtYz8Dy6FFGI5v6TOqADd1G3xHH3Hw,911
 airbyte_agent_zendesk_support/_vendored/connector_sdk/http/config.py,sha256=6J7YIIwHC6sRu9i-yKa5XvArwK2KU60rlnmxzDZq3lw,3283
 airbyte_agent_zendesk_support/_vendored/connector_sdk/http/exceptions.py,sha256=eYdYmxqcwA6pgrSoRXNfR6_nRBGRH6upp2-r1jcKaZo,3586
@@ -46,12 +46,12 @@ airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/base.py,sha256=IoAu
 airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/components.py,sha256=nJIPieavwX3o3ODvdtLHPk84d_V229xmg6LDfwEHjzc,8119
 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/operations.py,sha256=St-A75m6sZUZlsoM6WcoPaShYu_X1K19pdyPvJbabOE,6214
 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.69.dist-info/METADATA,sha256=Yf7VXfCebYPeuVQ5twugdvozWT1uCiG1dfWBAp97MEY,7293
-airbyte_agent_zendesk_support-0.18.69.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-airbyte_agent_zendesk_support-0.18.69.dist-info/RECORD,,
+airbyte_agent_zendesk_support-0.18.71.dist-info/METADATA,sha256=KEols_afuzTIgcFB4-JgFyBZsKpXbxQpUtMLzpDlfmc,7293
+airbyte_agent_zendesk_support-0.18.71.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+airbyte_agent_zendesk_support-0.18.71.dist-info/RECORD,,