Skip to main content

Module airbyte_agent_sdk.connectors.gmail.models

Pydantic models for gmail 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.gmail.models.AirbyteSearchResult[DraftsSearchData]
  • airbyte_agent_sdk.connectors.gmail.models.AirbyteSearchResult[LabelsSearchData]
  • airbyte_agent_sdk.connectors.gmail.models.AirbyteSearchResult[MessagesSearchData]
  • airbyte_agent_sdk.connectors.gmail.models.AirbyteSearchResult[ProfileSearchData]
  • airbyte_agent_sdk.connectors.gmail.models.AirbyteSearchResult[ThreadsSearchData]

Class variables

data: list[~D] : List of matching records.

meta: airbyte_agent_sdk.connectors.gmail.models.AirbyteSearchMeta : Pagination metadata.

model_config : The type of the None singleton.

AirbyteSearchResult[DraftsSearchData](**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.gmail.models.AirbyteSearchResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

DraftsSearchResult(**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.gmail.models.AirbyteSearchResult
  • pydantic.main.BaseModel
  • typing.Generic

AirbyteSearchResult[LabelsSearchData](**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.gmail.models.AirbyteSearchResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

LabelsSearchResult(**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.gmail.models.AirbyteSearchResult
  • pydantic.main.BaseModel
  • typing.Generic

AirbyteSearchResult[MessagesSearchData](**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.gmail.models.AirbyteSearchResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

MessagesSearchResult(**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.gmail.models.AirbyteSearchResult
  • pydantic.main.BaseModel
  • typing.Generic

AirbyteSearchResult[ProfileSearchData](**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.gmail.models.AirbyteSearchResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

ProfileSearchResult(**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.gmail.models.AirbyteSearchResult
  • pydantic.main.BaseModel
  • typing.Generic

AirbyteSearchResult[ThreadsSearchData](**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.gmail.models.AirbyteSearchResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

ThreadsSearchResult(**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.gmail.models.AirbyteSearchResult
  • pydantic.main.BaseModel
  • typing.Generic

Draft(**data: Any) : A Gmail draft message

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.

message: typing.Any | None : The type of the None singleton.

model_config : The type of the None singleton.

DraftCreateParams(**data: Any) : Parameters for creating or updating a draft

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

message: airbyte_agent_sdk.connectors.gmail.models.DraftCreateParamsMessage : The type of the None singleton.

model_config : The type of the None singleton.

DraftCreateParamsMessage(**data: Any) : The draft message content

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.

raw: str : The draft message in RFC 2822 format, base64url encoded

thread_id: str | None : The thread ID for the draft (for threading in a conversation)

DraftRef(**data: Any) : A lightweight reference to a draft (used in list 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

id: str | None : The type of the None singleton.

message: typing.Any | None : The type of the None singleton.

model_config : The type of the None singleton.

DraftSendParams(**data: Any) : Parameters for sending an existing draft

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.

DraftsListResponse(**data: Any) : Response from listing drafts

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

drafts: list[airbyte_agent_sdk.connectors.gmail.models.DraftRef] | None : The type of the None singleton.

model_config : The type of the None singleton.

next_page_token: str | None : The type of the None singleton.

result_size_estimate: int | None : The type of the None singleton.

DraftsListResultMeta(**data: Any) : Metadata for drafts.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.

next_page_token: str | None : The type of the None singleton.

result_size_estimate: int | None : The type of the None singleton.

DraftsSearchData(**data: Any) : Search result data for drafts 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 : Unique identifier for the draft

message: dict[str, typing.Any] | None : Draft message payload (headers, body, and metadata)

model_config : The type of the None singleton.

GmailAuthConfig(**data: Any) : OAuth 2.0 Authentication

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

access_token: str | None : Your Google OAuth2 Access Token (optional, will be obtained via refresh)

client_id: str | None : Your Google OAuth2 Client ID

client_secret: str | None : Your Google OAuth2 Client Secret

model_config : The type of the None singleton.

refresh_token: str : Your Google OAuth2 Refresh Token

GmailCheckResult(**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'.

GmailExecuteResult(**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.gmail.models.GmailExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.gmail.models.GmailExecuteResult[list[Label]]

Class variables

data: ~T : Response data containing the result of the action.

model_config : The type of the None singleton.

GmailExecuteResultWithMeta(**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.gmail.models.GmailExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Descendants

  • airbyte_agent_sdk.connectors.gmail.models.GmailExecuteResultWithMeta[list[DraftRef], DraftsListResultMeta]
  • airbyte_agent_sdk.connectors.gmail.models.GmailExecuteResultWithMeta[list[MessageRef], MessagesListResultMeta]
  • airbyte_agent_sdk.connectors.gmail.models.GmailExecuteResultWithMeta[list[ThreadRef], ThreadsListResultMeta]

Class variables

meta: ~S : Metadata about the response (e.g., pagination cursors, record counts).

GmailExecuteResultWithMeta[list[DraftRef], DraftsListResultMeta](**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.gmail.models.GmailExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.gmail.models.GmailExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

DraftsListResult(**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.gmail.models.GmailExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.gmail.models.GmailExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

GmailExecuteResultWithMeta[list[MessageRef], MessagesListResultMeta](**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.gmail.models.GmailExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.gmail.models.GmailExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

MessagesListResult(**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.gmail.models.GmailExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.gmail.models.GmailExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

GmailExecuteResultWithMeta[list[ThreadRef], ThreadsListResultMeta](**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.gmail.models.GmailExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.gmail.models.GmailExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

ThreadsListResult(**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.gmail.models.GmailExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.gmail.models.GmailExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

GmailExecuteResult[list[Label]](**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.gmail.models.GmailExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

LabelsListResult(**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.gmail.models.GmailExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

GmailReplicationConfig(**data: Any) : Replication Configuration - Settings for data replication from Gmail.

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

include_spam_and_trash: bool | None : Include messages from SPAM and TRASH in the results. Defaults to false.

model_config : The type of the None singleton.

Label(**data: Any) : A Gmail label used to organize messages and threads

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

color: typing.Any | None : The type of the None singleton.

id: str | None : The type of the None singleton.

label_list_visibility: str | None : The type of the None singleton.

message_list_visibility: str | None : The type of the None singleton.

messages_total: int | None : The type of the None singleton.

messages_unread: int | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str | None : The type of the None singleton.

threads_total: int | None : The type of the None singleton.

threads_unread: int | None : The type of the None singleton.

type_: str | None : The type of the None singleton.

LabelColor(**data: Any) : The color to assign to a label

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

background_color: str | None : The type of the None singleton.

model_config : The type of the None singleton.

text_color: str | None : The type of the None singleton.

LabelCreateParams(**data: Any) : Parameters for creating a label

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

color: airbyte_agent_sdk.connectors.gmail.models.LabelCreateParamsColor | None : The type of the None singleton.

label_list_visibility: str | None : The type of the None singleton.

message_list_visibility: str | None : The type of the None singleton.

model_config : The type of the None singleton.

name: str : The type of the None singleton.

LabelCreateParamsColor(**data: Any) : The color to assign to the label

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

background_color: str | None : The background color of the label as a hex string (#RRGGBB)

model_config : The type of the None singleton.

text_color: str | None : The text color of the label as a hex string (#RRGGBB)

LabelUpdateParams(**data: Any) : Parameters for updating a label

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

color: airbyte_agent_sdk.connectors.gmail.models.LabelUpdateParamsColor | None : The type of the None singleton.

id: str | None : The type of the None singleton.

label_list_visibility: str | None : The type of the None singleton.

message_list_visibility: 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.

LabelUpdateParamsColor(**data: Any) : The color to assign to the label

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

background_color: str | None : The background color of the label as a hex string (#RRGGBB)

model_config : The type of the None singleton.

text_color: str | None : The text color of the label as a hex string (#RRGGBB)

LabelsListResponse(**data: Any) : Response from listing labels

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

labels: list[airbyte_agent_sdk.connectors.gmail.models.Label] | None : The type of the None singleton.

model_config : The type of the None singleton.

LabelsSearchData(**data: Any) : Search result data for labels 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 : Unique identifier for the label

label_list_visibility: str | None : Visibility of the label in the label list

message_list_visibility: str | None : Visibility of the label when viewing a message list

model_config : The type of the None singleton.

name: str | None : Display name of the label

type_: str | None : Label type: system or user

Message(**data: Any) : A Gmail email message

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

history_id: str | None : The type of the None singleton.

id: str | None : The type of the None singleton.

internal_date: str | None : The type of the None singleton.

label_ids: list[str] | None : The type of the None singleton.

model_config : The type of the None singleton.

payload: typing.Any | None : The type of the None singleton.

raw: str | None : The type of the None singleton.

size_estimate: int | None : The type of the None singleton.

snippet: str | None : The type of the None singleton.

thread_id: str | None : The type of the None singleton.

MessageHeader(**data: Any) : A single email header key-value pair

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.

name: str | None : The type of the None singleton.

value: str | None : The type of the None singleton.

MessageModifyParams(**data: Any) : Parameters for modifying message labels

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

add_label_ids: list[str] | None : The type of the None singleton.

model_config : The type of the None singleton.

remove_label_ids: list[str] | None : The type of the None singleton.

MessagePart(**data: Any) : A single MIME message part

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

body: typing.Any | None : The type of the None singleton.

filename: str | None : The type of the None singleton.

headers: list[airbyte_agent_sdk.connectors.gmail.models.MessageHeader] | None : The type of the None singleton.

mime_type: str | None : The type of the None singleton.

model_config : The type of the None singleton.

part_id: str | None : The type of the None singleton.

parts: list[dict[str, typing.Any]] | None : The type of the None singleton.

MessagePartBody(**data: Any) : The body data of a MIME message part

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

attachment_id: str | None : The type of the None singleton.

data: str | None : The type of the None singleton.

model_config : The type of the None singleton.

size: int | None : The type of the None singleton.

MessageRef(**data: Any) : A lightweight reference to a message (used in list 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

id: str | None : The type of the None singleton.

model_config : The type of the None singleton.

thread_id: str | None : The type of the None singleton.

MessageSendParams(**data: Any) : Parameters for sending a message

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.

raw: str : The type of the None singleton.

thread_id: str | None : The type of the None singleton.

MessagesListResponse(**data: Any) : Response from listing messages

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

messages: list[airbyte_agent_sdk.connectors.gmail.models.MessageRef] | None : The type of the None singleton.

model_config : The type of the None singleton.

next_page_token: str | None : The type of the None singleton.

result_size_estimate: int | None : The type of the None singleton.

MessagesListResultMeta(**data: Any) : Metadata for messages.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.

next_page_token: str | None : The type of the None singleton.

result_size_estimate: int | None : The type of the None singleton.

MessagesSearchData(**data: Any) : Search result data for messages 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 : Unique identifier for the message

model_config : The type of the None singleton.

thread_id: str | None : Identifier of the thread this message belongs to

Profile(**data: Any) : Gmail user profile information

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

email_address: str | None : The type of the None singleton.

history_id: str | None : The type of the None singleton.

messages_total: int | None : The type of the None singleton.

model_config : The type of the None singleton.

threads_total: int | None : The type of the None singleton.

ProfileSearchData(**data: Any) : Search result data for profile 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

email_address: str | None : Email address of the authenticated Gmail account

history_id: str | None : Mailbox history record identifier used for incremental sync

messages_total: float | None : Total number of messages currently in the mailbox

model_config : The type of the None singleton.

threads_total: float | None : Total number of threads currently in the mailbox

Thread(**data: Any) : A Gmail thread (email conversation)

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

history_id: str | None : The type of the None singleton.

id: str | None : The type of the None singleton.

messages: list[airbyte_agent_sdk.connectors.gmail.models.Message] | None : The type of the None singleton.

model_config : The type of the None singleton.

snippet: str | None : The type of the None singleton.

ThreadRef(**data: Any) : A lightweight reference to a thread (used in list 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

history_id: str | None : The type of the None singleton.

id: str | None : The type of the None singleton.

model_config : The type of the None singleton.

snippet: str | None : The type of the None singleton.

ThreadsListResponse(**data: Any) : Response from listing threads

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.

next_page_token: str | None : The type of the None singleton.

result_size_estimate: int | None : The type of the None singleton.

threads: list[airbyte_agent_sdk.connectors.gmail.models.ThreadRef] | None : The type of the None singleton.

ThreadsListResultMeta(**data: Any) : Metadata for threads.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.

next_page_token: str | None : The type of the None singleton.

result_size_estimate: int | None : The type of the None singleton.

ThreadsSearchData(**data: Any) : Search result data for threads 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

history_id: str | None : Mailbox history record identifier for the thread

id: str : Unique identifier for the thread

model_config : The type of the None singleton.

snippet: str | None : Short snippet of the thread's most recent message

Was this page helpful?