Skip to main content

Module airbyte_agent_sdk.connectors.hubspot.models

Pydantic models for hubspot 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.hubspot.models.AirbyteSearchResult[CompaniesSearchData]
  • airbyte_agent_sdk.connectors.hubspot.models.AirbyteSearchResult[ContactsSearchData]
  • airbyte_agent_sdk.connectors.hubspot.models.AirbyteSearchResult[DealsSearchData]
  • airbyte_agent_sdk.connectors.hubspot.models.AirbyteSearchResult[TicketsSearchData]

Class variables

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

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

model_config : The type of the None singleton.

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

Class variables

model_config : The type of the None singleton.

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

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

Class variables

model_config : The type of the None singleton.

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

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

Class variables

model_config : The type of the None singleton.

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

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

Class variables

model_config : The type of the None singleton.

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

CRMObject(**data: Any) : Generic HubSpot CRM object (for custom objects)

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

archived: bool | None : The type of the None singleton.

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

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

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

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

properties: airbyte_agent_sdk.connectors.hubspot.models.CRMObjectProperties | None : The type of the None singleton.

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

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

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

CRMObjectProperties(**data: Any) : Object properties

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

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

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

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

model_config : The type of the None singleton.

CompaniesApiSearchResultMeta(**data: Any) : Metadata for companies.Action.API_SEARCH 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_cursor: str | None : The type of the None singleton.

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

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

CompaniesList(**data: Any) : Paginated list of companies

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.

paging: airbyte_agent_sdk.connectors.hubspot.models.Paging | None : The type of the None singleton.

results: list[airbyte_agent_sdk.connectors.hubspot.models.Company] | None : The type of the None singleton.

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

CompaniesListResultMeta(**data: Any) : Metadata for companies.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_cursor: str | None : The type of the None singleton.

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

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

archived: bool | None : Indicates whether the company has been deleted and moved to the recycling bin

contacts: list[typing.Any] | None : Associated contact records linked to this company

created_at: str | None : Timestamp when the company record was created

id: str | None : Unique identifier for the company record

model_config : The type of the None singleton.

properties: dict[str, typing.Any] : Object containing all property values for the company

updated_at: str | None : Timestamp when the company record was last modified

Company(**data: Any) : HubSpot company object

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

archived: bool | None : The type of the None singleton.

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

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

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

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

properties: airbyte_agent_sdk.connectors.hubspot.models.CompanyProperties | None : The type of the None singleton.

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

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

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

CompanyProperties(**data: Any) : Company properties

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

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

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

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

hs_object_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.

Contact(**data: Any) : HubSpot contact object

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

archived: bool | None : The type of the None singleton.

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

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

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

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

properties: airbyte_agent_sdk.connectors.hubspot.models.ContactProperties | None : The type of the None singleton.

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

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

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

ContactProperties(**data: Any) : Contact properties

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

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

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

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

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

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

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

model_config : The type of the None singleton.

ContactsApiSearchResultMeta(**data: Any) : Metadata for contacts.Action.API_SEARCH 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_cursor: str | None : The type of the None singleton.

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

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

ContactsList(**data: Any) : Paginated list of contacts

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.

paging: airbyte_agent_sdk.connectors.hubspot.models.Paging | None : The type of the None singleton.

results: list[airbyte_agent_sdk.connectors.hubspot.models.Contact] | None : The type of the None singleton.

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

ContactsListResultMeta(**data: Any) : Metadata for contacts.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_cursor: str | None : The type of the None singleton.

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

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

archived: bool | None : Boolean flag indicating whether the contact has been archived or deleted.

companies: list[typing.Any] | None : Associated company records linked to this contact.

created_at: str | None : Timestamp indicating when the contact was first created in the system.

id: str | None : Unique identifier for the contact record.

model_config : The type of the None singleton.

properties: dict[str, typing.Any] : Key-value object storing all contact properties and their values.

updated_at: str | None : Timestamp indicating when the contact record was last modified.

Deal(**data: Any) : HubSpot deal object

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

archived: bool | None : The type of the None singleton.

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

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

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

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

properties: airbyte_agent_sdk.connectors.hubspot.models.DealProperties | None : The type of the None singleton.

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

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

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

DealProperties(**data: Any) : Deal properties

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

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

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

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

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

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

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

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

model_config : The type of the None singleton.

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

DealsApiSearchResultMeta(**data: Any) : Metadata for deals.Action.API_SEARCH 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_cursor: str | None : The type of the None singleton.

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

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

