emailengine-client
Version:
A TypeScript client for the EmailEngine API
72 lines (71 loc) • 1.88 kB
TypeScript
import { Options } from "../../../../misc/Options";
/**
* Registers a new OAuth2 application for a specific provider
*/
export declare class RegisterOAuth2AppOptions extends Options {
/**
* Override the EENGINE_TIMEOUT environment variable for a single API request (in milliseconds)
*/
'x-ee-timeout'?: number | undefined;
/**
* Register OAuth2 application Details
*/
'body': {
/**
* Application name
*/
'name': string;
/**
* Application description
*/
'description'?: string;
/**
* Title for the application button
*/
'title'?: string;
/**
* OAuth2 provider enum: [ gmail, gmailService, outlook, mailRu ]
*/
'provider': string;
/**
* Enable this app
*/
'enabled'?: boolean | undefined;
/**
* Client or Application ID for 3-legged OAuth2 applications
*/
'clientId'?: string;
/**
* Client secret for 3-legged OAuth2 applications
*/
'clientSecret'?: string;
/**
* OAuth2 Base Scopes
*/
'baseScopes'?: string;
/**
* extraScopes
*/
'extraScopes'?: string[];
/**
* skipScopes
*/
'skipScopes'?: string[];
/**
* Service client ID for 2-legged OAuth2 applications
*/
'serviceClient': string;
/**
* PEM formatted service secret for 2-legged OAuth2 applications
*/
'serviceKey': string;
/**
* Authorization tenant value for Outlook OAuth2 applications
*/
'authority': string;
/**
* Redirect URL for 3-legged OAuth2 applications
*/
'redirectUrl'?: string | undefined;
};
}