from functools import partial
from typing import Any, Dict, List, Literal, Optional, TypeVar, Union
from typing_extensions import TypeAlias
from pyairtable._compat import pydantic
from ._base import AirtableModel, CanDeleteModel, CanUpdateModel, update_forward_refs
_T = TypeVar("_T", bound=Any)
_FL = partial(pydantic.Field, default_factory=list)
_FD = partial(pydantic.Field, default_factory=dict)
def _find(collection: List[_T], id_or_name: str) -> _T:
"""
For use on a collection model to find objects by either id or name.
"""
items_by_name: Dict[str, _T] = {}
for item in collection:
if getattr(item, "deleted", None):
continue
if item.id == id_or_name:
return item
items_by_name[item.name] = item
return items_by_name[id_or_name]
[docs]class Bases(AirtableModel):
"""
The list of bases visible to the API token.
See https://airtable.com/developers/web/api/list-bases
"""
bases: List["Bases.Info"] = _FL()
[docs] def base(self, base_id: str) -> "Bases.Info":
"""
Get basic information about the base with the given ID.
"""
return _find(self.bases, base_id)
[docs] class Info(AirtableModel):
id: str
name: str
permission_level: str
[docs]class BaseCollaborators(AirtableModel):
"""
Detailed information about who can access a base.
See https://airtable.com/developers/web/api/get-base-collaborators
"""
id: str
name: str
permission_level: str
workspace_id: str
interfaces: Dict[str, "BaseCollaborators.InterfaceCollaborators"] = _FD()
group_collaborators: Optional["BaseCollaborators.GroupCollaborators"]
individual_collaborators: Optional["BaseCollaborators.IndividualCollaborators"]
invite_links: Optional["BaseCollaborators.InviteLinks"]
[docs] class InterfaceCollaborators(AirtableModel):
created_time: str
group_collaborators: List["GroupCollaborator"] = _FL()
individual_collaborators: List["IndividualCollaborator"] = _FL()
invite_links: List["InviteLink"] = _FL()
[docs] class GroupCollaborators(AirtableModel):
via_base: List["GroupCollaborator"] = _FL(alias="baseCollaborators")
via_workspace: List["GroupCollaborator"] = _FL(alias="workspaceCollaborators")
[docs] class IndividualCollaborators(AirtableModel):
via_base: List["IndividualCollaborator"] = _FL(alias="baseCollaborators")
via_workspace: List["IndividualCollaborator"] = _FL(
alias="workspaceCollaborators"
)
[docs] class InviteLinks(AirtableModel):
base_invite_links: List["InviteLink"] = _FL()
workspace_invite_links: List["InviteLink"] = _FL()
[docs]class BaseShares(AirtableModel):
"""
Collection of shared views in a base.
See https://airtable.com/developers/web/api/list-shares
"""
shares: List["BaseShares.Info"]
[docs] class Info(AirtableModel):
state: str
created_by_user_id: str
created_time: str
share_id: str
type: str
is_password_protected: bool
block_installation_id: Optional[str] = None
restricted_to_email_domains: List[str] = _FL()
view_id: Optional[str] = None
effective_email_domain_allow_list: List[str] = _FL()
[docs]class BaseSchema(AirtableModel):
"""
Schema of all tables within the base.
See https://airtable.com/developers/web/api/get-base-schema
Usage:
>>> schema = api.base(base_id).schema()
>>> schema.tables
[TableSchema(...), ...]
>>> schema.table("Table Name")
TableSchema(
id='tbl6jG0XedVMNxFQW',
name='Table Name',
primary_field_id='fld0XedVMNxFQW6jG',
description=None,
fields=[...],
views=[...]
)
"""
tables: List["TableSchema"]
[docs] def table(self, id_or_name: str) -> "TableSchema":
"""
Get the schema for the table with the given ID or name.
"""
return _find(self.tables, id_or_name)
[docs]class TableSchema(
CanUpdateModel,
save_null_values=False,
writable=["name", "description"],
url="meta/bases/{base.id}/tables/{self.id}",
):
"""
Metadata for a table.
See https://airtable.com/developers/web/api/get-base-schema
Usage:
>>> schema = base.table("Table Name").schema()
>>> schema.id
'tbl6clmhESAtaCCwF'
>>> schema.name
'Table Name'
>>> schema.fields
[FieldSchema(...), ...]
>>> schema().field("fld6jG0XedVMNxFQW")
SingleLineTextFieldSchema(
id='fld6jG0XedVMNxFQW',
name='Name',
type='singleLineText'
)
>>> schema.views
[ViewSchema(...), ...]
>>> schema().view("View Name")
ViewSchema(
id='viw6jG0XedVMNxFQW',
name='My Grid View',
type='grid'
)
"""
id: str
name: str
primary_field_id: str
description: Optional[str]
fields: List["FieldSchema"]
views: List["ViewSchema"]
[docs] def field(self, id_or_name: str) -> "FieldSchema":
"""
Get the schema for the field with the given ID or name.
"""
return _find(self.fields, id_or_name)
[docs] def view(self, id_or_name: str) -> "ViewSchema":
"""
Get the schema for the view with the given ID or name.
"""
return _find(self.views, id_or_name)
[docs]class ViewSchema(CanDeleteModel, url="meta/bases/{base.id}/views/{self.id}"):
"""
Metadata for a view.
See https://airtable.com/developers/web/api/get-view-metadata
Usage:
>>> vw = table.schema().view("View name")
>>> vw.name
'View name'
>>> vw.type
'grid'
>>> vw.delete()
"""
id: str
type: str
name: str
personal_for_user_id: Optional[str]
visible_field_ids: Optional[List[str]]
[docs]class GroupCollaborator(AirtableModel):
created_time: str
granted_by_user_id: str
group_id: str
name: str
permission_level: str
[docs]class IndividualCollaborator(AirtableModel):
created_time: str
granted_by_user_id: str
user_id: str
email: str
permission_level: str
[docs]class InviteLink(AirtableModel):
id: str
type: str
created_time: str
invited_email: Optional[str]
referred_by_user_id: str
permission_level: str
restricted_to_email_domains: List[str] = _FL()
[docs]class BaseIndividualCollaborator(IndividualCollaborator):
base_id: str
[docs]class BaseGroupCollaborator(GroupCollaborator):
base_id: str
[docs]class BaseInviteLink(InviteLink):
base_id: str
[docs]class EnterpriseInfo(AirtableModel):
"""
Information about groups, users, workspaces, and email domains
associated with an enterprise account.
See https://airtable.com/developers/web/api/get-enterprise
"""
id: str
created_time: str
group_ids: List[str]
user_ids: List[str]
workspace_ids: List[str]
email_domains: List["EnterpriseInfo.EmailDomain"]
[docs] class EmailDomain(AirtableModel):
email_domain: str
is_sso_required: bool
[docs]class WorkspaceCollaborators(AirtableModel):
"""
Detailed information about who can access a workspace.
See https://airtable.com/developers/web/api/get-workspace-collaborators
"""
id: str
name: str
created_time: str
base_ids: List[str]
# We really don't need black to wrap these lines of text.
# fmt: off
restrictions: "WorkspaceCollaborators.Restrictions" = pydantic.Field(alias="workspaceRestrictions")
group_collaborators: Optional["WorkspaceCollaborators.GroupCollaborators"] = None
individual_collaborators: Optional["WorkspaceCollaborators.IndividualCollaborators"] = None
invite_links: Optional["WorkspaceCollaborators.InviteLinks"] = None
# fmt: on
[docs] class Restrictions(AirtableModel):
invite_creation: str = pydantic.Field(alias="inviteCreationRestriction")
share_creation: str = pydantic.Field(alias="shareCreationRestriction")
[docs] class GroupCollaborators(AirtableModel):
base_collaborators: List["BaseGroupCollaborator"]
workspace_collaborators: List["GroupCollaborator"]
[docs] class IndividualCollaborators(AirtableModel):
base_collaborators: List["BaseIndividualCollaborator"]
workspace_collaborators: List["IndividualCollaborator"]
[docs] class InviteLinks(AirtableModel):
base_invite_links: List["BaseInviteLink"]
workspace_invite_links: List["InviteLink"]
[docs]class NestedId(AirtableModel):
id: str
[docs]class NestedFieldId(AirtableModel):
field_id: str
[docs]class Collaborations(AirtableModel):
"""
The full set of collaborations granted to a user or user group.
See https://airtable.com/developers/web/api/model/collaborations
"""
base_collaborations: List["Collaborations.BaseCollaboration"] = _FL()
interface_collaborations: List["Collaborations.InterfaceCollaboration"] = _FL()
workspace_collaborations: List["Collaborations.WorkspaceCollaboration"] = _FL()
def __bool__(self) -> bool:
return bool(
self.base_collaborations
or self.interface_collaborations
or self.workspace_collaborations
)
@property
def bases(self) -> Dict[str, "Collaborations.BaseCollaboration"]:
"""
Mapping of base IDs to collaborations, to make lookups easier.
"""
return {c.base_id: c for c in self.base_collaborations}
@property
def interfaces(self) -> Dict[str, "Collaborations.InterfaceCollaboration"]:
"""
Mapping of interface IDs to collaborations, to make lookups easier.
"""
return {c.interface_id: c for c in self.interface_collaborations}
@property
def workspaces(self) -> Dict[str, "Collaborations.WorkspaceCollaboration"]:
"""
Mapping of workspace IDs to collaborations, to make lookups easier.
"""
return {c.workspace_id: c for c in self.workspace_collaborations}
[docs] class BaseCollaboration(AirtableModel):
base_id: str
created_time: str
granted_by_user_id: str
permission_level: str
[docs] class InterfaceCollaboration(BaseCollaboration):
interface_id: str
[docs] class WorkspaceCollaboration(AirtableModel):
workspace_id: str
created_time: str
granted_by_user_id: str
permission_level: str
[docs]class UserInfo(AirtableModel):
"""
Detailed information about a user.
See https://airtable.com/developers/web/api/get-user-by-id
"""
id: str
name: str
email: str
state: str
is_sso_required: bool
is_two_factor_auth_enabled: bool
last_activity_time: Optional[str]
created_time: Optional[str]
enterprise_user_type: Optional[str]
invited_to_airtable_by_user_id: Optional[str]
is_managed: bool = False
groups: List[NestedId] = _FL()
collaborations: "Collaborations" = pydantic.Field(default_factory=Collaborations)
[docs]class UserGroup(AirtableModel):
"""
Detailed information about a user group and its members.
See https://airtable.com/developers/web/api/get-user-group
"""
id: str
name: str
enterprise_account_id: str
created_time: str
updated_time: str
members: List["UserGroup.Member"]
collaborations: "Collaborations" = pydantic.Field(default_factory=Collaborations)
[docs] class Member(AirtableModel):
user_id: str
email: str
first_name: str
last_name: str
role: str
created_time: str
# The data model is a bit confusing here, but it's designed for maximum reuse.
# SomethingFieldConfig contains the `type` and `options` values for each field type.
# _FieldSchemaBase contains the `id`, `name`, and `description` values.
# SomethingFieldSchema inherits from _FieldSchemaBase and SomethingFieldConfig.
# FieldConfig is a union of all available *FieldConfig classes.
# FieldSchema is a union of all available *FieldSchema classes.
[docs]class AITextFieldConfig(AirtableModel):
"""
Field configuration for `AI text <https://airtable.com/developers/web/api/field-model#aitext>`__.
"""
type: Literal["aiText"]
options: "AITextFieldOptions"
[docs]class AITextFieldOptions(AirtableModel):
prompt: Optional[List[Union[str, "AITextFieldOptions.PromptField"]]]
referenced_field_ids: Optional[List[str]]
[docs] class PromptField(AirtableModel):
field: NestedFieldId
[docs]class AutoNumberFieldConfig(AirtableModel):
"""
Field configuration for `Auto number <https://airtable.com/developers/web/api/field-model#autonumber>`__.
"""
type: Literal["autoNumber"]
[docs]class BarcodeFieldConfig(AirtableModel):
"""
Field configuration for `Barcode <https://airtable.com/developers/web/api/field-model#barcode>`__.
"""
type: Literal["barcode"]
[docs]class CheckboxFieldConfig(AirtableModel):
"""
Field configuration for `Checkbox <https://airtable.com/developers/web/api/field-model#checkbox>`__.
"""
type: Literal["checkbox"]
options: Optional["CheckboxFieldOptions"]
[docs]class CheckboxFieldOptions(AirtableModel):
color: str
icon: str
[docs]class CountFieldConfig(AirtableModel):
"""
Field configuration for `Count <https://airtable.com/developers/web/api/field-model#count>`__.
"""
type: Literal["count"]
options: Optional["CountFieldOptions"]
[docs]class CountFieldOptions(AirtableModel):
is_valid: bool
record_link_field_id: Optional[str]
[docs]class CreatedByFieldConfig(AirtableModel):
"""
Field configuration for `Created by <https://airtable.com/developers/web/api/field-model#createdby>`__.
"""
type: Literal["createdBy"]
[docs]class CreatedTimeFieldConfig(AirtableModel):
"""
Field configuration for `Created time <https://airtable.com/developers/web/api/field-model#createdtime>`__.
"""
type: Literal["createdTime"]
[docs]class CurrencyFieldConfig(AirtableModel):
"""
Field configuration for `Currency <https://airtable.com/developers/web/api/field-model#currencynumber>`__.
"""
type: Literal["currency"]
options: "CurrencyFieldOptions"
[docs]class CurrencyFieldOptions(AirtableModel):
precision: int
symbol: str
[docs]class DateFieldConfig(AirtableModel):
"""
Field configuration for `Date <https://airtable.com/developers/web/api/field-model#dateonly>`__.
"""
type: Literal["date"]
options: "DateFieldOptions"
[docs]class DateFieldOptions(AirtableModel):
date_format: "DateTimeFieldOptions.DateFormat"
[docs]class DateTimeFieldConfig(AirtableModel):
"""
Field configuration for `Date and time <https://airtable.com/developers/web/api/field-model#dateandtime>`__.
"""
type: Literal["dateTime"]
options: "DateTimeFieldOptions"
[docs]class DateTimeFieldOptions(AirtableModel):
time_zone: str
date_format: "DateTimeFieldOptions.DateFormat"
time_format: "DateTimeFieldOptions.TimeFormat"
[docs]class DurationFieldConfig(AirtableModel):
"""
Field configuration for `Duration <https://airtable.com/developers/web/api/field-model#durationnumber>`__.
"""
type: Literal["duration"]
options: Optional["DurationFieldOptions"]
[docs]class DurationFieldOptions(AirtableModel):
duration_format: str
[docs]class EmailFieldConfig(AirtableModel):
"""
Field configuration for `Email <https://airtable.com/developers/web/api/field-model#email>`__.
"""
type: Literal["email"]
[docs]class ExternalSyncSourceFieldConfig(AirtableModel):
"""
Field configuration for `Sync source <https://airtable.com/developers/web/api/field-model#syncsource>`__.
"""
type: Literal["externalSyncSource"]
options: Optional["SingleSelectFieldOptions"]
[docs]class LastModifiedByFieldConfig(AirtableModel):
"""
Field configuration for `Last modified by <https://airtable.com/developers/web/api/field-model#lastmodifiedby>`__.
"""
type: Literal["lastModifiedBy"]
[docs]class LastModifiedTimeFieldConfig(AirtableModel):
"""
Field configuration for `Last modified time <https://airtable.com/developers/web/api/field-model#lastmodifiedtime>`__.
"""
type: Literal["lastModifiedTime"]
options: Optional["LastModifiedTimeFieldOptions"]
[docs]class LastModifiedTimeFieldOptions(AirtableModel):
is_valid: bool
referenced_field_ids: Optional[List[str]]
result: Optional[Union["DateFieldConfig", "DateTimeFieldConfig"]]
[docs]class MultilineTextFieldConfig(AirtableModel):
"""
Field configuration for `Long text <https://airtable.com/developers/web/api/field-model#multilinetext>`__.
"""
type: Literal["multilineText"]
[docs]class MultipleAttachmentsFieldConfig(AirtableModel):
"""
Field configuration for `Attachments <https://airtable.com/developers/web/api/field-model#multipleattachment>`__.
"""
type: Literal["multipleAttachments"]
options: Optional["MultipleAttachmentsFieldOptions"]
[docs]class MultipleAttachmentsFieldOptions(AirtableModel):
"""
Field configuration for `Attachments <https://airtable.com/developers/web/api/field-model#multipleattachment>`__.
"""
is_reversed: bool
[docs]class MultipleCollaboratorsFieldConfig(AirtableModel):
"""
Field configuration for `Multiple Collaborators <https://airtable.com/developers/web/api/field-model#multicollaborator>`__.
"""
type: Literal["multipleCollaborators"]
[docs]class MultipleLookupValuesFieldConfig(AirtableModel):
"""
Field configuration for `Lookup <https://airtable.com/developers/web/api/field-model#lookup>__`.
"""
type: Literal["multipleLookupValues"]
options: Optional["MultipleLookupValuesFieldOptions"]
[docs]class MultipleLookupValuesFieldOptions(AirtableModel):
field_id_in_linked_table: Optional[str]
is_valid: bool
record_link_field_id: Optional[str]
result: Optional["FieldConfig"]
[docs]class MultipleRecordLinksFieldConfig(AirtableModel):
"""
Field configuration for `Link to another record <https://airtable.com/developers/web/api/field-model#foreignkey>__`.
"""
type: Literal["multipleRecordLinks"]
options: Optional["MultipleRecordLinksFieldOptions"]
[docs]class MultipleRecordLinksFieldOptions(AirtableModel):
is_reversed: bool
linked_table_id: str
prefers_single_record_link: bool
inverse_link_field_id: Optional[str]
view_id_for_record_selection: Optional[str]
[docs]class MultipleSelectsFieldConfig(AirtableModel):
"""
Field configuration for `Multiple select <https://airtable.com/developers/web/api/field-model#multiselect>`__.
"""
type: Literal["multipleSelects"]
options: Optional["SingleSelectFieldOptions"]
[docs]class NumberFieldConfig(AirtableModel):
"""
Field configuration for `Number <https://airtable.com/developers/web/api/field-model#decimalorintegernumber>`__.
"""
type: Literal["number"]
options: Optional["NumberFieldOptions"]
[docs]class NumberFieldOptions(AirtableModel):
precision: int
[docs]class PercentFieldConfig(AirtableModel):
"""
Field configuration for `Percent <https://airtable.com/developers/web/api/field-model#percentnumber>`__.
"""
type: Literal["percent"]
options: Optional["NumberFieldOptions"]
[docs]class PhoneNumberFieldConfig(AirtableModel):
"""
Field configuration for `Phone <https://airtable.com/developers/web/api/field-model#phone>`__.
"""
type: Literal["phoneNumber"]
[docs]class RatingFieldConfig(AirtableModel):
"""
Field configuration for `Rating <https://airtable.com/developers/web/api/field-model#rating>`__.
"""
type: Literal["rating"]
options: Optional["RatingFieldOptions"]
[docs]class RatingFieldOptions(AirtableModel):
color: str
icon: str
max: int
[docs]class RichTextFieldConfig(AirtableModel):
"""
Field configuration for `Rich text <https://airtable.com/developers/web/api/field-model#rich-text>`__.
"""
type: Literal["richText"]
[docs]class RollupFieldConfig(AirtableModel):
"""
Field configuration for `Rollup <https://airtable.com/developers/web/api/field-model#rollup>__`.
"""
type: Literal["rollup"]
options: Optional["RollupFieldOptions"]
[docs]class RollupFieldOptions(AirtableModel):
field_id_in_linked_table: Optional[str]
is_valid: bool
record_link_field_id: Optional[str]
referenced_field_ids: Optional[List[str]]
result: Optional["FieldConfig"]
[docs]class SingleCollaboratorFieldConfig(AirtableModel):
"""
Field configuration for `Collaborator <https://airtable.com/developers/web/api/field-model#collaborator>`__.
"""
type: Literal["singleCollaborator"]
[docs]class SingleLineTextFieldConfig(AirtableModel):
"""
Field configuration for `Single line text <https://airtable.com/developers/web/api/field-model#simpletext>`__.
"""
type: Literal["singleLineText"]
[docs]class SingleSelectFieldConfig(AirtableModel):
"""
Field configuration for `Single select <https://airtable.com/developers/web/api/field-model#select>`__.
"""
type: Literal["singleSelect"]
options: Optional["SingleSelectFieldOptions"]
[docs]class SingleSelectFieldOptions(AirtableModel):
choices: List["SingleSelectFieldOptions.Choice"]
[docs] class Choice(AirtableModel):
id: str
name: str
color: Optional[str]
[docs]class UrlFieldConfig(AirtableModel):
"""
Field configuration for `Url <https://airtable.com/developers/web/api/field-model#urltext>`__.
"""
type: Literal["url"]
[docs]class UnknownFieldConfig(AirtableModel):
"""
Field configuration class used as a fallback for unrecognized types.
This ensures we don't raise pydantic.ValidationError if Airtable adds new types.
"""
type: str
options: Optional[Dict[str, Any]]
class _FieldSchemaBase(
CanUpdateModel,
save_null_values=False,
writable=["name", "description"],
url="meta/bases/{base.id}/tables/{table_schema.id}/fields/{self.id}",
):
id: str
name: str
description: Optional[str]
# This section is auto-generated so that FieldSchema and FieldConfig are kept aligned.
# See .pre-commit-config.yaml, or just run `tox -e pre-commit` to refresh it.
# fmt: off
r"""[[[cog]]]
import re
with open(cog.inFile) as fp:
field_types = re.findall(
r"class (\w+Field)Config\(.*?\):(?:\n \"{3}(.*?)\"{3})?",
fp.read(),
re.MULTILINE + re.DOTALL
)
cog.out("\n\n")
cog.outl("FieldConfig: TypeAlias = Union[")
for fld, _ in field_types:
cog.outl(f" {fld}Config,")
cog.outl("]")
cog.out("\n\n")
for fld, doc in field_types:
cog.out(f"class {fld}Schema(_FieldSchemaBase, {fld}Config):\n ")
if doc:
doc = doc.replace('ield configuration', 'ield schema')
cog.outl("\"\"\"" + doc + "\"\"\"")
else:
cog.outl("pass")
cog.out("\n\n")
cog.outl("FieldSchema: TypeAlias = Union[")
for fld, _ in field_types:
cog.outl(f" {fld}Schema,")
cog.outl("]")
[[[out]]]"""
FieldConfig: TypeAlias = Union[
AITextFieldConfig,
AutoNumberFieldConfig,
BarcodeFieldConfig,
ButtonFieldConfig,
CheckboxFieldConfig,
CountFieldConfig,
CreatedByFieldConfig,
CreatedTimeFieldConfig,
CurrencyFieldConfig,
DateFieldConfig,
DateTimeFieldConfig,
DurationFieldConfig,
EmailFieldConfig,
ExternalSyncSourceFieldConfig,
FormulaFieldConfig,
LastModifiedByFieldConfig,
LastModifiedTimeFieldConfig,
MultilineTextFieldConfig,
MultipleAttachmentsFieldConfig,
MultipleCollaboratorsFieldConfig,
MultipleLookupValuesFieldConfig,
MultipleRecordLinksFieldConfig,
MultipleSelectsFieldConfig,
NumberFieldConfig,
PercentFieldConfig,
PhoneNumberFieldConfig,
RatingFieldConfig,
RichTextFieldConfig,
RollupFieldConfig,
SingleCollaboratorFieldConfig,
SingleLineTextFieldConfig,
SingleSelectFieldConfig,
UrlFieldConfig,
UnknownFieldConfig,
]
[docs]class AITextFieldSchema(_FieldSchemaBase, AITextFieldConfig):
"""
Field schema for `AI text <https://airtable.com/developers/web/api/field-model#aitext>`__.
"""
[docs]class AutoNumberFieldSchema(_FieldSchemaBase, AutoNumberFieldConfig):
"""
Field schema for `Auto number <https://airtable.com/developers/web/api/field-model#autonumber>`__.
"""
[docs]class BarcodeFieldSchema(_FieldSchemaBase, BarcodeFieldConfig):
"""
Field schema for `Barcode <https://airtable.com/developers/web/api/field-model#barcode>`__.
"""
[docs]class CheckboxFieldSchema(_FieldSchemaBase, CheckboxFieldConfig):
"""
Field schema for `Checkbox <https://airtable.com/developers/web/api/field-model#checkbox>`__.
"""
[docs]class CountFieldSchema(_FieldSchemaBase, CountFieldConfig):
"""
Field schema for `Count <https://airtable.com/developers/web/api/field-model#count>`__.
"""
[docs]class CreatedByFieldSchema(_FieldSchemaBase, CreatedByFieldConfig):
"""
Field schema for `Created by <https://airtable.com/developers/web/api/field-model#createdby>`__.
"""
[docs]class CreatedTimeFieldSchema(_FieldSchemaBase, CreatedTimeFieldConfig):
"""
Field schema for `Created time <https://airtable.com/developers/web/api/field-model#createdtime>`__.
"""
[docs]class CurrencyFieldSchema(_FieldSchemaBase, CurrencyFieldConfig):
"""
Field schema for `Currency <https://airtable.com/developers/web/api/field-model#currencynumber>`__.
"""
[docs]class DateFieldSchema(_FieldSchemaBase, DateFieldConfig):
"""
Field schema for `Date <https://airtable.com/developers/web/api/field-model#dateonly>`__.
"""
[docs]class DateTimeFieldSchema(_FieldSchemaBase, DateTimeFieldConfig):
"""
Field schema for `Date and time <https://airtable.com/developers/web/api/field-model#dateandtime>`__.
"""
[docs]class DurationFieldSchema(_FieldSchemaBase, DurationFieldConfig):
"""
Field schema for `Duration <https://airtable.com/developers/web/api/field-model#durationnumber>`__.
"""
[docs]class EmailFieldSchema(_FieldSchemaBase, EmailFieldConfig):
"""
Field schema for `Email <https://airtable.com/developers/web/api/field-model#email>`__.
"""
[docs]class ExternalSyncSourceFieldSchema(_FieldSchemaBase, ExternalSyncSourceFieldConfig):
"""
Field schema for `Sync source <https://airtable.com/developers/web/api/field-model#syncsource>`__.
"""
[docs]class LastModifiedByFieldSchema(_FieldSchemaBase, LastModifiedByFieldConfig):
"""
Field schema for `Last modified by <https://airtable.com/developers/web/api/field-model#lastmodifiedby>`__.
"""
[docs]class LastModifiedTimeFieldSchema(_FieldSchemaBase, LastModifiedTimeFieldConfig):
"""
Field schema for `Last modified time <https://airtable.com/developers/web/api/field-model#lastmodifiedtime>`__.
"""
[docs]class MultilineTextFieldSchema(_FieldSchemaBase, MultilineTextFieldConfig):
"""
Field schema for `Long text <https://airtable.com/developers/web/api/field-model#multilinetext>`__.
"""
[docs]class MultipleAttachmentsFieldSchema(_FieldSchemaBase, MultipleAttachmentsFieldConfig):
"""
Field schema for `Attachments <https://airtable.com/developers/web/api/field-model#multipleattachment>`__.
"""
[docs]class MultipleCollaboratorsFieldSchema(_FieldSchemaBase, MultipleCollaboratorsFieldConfig):
"""
Field schema for `Multiple Collaborators <https://airtable.com/developers/web/api/field-model#multicollaborator>`__.
"""
[docs]class MultipleLookupValuesFieldSchema(_FieldSchemaBase, MultipleLookupValuesFieldConfig):
"""
Field schema for `Lookup <https://airtable.com/developers/web/api/field-model#lookup>__`.
"""
[docs]class MultipleRecordLinksFieldSchema(_FieldSchemaBase, MultipleRecordLinksFieldConfig):
"""
Field schema for `Link to another record <https://airtable.com/developers/web/api/field-model#foreignkey>__`.
"""
[docs]class MultipleSelectsFieldSchema(_FieldSchemaBase, MultipleSelectsFieldConfig):
"""
Field schema for `Multiple select <https://airtable.com/developers/web/api/field-model#multiselect>`__.
"""
[docs]class NumberFieldSchema(_FieldSchemaBase, NumberFieldConfig):
"""
Field schema for `Number <https://airtable.com/developers/web/api/field-model#decimalorintegernumber>`__.
"""
[docs]class PercentFieldSchema(_FieldSchemaBase, PercentFieldConfig):
"""
Field schema for `Percent <https://airtable.com/developers/web/api/field-model#percentnumber>`__.
"""
[docs]class PhoneNumberFieldSchema(_FieldSchemaBase, PhoneNumberFieldConfig):
"""
Field schema for `Phone <https://airtable.com/developers/web/api/field-model#phone>`__.
"""
[docs]class RatingFieldSchema(_FieldSchemaBase, RatingFieldConfig):
"""
Field schema for `Rating <https://airtable.com/developers/web/api/field-model#rating>`__.
"""
[docs]class RichTextFieldSchema(_FieldSchemaBase, RichTextFieldConfig):
"""
Field schema for `Rich text <https://airtable.com/developers/web/api/field-model#rich-text>`__.
"""
[docs]class RollupFieldSchema(_FieldSchemaBase, RollupFieldConfig):
"""
Field schema for `Rollup <https://airtable.com/developers/web/api/field-model#rollup>__`.
"""
[docs]class SingleCollaboratorFieldSchema(_FieldSchemaBase, SingleCollaboratorFieldConfig):
"""
Field schema for `Collaborator <https://airtable.com/developers/web/api/field-model#collaborator>`__.
"""
[docs]class SingleLineTextFieldSchema(_FieldSchemaBase, SingleLineTextFieldConfig):
"""
Field schema for `Single line text <https://airtable.com/developers/web/api/field-model#simpletext>`__.
"""
[docs]class SingleSelectFieldSchema(_FieldSchemaBase, SingleSelectFieldConfig):
"""
Field schema for `Single select <https://airtable.com/developers/web/api/field-model#select>`__.
"""
[docs]class UrlFieldSchema(_FieldSchemaBase, UrlFieldConfig):
"""
Field schema for `Url <https://airtable.com/developers/web/api/field-model#urltext>`__.
"""
[docs]class UnknownFieldSchema(_FieldSchemaBase, UnknownFieldConfig):
"""
Field schema class used as a fallback for unrecognized types.
This ensures we don't raise pydantic.ValidationError if Airtable adds new types.
"""
FieldSchema: TypeAlias = Union[
AITextFieldSchema,
AutoNumberFieldSchema,
BarcodeFieldSchema,
ButtonFieldSchema,
CheckboxFieldSchema,
CountFieldSchema,
CreatedByFieldSchema,
CreatedTimeFieldSchema,
CurrencyFieldSchema,
DateFieldSchema,
DateTimeFieldSchema,
DurationFieldSchema,
EmailFieldSchema,
ExternalSyncSourceFieldSchema,
FormulaFieldSchema,
LastModifiedByFieldSchema,
LastModifiedTimeFieldSchema,
MultilineTextFieldSchema,
MultipleAttachmentsFieldSchema,
MultipleCollaboratorsFieldSchema,
MultipleLookupValuesFieldSchema,
MultipleRecordLinksFieldSchema,
MultipleSelectsFieldSchema,
NumberFieldSchema,
PercentFieldSchema,
PhoneNumberFieldSchema,
RatingFieldSchema,
RichTextFieldSchema,
RollupFieldSchema,
SingleCollaboratorFieldSchema,
SingleLineTextFieldSchema,
SingleSelectFieldSchema,
UrlFieldSchema,
UnknownFieldSchema,
]
# [[[end]]] (checksum: afb669896323650954a082cb4b079c16)
# fmt: on
# Shortcut to allow parsing unions, which is not possible otherwise in Pydantic v1.
# See https://github.com/pydantic/pydantic/discussions/4950
class _HasFieldSchema(AirtableModel):
field_schema: FieldSchema
def parse_field_schema(obj: Any) -> FieldSchema:
return _HasFieldSchema.parse_obj({"field_schema": obj}).field_schema
update_forward_refs(vars())