nylas 7.0.0-beta.0 → 7.0.0-beta.2

package/lib/esm/utils.js

@@ -0,0 +1,53 @@
+import { camelCase, snakeCase } from 'change-case';
+/**
+ * A utility function that recursively converts all keys in an object to a given case.
+ * @param obj The object to convert
+ * @param casingFunction The function to use to convert the keys
+ * @param excludeKeys An array of keys to exclude from conversion
+ * @returns The converted object
+ * @ignore Not for public use.
+ */
+function convertCase(obj, casingFunction, excludeKeys) {
+    const newObj = {};
+    for (const key in obj) {
+        if (excludeKeys?.includes(key)) {
+            newObj[key] = obj[key];
+        }
+        else if (Array.isArray(obj[key])) {
+            newObj[casingFunction(key)] = obj[key].map(item => {
+                if (typeof item === 'object') {
+                    return convertCase(item, casingFunction);
+                }
+                else {
+                    return item;
+                }
+            });
+        }
+        else if (typeof obj[key] === 'object' && obj[key] !== null) {
+            newObj[casingFunction(key)] = convertCase(obj[key], casingFunction);
+        }
+        else {
+            newObj[casingFunction(key)] = obj[key];
+        }
+    }
+    return newObj;
+}
+/**
+ * A utility function that recursively converts all keys in an object to camelCase.
+ * @param obj The object to convert
+ * @param exclude An array of keys to exclude from conversion
+ * @returns The converted object
+ * @ignore Not for public use.
+ */
+export function objKeysToCamelCase(obj, exclude) {
+    return convertCase(obj, camelCase, exclude);
+}
+/**
+ * A utility function that recursively converts all keys in an object to snake_case.
+ * @param obj The object to convert
+ * @param exclude An array of keys to exclude from conversion
+ * @returns The converted object
+ */
+export function objKeysToSnakeCase(obj, exclude) {
+    return convertCase(obj, snakeCase, exclude);
+}

package/lib/esm/version.js

@@ -0,0 +1,2 @@
+// This file is generated by scripts/exportVersion.js
+export const SDK_VERSION = '7.0.0-beta.2';

package/lib/types/apiClient.d.ts

@@ -0,0 +1,65 @@
+import { Request, Response } from 'node-fetch';
+import { NylasConfig, OverridableNylasConfig } from './config.js';
+/**
+ * Options for a request to the Nylas API
+ * @property path The path to the API endpoint
+ * @property method The HTTP method to use
+ * @property headers Additional headers to send with the request
+ * @property queryParams Query parameters to send with the request
+ * @property body The body of the request
+ * @property overrides Overrides to the default Nylas API client configuration
+ * @ignore Not for public use
+ */
+export interface RequestOptionsParams {
+    path: string;
+    method: string;
+    headers?: Record<string, string>;
+    queryParams?: Record<string, any>;
+    body?: any;
+    overrides?: OverridableNylasConfig;
+}
+/**
+ * Options for building a request for fetch to understand
+ * @property path The path to the API endpoint
+ * @property method The HTTP method to use
+ * @property headers Additional headers to send with the request
+ * @property url The URL of the request
+ * @property body The body of the request
+ * @property overrides Overrides to the default Nylas API client configuration
+ * @ignore Not for public use
+ */
+interface RequestOptions {
+    path: string;
+    method: string;
+    headers: Record<string, string>;
+    url: URL;
+    body?: string;
+    overrides?: Partial<NylasConfig>;
+}
+/**
+ * The API client for communicating with the Nylas API
+ * @ignore Not for public use
+ */
+export default class APIClient {
+    /**
+     * The API key to use for authentication
+     */
+    apiKey: string;
+    /**
+     * The URL to use for communicating with the Nylas API
+     */
+    serverUrl: string;
+    /**
+     * The timeout for requests to the Nylas API, in seconds
+     */
+    timeout: number;
+    constructor({ apiKey, apiUri, timeout }: Required<NylasConfig>);
+    private setRequestUrl;
+    private setQueryStrings;
+    private setRequestHeaders;
+    requestOptions(optionParams: RequestOptionsParams): RequestOptions;
+    newRequest(options: RequestOptionsParams): Request;
+    requestWithResponse<T>(response: Response): Promise<T>;
+    request<T>(options: RequestOptionsParams): Promise<T>;
+}
+export {};

