contacts

`ListContactGroupsQueryParams = ListQueryParams` `module-attribute`

The available query parameters for listing contact groups.

`UpdateContactRequest = CreateContactRequest` `module-attribute`

Interface for updating a Nylas contact.

`Contact` `dataclass`

Class representation of a Nylas contact object.

Attributes:

Name	Type	Description
`id`	`str`	Globally unique object identifier.
`grant_id`	`str`	Grant ID representing the user's account.
`object`	`str`	The type of object.
`birthday`	`Optional[str]`	The contact's birthday.
`company_name`	`Optional[str]`	The contact's company name.
`display_name`	`Optional[str]`	The contact's display name.
`emails`	`Optional[List[ContactEmail]]`	The contact's email addresses.
`im_addresses`	`Optional[List[InstantMessagingAddress]]`	The contact's instant messaging addresses.
`given_name`	`Optional[str]`	The contact's given name.
`job_title`	`Optional[str]`	The contact's job title.
`manager_name`	`Optional[str]`	The contact's manager name.
`metadata`	`Optional[Dict[str, str]]`	Nylas-owned metadata associated with the contact. Metadata is not written to the provider and does not follow a contact if its public ID changes.
`middle_name`	`Optional[str]`	The contact's middle name.
`nickname`	`Optional[str]`	The contact's nickname.
`notes`	`Optional[str]`	The contact's notes.
`office_location`	`Optional[str]`	The contact's office location.
`picture_url`	`Optional[str]`	The contact's picture URL.
`picture`	`Optional[str]`	The contact's picture.
`suffix`	`Optional[str]`	The contact's suffix.
`surname`	`Optional[str]`	The contact's surname.
`source`	`Optional[SourceType]`	The contact's source.
`phone_numbers`	`Optional[List[PhoneNumber]]`	The contact's phone numbers.
`physical_addresses`	`Optional[List[PhysicalAddress]]`	The contact's physical addresses.
`web_pages`	`Optional[List[WebPage]]`	The contact's web pages.
`groups`	`Optional[List[ContactGroupId]]`	The contact's groups.

Source code in nylas/models/contacts.py

@dataclass_json
@dataclass
class Contact:
    """
    Class representation of a Nylas contact object.

    Attributes:
        id: Globally unique object identifier.
        grant_id: Grant ID representing the user's account.
        object: The type of object.
        birthday: The contact's birthday.
        company_name: The contact's company name.
        display_name: The contact's display name.
        emails: The contact's email addresses.
        im_addresses: The contact's instant messaging addresses.
        given_name: The contact's given name.
        job_title: The contact's job title.
        manager_name: The contact's manager name.
        metadata: Nylas-owned metadata associated with the contact. Metadata is
            not written to the provider and does not follow a contact if its
            public ID changes.
        middle_name: The contact's middle name.
        nickname: The contact's nickname.
        notes: The contact's notes.
        office_location: The contact's office location.
        picture_url: The contact's picture URL.
        picture: The contact's picture.
        suffix: The contact's suffix.
        surname: The contact's surname.
        source: The contact's source.
        phone_numbers: The contact's phone numbers.
        physical_addresses: The contact's physical addresses.
        web_pages: The contact's web pages.
        groups: The contact's groups.
    """

    id: str
    grant_id: str
    object: str = "contact"
    birthday: Optional[str] = None
    company_name: Optional[str] = None
    display_name: Optional[str] = None
    emails: Optional[List[ContactEmail]] = None
    im_addresses: Optional[List[InstantMessagingAddress]] = None
    given_name: Optional[str] = None
    job_title: Optional[str] = None
    manager_name: Optional[str] = None
    metadata: Optional[Dict[str, str]] = None
    middle_name: Optional[str] = None
    nickname: Optional[str] = None
    notes: Optional[str] = None
    office_location: Optional[str] = None
    picture_url: Optional[str] = None
    picture: Optional[str] = None
    suffix: Optional[str] = None
    surname: Optional[str] = None
    source: Optional[SourceType] = None
    phone_numbers: Optional[List[PhoneNumber]] = None
    physical_addresses: Optional[List[PhysicalAddress]] = None
    web_pages: Optional[List[WebPage]] = None
    groups: Optional[List[ContactGroupId]] = None

