ggvlib.hubspot.schemas

Attributes

`PROPERTY_ARRAY_SCHEMA`
`CRM_FILTER_ARRAY_SCHEMA`

Classes

Contact

A schema for updating contacts in the Hubspot API. You can provide either an email or vid

Module Contents

ggvlib.hubspot.schemas.PROPERTY_ARRAY_SCHEMA

ggvlib.hubspot.schemas.CRM_FILTER_ARRAY_SCHEMA

class ggvlib.hubspot.schemas.Contact

Bases: pydantic.BaseModel

A schema for updating contacts in the Hubspot API. You can provide either an email or vid along with a list of properties

Parameters:

vid (str) – The vid of the contact
email (str) – The email of the contact

Raises:

ValueError – Invalid values

>>> contact = Contact(
...     email="a.person@gogox.com",
...     properties=[
...         {"property": "include_in_call_list", "value": False},
...     ],
... )
>>> another_contact = Contact(
...     vid=123,
...     properties=[
...         {"property": "include_in_call_list", "value": False},
...     ],
... )

vid: str | None = None

email: str | None = None

properties: List[Dict[str, bool | str | int]]

check_email_or_vid(email, values)

check_properties(properties)