Module airbyte_agent_sdk.connectors.airtable.models
Pydantic models for airtable connector.
This module contains Pydantic models used for authentication configuration and response envelope types.
Classes
AirbyteSearchMeta(**data: Any)
: Pagination metadata for search responses.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
cursor: str | None
: Cursor for fetching the next page of results.
has_more: bool
: Whether more results are available.
model_config
: The type of the None singleton.
took_ms: int | None
: Time taken to execute the search in milliseconds.
AirbyteSearchResult(**data: Any)
: Result from Airbyte cache search operations with typed records.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
- typing.Generic
Descendants
- airbyte_agent_sdk.connectors.airtable.models.AirbyteSearchResult[BasesSearchData]
- airbyte_agent_sdk.connectors.airtable.models.AirbyteSearchResult[TablesSearchData]
Class variables
data: list[~D]
: List of matching records.
meta: airbyte_agent_sdk.connectors.airtable.models.AirbyteSearchMeta
: Pagination metadata.
model_config
: The type of the None singleton.
AirbyteSearchResult[BasesSearchData](**data: Any)
: Result from Airbyte cache search operations with typed records.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- airbyte_agent_sdk.connectors.airtable.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
BasesSearchResult(**data: Any)
: Result from Airbyte cache search operations with typed records.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- airbyte_agent_sdk.connectors.airtable.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
AirbyteSearchResult[TablesSearchData](**data: Any)
: Result from Airbyte cache search operations with typed records.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- airbyte_agent_sdk.connectors.airtable.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
TablesSearchResult(**data: Any)
: Result from Airbyte cache search operations with typed records.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- airbyte_agent_sdk.connectors.airtable.models.AirbyteSearchResult
- pydantic.main.BaseModel
- typing.Generic
AirtableAuthConfig(**data: Any)
: Personal Access Token
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
model_config
: The type of the None singleton.
personal_access_token: str
: Airtable Personal Access Token. See https://airtable.com/developers/web/guides/personal-access-tokens
AirtableCheckResult(**data: Any)
: Result of a health check operation.
Returned by the check() method to indicate connectivity and credential status.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
checked_action: str | None
: Action name used for the health check.
checked_entity: str | None
: Entity name used for the health check.
error: str | None
: Error message if status is 'unhealthy', None otherwise.
model_config
: The type of the None singleton.
status: str
: Health check status: 'healthy' or 'unhealthy'.
AirtableExecuteResult(**data: Any)
: Response envelope with data only.
Used for actions that return data without metadata.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
- typing.Generic
Descendants
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResultWithMeta
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResult[list[Table]]
Class variables
data: ~T
: Response data containing the result of the action.
model_config
: The type of the None singleton.
AirtableExecuteResultWithMeta(**data: Any)
: Response envelope with data and metadata.
Used for actions that return both data and metadata (e.g., pagination info).
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Descendants
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResultWithMeta[list[Base], BasesListResultMeta]
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResultWithMeta[list[Record], RecordsListResultMeta]
Class variables
meta: ~S
: Metadata about the response (e.g., pagination cursors, record counts).
AirtableExecuteResultWithMeta[list[Base], BasesListResultMeta](**data: Any)
: Response envelope with data and metadata.
Used for actions that return both data and metadata (e.g., pagination info).
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResultWithMeta
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
BasesListResult(**data: Any)
: Response envelope with data and metadata.
Used for actions that return both data and metadata (e.g., pagination info).
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResultWithMeta
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResult
- pydantic.main.BaseModel
- typing.Generic
AirtableExecuteResultWithMeta[list[Record], RecordsListResultMeta](**data: Any)
: Response envelope with data and metadata.
Used for actions that return both data and metadata (e.g., pagination info).
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResultWithMeta
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
RecordsListResult(**data: Any)
: Response envelope with data and metadata.
Used for actions that return both data and metadata (e.g., pagination info).
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResultWithMeta
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResult
- pydantic.main.BaseModel
- typing.Generic
AirtableExecuteResult[list[Table]](**data: Any)
: Response envelope with data only.
Used for actions that return data without metadata.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Class variables
model_config
: The type of the None singleton.
TablesListResult(**data: Any)
: Response envelope with data only.
Used for actions that return data without metadata.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- airbyte_agent_sdk.connectors.airtable.models.AirtableExecuteResult
- pydantic.main.BaseModel
- typing.Generic
Base(**data: Any)
: An Airtable base (workspace)
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
id: str
: The type of the None singleton.
model_config
: The type of the None singleton.
name: str | None
: The type of the None singleton.
permission_level: str | None
: The type of the None singleton.
BasesList(**data: Any)
: Paginated list of bases
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
bases: list[airbyte_agent_sdk.connectors.airtable.models.Base] | None
: The type of the None singleton.
model_config
: The type of the None singleton.
offset: str | None
: The type of the None singleton.
BasesListResultMeta(**data: Any)
: Metadata for bases.Action.LIST operation
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
model_config
: The type of the None singleton.
offset: str | None
: The type of the None singleton.
BasesSearchData(**data: Any)
: Search result data for bases entity.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
id: str | None
: Unique identifier for the base
model_config
: The type of the None singleton.
name: str | None
: Name of the base
permission_level: str | None
: Permission level for the base
Record(**data: Any)
: A record (row) in an Airtable table
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
created_time: str | None
: The type of the None singleton.
fields: dict[str, typing.Any] | None
: The type of the None singleton.
id: str
: The type of the None singleton.
model_config
: The type of the None singleton.
RecordsList(**data: Any)
: Paginated list of records
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
model_config
: The type of the None singleton.
offset: str | None
: The type of the None singleton.
records: list[airbyte_agent_sdk.connectors.airtable.models.Record] | None
: The type of the None singleton.
RecordsListResultMeta(**data: Any)
: Metadata for records.Action.LIST operation
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
model_config
: The type of the None singleton.
offset: str | None
: The type of the None singleton.
Table(**data: Any)
: A table within an Airtable base
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
fields: list[airbyte_agent_sdk.connectors.airtable.models.TableField] | None
: The type of the None singleton.
id: str
: The type of the None singleton.
model_config
: The type of the None singleton.
name: str | None
: The type of the None singleton.
primary_field_id: str | None
: The type of the None singleton.
views: list[airbyte_agent_sdk.connectors.airtable.models.View] | None
: The type of the None singleton.
TableField(**data: Any)
: A field (column) in a table
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
id: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
name: str | None
: The type of the None singleton.
options: dict[str, typing.Any] | None
: The type of the None singleton.
type_: str | None
: The type of the None singleton.
TablesList(**data: Any)
: List of tables in a base
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
model_config
: The type of the None singleton.
tables: list[airbyte_agent_sdk.connectors.airtable.models.Table] | None
: The type of the None singleton.
TablesSearchData(**data: Any)
: Search result data for tables entity.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
fields: list[typing.Any] | None
: List of fields in the table
id: str | None
: Unique identifier for the table
model_config
: The type of the None singleton.
name: str | None
: Name of the table
primary_field_id: str | None
: ID of the primary field
views: list[typing.Any] | None
: List of views in the table
View(**data: Any)
: A view in a table
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Ancestors (in MRO)
- pydantic.main.BaseModel
Class variables
id: str | None
: The type of the None singleton.
model_config
: The type of the None singleton.
name: str | None
: The type of the None singleton.
type_: str | None
: The type of the None singleton.