airbyte-agent-airtable 0.1.5__py3-none-any.whl

airbyte_agent_airtable/connector_model.py

@@ -0,0 +1,365 @@
+"""
+Connector model for airtable.
+
+This file is auto-generated from the connector definition at build time.
+DO NOT EDIT MANUALLY - changes will be overwritten on next generation.
+"""
+
+from __future__ import annotations
+
+from ._vendored.connector_sdk.types import (
+    Action,
+    AuthConfig,
+    AuthType,
+    ConnectorModel,
+    EndpointDefinition,
+    EntityDefinition,
+)
+from ._vendored.connector_sdk.schema.security import (
+    AirbyteAuthConfig,
+    AuthConfigFieldSpec,
+)
+from uuid import (
+    UUID,
+)
+
+AirtableConnectorModel: ConnectorModel = ConnectorModel(
+    id=UUID('14c6e7ea-97ed-4f5e-a7b5-25e9a80b8212'),
+    name='airtable',
+    version='1.0.2',
+    base_url='https://api.airtable.com/v0',
+    auth=AuthConfig(
+        type=AuthType.BEARER,
+        config={'header': 'Authorization', 'prefix': 'Bearer'},
+        user_config_spec=AirbyteAuthConfig(
+            title='Personal Access Token',
+            type='object',
+            required=['personal_access_token'],
+            properties={
+                'personal_access_token': AuthConfigFieldSpec(
+                    title='Personal Access Token',
+                    description='Airtable Personal Access Token. See https://airtable.com/developers/web/guides/personal-access-tokens',
+                ),
+            },
+            auth_mapping={'token': '${personal_access_token}'},
+            replication_auth_key_mapping={'credentials.api_key': 'personal_access_token'},
+        ),
+    ),
+    entities=[
+        EntityDefinition(
+            name='bases',
+            stream_name='bases',
+            actions=[Action.LIST],
+            endpoints={
+                Action.LIST: EndpointDefinition(
+                    method='GET',
+                    path='/meta/bases',
+                    action=Action.LIST,
+                    description='Returns a list of all bases the user has access to',
+                    query_params=['offset'],
+                    query_params_schema={
+                        'offset': {'type': 'string', 'required': False},
+                    },
+                    response_schema={
+                        'type': 'object',
+                        'description': 'Paginated list of bases',
+                        'properties': {
+                            'bases': {
+                                'type': 'array',
+                                'items': {
+                                    'type': 'object',
+                                    'description': 'An Airtable base (workspace)',
+                                    'properties': {
+                                        'id': {'type': 'string', 'description': 'Unique identifier for the base'},
+                                        'name': {
+                                            'type': ['string', 'null'],
+                                            'description': 'Name of the base',
+                                        },
+                                        'permissionLevel': {
+                                            'type': ['string', 'null'],
+                                            'description': 'Permission level for the base (e.g., owner, editor, commenter, read)',
+                                        },
+                                    },
+                                    'required': ['id'],
+                                    'x-airbyte-entity-name': 'bases',
+                                    'x-airbyte-stream-name': 'bases',
+                                },
+                            },
+                            'offset': {
+                                'type': ['string', 'null'],
+                                'description': 'Pagination offset for next page',
+                            },
+                        },
+                    },
+                    record_extractor='$.bases',
+                ),
+            },
+            entity_schema={
+                'type': 'object',
+                'description': 'An Airtable base (workspace)',
+                'properties': {
+                    'id': {'type': 'string', 'description': 'Unique identifier for the base'},
+                    'name': {
+                        'type': ['string', 'null'],
+                        'description': 'Name of the base',
+                    },
+                    'permissionLevel': {
+                        'type': ['string', 'null'],
+                        'description': 'Permission level for the base (e.g., owner, editor, commenter, read)',
+                    },
+                },
+                'required': ['id'],
+                'x-airbyte-entity-name': 'bases',
+                'x-airbyte-stream-name': 'bases',
+            },
+        ),
+        EntityDefinition(
+            name='tables',
+            stream_name='tables',
+            actions=[Action.LIST],
+            endpoints={
+                Action.LIST: EndpointDefinition(
+                    method='GET',
+                    path='/meta/bases/{base_id}/tables',
+                    action=Action.LIST,
+                    description='Returns a list of all tables in the specified base with their schema information',
+                    path_params=['base_id'],
+                    path_params_schema={
+                        'base_id': {'type': 'string', 'required': True},
+                    },
+                    response_schema={
+                        'type': 'object',
+                        'description': 'List of tables in a base',
+                        'properties': {
+                            'tables': {
+                                'type': 'array',
+                                'items': {
+                                    'type': 'object',
+                                    'description': 'A table within an Airtable base',
+                                    'properties': {
+                                        'id': {'type': 'string', 'description': 'Unique identifier for the table'},
+                                        'name': {
+                                            'type': ['string', 'null'],
+                                            'description': 'Name of the table',
+                                        },
+                                        'primaryFieldId': {
+                                            'type': ['string', 'null'],
+                                            'description': 'ID of the primary field',
+                                        },
+                                        'fields': {
+                                            'type': ['array', 'null'],
+                                            'description': 'List of fields in the table',
+                                            'items': {
+                                                'type': 'object',
+                                                'description': 'A field (column) in a table',
+                                                'properties': {
+                                                    'id': {
+                                                        'type': ['string', 'null'],
+                                                        'description': 'Unique identifier for the field',
+                                                    },
+                                                    'name': {
+                                                        'type': ['string', 'null'],
+                                                        'description': 'Name of the field',
+                                                    },
+                                                    'type': {
+                                                        'type': ['string', 'null'],
+                                                        'description': 'Type of the field (e.g., singleLineText, number, checkbox)',
+                                                    },
+                                                    'options': {
+                                                        'type': ['object', 'null'],
+                                                        'description': 'Field-specific options',
+                                                        'additionalProperties': True,
+                                                    },
+                                                },
+                                            },
+                                        },
+                                        'views': {
+                                            'type': ['array', 'null'],
+                                            'description': 'List of views in the table',
+                                            'items': {
+                                                'type': 'object',
+                                                'description': 'A view in a table',
+                                                'properties': {
+                                                    'id': {
+                                                        'type': ['string', 'null'],
+                                                        'description': 'Unique identifier for the view',
+                                                    },
+                                                    'name': {
+                                                        'type': ['string', 'null'],
+                                                        'description': 'Name of the view',
+                                                    },
+                                                    'type': {
+                                                        'type': ['string', 'null'],
+                                                        'description': 'Type of the view (e.g., grid, form, calendar)',
+                                                    },
+                                                },
+                                            },
+                                        },
+                                    },
+                                    'required': ['id'],
+                                    'x-airbyte-entity-name': 'tables',
+                                    'x-airbyte-stream-name': 'tables',
+                                },
+                            },
+                        },
+                    },
+                    record_extractor='$.tables',
+                ),
+            },
+            entity_schema={
+                'type': 'object',
+                'description': 'A table within an Airtable base',
+                'properties': {
+                    'id': {'type': 'string', 'description': 'Unique identifier for the table'},
+                    'name': {
+                        'type': ['string', 'null'],
+                        'description': 'Name of the table',
+                    },
+                    'primaryFieldId': {
+                        'type': ['string', 'null'],
+                        'description': 'ID of the primary field',
+                    },
+                    'fields': {
+                        'type': ['array', 'null'],
+                        'description': 'List of fields in the table',
+                        'items': {'$ref': '#/components/schemas/TableField'},
+                    },
+                    'views': {
+                        'type': ['array', 'null'],
+                        'description': 'List of views in the table',
+                        'items': {'$ref': '#/components/schemas/View'},
+                    },
+                },
+                'required': ['id'],
+                'x-airbyte-entity-name': 'tables',
+                'x-airbyte-stream-name': 'tables',
+            },
+        ),
+        EntityDefinition(
+            name='records',
+            actions=[Action.LIST, Action.GET],
+            endpoints={
+                Action.LIST: EndpointDefinition(
+                    method='GET',
+                    path='/{base_id}/{table_id_or_name}',
+                    action=Action.LIST,
+                    description='Returns a paginated list of records from the specified table',
+                    query_params=[
+                        'offset',
+                        'pageSize',
+                        'view',
+                        'filterByFormula',
+                        'sort',
+                    ],
+                    query_params_schema={
+                        'offset': {'type': 'string', 'required': False},
+                        'pageSize': {'type': 'integer', 'required': False},
+                        'view': {'type': 'string', 'required': False},
+                        'filterByFormula': {'type': 'string', 'required': False},
+                        'sort': {'type': 'string', 'required': False},
+                    },
+                    path_params=['base_id', 'table_id_or_name'],
+                    path_params_schema={
+                        'base_id': {'type': 'string', 'required': True},
+                        'table_id_or_name': {'type': 'string', 'required': True},
+                    },
+                    response_schema={
+                        'type': 'object',
+                        'description': 'Paginated list of records',
+                        'properties': {
+                            'records': {
+                                'type': 'array',
+                                'items': {
+                                    'type': 'object',
+                                    'description': 'A record (row) in an Airtable table',
+                                    'properties': {
+                                        'id': {'type': 'string', 'description': 'Unique identifier for the record'},
+                                        'createdTime': {
+                                            'type': ['string', 'null'],
+                                            'format': 'date-time',
+                                            'description': 'Timestamp when the record was created',
+                                        },
+                                        'fields': {
+                                            'type': ['object', 'null'],
+                                            'description': 'Field values for the record',
+                                            'additionalProperties': True,
+                                        },
+                                    },
+                                    'required': ['id'],
+                                    'x-airbyte-entity-name': 'records',
+                                },
+                            },
+                            'offset': {
+                                'type': ['string', 'null'],
+                                'description': 'Pagination offset for next page',
+                            },
+                        },
+                    },
+                    record_extractor='$.records',
+                ),
+                Action.GET: EndpointDefinition(
+                    method='GET',
+                    path='/{base_id}/{table_id_or_name}/{record_id}',
+                    action=Action.GET,
+                    description='Returns a single record by ID from the specified table',
+                    path_params=['base_id', 'table_id_or_name', 'record_id'],
+                    path_params_schema={
+                        'base_id': {'type': 'string', 'required': True},
+                        'table_id_or_name': {'type': 'string', 'required': True},
+                        'record_id': {'type': 'string', 'required': True},
+                    },
+                    response_schema={
+                        'type': 'object',
+                        'description': 'A record (row) in an Airtable table',
+                        'properties': {
+                            'id': {'type': 'string', 'description': 'Unique identifier for the record'},
+                            'createdTime': {
+                                'type': ['string', 'null'],
+                                'format': 'date-time',
+                                'description': 'Timestamp when the record was created',
+                            },
+                            'fields': {
+                                'type': ['object', 'null'],
+                                'description': 'Field values for the record',
+                                'additionalProperties': True,
+                            },
+                        },
+                        'required': ['id'],
+                        'x-airbyte-entity-name': 'records',
+                    },
+                ),
+            },
+            entity_schema={
+                'type': 'object',
+                'description': 'A record (row) in an Airtable table',
+                'properties': {
+                    'id': {'type': 'string', 'description': 'Unique identifier for the record'},
+                    'createdTime': {
+                        'type': ['string', 'null'],
+                        'format': 'date-time',
+                        'description': 'Timestamp when the record was created',
+                    },
+                    'fields': {
+                        'type': ['object', 'null'],
+                        'description': 'Field values for the record',
+                        'additionalProperties': True,
+                    },
+                },
+                'required': ['id'],
+                'x-airbyte-entity-name': 'records',
+            },
+        ),
+    ],
+    search_field_paths={
+        'bases': ['id', 'name', 'permissionLevel'],
+        'tables': [
+            'id',
+            'name',
+            'primaryFieldId',
+            'fields',
+            'fields[]',
+            'views',
+            'views[]',
+        ],
+    },
+)

