Skip to content

domains

CreateDomainRequest

Bases: TypedDict

Request body for registering a domain.

Source code in nylas/models/domains.py 
33
34
35
36
37
class CreateDomainRequest(TypedDict):
    """Request body for registering a domain."""

    name: str
    domain_address: str

Domain dataclass

A domain registered for Transactional Send or Nylas Inbound.

Source code in nylas/models/domains.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
@dataclass_json
@dataclass
class Domain:
    """
    A domain registered for Transactional Send or Nylas Inbound.
    """

    id: str
    name: str
    branded: bool
    domain_address: str
    organization_id: str
    region: str
    verified_ownership: bool
    verified_dkim: bool
    verified_spf: bool
    verified_mx: bool
    verified_feedback: bool
    verified_dmarc: bool
    verified_arc: bool
    created_at: int
    updated_at: int

DomainVerificationAttempt dataclass

DNS verification attempt or required records for a verification type.

Source code in nylas/models/domains.py 
84
85
86
87
88
89
90
91
92
93
94
95
96
97
@dataclass_json
@dataclass
class DomainVerificationAttempt:
    """
    DNS verification attempt or required records for a verification type.
    """

    verification_type: Optional[str] = field(
        default=None, metadata=config(field_name="type")
    )
    options: Optional[Any] = None
    host: Optional[str] = None
    value: Optional[str] = None
    status: Optional[str] = None

DomainVerificationDetails dataclass

Response data from get domain info or verify domain endpoints.

Source code in nylas/models/domains.py 
100
101
102
103
104
105
106
107
108
109
110
111
@dataclass_json
@dataclass
class DomainVerificationDetails:
    """
    Response data from get domain info or verify domain endpoints.
    """

    domain_id: str
    attempt: Optional[DomainVerificationAttempt] = None
    created_at: Optional[int] = None
    expires_at: Optional[int] = None
    message: Optional[str] = None

DomainVerificationOptions

Bases: TypedDict

Options for domain verification operations.

Source code in nylas/models/domains.py 
15
16
17
18
class DomainVerificationOptions(TypedDict, total=False):
    """Options for domain verification operations."""

    key_length: int

GetDomainInfoRequest

Bases: TypedDict

Request body for retrieving DNS records for a verification type.

Source code in nylas/models/domains.py 
46
47
48
49
50
class GetDomainInfoRequest(TypedDict):
    """Request body for retrieving DNS records for a verification type."""

    type: DomainVerificationRequestType
    options: NotRequired[DomainVerificationOptions]

ListDomainsQueryParams

Bases: ListQueryParams

Query parameters for listing domains.

Attributes:

Name Type Description
limit

Maximum number of objects to return.
page_token

Cursor for the next page (from next_cursor on the previous response).
Source code in nylas/models/domains.py 
21
22
23
24
25
26
27
28
29
30
class ListDomainsQueryParams(ListQueryParams):
    """
    Query parameters for listing domains.

    Attributes:
        limit: Maximum number of objects to return.
        page_token: Cursor for the next page (from ``next_cursor`` on the previous response).
    """

    pass

UpdateDomainRequest

Bases: TypedDict

Request body for updating a domain (currently only name is supported).

Source code in nylas/models/domains.py 
40
41
42
43
class UpdateDomainRequest(TypedDict, total=False):
    """Request body for updating a domain (currently only ``name`` is supported)."""

    name: str

VerifyDomainRequest

Bases: TypedDict

Request body for triggering DNS verification.

Source code in nylas/models/domains.py 
53
54
55
56
57
class VerifyDomainRequest(TypedDict):
    """Request body for triggering DNS verification."""

    type: DomainVerificationRequestType
    options: NotRequired[DomainVerificationOptions]