`ContactEmail` `dataclass`

An email address for a contact.

Attributes:

Name	Type	Description
`email`	`Optional[str]`	The email address.
`type`	`Optional[str]`	The type of email address.

Source code in nylas/models/contacts.py

@dataclass_json
@dataclass
class ContactEmail:
    """
    An email address for a contact.

    Attributes:
        email: The email address.
        type: The type of email address.
    """

    email: Optional[str] = None
    type: Optional[str] = None

`ContactGroup` `dataclass`

Class representation of a Nylas contact group object.

Attributes:

Name	Type	Description
`id`	`str`	Globally unique object identifier.
`grant_id`	`str`	Grant ID representing the user's account.
`object`	`str`	The type of object.
`group_type`	`Optional[GroupType]`	The type of contact group.
`name`	`Optional[str]`	The name of the contact group.
`path`	`Optional[str]`	The path of the contact group.

Source code in nylas/models/contacts.py

@dataclass_json
@dataclass
class ContactGroup:
    """
    Class representation of a Nylas contact group object.

    Attributes:
        id: Globally unique object identifier.
        grant_id: Grant ID representing the user's account.
        object: The type of object.
        group_type: The type of contact group.
        name: The name of the contact group.
        path: The path of the contact group.
    """

    id: str
    grant_id: str
    object: str = "contact_group"
    group_type: Optional[GroupType] = None
    name: Optional[str] = None
    path: Optional[str] = None

`ContactGroupId` `dataclass`

A contact group ID for a contact.

Attributes:

Name	Type	Description
`id`	`str`	The contact group ID.

Source code in nylas/models/contacts.py

@dataclass_json
@dataclass
class ContactGroupId:
    """
    A contact group ID for a contact.

    Attributes:
        id: The contact group ID.
    """

    id: str

`CreateContactRequest`

Bases: TypedDict

Interface for creating a Nylas contact.

Attributes:

Name	Type	Description
`birthday`	`NotRequired[str]`	The contact's birthday.
`company_name`	`NotRequired[str]`	The contact's company name.
`display_name`	`NotRequired[str]`	The contact's display name.
`emails`	`NotRequired[List[WriteableContactEmail]]`	The contact's email addresses.
`im_addresses`	`NotRequired[List[WriteableInstantMessagingAddress]]`	The contact's instant messaging addresses.
`given_name`	`NotRequired[str]`	The contact's given name.
`job_title`	`NotRequired[str]`	The contact's job title.
`manager_name`	`NotRequired[str]`	The contact's manager name.
`metadata`	`NotRequired[Optional[Dict[str, str]]]`	Nylas-owned metadata for the contact. On update, omission or None preserves existing metadata, an object replaces it, and an empty object clears it.
`middle_name`	`NotRequired[str]`	The contact's middle name.
`nickname`	`NotRequired[str]`	The contact's nickname.
`notes`	`NotRequired[str]`	The contact's notes.
`office_location`	`NotRequired[str]`	The contact's office location.
`picture_url`	`NotRequired[str]`	The contact's picture URL.
`picture`	`NotRequired[str]`	The contact's picture.
`suffix`	`NotRequired[str]`	The contact's suffix.
`surname`	`NotRequired[str]`	The contact's surname.
`source`	`NotRequired[SourceType]`	The contact's source.
`phone_numbers`	`NotRequired[List[WriteablePhoneNumber]]`	The contact's phone numbers.
`physical_addresses`	`NotRequired[List[WriteablePhysicalAddress]]`	The contact's physical addresses.
`web_pages`	`NotRequired[List[WriteableWebPage]]`	The contact's web pages.
`groups`	`NotRequired[List[WriteableContactGroupId]]`	The contact's groups.

Source code in nylas/models/contacts.py

