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

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

@@ -0,0 +1,134 @@
+import { Provider } from './auth.js';
+/**
+ * Interface representing a Nylas Grant object.
+ */
+export interface Grant {
+    /**
+     * Globally unique object identifier.
+     */
+    id: string;
+    /**
+     * OAuth provider that the user authenticated with.
+     */
+    provider: string;
+    /**
+     * Scopes specified for the grant.
+     */
+    scope: string[];
+    /**
+     * Unix timestamp when the grant was created.
+     */
+    createdAt: number;
+    /**
+     * Status of the grant, if it is still valid or if the user needs to re-authenticate.
+     */
+    grantStatus?: string;
+    /**
+     * Email address associated with the grant.
+     */
+    email?: string;
+    /**
+     * End user's client user agent.
+     */
+    userAgent?: string;
+    /**
+     * End user's client IP address.
+     */
+    ip?: string;
+    /**
+     * Initial state that was sent as part of the OAuth request.
+     */
+    state?: string;
+    /**
+     * Unix timestamp when the grant was updated.
+     */
+    updatedAt?: number;
+    /**
+     * Provider's ID for the user this grant is associated with.
+     */
+    providerUserId?: string;
+    /**
+     * Settings required by the provider that were sent as part of the OAuth request.
+     */
+    settings?: Record<string, unknown>;
+}
+/**
+ * Interface representing a request to create a grant.
+ */
+export interface CreateGrantRequest {
+    /**
+     * OAuth provider
+     */
+    provider: Provider;
+    /**
+     * Settings required by provider.
+     */
+    settings: Record<string, unknown>;
+    /**
+     * Optional state value to return to developer's website after authentication flow is completed.
+     */
+    state?: string;
+    /**
+     * Optional list of scopes to request. If not specified it will use the integration default scopes.
+     */
+    scope?: string[];
+}
+/**
+ * Interface representing a request to update a grant.
+ */
+export interface UpdateGrantRequest {
+    /**
+     * Settings required by provider.
+     */
+    settings?: Record<string, unknown>;
+    /**
+     * List of integration scopes for the grant.
+     */
+    scope?: string[];
+}
+/**
+ * Interface representing the query parameters for listing grants.
+ */
+export interface ListGrantsQueryParams {
+    /**
+     * The maximum number of objects to return.
+     * This field defaults to 10. The maximum allowed value is 200.
+     */
+    limit?: number;
+    /**
+     * Offset grant results by this number.
+     */
+    offset?: number;
+    /**
+     * Sort entries by field name
+     */
+    sortBy?: 'createdAt' | 'updatedAt';
+    /**
+     * Specify ascending or descending order.
+     */
+    orderBy?: 'asc' | 'desc';
+    /**
+     * Scope grants from a specific point in time by Unix timestamp.
+     */
+    since?: number;
+    /**
+     * Scope grants to a specific point in time by Unix timestamp.
+     */
+    before?: number;
+    /**
+     * Filtering your query based on grant email address (if applicable)
+     */
+    email?: string;
+    /**
+     * Filtering your query based on grant email status (if applicable)
+     */
+    grantStatus?: string;
+    /**
+     * Filtering your query based on grant IP address
+     */
+    ip?: string;
+    /**
+     * Filtering your query based on OAuth provider
+     */
+    provider?: Provider;
+}

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

@@ -0,0 +1,4 @@
+export interface ListQueryParams {
+    limit?: number;
+    pageToken?: string;
+}

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

@@ -0,0 +1,71 @@
+/**
+ * Interface representation of a Redirect URI object
+ */
+export type RedirectUri = {
+    /**
+     * Globally unique object identifier
+     */
+    id: string;
+    /**
+     * Redirect URL
+     */
+    url: string;
+    /**
+     * Platform identifier
+     */
+    platform: string;
+    /**
+     * Configuration settings
+     */
+    settings?: RedirectUriSettings;
+};
+/**
+ * Configuration settings for a Redirect URI object
+ */
+export type RedirectUriSettings = {
+    /**
+     * Related to JS platform
+     */
+    origin?: string;
+    /**
+     * Related to iOS platform
+     */
+    bundleId?: string;
+    /**
+     * Related to iOS platform
+     */
+    appStoreId?: string;
+    /**
+     * Related to iOS platform
+     */
+    teamId?: string;
+    /**
+     * Related to Android platform
+     */
+    packageName?: string;
+    /**
+     * Related to Android platform
+     */
+    sha1CertificateFingerprint?: string;
+};
+/**
+ * Class representing a request to create a redirect uri.
+ */
+export type CreateRedirectUriRequest = {
+    /**
+     * Redirect URL.
+     */
+    url: string;
+    /**
+     * Platform identifier.
+     */
+    platform: string;
+    /**
+     * Optional settings for the redirect uri.
+     */
+    settings?: RedirectUriSettings;
+};
+/**
+ * Interface representation of a Nylas update redirect uri request
+ */
+export type UpdateRedirectUriRequest = Partial<CreateRedirectUriRequest>;

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

