airbyte-agent-zendesk-support 0.18.41__py3-none-any.whl → 0.18.43__py3-none-any.whl

airbyte_agent_zendesk_support/__init__.py

@@ -53,42 +53,26 @@ from .models import (
     ZendeskSupportExecuteResult,
     ZendeskSupportExecuteResultWithMeta,
     TicketsListResult,
-    TicketsGetResult,
     UsersListResult,
-    UsersGetResult,
     OrganizationsListResult,
-    OrganizationsGetResult,
     GroupsListResult,
-    GroupsGetResult,
     TicketCommentsListResult,
-    AttachmentsGetResult,
     TicketAuditsListResult,
     TicketMetricsListResult,
     TicketFieldsListResult,
-    TicketFieldsGetResult,
     BrandsListResult,
-    BrandsGetResult,
     ViewsListResult,
-    ViewsGetResult,
     MacrosListResult,
-    MacrosGetResult,
     TriggersListResult,
-    TriggersGetResult,
     AutomationsListResult,
-    AutomationsGetResult,
     TagsListResult,
     SatisfactionRatingsListResult,
-    SatisfactionRatingsGetResult,
     GroupMembershipsListResult,
     OrganizationMembershipsListResult,
     SlaPoliciesListResult,
-    SlaPoliciesGetResult,
     TicketFormsListResult,
-    TicketFormsGetResult,
     ArticlesListResult,
-    ArticlesGetResult,
-    ArticleAttachmentsListResult,
-    ArticleAttachmentsGetResult
+    ArticleAttachmentsListResult
 )
 from .types import (
     TicketsListParams,
@@ -182,42 +166,26 @@ __all__ = [
     "ZendeskSupportExecuteResult",
     "ZendeskSupportExecuteResultWithMeta",
     "TicketsListResult",
-    "TicketsGetResult",
     "UsersListResult",
-    "UsersGetResult",
     "OrganizationsListResult",
-    "OrganizationsGetResult",
     "GroupsListResult",
-    "GroupsGetResult",
     "TicketCommentsListResult",
-    "AttachmentsGetResult",
     "TicketAuditsListResult",
     "TicketMetricsListResult",
     "TicketFieldsListResult",
-    "TicketFieldsGetResult",
     "BrandsListResult",
-    "BrandsGetResult",
     "ViewsListResult",
-    "ViewsGetResult",
     "MacrosListResult",
-    "MacrosGetResult",
     "TriggersListResult",
-    "TriggersGetResult",
     "AutomationsListResult",
-    "AutomationsGetResult",
     "TagsListResult",
     "SatisfactionRatingsListResult",
-    "SatisfactionRatingsGetResult",
     "GroupMembershipsListResult",
     "OrganizationMembershipsListResult",
     "SlaPoliciesListResult",
-    "SlaPoliciesGetResult",
     "TicketFormsListResult",
-    "TicketFormsGetResult",
     "ArticlesListResult",
-    "ArticlesGetResult",
     "ArticleAttachmentsListResult",
-    "ArticleAttachmentsGetResult",
     "TicketsListParams",
     "TicketsGetParams",
     "UsersListParams",

airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/base.py

@@ -13,7 +13,7 @@ from uuid import UUID
 from pydantic import BaseModel, ConfigDict, Field, field_validator
 from pydantic_core import Url
 
-from .extensions import RetryConfig
+from .extensions import CacheConfig, RetryConfig
 
 
 class ExampleQuestions(BaseModel):
@@ -105,6 +105,7 @@ class Info(BaseModel):
     - x-airbyte-external-documentation-urls: List of external documentation URLs (Airbyte extension)
     - x-airbyte-retry-config: Retry configuration for transient errors (Airbyte extension)
     - x-airbyte-example-questions: Example questions for AI connector README (Airbyte extension)
+    - x-airbyte-cache: Cache configuration for field mapping between API and cache schemas (Airbyte extension)
     """
 
     model_config = ConfigDict(populate_by_name=True, extra="forbid")
@@ -122,6 +123,7 @@ class Info(BaseModel):
     x_airbyte_external_documentation_urls: list[DocUrl] = Field(..., alias="x-airbyte-external-documentation-urls")
     x_airbyte_retry_config: RetryConfig | None = Field(None, alias="x-airbyte-retry-config")
     x_airbyte_example_questions: ExampleQuestions | None = Field(None, alias="x-airbyte-example-questions")
+    x_airbyte_cache: CacheConfig | None = Field(None, alias="x-airbyte-cache")
 
 
 class ServerVariable(BaseModel):

airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/extensions.py

@@ -14,7 +14,7 @@ are implemented.
 
 from typing import Literal
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class PaginationConfig(BaseModel):
@@ -107,3 +107,96 @@ class RetryConfig(BaseModel):
     # Header-based delay extraction
     retry_after_header: str = "Retry-After"
     retry_after_format: Literal["seconds", "milliseconds", "unix_timestamp"] = "seconds"
+
+
+class CacheFieldConfig(BaseModel):
+    """
+    Field configuration for cache mapping.
+
+    Defines a single field in a cache entity, with optional name aliasing
+    to map between user-facing field names and cache storage names.
+
+    Used in x-airbyte-cache extension for api_search operations.
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    name: str
+    x_airbyte_name: str | None = Field(default=None, alias="x-airbyte-name")
+    type: str | list[str]
+    description: str
+
+    @property
+    def cache_name(self) -> str:
+        """Return cache name, falling back to name if alias not specified."""
+        return self.x_airbyte_name or self.name
+
+
+class CacheEntityConfig(BaseModel):
+    """
+    Entity configuration for cache mapping.
+
+    Defines a cache-enabled entity with its fields and optional name aliasing
+    to map between user-facing entity names and cache storage names.
+
+    Used in x-airbyte-cache extension for api_search operations.
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    entity: str
+    x_airbyte_name: str | None = Field(default=None, alias="x-airbyte-name")
+    fields: list[CacheFieldConfig]
+
+    @property
+    def cache_name(self) -> str:
+        """Return cache entity name, falling back to entity if alias not specified."""
+        return self.x_airbyte_name or self.entity
+
+
+class CacheConfig(BaseModel):
+    """
+    Cache configuration extension (x-airbyte-cache).
+
+    Defines cache-enabled entities and their field mappings for api_search operations.
+    Supports optional name aliasing via x-airbyte-name for both entities and fields,
+    enabling bidirectional mapping between user-facing names and cache storage names.
+
+    This extension is added to the Info model and provides field-level mapping for
+    search operations that use cached data.
+
+    Example YAML usage:
+        info:
+          title: Stripe API
+          x-airbyte-cache:
+            entities:
+              - entity: customers
+                stream: customers
+                fields:
+                  - name: email
+                    type: ["null", "string"]
+                    description: "Customer email address"
+                  - name: customer_name
+                    x-airbyte-name: name
+                    type: ["null", "string"]
+                    description: "Customer full name"
+    """
+
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+
+    entities: list[CacheEntityConfig]
+
+    def get_entity_mapping(self, user_entity: str) -> CacheEntityConfig | None:
+        """
+        Get entity config by user-facing name.
+
+        Args:
+            user_entity: User-facing entity name to look up
+
+        Returns:
+            CacheEntityConfig if found, None otherwise
+        """
+        for entity in self.entities:
+            if entity.entity == user_entity:
+                return entity
+        return None