package/lib/types/config.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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
+ */
+export type NylasConfig = {
+    apiKey: string;
+    apiUri?: string;
+    timeout?: number;
+};
+/**
+ * The options that can override the default Nylas API client configuration.
+ */
+export type OverridableNylasConfig = Partial<NylasConfig>;
+/**
+ * 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 {};

package/lib/types/models/applicationDetails.d.ts

@@ -0,0 +1,93 @@
+import { RedirectUri } from './redirectUri.js';
+/**
+ * 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;
+}
+export {};

package/lib/types/models/auth.d.ts

@@ -0,0 +1,196 @@
+/**
+ * Type for the access type of the authentication URL.
+ */
+type AccessType = 'online' | 'offline';
+/**
+ * Type for the different OAuth providers Nylas supports.
+ */
+export type Provider = 'google' | 'imap' | 'microsoft';
+/**
+ * Configuration for generating a URL for OAuth 2.0 authentication.
+ */
+export interface URLForAuthenticationConfig {
+    /**
+     * The client ID of your application.
+     */
+    clientId: string;
+    /**
+     * Redirect URI of the integration.
+     */
+    redirectUri: string;
+    /**
+     * The integration provider type that you already had set up with Nylas for this application.
+     * If not set, the user is directed to the Hosted Login screen and prompted to select a provider.
+     */
+    provider?: Provider;
+    /**
+     * If the exchange token should return a refresh token too. Not suitable for client side or JavaScript apps.
+     */
+    accessType?: AccessType;
+    /**
+     * The prompt parameter is used to force the consent screen to be displayed even if the user has already given consent to your application.
+     */
+    prompt?: string;
+    /**
+     * A space-delimited list of scopes that identify the resources that your application could access on the user's behalf.
+     * If no scope is given, all of the default integration's scopes are used.
+     */
+    scope?: string[];
+    /**
+     * If set to true, the scopes granted to the application will be included in the response.
+     */
+    includeGrantScopes?: boolean;
+    /**
+     * Optional state to be returned after authentication
+     */
+    state?: string;
+    /**
+     * Prefill the login name (usually email) during authorization flow.
+     * If a Grant for the provided email already exists, a Grant's re-auth will automatically be initiated.
+     */
+    loginHint?: string;
+}
+/**
+ * Configuration for generating a URL for admin consent authentication for Microsoft.
+ */
+export interface URLForAdminConsentConfig extends URLForAuthenticationConfig {
+    /**
+     * The credential ID for the Microsoft account
+     */
+    credentialId: string;
+}
+/**
+ * Interface of a Nylas code exchange request
+ */
+export interface CodeExchangeRequest {
+    /**
+     * Should match the same redirect URI that was used for getting the code during the initial authorization request.
+     */
+    redirectUri: string;
+    /**
+     * OAuth 2.0 code fetched from the previous step.
+     */
+    code: string;
+    /**
+     * Client ID of the application.
+     */
+    clientId: string;
+    /**
+     * Client secret of the application.
+     */
+    clientSecret: string;
+    /**
+     * The original plain text code verifier (code_challenge) used in the initial authorization request (PKCE).
+     */
+    codeVerifier?: string;
+}
+/**
+ * Interface of a Nylas token exchange request
+ */
+export interface TokenExchangeRequest {
+    /**
+     * Should match the same redirect URI that was used for getting the code during the initial authorization request.
+     */
+    redirectUri: string;
+    /**
+     * Token to refresh/request your short-lived access token
+     */
+    refreshToken: string;
+    /**
+     * Client ID of the application.
+     */
+    clientId: string;
+    /**
+     * Client secret of the application.
+     */
+    clientSecret: string;
+}
+/**
+ * Interface of the object containing the OAuth 2.0 URL as well as the hashed secret.
+ */
+export interface PKCEAuthURL {
+    /**
+     * The URL for hosted authentication
+     */
+    url: string;
+    /**
+     * Server-side challenge used in the OAuth 2.0 flow
+     */
+    secret: string;
+    /**
+     * SHA-256 hash of the secret
+     */
+    secretHash: string;
+}
+/**
+ * Interface of a Nylas code exchange response
+ */
+export interface CodeExchangeResponse {
+    /**
+     * Supports exchanging the code for tokens, or refreshing an access token using [Auth.refreshAccessToken][com.nylas.resources.Auth.refreshAccessToken].
+     */
+    accessToken: string;
+    /**
+     * Nylas grant ID that is now successfully created.
+     */
+    grantId: string;
+    /**
+     * The remaining lifetime of the access token in seconds.
+     */
+    expiresIn: number;
+    /**
+     * List of scopes associated with this token.
+     */
+    scope: string;
+    /**
+     * Only returned if the code was requested using [AccessType.OFFLINE][com.nylas.models.AccessType.OFFLINE].
+     */
+    refreshToken?: string;
+    /**
+     * A JWT that contains identity information about the user that is digitally signed by Nylas.
+     */
+    idToken?: string;
+    /**
+     * Currently always Bearer.
+     */
+    tokenType?: string;
+}
+/**
+ * Interface representing the object used to set parameters for detecting a provider.
+ */
+export interface ProviderDetectParams {
+    /**
+     * Email address to detect the provider for.
+     */
+    email: string;
+    /**
+     * Client ID of the Nylas application.
+     */
+    clientId: string;
+    /**
+     * Search by all providers regardless of created integrations. If unset, defaults to false.
+     */
+    allProviderTypes?: boolean;
+}
+/**
+ * Interface representing the Nylas provider detect response.
+ */
+export interface ProviderDetectResponse {
+    /**
+     * Email provided for autodetection
+     */
+    emailAddress: string;
+    /**
+     * Whether the provider was detected
+     */
+    detected: boolean;
+    /**
+     * Detected provider
+     */
+    provider?: string;
+    /**
+     * Provider type (if IMAP provider detected displays the IMAP provider)
+     */
+    type?: string;
+}
+export {};

