-
Notifications
You must be signed in to change notification settings - Fork 118
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add SDK documentation for models and top-level files (#478)
This PR adds documentation for the models and top-level files, completing the SDK reference.
- Loading branch information
1 parent
348b959
commit 61cc69e
Showing
29 changed files
with
1,283 additions
and
153 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
node_modules | ||
lib | ||
example | ||
example | ||
docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
node_modules | ||
lib | ||
example | ||
example | ||
docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,95 @@ | ||
import { RedirectUri } from './redirectUri'; | ||
|
||
/** | ||
* Interface for a Nylas application details object | ||
*/ | ||
export interface ApplicationDetails { | ||
/** | ||
* Public Application ID | ||
*/ | ||
applicationId: string; | ||
/** | ||
* ID of organization | ||
*/ | ||
organizationId: string; | ||
/** | ||
* Region identifier | ||
*/ | ||
region: 'us' | 'eu'; | ||
/** | ||
* Environment identifier | ||
*/ | ||
environment: 'production' | 'staging'; | ||
/** | ||
* Branding details for the application | ||
*/ | ||
branding: Branding; | ||
/** | ||
* Hosted authentication branding details | ||
*/ | ||
hostedAuthentication?: HostedAuthentication; | ||
/** | ||
* List of redirect URIs | ||
*/ | ||
redirectUris?: RedirectUri[]; | ||
} | ||
|
||
/** | ||
* Interface for branding details for the application | ||
*/ | ||
interface Branding { | ||
/** | ||
* Name of the application | ||
*/ | ||
name: string; | ||
/** | ||
* URL points to application icon | ||
*/ | ||
iconUrl?: string; | ||
/** | ||
* Application / publisher website URL | ||
*/ | ||
websiteUrl?: string; | ||
/** | ||
* Description of the appli∏cati∏on | ||
*/ | ||
description?: string; | ||
} | ||
|
||
/** | ||
* Interface for hosted authentication branding details | ||
*/ | ||
interface HostedAuthentication { | ||
/** | ||
* URL of the background image | ||
*/ | ||
backgroundImageUrl?: string; | ||
/** | ||
* Alignment of background image | ||
*/ | ||
alignment?: string; | ||
/** | ||
* Primary color | ||
*/ | ||
colorPrimary?: string; | ||
/** | ||
* Secondary color | ||
*/ | ||
colorSecondary?: string; | ||
/** | ||
* Title | ||
*/ | ||
title?: string; | ||
/** | ||
* Subtitle | ||
*/ | ||
subtitle?: string; | ||
/** | ||
* Background color | ||
*/ | ||
backgroundColor?: string; | ||
/** | ||
* CSS spacing attribute in px | ||
*/ | ||
spacing?: number; | ||
} |
Oops, something went wrong.