Skip to content

redirect_uri

CreateRedirectUriRequest

Bases: TypedDict

Class representing a request to create a redirect uri.

Attributes:

Name Type Description
url str

Redirect URL.
platform str

Platform identifier.
settings NotRequired[WritableRedirectUriSettings]

Optional settings for the redirect uri.
Source code in nylas/models/redirect_uri.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
class CreateRedirectUriRequest(TypedDict):
    """
    Class representing a request to create a redirect uri.

    Attributes:
        url: Redirect URL.
        platform: Platform identifier.
        settings: Optional settings for the redirect uri.
    """

    url: str
    platform: str
    settings: NotRequired[WritableRedirectUriSettings]

RedirectUri dataclass

Class representing a Redirect URI object.

Attributes:

Name Type Description
id str

Globally unique object identifier.
url str

Redirect URL.
platform str

Platform identifier.
settings Optional[RedirectUriSettings]

Configuration settings.
Source code in nylas/models/redirect_uri.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
@dataclass_json
@dataclass
class RedirectUri:
    """
    Class representing a Redirect URI object.

    Attributes:
        id: Globally unique object identifier.
        url: Redirect URL.
        platform: Platform identifier.
        settings: Configuration settings.
    """
    id: str
    url: str
    platform: str
    settings: Optional[RedirectUriSettings] = None

RedirectUriSettings dataclass

Configuration settings for a Redirect URI object.

Attributes:

Name Type Description
origin Optional[str]

Related to JS platform.
bundle_id Optional[str]

Related to iOS platform.
app_store_id Optional[str]

Related to iOS platform.
team_id Optional[str]

Related to iOS platform.
package_name Optional[str]

Related to Android platform.
sha1_certificate_fingerprint Optional[str]

Related to Android platform.
Source code in nylas/models/redirect_uri.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
@dataclass_json
@dataclass
class RedirectUriSettings:
    """
    Configuration settings for a Redirect URI object.

    Attributes:
        origin: Related to JS platform.
        bundle_id: Related to iOS platform.
        app_store_id: Related to iOS platform.
        team_id: Related to iOS platform.
        package_name: Related to Android platform.
        sha1_certificate_fingerprint: Related to Android platform.
    """

    origin: Optional[str] = None
    bundle_id: Optional[str] = None
    app_store_id: Optional[str] = None
    team_id: Optional[str] = None
    package_name: Optional[str] = None
    sha1_certificate_fingerprint: Optional[str] = None

UpdateRedirectUriRequest

Bases: TypedDict

Class representing a request to update a redirect uri.

Attributes:

Name Type Description
url NotRequired[str]

Redirect URL.
platform NotRequired[str]

Platform identifier.
settings NotRequired[WritableRedirectUriSettings]

Optional settings for the redirect uri.
Source code in nylas/models/redirect_uri.py 
85
86
87
88
89
90
91
92
93
94
95
96
97
class UpdateRedirectUriRequest(TypedDict):
    """
    Class representing a request to update a redirect uri.

    Attributes:
        url: Redirect URL.
        platform: Platform identifier.
        settings: Optional settings for the redirect uri.
    """

    url: NotRequired[str]
    platform: NotRequired[str]
    settings: NotRequired[WritableRedirectUriSettings]

WritableRedirectUriSettings

Bases: TypedDict

Class representing redirect uri settings to be provided for a create/update call.

Attributes:

Name Type Description
origin NotRequired[str]

Optional origin for the redirect uri.
bundle_id NotRequired[str]

Optional bundle id for the redirect uri.
app_store_id NotRequired[str]

Optional app store id for the redirect uri.
team_id NotRequired[str]

Optional team id for the redirect uri.
package_name NotRequired[str]

Optional package name for the redirect uri.
sha1_certificate_fingerprint NotRequired[str]

Optional sha1 certificate fingerprint for the redirect uri.
Source code in nylas/models/redirect_uri.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
class WritableRedirectUriSettings(TypedDict):
    """
    Class representing redirect uri settings to be provided for a create/update call.

    Attributes:
        origin: Optional origin for the redirect uri.
        bundle_id: Optional bundle id for the redirect uri.
        app_store_id: Optional app store id for the redirect uri.
        team_id: Optional team id for the redirect uri.
        package_name: Optional package name for the redirect uri.
        sha1_certificate_fingerprint: Optional sha1 certificate fingerprint for the redirect uri.
    """

    origin: NotRequired[str]
    bundle_id: NotRequired[str]
    app_store_id: NotRequired[str]
    team_id: NotRequired[str]
    package_name: NotRequired[str]
    sha1_certificate_fingerprint: NotRequired[str]