@@ -0,0 +1,40 @@
+/**
+ * Interface representation of a Nylas response object
+ */
+export interface NylasResponse<T> {
+    /**
+     * The requested data object
+     */
+    data: T;
+    /**
+     * The request ID
+     */
+    requestId: string;
+}
+/**
+ * Interface representation of a Nylas response object that contains a list of objects.
+ */
+export interface NylasListResponse<T> {
+    /**
+     * The list of requested data objects.
+     */
+    data: T[];
+    /**
+     * The request ID.
+     */
+    requestId: string;
+    /**
+     * The cursor to use to get the next page of data.
+     */
+    nextCursor?: string;
+}
+/**
+ * Interface representing a response to a delete request.
+ */
+export interface NylasDeleteResponse {
+    requestId: string;
+}
+/**
+ * Helper type for pagination
+ */
+export type ListResponseInnerType<T> = T extends NylasListResponse<infer R> ? R : never;

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

@@ -0,0 +1,45 @@
+export interface Webhook {
+    id: string;
+    description?: string;
+    triggerTypes: WebhookTriggers[];
+    callbackUrl: string;
+    status: 'active' | 'failing' | 'failed' | 'pause';
+    notificationEmailAddress?: string;
+    statusUpdatedAt: number;
+    createdAt: number;
+    updatedAt: number;
+}
+export interface WebhookWithSecret extends Webhook {
+    webhookSecret: string;
+}
+export interface WebhookDeleteResponse {
+    requestId: string;
+    data?: {
+        status: 'success';
+    };
+}
+export interface WebhookIpAddressesResponse {
+    ipAddresses: string[];
+    updatedAt: number;
+}
+export interface CreateWebhookRequest {
+    triggerTypes: WebhookTriggers[];
+    callbackUrl: string;
+    description?: string;
+    notificationEmailAddress?: string;
+}
+export type UpdateWebhookRequest = Partial<CreateWebhookRequest>;
+export declare enum WebhookTriggers {
+    CalendarCreated = "calendar.created",
+    CalendarUpdated = "calendar.updated",
+    CalendarDeleted = "calendar.deleted",
+    EventCreated = "event.created",
+    EventUpdated = "event.updated",
+    EventDeleted = "event.deleted",
+    GrantCreated = "grant.created",
+    GrantUpdated = "grant.updated",
+    GrantDeleted = "grant.deleted",
+    GrantExpired = "grant.expired",
+    MessageSendSuccess = "message.send_success",
+    MessageSendFailed = "message.send_failed"
+}

package/lib/types/nylas.d.ts

@@ -0,0 +1,44 @@
+import APIClient from './apiClient.js';
+import { NylasConfig } from './config.js';
+import { Calendars } from './resources/calendars.js';
+import { Events } from './resources/events.js';
+import { Auth } from './resources/auth.js';
+import { Webhooks } from './resources/webhooks.js';
+import { Applications } from './resources/applications.js';
+/**
+ * The entry point to the Node SDK
+ *
+ * A Nylas instance holds a configured http client pointing to a base URL and is intended to be reused and shared
+ * across threads and time.
+ */
+export default class Nylas {
+    /**
+     * Access the Applications API
+     */
+    applications: Applications;
+    /**
+     * Access the Auth API
+     */
+    auth: Auth;
+    /**
+     * Access the Calendars API
+     */
+    calendars: Calendars;
+    /**
+     * Access the Events API
+     */
+    events: Events;
+    /**
+     * Access the Webhooks API
+     */
+    webhooks: Webhooks;
+    /**
+     * The configured API client
+     * @ignore Not for public use
+     */
+    apiClient: APIClient;
+    /**
+     * @param config Configuration options for the Nylas SDK
+     */
+    constructor(config: NylasConfig);
+}

package/lib/types/resources/applications.d.ts