airbyte_agent_airtable/models.py

@@ -0,0 +1,219 @@
+"""
+Pydantic models for airtable connector.
+
+This module contains Pydantic models used for authentication configuration
+and response envelope types.
+"""
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import TypeVar, Generic, Union, Any
+
+# Authentication configuration
+
+class AirtableAuthConfig(BaseModel):
+    """Personal Access Token"""
+
+    model_config = ConfigDict(extra="forbid")
+
+    personal_access_token: str
+    """Airtable Personal Access Token. See https://airtable.com/developers/web/guides/personal-access-tokens"""
+
+# ===== RESPONSE TYPE DEFINITIONS (PYDANTIC) =====
+
+class Base(BaseModel):
+    """An Airtable base (workspace)"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Union[str, Any] = Field(default=None)
+    name: Union[str | None, Any] = Field(default=None)
+    permission_level: Union[str | None, Any] = Field(default=None, alias="permissionLevel")
+
+class BasesList(BaseModel):
+    """Paginated list of bases"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    bases: Union[list[Base], Any] = Field(default=None)
+    offset: Union[str | None, Any] = Field(default=None)
+
+class TableField(BaseModel):
+    """A field (column) in a table"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Union[str | None, Any] = Field(default=None)
+    name: Union[str | None, Any] = Field(default=None)
+    type: Union[str | None, Any] = Field(default=None)
+    options: Union[dict[str, Any] | None, Any] = Field(default=None)
+
+class View(BaseModel):
+    """A view in a table"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Union[str | None, Any] = Field(default=None)
+    name: Union[str | None, Any] = Field(default=None)
+    type: Union[str | None, Any] = Field(default=None)
+
+class Table(BaseModel):
+    """A table within an Airtable base"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Union[str, Any] = Field(default=None)
+    name: Union[str | None, Any] = Field(default=None)
+    primary_field_id: Union[str | None, Any] = Field(default=None, alias="primaryFieldId")
+    fields: Union[list[TableField] | None, Any] = Field(default=None)
+    views: Union[list[View] | None, Any] = Field(default=None)
+
+class TablesList(BaseModel):
+    """List of tables in a base"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    tables: Union[list[Table], Any] = Field(default=None)
+
+class Record(BaseModel):
+    """A record (row) in an Airtable table"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Union[str, Any] = Field(default=None)
+    created_time: Union[str | None, Any] = Field(default=None, alias="createdTime")
+    fields: Union[dict[str, Any] | None, Any] = Field(default=None)
+
+class RecordsList(BaseModel):
+    """Paginated list of records"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    records: Union[list[Record], Any] = Field(default=None)
+    offset: Union[str | None, Any] = Field(default=None)
+
+# ===== METADATA TYPE DEFINITIONS (PYDANTIC) =====
+# Meta types for operations that extract metadata (e.g., pagination info)
+
+# ===== CHECK RESULT MODEL =====
+
+class AirtableCheckResult(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
+T = TypeVar('T')
+S = TypeVar('S')
+
+
+class AirtableExecuteResult(BaseModel, Generic[T]):
+    """Response envelope with data only.
+
+    Used for actions that return data without metadata.
+    """
+    model_config = ConfigDict(extra="forbid")
+
+    data: T
+    """Response data containing the result of the action."""
+
+
+class AirtableExecuteResultWithMeta(AirtableExecuteResult[T], Generic[T, S]):
+    """Response envelope with data and metadata.
+
+    Used for actions that return both data and metadata (e.g., pagination info).
+    """
+    meta: S
+    """Metadata about the response (e.g., pagination cursors, record counts)."""
+
+# ===== SEARCH DATA MODELS =====
+# Entity-specific Pydantic models for search result data
+
+# Type variable for search data generic
+D = TypeVar('D')
+
+class BasesSearchData(BaseModel):
+    """Search result data for bases entity."""
+    model_config = ConfigDict(extra="allow")
+
+    id: str | None = None
+    """Unique identifier for the base"""
+    name: str | None = None
+    """Name of the base"""
+    permission_level: str | None = None
+    """Permission level for the base"""
+
+
+class TablesSearchData(BaseModel):
+    """Search result data for tables entity."""
+    model_config = ConfigDict(extra="allow")
+
+    id: str | None = None
+    """Unique identifier for the table"""
+    name: str | None = None
+    """Name of the table"""
+    primary_field_id: str | None = None
+    """ID of the primary field"""
+    fields: list[Any] | None = None
+    """List of fields in the table"""
+    views: list[Any] | None = None
+    """List of views in the table"""
+
+
+# ===== GENERIC SEARCH RESULT TYPES =====
+
+class AirbyteSearchHit(BaseModel, Generic[D]):
+    """A single search result with typed data."""
+    model_config = ConfigDict(extra="allow")
+
+    id: str | None = None
+    """Unique identifier for the record."""
+    score: float | None = None
+    """Relevance score for the match."""
+    data: D
+    """The matched record data."""
+
+
+class AirbyteSearchResult(BaseModel, Generic[D]):
+    """Result from Airbyte cache search operations with typed hits."""
+    model_config = ConfigDict(extra="allow")
+
+    hits: list[AirbyteSearchHit[D]] = Field(default_factory=list)
+    """List of matching records."""
+    next_cursor: str | None = None
+    """Cursor for fetching the next page of results."""
+    took_ms: int | None = None
+    """Time taken to execute the search in milliseconds."""
+
+
+# ===== ENTITY-SPECIFIC SEARCH RESULT TYPE ALIASES =====
+
+BasesSearchResult = AirbyteSearchResult[BasesSearchData]
+"""Search result type for bases entity."""
+
+TablesSearchResult = AirbyteSearchResult[TablesSearchData]
+"""Search result type for tables entity."""
+
+
+
+# ===== OPERATION RESULT TYPE ALIASES =====
+
+# Concrete type aliases for each operation result.
+# These provide simpler, more readable type annotations than using the generic forms.
+
+BasesListResult = AirtableExecuteResult[list[Base]]
+"""Result type for bases.list operation."""
+
+TablesListResult = AirtableExecuteResult[list[Table]]
+"""Result type for tables.list operation."""
+
+RecordsListResult = AirtableExecuteResult[list[Record]]
+"""Result type for records.list operation."""
+