nylas/lib/types/config.d.ts

A NodeJS wrapper for the Nylas REST API for email, contacts, and calendar.

/**
 * Configuration options for initializing the Nylas SDK.
 * @property apiKey The Nylas API key to use for authentication
 * @property apiUri The URL to use for communicating with the Nylas API
 * @property timeout The timeout for requests to the Nylas API, in seconds
 * @property headers Additional headers to send with outgoing requests
 */
export type NylasConfig = {
    apiKey: string;
    apiUri?: string;
    timeout?: number;
    headers?: Record<string, string>;
};
/**
 * The options that can override the default Nylas API client configuration.
 */
export type OverridableNylasConfig = {
    apiKey?: string;
    apiUri?: string;
    /**
     * @deprecated Providing timeout in milliseconds is deprecated and will be removed in the next major release. Please use seconds instead.
     */
    timeout?: number;
    headers?: Record<string, string>;
};
/**
 * An object that can be used to override the default Nylas API client configuration on a per-request basis.
 * @property overrides Overrides to the default Nylas API client configuration
 */
export interface Overrides {
    overrides?: OverridableNylasConfig;
}
/**
 * Enum representing the available Nylas API regions.
 */
export declare enum Region {
    Us = "us",
    Eu = "eu"
}
/**
 * The default Nylas API region.
 * @default Region.Us
 */
export declare const DEFAULT_REGION = Region.Us;
/**
 * The configuration options for each Nylas API region.
 */
type RegionConfig = {
    nylasAPIUrl: string;
};
/**
 * The available preset configuration values for each Nylas API region.
 */
export declare const REGION_CONFIG: Record<Region, RegionConfig>;
/**
 * The default Nylas API URL.
 * @default https://api.us.nylas.com
 */
export declare const DEFAULT_SERVER_URL: string;
export {};