@@ -0,0 +1,26 @@
+import { Resource } from './resource.js';
+import { RedirectUris } from './redirectUris.js';
+import APIClient from '../apiClient.js';
+import { ApplicationDetails } from '../models/applicationDetails.js';
+import { NylasResponse } from '../models/response.js';
+import { Overrides } from '../config.js';
+/**
+ * Nylas Applications API
+ *
+ * This endpoint allows for getting application details as well as redirect URI operations.
+ */
+export declare class Applications extends Resource {
+    /**
+     * Access the collection of redirect URI related API endpoints.
+     */
+    redirectUris: RedirectUris;
+    /**
+     * @param apiClient client The configured Nylas API client
+     */
+    constructor(apiClient: APIClient);
+    /**
+     * Get application details
+     * @returns The application details
+     */
+    getDetails({ overrides }?: Overrides): Promise<NylasResponse<ApplicationDetails>>;
+}

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

@@ -0,0 +1,66 @@
+import APIClient from '../apiClient.js';
+import { Resource } from './resource.js';
+import { Grants } from './grants.js';
+import { URLForAdminConsentConfig, URLForAuthenticationConfig, CodeExchangeRequest, PKCEAuthURL, TokenExchangeRequest, CodeExchangeResponse, ProviderDetectParams, ProviderDetectResponse } from '../models/auth.js';
+/**
+ * A collection of authentication related API endpoints
+ *
+ * These endpoints allow for various functionality related to authentication.
+ * Also contains the Grants API and collection of provider API endpoints.
+ */
+export declare class Auth extends Resource {
+    /**
+     * Access the Grants API
+     */
+    grants: Grants;
+    apiClient: APIClient;
+    /**
+     * @param apiClient The configured Nylas API client
+     */
+    constructor(apiClient: APIClient);
+    /**
+     * Build the URL for authenticating users to your application with OAuth 2.0
+     * @param config The configuration for building the URL
+     * @return The URL for hosted authentication
+     */
+    urlForOAuth2(config: URLForAuthenticationConfig): string;
+    /**
+     * Exchange an authorization code for an access token
+     * @param request The request parameters for the code exchange
+     * @return Information about the Nylas application
+     */
+    exchangeCodeForToken(request: CodeExchangeRequest): Promise<CodeExchangeResponse>;
+    /**
+     * Refresh an access token
+     * @param request The refresh token request
+     * @return The response containing the new access token
+     */
+    refreshAccessToken(request: TokenExchangeRequest): Promise<CodeExchangeResponse>;
+    /**
+     * Build the URL for authenticating users to your application with OAuth 2.0 and PKCE
+     * IMPORTANT: YOU WILL NEED TO STORE THE 'secret' returned to use it inside the CodeExchange flow
+     * @param config The configuration for building the URL
+     * @return The URL for hosted authentication
+     */
+    urlForOAuth2PKCE(config: URLForAuthenticationConfig): PKCEAuthURL;
+    /**
+     * Build the URL for admin consent authentication for Microsoft
+     * @param config The configuration for building the URL
+     * @return The URL for admin consent authentication
+     */
+    urlForAdminConsent(config: URLForAdminConsentConfig): string;
+    /**
+     * Revoke a token (and the grant attached to the token)
+     * @param token The token to revoke
+     * @return True if the token was revoked successfully
+     */
+    revoke(token: string): Promise<boolean>;
+    /**
+     * Detect provider from email address
+     * @param params The parameters to include in the request
+     * @return The detected provider, if found
+     */
+    detectProvider(params: ProviderDetectParams): Promise<ProviderDetectResponse>;
+    private urlAuthBuilder;
+    private hashPKCESecret;
+}

package/lib/types/resources/calendars.d.ts

