airbyte-agent-orb 0.1.0__tar.gz → 0.1.2__tar.gz

airbyte_agent_orb-0.1.2/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Orb changelog
+
+## [0.1.2] - 2026-01-29
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: 43200eed
+- SDK version: 0.1.0
+
+## [0.1.1] - 2026-01-29
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: c718c683
+- SDK version: 0.1.0
+
+## [0.1.0] - 2026-01-29
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: 68ca482c
+- SDK version: 0.1.0

{airbyte_agent_orb-0.1.0 → airbyte_agent_orb-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: airbyte-agent-orb
-Version: 0.1.0
+Version: 0.1.2
 Summary: Airbyte Orb Connector for AI platforms
 Project-URL: Homepage, https://github.com/airbytehq/airbyte-agent-connectors
 Project-URL: Documentation, https://docs.airbyte.com/ai-agents/
@@ -147,6 +147,6 @@ See the official [Orb API reference](https://docs.withorb.com/api-reference).
 
 ## Version information
 
-- **Package version:** 0.1.0
+- **Package version:** 0.1.2
 - **Connector version:** 0.1.1
-- **Generated with Connector SDK commit SHA:** 68ca482c0154f5364832daa205c3e43f44bc45c4
+- **Generated with Connector SDK commit SHA:** 43200eed5845ee089ef5b9afc0199a8af3966169

{airbyte_agent_orb-0.1.0 → airbyte_agent_orb-0.1.2}/README.md

@@ -114,6 +114,6 @@ See the official [Orb API reference](https://docs.withorb.com/api-reference).
 
 ## Version information
 
-- **Package version:** 0.1.0
+- **Package version:** 0.1.2
 - **Connector version:** 0.1.1
-- **Generated with Connector SDK commit SHA:** 68ca482c0154f5364832daa205c3e43f44bc45c4
+- **Generated with Connector SDK commit SHA:** 43200eed5845ee089ef5b9afc0199a8af3966169

{airbyte_agent_orb-0.1.0 → airbyte_agent_orb-0.1.2}/airbyte_agent_orb/__init__.py

@@ -12,16 +12,16 @@ from .models import (
     Customer,
     PaginationMetadata,
     CustomersList,
-    SubscriptionCustomer,
     SubscriptionPlan,
+    SubscriptionCustomer,
     Subscription,
     SubscriptionsList,
-    PlanProduct,
     PlanPricesItem,
+    PlanProduct,
     Plan,
     PlansList,
-    InvoiceCustomer,
     InvoiceLineItemsItem,
+    InvoiceCustomer,
     InvoiceSubscription,
     Invoice,
     InvoicesList,
@@ -29,6 +29,7 @@ from .models import (
     SubscriptionsListResultMeta,
     PlansListResultMeta,
     InvoicesListResultMeta,
+    OrbCheckResult,
     OrbExecuteResult,
     OrbExecuteResultWithMeta,
     CustomersListResult,
@@ -79,16 +80,16 @@ __all__ = [
     "Customer",
     "PaginationMetadata",
     "CustomersList",
-    "SubscriptionCustomer",
     "SubscriptionPlan",
+    "SubscriptionCustomer",
     "Subscription",
     "SubscriptionsList",
-    "PlanProduct",
     "PlanPricesItem",
+    "PlanProduct",
     "Plan",
     "PlansList",
-    "InvoiceCustomer",
     "InvoiceLineItemsItem",
+    "InvoiceCustomer",
     "InvoiceSubscription",
     "Invoice",
     "InvoicesList",
@@ -96,6 +97,7 @@ __all__ = [
     "SubscriptionsListResultMeta",
     "PlansListResultMeta",
     "InvoicesListResultMeta",
+    "OrbCheckResult",
     "OrbExecuteResult",
     "OrbExecuteResultWithMeta",
     "CustomersListResult",

{airbyte_agent_orb-0.1.0 → airbyte_agent_orb-0.1.2}/airbyte_agent_orb/_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_orb-0.1.0 → airbyte_agent_orb-0.1.2}/airbyte_agent_orb/_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_orb-0.1.0 → airbyte_agent_orb-0.1.2}/airbyte_agent_orb/_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_orb-0.1.0 → airbyte_agent_orb-0.1.2}/airbyte_agent_orb/_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_orb-0.1.0 → airbyte_agent_orb-0.1.2}/airbyte_agent_orb/_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_orb-0.1.0 → airbyte_agent_orb-0.1.2}/airbyte_agent_orb/_vendored/connector_sdk/telemetry/tracker.py

@@ -3,7 +3,7 @@
 import logging
 import platform
 import sys
-from datetime import datetime
+from datetime import UTC, datetime
 
 from ..observability import ObservabilitySession
 
@@ -56,7 +56,7 @@ class SegmentTracker:
 
         try:
             event = ConnectorInitEvent(
-                timestamp=datetime.utcnow(),
+                timestamp=datetime.now(UTC),
                 session_id=self.session.session_id,
                 user_id=self.session.user_id,
                 execution_context=self.session.execution_context,
@@ -99,7 +99,7 @@ class SegmentTracker:
 
         try:
             event = OperationEvent(
-                timestamp=datetime.utcnow(),
+                timestamp=datetime.now(UTC),
                 session_id=self.session.session_id,
                 user_id=self.session.user_id,
                 execution_context=self.session.execution_context,
@@ -129,7 +129,7 @@ class SegmentTracker:
 
         try:
             event = SessionEndEvent(
-                timestamp=datetime.utcnow(),
+                timestamp=datetime.now(UTC),
                 session_id=self.session.session_id,
                 user_id=self.session.user_id,
                 execution_context=self.session.execution_context,

{airbyte_agent_orb-0.1.0 → airbyte_agent_orb-0.1.2}/airbyte_agent_orb/_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_orb-0.1.0 → airbyte_agent_orb-0.1.2}/airbyte_agent_orb/_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_orb-0.1.0 → airbyte_agent_orb-0.1.2}/airbyte_agent_orb/connector.py

@@ -39,6 +39,7 @@ if TYPE_CHECKING:
     from .models import OrbAuthConfig
 # Import response models and envelope models at runtime
 from .models import (
+    OrbCheckResult,
     OrbExecuteResult,
     OrbExecuteResultWithMeta,
     CustomersListResult,
@@ -355,6 +356,40 @@ class OrbConnector:
             # No extractors - return raw response data
             return result.data
 
+    # ===== HEALTH CHECK METHOD =====
+
+    async def check(self) -> OrbCheckResult:
+        """
+        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:
+            OrbCheckResult 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 OrbCheckResult(
+                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 OrbCheckResult(
+                status="unhealthy",
+                error=result.error or "Unknown error during health check",
+            )
+
     # ===== INTROSPECTION METHODS =====
 
     @classmethod

{airbyte_agent_orb-0.1.0 → airbyte_agent_orb-0.1.2}/airbyte_agent_orb/models.py

@@ -78,15 +78,6 @@ class CustomersList(BaseModel):
     data: Union[list[Customer], Any] = Field(default=None)
     pagination_metadata: Union[PaginationMetadata, Any] = Field(default=None)
 
-class SubscriptionCustomer(BaseModel):
-    """The customer associated with the subscription"""
-    model_config = ConfigDict(extra="allow", populate_by_name=True)
-
-    id: Union[str | None, Any] = Field(default=None, description="The customer ID")
-    """The customer ID"""
-    external_customer_id: Union[str | None, Any] = Field(default=None, description="The external customer ID")
-    """The external customer ID"""
-
 class SubscriptionPlan(BaseModel):
     """The plan associated with the subscription"""
     model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -96,6 +87,15 @@ class SubscriptionPlan(BaseModel):
     name: Union[str | None, Any] = Field(default=None, description="The plan name")
     """The plan name"""
 
+class SubscriptionCustomer(BaseModel):
+    """The customer associated with the subscription"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Union[str | None, Any] = Field(default=None, description="The customer ID")
+    """The customer ID"""
+    external_customer_id: Union[str | None, Any] = Field(default=None, description="The external customer ID")
+    """The external customer ID"""
+
 class Subscription(BaseModel):
     """Subscription object"""
     model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -126,15 +126,6 @@ class SubscriptionsList(BaseModel):
     data: Union[list[Subscription], Any] = Field(default=None)
     pagination_metadata: Union[PaginationMetadata, Any] = Field(default=None)
 
-class PlanProduct(BaseModel):
-    """The product associated with the plan"""
-    model_config = ConfigDict(extra="allow", populate_by_name=True)
-
-    id: Union[str | None, Any] = Field(default=None, description="The product ID")
-    """The product ID"""
-    name: Union[str | None, Any] = Field(default=None, description="The product name")
-    """The product name"""
-
 class PlanPricesItem(BaseModel):
     """Nested schema for Plan.prices_item"""
     model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -150,6 +141,15 @@ class PlanPricesItem(BaseModel):
     currency: Union[str | None, Any] = Field(default=None, description="The currency of the price")
     """The currency of the price"""
 
+class PlanProduct(BaseModel):
+    """The product associated with the plan"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Union[str | None, Any] = Field(default=None, description="The product ID")
+    """The product ID"""
+    name: Union[str | None, Any] = Field(default=None, description="The product name")
+    """The product name"""
+
 class Plan(BaseModel):
     """Plan object"""
     model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -180,15 +180,6 @@ class PlansList(BaseModel):
     data: Union[list[Plan], Any] = Field(default=None)
     pagination_metadata: Union[PaginationMetadata, Any] = Field(default=None)
 
-class InvoiceCustomer(BaseModel):
-    """The customer associated with the invoice"""
-    model_config = ConfigDict(extra="allow", populate_by_name=True)
-
-    id: Union[str | None, Any] = Field(default=None, description="The customer ID")
-    """The customer ID"""
-    external_customer_id: Union[str | None, Any] = Field(default=None, description="The external customer ID")
-    """The external customer ID"""
-
 class InvoiceLineItemsItem(BaseModel):
     """Nested schema for Invoice.line_items_item"""
     model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -206,6 +197,15 @@ class InvoiceLineItemsItem(BaseModel):
     end_date: Union[str | None, Any] = Field(default=None, description="The end date of the line item")
     """The end date of the line item"""
 
+class InvoiceCustomer(BaseModel):
+    """The customer associated with the invoice"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Union[str | None, Any] = Field(default=None, description="The customer ID")
+    """The customer ID"""
+    external_customer_id: Union[str | None, Any] = Field(default=None, description="The external customer ID")
+    """The external customer ID"""
+
 class InvoiceSubscription(BaseModel):
     """The subscription associated with the invoice"""
     model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -286,6 +286,25 @@ class InvoicesListResultMeta(BaseModel):
 
     next_cursor: Union[str | None, Any] = Field(default=None)
 
+# ===== CHECK RESULT MODEL =====
+
+class OrbCheckResult(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_orb-0.1.0 → airbyte_agent_orb-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "airbyte-agent-orb"
-version = "0.1.0"
+version = "0.1.2"
 description = "Airbyte Orb Connector for AI platforms"
 readme = "README.md"
 requires-python = ">=3.13"

airbyte_agent_orb-0.1.0/CHANGELOG.md

@@ -1,6 +0,0 @@
-# Orb changelog
-
-## [0.1.0] - 2026-01-29
-- Updated connector definition (YAML version 0.1.1)
-- Source commit: 68ca482c
-- SDK version: 0.1.0