package/lib/types/models/availability.d.ts

@@ -0,0 +1,159 @@
+/**
+ * Interface for a Nylas get availability response
+ */
+export interface GetAvailabilityResponse {
+    /**
+     * This property is only populated for round-robin events.
+     * It will contain the order in which the accounts would be next in line to attend the proposed meeting.
+     */
+    order: string[];
+    /**
+     * The available time slots where a new meeting can be created for the requested preferences.
+     */
+    timeSlots: TimeSlot[];
+}
+/**
+ * Interface for a Nylas get availability request
+ */
+export interface GetAvailabilityRequest {
+    /**
+     * Unix timestamp for the start time to check availability for.
+     */
+    startTime: number;
+    /**
+     * Unix timestamp for the end time to check availability for.
+     */
+    endTime: number;
+    /**
+     * Participant details to check availability for.
+     */
+    participants: AvailabilityParticipant[];
+    /**
+     * The total number of minutes the event should last.
+     */
+    durationMinutes: number;
+    /**
+     * Nylas checks from the nearest interval of the passed [startTime].
+     * For example, to schedule 30-minute meetings ([durationMinutes]) with 15 minutes between them ([intervalMinutes]).
+     * If you have a meeting starting at 9:59, the API returns times starting at 10:00. 10:00-10:30, 10:15-10:45.
+     */
+    intervalMinutes?: number;
+    /**
+     * When set to true, the availability time slots will start at 30 minutes past or on the hour.
+     * For example, a free slot starting at 16:10 is considered available only from 16:30.
+     */
+    roundTo30Minutes?: boolean;
+    /**
+     * The rules to apply when checking availability.
+     */
+    availabilityRules?: AvailabilityRules;
+}
+/**
+ * Interface for a Nylas availability time slot
+ */
+export interface TimeSlot {
+    /**
+     * The emails of the participants who are available for the time slot.
+     */
+    emails: string[];
+    /**
+     * Unix timestamp for the start of the slot.
+     */
+    startTime: string;
+    /**
+     * Unix timestamp for the end of the slot.
+     */
+    endTime: string;
+}
+/**
+ * Interface for the availability rules for a Nylas calendar.
+ */
+export interface AvailabilityRules {
+    /**
+     * The method used to determine availability for a meeting.
+     */
+    availabilityMethod?: AvailabilityMethod;
+    /**
+     * The buffer to add to the start and end of a meeting.
+     */
+    buffer?: MeetingBuffer;
+    /**
+     * A default set of open hours to apply to all participants.
+     * You can overwrite these open hours for individual participants by specifying [AvailabilityParticipant.openHours]
+     * on the participant object.
+     */
+    defaultOpenHours?: OpenHours[];
+    /**
+     * The ID on events that Nylas considers when calculating the order of round-robin participants.
+     * This is used for both max-fairness and max-availability methods.
+     */
+    roundRobinEventId?: string;
+}
+/**
+ * Interface for the meeting buffer object within an availability request.
+ */
+export interface MeetingBuffer {
+    /**
+     * The amount of buffer time in increments of 5 minutes to add before existing meetings.
+     * Defaults to 0.
+     */
+    before: number;
+    /**
+     * The amount of buffer time in increments of 5 minutes to add after existing meetings.
+     * Defaults to 0.
+     */
+    after: number;
+}
+/**
+ * Interface of a participant's open hours.
+ */
+export interface OpenHours {
+    /**
+     * The days of the week that the open hour settings will be applied to.
+     * Sunday corresponds to 0 and Saturday corresponds to 6.
+     */
+    days: number[];
+    /**
+     * IANA time zone database formatted string (e.g. America/New_York).
+     * @see <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">List of tz database time zones</a>
+     */
+    timezone: string;
+    /**
+     * Start time in 24-hour time format. Leading 0's are left off.
+     */
+    start: string;
+    /**
+     * End time in 24-hour time format. Leading 0's are left off.
+     */
+    end: string;
+    /**
+     * A list of dates that will be excluded from the open hours.
+     * Dates should be formatted as YYYY-MM-DD.
+     */
+    exdates: string[];
+}
+/**
+ * Interface of participant details to check availability for.
+ */
+export interface AvailabilityParticipant {
+    /**
+     * The email address of the participant.
+     */
+    email: string;
+    /**
+     * An optional list of the calendar IDs associated with each participant's email address.
+     * If not provided, Nylas uses the primary calendar ID.
+     */
+    calendarIds?: string[];
+    /**
+     * Open hours for this participant. The endpoint searches for free time slots during these open hours.
+     */
+    openHours?: OpenHours[];
+}
+/**
+ * Enum representing the method used to determine availability for a meeting.
+ */
+export declare enum AvailabilityMethod {
+    MaxFairness = "max-fairness",
+    MaxAvailability = "max-availability"
+}