Skip to content

application_details

Environment = Literal['production', 'staging'] module-attribute

Literal representing the different Nylas API environments.

Region = Literal['us', 'eu'] module-attribute

Literal representing the available Nylas API regions.

ApplicationDetails dataclass

Class representation of a Nylas application details object.

Attributes:

Name Type Description
application_id str

Public application ID.
organization_id str

ID representing the organization.
region Region

Region identifier.
environment Environment

Environment identifier.
branding Branding

Branding details for the application.
hosted_authentication Optional[HostedAuthentication]

Hosted authentication branding details.
callback_uris List[RedirectUri]

List of redirect URIs.
Source code in nylas/models/application_details.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
@dataclass_json
@dataclass
class ApplicationDetails:
    """
    Class representation of a Nylas application details object.

    Attributes:
        application_id: Public application ID.
        organization_id: ID representing the organization.
        region: Region identifier.
        environment: Environment identifier.
        branding: Branding details for the application.
        hosted_authentication: Hosted authentication branding details.
        callback_uris: List of redirect URIs.
    """

    application_id: str
    organization_id: str
    region: Region
    environment: Environment
    branding: Branding
    hosted_authentication: Optional[HostedAuthentication] = None
    callback_uris: List[RedirectUri] = field(default_factory=list)

Branding dataclass

Class representation of branding details for the application.

Attributes:

Name Type Description
name str

Name of the application.
icon_url Optional[str]

URL pointing to the application icon.
website_url Optional[str]

Application/publisher website URL.
description Optional[str]

Description of the application.
Source code in nylas/models/application_details.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
@dataclass_json
@dataclass
class Branding:
    """
    Class representation of branding details for the application.

    Attributes:
        name: Name of the application.
        icon_url: URL pointing to the application icon.
        website_url: Application/publisher website URL.
        description: Description of the application.
    """

    name: str
    icon_url: Optional[str] = None
    website_url: Optional[str] = None
    description: Optional[str] = None

HostedAuthentication dataclass

Class representation of hosted authentication branding details.

Attributes:

Name Type Description
background_image_url Optional[str]

URL pointing to the background image.
alignment Optional[str]

Alignment of the background image.
color_primary Optional[str]

Primary color of the hosted authentication page.
color_secondary Optional[str]

Secondary color of the hosted authentication page.
title Optional[str]

Title of the hosted authentication page.
subtitle Optional[str]

Subtitle for the hosted authentication page.
background_color Optional[str]

Background color of the hosted authentication page.
spacing Optional[int]

CSS spacing attribute in px.
Source code in nylas/models/application_details.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
@dataclass_json
@dataclass
class HostedAuthentication:
    """
    Class representation of hosted authentication branding details.

    Attributes:
        background_image_url: URL pointing to the background image.
        alignment: Alignment of the background image.
        color_primary: Primary color of the hosted authentication page.
        color_secondary: Secondary color of the hosted authentication page.
        title: Title of the hosted authentication page.
        subtitle: Subtitle for the hosted authentication page.
        background_color: Background color of the hosted authentication page.
        spacing: CSS spacing attribute in px.
    """

    background_image_url: Optional[str] = None
    alignment: Optional[str] = None
    color_primary: Optional[str] = None
    color_secondary: Optional[str] = None
    title: Optional[str] = None
    subtitle: Optional[str] = None
    background_color: Optional[str] = None
    spacing: Optional[int] = None