class CreateContactRequest(TypedDict):
    """
    Interface for creating a Nylas contact.

    Attributes:
        birthday: The contact's birthday.
        company_name: The contact's company name.
        display_name: The contact's display name.
        emails: The contact's email addresses.
        im_addresses: The contact's instant messaging addresses.
        given_name: The contact's given name.
        job_title: The contact's job title.
        manager_name: The contact's manager name.
        metadata: Nylas-owned metadata for the contact. On update, omission or
            None preserves existing metadata, an object replaces it, and an
            empty object clears it.
        middle_name: The contact's middle name.
        nickname: The contact's nickname.
        notes: The contact's notes.
        office_location: The contact's office location.
        picture_url: The contact's picture URL.
        picture: The contact's picture.
        suffix: The contact's suffix.
        surname: The contact's surname.
        source: The contact's source.
        phone_numbers: The contact's phone numbers.
        physical_addresses: The contact's physical addresses.
        web_pages: The contact's web pages.
        groups: The contact's groups.
    """

    birthday: NotRequired[str]
    company_name: NotRequired[str]
    display_name: NotRequired[str]
    emails: NotRequired[List[WriteableContactEmail]]
    im_addresses: NotRequired[List[WriteableInstantMessagingAddress]]
    given_name: NotRequired[str]
    job_title: NotRequired[str]
    manager_name: NotRequired[str]
    metadata: NotRequired[Optional[Dict[str, str]]]
    middle_name: NotRequired[str]
    nickname: NotRequired[str]
    notes: NotRequired[str]
    office_location: NotRequired[str]
    picture_url: NotRequired[str]
    picture: NotRequired[str]
    suffix: NotRequired[str]
    surname: NotRequired[str]
    source: NotRequired[SourceType]
    phone_numbers: NotRequired[List[WriteablePhoneNumber]]
    physical_addresses: NotRequired[List[WriteablePhysicalAddress]]
    web_pages: NotRequired[List[WriteableWebPage]]
    groups: NotRequired[List[WriteableContactGroupId]]

`FindContactQueryParams`

Bases: TypedDict

The available query parameters for finding a contact. Attributes: profile_picture: If true and picture_url is present, the response includes a Base64 binary data blob that you can use to view information as an image file. select: Comma-separated list of fields to return in the response. This allows you to receive only the portion of object data that you're interested in.

Source code in nylas/models/contacts.py

class FindContactQueryParams(TypedDict):
    """
    The available query parameters for finding a contact.
    Attributes:
        profile_picture: If true and picture_url is present, the response includes a Base64 binary data blob that
            you can use to view information as an image file.
        select: Comma-separated list of fields to return in the response.
            This allows you to receive only the portion of object data that you're interested in.
    """

    profile_picture: NotRequired[bool]
    select: NotRequired[str]

`GroupType`

Bases: str, Enum

Enum representing the different types of contact groups.

Source code in nylas/models/contacts.py

class GroupType(str, Enum):
    """Enum representing the different types of contact groups."""

    USER = "user"
    SYSTEM = "system"
    OTHER = "other"

`InstantMessagingAddress` `dataclass`

An instant messaging address for a contact.

Attributes:

Name	Type	Description
`im_address`	`Optional[str]`	The instant messaging address.
`type`	`Optional[str]`	The type of instant messaging address.

Source code in nylas/models/contacts.py

@dataclass_json
@dataclass
class InstantMessagingAddress:
    """
    An instant messaging address for a contact.

    Attributes:
        im_address: The instant messaging address.
        type: The type of instant messaging address.
    """

    im_address: Optional[str] = None
    type: Optional[str] = None

`ListContactsQueryParams`

Bases: ListQueryParams

Interface representing the query parameters for listing contacts.

Attributes:

Name	Type	Description
`email`	`NotRequired[str]`	Return contacts with matching email address.
`phone_number`	`NotRequired[str]`	Return contacts with matching phone number.
`source`	`NotRequired[SourceType]`	Return contacts from a specific source.
`group`	`NotRequired[str]`	Return contacts from a specific group.
`recurse`	`NotRequired[bool]`	Return contacts from all sub-groups of the specified group.
`metadata_pair`	`NotRequired[Dict[str, str]]`	Filter by one indexed metadata key/value pair. Use one of key1 through key5. This cannot be combined with provider-side contact filters; pagination parameters are supported.
`select`	`NotRequired[str]`	Comma-separated list of fields to return in the response. This allows you to receive only the portion of object data that you're interested in.
`limit`	`NotRequired[int]`	The maximum number of objects to return. This field defaults to 50. The maximum allowed value is 200.
`page_token`	`NotRequired[str]`	An identifier that specifies which page of data to return. This value should be taken from a ListResponse object's next_cursor parameter.