DealsList(**data: Any) : Paginated list of deals

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.

paging: airbyte_agent_sdk.connectors.hubspot.models.Paging | None : The type of the None singleton.

results: list[airbyte_agent_sdk.connectors.hubspot.models.Deal] | None : The type of the None singleton.

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

DealsListResultMeta(**data: Any) : Metadata for deals.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_cursor: str | None : The type of the None singleton.

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

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

archived: bool | None : Indicates whether the deal has been deleted and moved to the recycling bin

companies: list[typing.Any] | None : Collection of company records associated with the deal

contacts: list[typing.Any] | None : Collection of contact records associated with the deal

created_at: str | None : Timestamp when the deal record was originally created

id: str | None : Unique identifier for the deal record

line_items: list[typing.Any] | None : Collection of product line items associated with the deal

model_config : The type of the None singleton.

properties: dict[str, typing.Any] : Key-value object containing all deal properties and custom fields

updated_at: str | None : Timestamp when the deal record was last modified

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

HubspotExecuteResult(**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult[list[Schema]]

Class variables

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

model_config : The type of the None singleton.

HubspotExecuteResultWithMeta(**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.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Descendants

  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResultWithMeta[list[CRMObject], ObjectsListResultMeta]
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResultWithMeta[list[Company], CompaniesApiSearchResultMeta]
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResultWithMeta[list[Company], CompaniesListResultMeta]
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResultWithMeta[list[Contact], ContactsApiSearchResultMeta]
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResultWithMeta[list[Contact], ContactsListResultMeta]
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResultWithMeta[list[Deal], DealsApiSearchResultMeta]
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResultWithMeta[list[Deal], DealsListResultMeta]
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResultWithMeta[list[Ticket], TicketsApiSearchResultMeta]
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResultWithMeta[list[Ticket], TicketsListResultMeta]

Class variables

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

HubspotExecuteResultWithMeta[list[CRMObject], ObjectsListResultMeta](**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

ObjectsListResult(**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

HubspotExecuteResultWithMeta[list[Company], CompaniesApiSearchResultMeta](**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

CompaniesApiSearchResult(**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

HubspotExecuteResultWithMeta[list[Company], CompaniesListResultMeta](**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

CompaniesListResult(**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

HubspotExecuteResultWithMeta[list[Contact], ContactsApiSearchResultMeta](**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

ContactsApiSearchResult(**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

HubspotExecuteResultWithMeta[list[Contact], ContactsListResultMeta](**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

ContactsListResult(**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

HubspotExecuteResultWithMeta[list[Deal], DealsApiSearchResultMeta](**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

DealsApiSearchResult(**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

HubspotExecuteResultWithMeta[list[Deal], DealsListResultMeta](**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

DealsListResult(**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

HubspotExecuteResultWithMeta[list[Ticket], TicketsApiSearchResultMeta](**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

TicketsApiSearchResult(**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

HubspotExecuteResultWithMeta[list[Ticket], TicketsListResultMeta](**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

TicketsListResult(**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.hubspot.models.HubspotExecuteResultWithMeta
  • airbyte_agent_sdk.connectors.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

HubspotExecuteResult[list[Schema]](**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.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

Class variables

model_config : The type of the None singleton.

SchemasListResult(**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.hubspot.models.HubspotExecuteResult
  • pydantic.main.BaseModel
  • typing.Generic

HubspotOAuthCredentials(**data: Any) : HubSpot OAuth App Credentials - Provide your own HubSpot OAuth app credentials to override the default Airbyte-managed ones.

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

client_id: str : Your HubSpot OAuth app's client ID

client_secret: str : Your HubSpot OAuth app's client secret

model_config : The type of the None singleton.

HubspotOauth2AuthConfig(**data: Any) : OAuth2

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 HubSpot OAuth2 Access Token (optional if refresh_token is provided)

client_id: str | None : Your HubSpot OAuth2 Client ID

client_secret: str | None : Your HubSpot OAuth2 Client Secret

model_config : The type of the None singleton.

refresh_token: str : Your HubSpot OAuth2 Refresh Token

HubspotPrivateAppAuthConfig(**data: Any) : Private App

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.

private_app_token: str : Access token from a HubSpot Private App

ObjectsList(**data: Any) : Paginated list of generic CRM objects

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.

paging: airbyte_agent_sdk.connectors.hubspot.models.Paging | None : The type of the None singleton.

results: list[airbyte_agent_sdk.connectors.hubspot.models.CRMObject] | None : The type of the None singleton.

ObjectsListResultMeta(**data: Any) : Metadata for objects.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_cursor: str | None : The type of the None singleton.

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

Paging(**data: Any) : Pagination 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

model_config : The type of the None singleton.

next: airbyte_agent_sdk.connectors.hubspot.models.PagingNext | None : The type of the None singleton.

PagingNext(**data: Any) : Nested schema for Paging.next

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

after: str | None : Cursor for next page

link: str | None : URL for next page

model_config : The type of the None singleton.

Schema(**data: Any) : Custom object schema definition

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

allows_sensitive_properties: bool | None : The type of the None singleton.

archived: bool | None : The type of the None singleton.

associations: list[airbyte_agent_sdk.connectors.hubspot.models.SchemaAssociationsItem] | None : The type of the None singleton.

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

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

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

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

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

labels: airbyte_agent_sdk.connectors.hubspot.models.SchemaLabels | None : The type of the None singleton.

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

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

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

properties: list[airbyte_agent_sdk.connectors.hubspot.models.SchemaPropertiesItem] | None : The type of the None singleton.

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

restorable: bool | None : The type of the None singleton.

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

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

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

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

SchemaAssociationsItem(**data: Any) : Nested schema for Schema.associations_item

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

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

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

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

has_user_enforced_max_from_object_ids: bool | None : The type of the None singleton.

has_user_enforced_max_to_object_ids: bool | None : The type of the None singleton.

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

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

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

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

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

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

SchemaLabels(**data: Any) : Display 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

model_config : The type of the None singleton.

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

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

SchemaPropertiesItem(**data: Any) : Nested schema for Schema.properties_item

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

archived: bool | None : The type of the None singleton.

calculated: bool | None : The type of the None singleton.

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

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

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

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

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

external_options: bool | None : The type of the None singleton.

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

form_field: bool | None : The type of the None singleton.

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

has_unique_value: bool | None : The type of the None singleton.

hidden: bool | None : The type of the None singleton.

hubspot_defined: bool | None : The type of the None singleton.

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

model_config : The type of the None singleton.

modification_metadata: airbyte_agent_sdk.connectors.hubspot.models.SchemaPropertiesItemModificationmetadata | None : The type of the None singleton.

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

options: list[typing.Any] | None : The type of the None singleton.

show_currency_symbol: bool | None : The type of the None singleton.

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

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

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

SchemaPropertiesItemModificationmetadata(**data: Any) : Nested schema for SchemaPropertiesItem.modificationMetadata

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

archivable: bool | None : The type of the None singleton.

model_config : The type of the None singleton.

read_only_definition: bool | None : The type of the None singleton.

read_only_options: bool | None : The type of the None singleton.

read_only_value: bool | None : The type of the None singleton.

SchemasList(**data: Any) : List of custom object schemas

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.

results: list[airbyte_agent_sdk.connectors.hubspot.models.Schema] | None : The type of the None singleton.

Ticket(**data: Any) : HubSpot ticket object

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

archived: bool | None : The type of the None singleton.

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

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

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

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

properties: airbyte_agent_sdk.connectors.hubspot.models.TicketProperties | None : The type of the None singleton.

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

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

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

TicketProperties(**data: Any) : Ticket properties

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

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

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

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

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

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

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

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

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

model_config : The type of the None singleton.

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

TicketsApiSearchResultMeta(**data: Any) : Metadata for tickets.Action.API_SEARCH 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_cursor: str | None : The type of the None singleton.

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

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

TicketsList(**data: Any) : Paginated list of tickets

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.

paging: airbyte_agent_sdk.connectors.hubspot.models.Paging | None : The type of the None singleton.

results: list[airbyte_agent_sdk.connectors.hubspot.models.Ticket] | None : The type of the None singleton.

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

TicketsListResultMeta(**data: Any) : Metadata for tickets.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_cursor: str | None : The type of the None singleton.

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

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

archived: bool | None : Indicates whether the ticket has been deleted and moved to the recycling bin

companies: list[typing.Any] | None : Collection of company records associated with the ticket

contacts: list[typing.Any] | None : Collection of contact records associated with the ticket

created_at: str | None : Timestamp when the ticket record was originally created

id: str | None : Unique identifier for the ticket record

model_config : The type of the None singleton.

properties: dict[str, typing.Any] : Key-value object containing all ticket properties and custom fields

updated_at: str | None : Timestamp when the ticket record was last modified

Was this page helpful?