@@ -0,0 +1,97 @@
+import { Overrides } from '../config.js';
+import { Calendar, CreateCalenderRequest, ListCalendersQueryParams, UpdateCalenderRequest } from '../models/calendars.js';
+import { NylasDeleteResponse, NylasResponse, NylasListResponse } from '../models/response.js';
+import { Resource, AsyncListResponse } from './resource.js';
+import { GetAvailabilityRequest, GetAvailabilityResponse } from '../models/availability.js';
+/**
+ * The parameters for the {@link Calendars.find} method
+ * @property calendarId The id of the Calendar to retrieve. Use "primary" to refer to the primary calendar associated with grant.
+ * @property identifier The identifier of the grant to act upon
+ */
+interface FindCalendarParams {
+    identifier: string;
+    calendarId: string;
+}
+/**
+ * The parameters for the {@link Calendars.list} method
+ * @property identifier The identifier of the grant to act upon
+ * @property queryParams The query parameters to include in the request
+ */
+interface ListCalendersParams {
+    identifier: string;
+    queryParams?: ListCalendersQueryParams;
+}
+/**
+ * The parameters for the {@link Calendars.create} method
+ * @property identifier The identifier of the grant to act upon
+ * @property requestBody The request body to create a calendar
+ */
+interface CreateCalendarParams {
+    identifier: string;
+    requestBody: CreateCalenderRequest;
+}
+/**
+ * The parameters for the {@link Calendars.update} method
+ * @property identifier The identifier of the grant to act upon
+ * @property calendarId The id of the Calendar to retrieve. Use "primary" to refer to the primary calendar associated with grant.
+ */
+interface UpdateCalendarParams {
+    identifier: string;
+    calendarId: string;
+    requestBody: UpdateCalenderRequest;
+}
+/**
+ * The parameters for the {@link Calendars.destroy} method
+ * @property identifier The identifier of the grant to act upon
+ * @property calendarId The id of the Calendar to retrieve. Use "primary" to refer to the primary calendar associated with grant.
+ */
+interface DestroyCalendarParams {
+    identifier: string;
+    calendarId: string;
+}
+/**
+ * The parameters for the {@link Calendars.getAvailability} method
+ * @property requestBody The availability request
+ */
+interface GetAvailabilityParams {
+    requestBody: GetAvailabilityRequest;
+}
+/**
+ * Nylas Calendar API
+ *
+ * The Nylas calendar API allows you to create new calendars or manage existing ones.
+ * A calendar can be accessed by one, or several people, and can contain events.
+ */
+export declare class Calendars extends Resource {
+    /**
+     * Return all Calendars
+     * @return A list of calendars
+     */
+    list({ identifier, queryParams, overrides, }: ListCalendersParams & ListCalendersQueryParams & Overrides): AsyncListResponse<NylasListResponse<Calendar>>;
+    /**
+     * Return a Calendar
+     * @return The calendar
+     */
+    find({ identifier, calendarId, overrides, }: FindCalendarParams & Overrides): Promise<NylasResponse<Calendar>>;
+    /**
+     * Create a Calendar
+     * @return The created calendar
+     */
+    create({ identifier, requestBody, overrides, }: CreateCalendarParams & Overrides): Promise<NylasResponse<Calendar>>;
+    /**
+     * Update a Calendar
+     * @return The updated Calendar
+     */
+    update({ calendarId, identifier, requestBody, overrides, }: UpdateCalendarParams & Overrides): Promise<NylasResponse<Calendar>>;
+    /**
+     * Delete a Calendar
+     * @return The deleted Calendar
+     */
+    destroy({ identifier, calendarId, overrides, }: DestroyCalendarParams & Overrides): Promise<NylasDeleteResponse>;
+    /**
+     * Get Availability for a given account / accounts
+     * @return The availability response
+     */
+    getAvailability({ requestBody, overrides, }: GetAvailabilityParams & Overrides): Promise<GetAvailabilityResponse>;
+}
+export {};

package/lib/types/resources/events.d.ts