Source code in nylas/models/contacts.py

class ListContactsQueryParams(ListQueryParams):
    """
    Interface representing the query parameters for listing contacts.

    Attributes:
        email: Return contacts with matching email address.
        phone_number: Return contacts with matching phone number.
        source: Return contacts from a specific source.
        group: Return contacts from a specific group.
        recurse: Return contacts from all sub-groups of the specified group.
        metadata_pair: Filter by one indexed metadata key/value pair. Use one
            of key1 through key5. This cannot be combined with provider-side
            contact filters; pagination parameters are supported.
        select (NotRequired[str]): Comma-separated list of fields to return in the response.
            This allows you to receive only the portion of object data that you're interested in.
        limit (NotRequired[int]): The maximum number of objects to return.
            This field defaults to 50. The maximum allowed value is 200.
        page_token (NotRequired[str]): An identifier that specifies which page of data to return.
            This value should be taken from a ListResponse object's next_cursor parameter.
    """

    email: NotRequired[str]
    phone_number: NotRequired[str]
    source: NotRequired[SourceType]
    group: NotRequired[str]
    recurse: NotRequired[bool]
    metadata_pair: NotRequired[Dict[str, str]]

`PhoneNumber` `dataclass`

A phone number for a contact.

Attributes:

Name	Type	Description
`number`	`Optional[str]`	The phone number.
`type`	`Optional[str]`	The type of phone number.

Source code in nylas/models/contacts.py

@dataclass_json
@dataclass
class PhoneNumber:
    """
    A phone number for a contact.

    Attributes:
        number: The phone number.
        type: The type of phone number.
    """

    number: Optional[str] = None
    type: Optional[str] = None

`PhysicalAddress` `dataclass`

A physical address for a contact.

Attributes:

Name	Type	Description
`format`	`Optional[str]`	The format of the address.
`street_address`	`Optional[str]`	The street address of the contact.
`city`	`Optional[str]`	The city of the contact.
`postal_code`	`Optional[str]`	The postal code of the contact.
`state`	`Optional[str]`	The state of the contact.
`country`	`Optional[str]`	The country of the contact.
`type`	`Optional[str]`	The type of address.

Source code in nylas/models/contacts.py

@dataclass_json
@dataclass
class PhysicalAddress:
    """
    A physical address for a contact.

    Attributes:
        format: The format of the address.
        street_address: The street address of the contact.
        city: The city of the contact.
        postal_code: The postal code of the contact.
        state: The state of the contact.
        country: The country of the contact.
        type: The type of address.
    """

    format: Optional[str] = None
    street_address: Optional[str] = None
    city: Optional[str] = None
    postal_code: Optional[str] = None
    state: Optional[str] = None
    country: Optional[str] = None
    type: Optional[str] = None

`SourceType`

Bases: str, Enum

Enum representing the different types of sources for a contact.

Source code in nylas/models/contacts.py

class SourceType(str, Enum):
    """Enum representing the different types of sources for a contact."""

    ADDRESS_BOOK = "address_book"
    INBOX = "inbox"
    DOMAIN = "domain"

`WebPage` `dataclass`

A web page for a contact.

Attributes:

Name	Type	Description
`url`	`Optional[str]`	The URL of the web page.
`type`	`Optional[str]`	The type of web page.

Source code in nylas/models/contacts.py

@dataclass_json
@dataclass
class WebPage:
    """
    A web page for a contact.

    Attributes:
        url: The URL of the web page.
        type: The type of web page.
    """

    url: Optional[str] = None
    type: Optional[str] = None

`WriteableContactEmail`

Bases: TypedDict

An email address for a contact.

Attributes:

Name	Type	Description
`email`	`NotRequired[str]`	The email address.
`type`	`NotRequired[str]`	The type of email address.

Source code in nylas/models/contacts.py

class WriteableContactEmail(TypedDict):
    """
    An email address for a contact.

    Attributes:
        email: The email address.
        type: The type of email address.
    """

    email: NotRequired[str]
    type: NotRequired[str]

`WriteableContactGroupId`

Bases: TypedDict

A contact group ID for a contact.

Attributes:

Name	Type	Description
`id`	`str`	The contact group ID.

Source code in nylas/models/contacts.py

class WriteableContactGroupId(TypedDict):
    """
    A contact group ID for a contact.

    Attributes:
        id: The contact group ID.
    """

    id: str

`WriteableInstantMessagingAddress`

Bases: TypedDict

An instant messaging address for a contact.

Attributes:

Name	Type	Description
`im_address`	`NotRequired[str]`	The instant messaging address.
`type`	`NotRequired[str]`	The type of instant messaging address.

Source code in nylas/models/contacts.py

class WriteableInstantMessagingAddress(TypedDict):
    """
    An instant messaging address for a contact.

    Attributes:
        im_address: The instant messaging address.
        type: The type of instant messaging address.
    """

    im_address: NotRequired[str]
    type: NotRequired[str]

`WriteablePhoneNumber`

Bases: TypedDict

A phone number for a contact.

Attributes:

Name	Type	Description
`number`	`NotRequired[str]`	The phone number.
`type`	`NotRequired[str]`	The type of phone number.

Source code in nylas/models/contacts.py

class WriteablePhoneNumber(TypedDict):
    """
    A phone number for a contact.

    Attributes:
        number: The phone number.
        type: The type of phone number.
    """

    number: NotRequired[str]
    type: NotRequired[str]

`WriteablePhysicalAddress`

Bases: TypedDict

A physical address for a contact.

Attributes:

Name	Type	Description
`format`	`NotRequired[str]`	The format of the address.
`street_address`	`NotRequired[str]`	The street address of the contact.
`city`	`NotRequired[str]`	The city of the contact.
`postal_code`	`NotRequired[str]`	The postal code of the contact.
`state`	`NotRequired[str]`	The state of the contact.
`country`	`NotRequired[str]`	The country of the contact.
`type`	`NotRequired[str]`	The type of address.

Source code in nylas/models/contacts.py

class WriteablePhysicalAddress(TypedDict):
    """
    A physical address for a contact.

    Attributes:
        format: The format of the address.
        street_address: The street address of the contact.
        city: The city of the contact.
        postal_code: The postal code of the contact.
        state: The state of the contact.
        country: The country of the contact.
        type: The type of address.
    """

    format: NotRequired[str]
    street_address: NotRequired[str]
    city: NotRequired[str]
    postal_code: NotRequired[str]
    state: NotRequired[str]
    country: NotRequired[str]
    type: NotRequired[str]

`WriteableWebPage`

Bases: TypedDict

A web page for a contact.

Attributes:

Name	Type	Description
`url`	`NotRequired[str]`	The URL of the web page.
`type`	`NotRequired[str]`	The type of web page.

Source code in nylas/models/contacts.py

class WriteableWebPage(TypedDict):
    """
    A web page for a contact.

    Attributes:
        url: The URL of the web page.
        type: The type of web page.
    """

    url: NotRequired[str]
    type: NotRequired[str]

contacts

ListContactGroupsQueryParams = ListQueryParams module-attribute

UpdateContactRequest = CreateContactRequest module-attribute

Contact dataclass

ContactEmail dataclass

ContactGroup dataclass

ContactGroupId dataclass

CreateContactRequest

FindContactQueryParams

GroupType

InstantMessagingAddress dataclass

ListContactsQueryParams

PhoneNumber dataclass

PhysicalAddress dataclass

SourceType

WebPage dataclass

WriteableContactEmail

WriteableContactGroupId

WriteableInstantMessagingAddress

WriteablePhoneNumber

WriteablePhysicalAddress

WriteableWebPage

`ListContactGroupsQueryParams = ListQueryParams` `module-attribute`

`UpdateContactRequest = CreateContactRequest` `module-attribute`

`Contact` `dataclass`

`ContactEmail` `dataclass`

`ContactGroup` `dataclass`

`ContactGroupId` `dataclass`

`CreateContactRequest`

`FindContactQueryParams`

`GroupType`

`InstantMessagingAddress` `dataclass`

`ListContactsQueryParams`

`PhoneNumber` `dataclass`

`PhysicalAddress` `dataclass`

`SourceType`

`WebPage` `dataclass`

`WriteableContactEmail`

`WriteableContactGroupId`

`WriteableInstantMessagingAddress`

`WriteablePhoneNumber`

`WriteablePhysicalAddress`

`WriteableWebPage`