@@ -0,0 +1,87 @@
+import { Overrides } from '../config.js';
+import { CreateEventQueryParams, CreateEventRequest, DestroyEventQueryParams, Event, FindEventQueryParams, ListEventQueryParams, UpdateEventQueryParams, UpdateEventRequest } from '../models/events.js';
+import { NylasDeleteResponse, NylasResponse, NylasListResponse } from '../models/response.js';
+import { AsyncListResponse, Resource } from './resource.js';
+/**
+ * @property eventId The id of the Event to retrieve.
+ * @property identifier The identifier of the grant to act upon
+ * @property queryParams The query parameters to include in the request
+ */
+interface FindEventParams {
+    identifier: string;
+    eventId: string;
+    queryParams: FindEventQueryParams;
+}
+/**
+ * @property identifier The identifier of the grant to act upon
+ * @property queryParams The query parameters to include in the request
+ */
+interface ListEventParams {
+    identifier: string;
+    queryParams: ListEventQueryParams;
+}
+/**
+ * @property identifier The identifier of the grant to act upon
+ * @property queryParams The query parameters to include in the request
+ * @property requestBody The values to create the Event with
+ */
+interface CreateEventParams {
+    identifier: string;
+    requestBody: CreateEventRequest;
+    queryParams: CreateEventQueryParams;
+}
+/**
+ * @property identifier The identifier of the grant to act upon
+ * @property eventId The id of the Event to retrieve.
+ * @property requestBody The values to update the Event with
+ * @property queryParams The query parameters to include in the request
+ */
+interface UpdateEventParams {
+    identifier: string;
+    eventId: string;
+    requestBody: UpdateEventRequest;
+    queryParams: UpdateEventQueryParams;
+}
+/**
+ * @property identifier The identifier of the grant to act upon
+ * @property eventId The id of the Event to retrieve.
+ * @property queryParams The query parameters to include in the request
+ */
+interface DestroyEventParams {
+    identifier: string;
+    eventId: string;
+    queryParams: DestroyEventQueryParams;
+}
+/**
+ * Nylas Events API
+ *
+ * The Nylas Events API allows you to create, update, and delete events on user calendars.
+ */
+export declare class Events extends Resource {
+    /**
+     * Return all Events
+     * @return The list of Events
+     */
+    list({ identifier, queryParams, overrides, }: ListEventParams & Overrides): AsyncListResponse<NylasListResponse<Event>>;
+    /**
+     * Return an Event
+     * @return The Event
+     */
+    find({ identifier, eventId, queryParams, overrides, }: FindEventParams & Overrides): Promise<NylasResponse<Event>>;
+    /**
+     * Create an Event
+     * @return The created Event
+     */
+    create({ identifier, requestBody, queryParams, overrides, }: CreateEventParams & Overrides): Promise<NylasResponse<Event>>;
+    /**
+     * Update an Event
+     * @return The updated Event
+     */
+    update({ identifier, eventId, requestBody, queryParams, overrides, }: UpdateEventParams & Overrides): Promise<NylasResponse<Event>>;
+    /**
+     * Delete an Event
+     * @return The deletion response
+     */
+    destroy({ identifier, eventId, queryParams, overrides, }: DestroyEventParams & Overrides): Promise<NylasDeleteResponse>;
+}
+export {};

package/lib/types/resources/grants.d.ts

@@ -0,0 +1,63 @@
+import { Resource } from './resource.js';
+import { Overrides } from '../config.js';
+import { NylasDeleteResponse, NylasResponse, NylasListResponse } from '../models/response.js';
+import { CreateGrantRequest, Grant, ListGrantsQueryParams, UpdateGrantRequest } from '../models/grants.js';
+/**
+ * @property grantId The id of the Grant to retrieve.
+ */
+interface FindGrantParams {
+    grantId: string;
+}
+/**
+ * @property requestBody The values to create the Grant with.
+ */
+interface CreateGrantParams {
+    requestBody: CreateGrantRequest;
+}
+/**
+ * @property grantId The id of the Grant to update.
+ * @property requestBody The values to update the Grant with.
+ */
+interface UpdateGrantParams {
+    grantId: string;
+    requestBody: UpdateGrantRequest;
+}
+/**
+ * @property grantId The id of the Grant to delete.
+ */
+interface DestroyGrantParams {
+    grantId: string;
+}
+/**
+ * Nylas Grants API
+ *
+ * The Nylas Grants API allows for the management of grants.
+ */
+export declare class Grants extends Resource {
+    /**
+     * Return all Grants
+     * @return The list of Grants
+     */
+    list({ overrides }?: Overrides, queryParams?: ListGrantsQueryParams): Promise<NylasListResponse<Grant>>;
+    /**
+     * Return a Grant
+     * @return The Grant
+     */
+    find({ grantId, overrides, }: FindGrantParams & Overrides): Promise<NylasResponse<Grant>>;
+    /**
+     * Create a Grant
+     * @return The created Grant
+     */
+    create({ requestBody, overrides, }: CreateGrantParams & Overrides): Promise<NylasResponse<Grant>>;
+    /**
+     * Update a Grant
+     * @return The updated Grant
+     */
+    update({ grantId, requestBody, overrides, }: UpdateGrantParams & Overrides): Promise<NylasResponse<Grant>>;
+    /**
+     * Delete a Grant
+     * @return The deletion response
+     */
+    destroy({ grantId, overrides, }: DestroyGrantParams & Overrides): Promise<NylasDeleteResponse>;
+}
+export {};