nylas 8.0.4 → 8.1.0

package/lib/esm/resources/rules.js

@@ -0,0 +1,75 @@
+import { makePathParams } from '../utils.js';
+import { Resource } from './resource.js';
+/**
+ * Nylas Agent Account Rules API
+ *
+ * Rules define inbound and outbound filtering logic for Agent Accounts.
+ */
+export class Rules extends Resource {
+    /**
+     * Return all rules.
+     * @return The list of rules.
+     */
+    list({ queryParams, overrides, } = {}) {
+        return super._list({
+            queryParams,
+            path: makePathParams('/v3/rules', {}),
+            overrides,
+        });
+    }
+    /**
+     * Return a rule.
+     * @return The rule.
+     */
+    find({ ruleId, overrides, }) {
+        return super._find({
+            path: makePathParams('/v3/rules/{ruleId}', { ruleId }),
+            overrides,
+        });
+    }
+    /**
+     * Create a rule.
+     * @return The created rule.
+     */
+    create({ requestBody, overrides, }) {
+        return super._create({
+            path: makePathParams('/v3/rules', {}),
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Update a rule.
+     * @return The updated rule.
+     */
+    update({ ruleId, requestBody, overrides, }) {
+        return super._update({
+            path: makePathParams('/v3/rules/{ruleId}', { ruleId }),
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Delete a rule.
+     * @return The deletion response.
+     */
+    destroy({ ruleId, overrides, }) {
+        return super._destroy({
+            path: makePathParams('/v3/rules/{ruleId}', { ruleId }),
+            overrides,
+        });
+    }
+    /**
+     * Return rule evaluation records for a grant.
+     * @return The list of rule evaluation records.
+     */
+    listEvaluations({ identifier, queryParams, overrides, }) {
+        return super._list({
+            queryParams,
+            path: makePathParams('/v3/grants/{identifier}/rule-evaluations', {
+                identifier,
+            }),
+            overrides,
+        });
+    }
+}

package/lib/esm/resources/scheduler.js

@@ -1,10 +1,12 @@
 import { Configurations } from './configurations.js';
 import { Sessions } from './sessions.js';
 import { Bookings } from './bookings.js';
+import { SchedulerAvailability } from './availability.js';
 export class Scheduler {
     constructor(apiClient) {
         this.configurations = new Configurations(apiClient);
         this.bookings = new Bookings(apiClient);
         this.sessions = new Sessions(apiClient);
+        this.availability = new SchedulerAvailability(apiClient);
     }
 }

package/lib/esm/version.js

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

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

@@ -0,0 +1,123 @@
+import { ListQueryParams } from './listQueryParams.js';
+/**
+ * Type for values a Nylas Agent Account list can hold.
+ */
+export type AgentListType = 'domain' | 'tld' | 'address';
+/**
+ * Interface representing a Nylas Agent Account list.
+ */
+export interface AgentList {
+    /**
+     * Globally unique identifier for the list.
+     */
+    id: string;
+    /**
+     * Human-readable name for the list.
+     */
+    name: string;
+    /**
+     * Optional description of the list's purpose.
+     */
+    description?: string;
+    /**
+     * The kind of values the list holds.
+     */
+    type: AgentListType;
+    /**
+     * Number of items currently in the list.
+     */
+    itemsCount?: number;
+    /**
+     * The ID of the application that owns the list.
+     */
+    applicationId?: string;
+    /**
+     * The ID of the Nylas organization that owns the list.
+     */
+    organizationId?: string;
+    /**
+     * Unix timestamp when the list was created.
+     */
+    createdAt?: number;
+    /**
+     * Unix timestamp when the list was last updated.
+     */
+    updatedAt?: number;
+}
+/**
+ * Interface representing an item in a Nylas Agent Account list.
+ */
+export interface AgentListItem {
+    /**
+     * Globally unique identifier for the list item.
+     */
+    id: string;
+    /**
+     * The ID of the list that contains the item.
+     */
+    listId: string;
+    /**
+     * The normalized list item value.
+     */
+    value: string;
+    /**
+     * Unix timestamp when the item was added to the list.
+     */
+    createdAt?: number;
+}
+/**
+ * Interface representing a request to create a Nylas Agent Account list.
+ */
+export interface CreateAgentListRequest {
+    /**
+     * Human-readable name for the list.
+     */
+    name: string;
+    /**
+     * Optional description of the list's purpose.
+     */
+    description?: string;
+    /**
+     * The kind of values the list holds.
+     */
+    type: AgentListType;
+}
+/**
+ * Interface representing a request to update a Nylas Agent Account list.
+ */
+export interface UpdateAgentListRequest {
+    /**
+     * Human-readable name for the list.
+     */
+    name?: string;
+    /**
+     * Optional description of the list's purpose.
+     */
+    description?: string;
+}
+/**
+ * Interface representing a request to add items to a Nylas Agent Account list.
+ */
+export interface AddAgentListItemsRequest {
+    /**
+     * Values to add to the list.
+     */
+    items: string[];
+}
+/**
+ * Interface representing a request to remove items from a Nylas Agent Account list.
+ */
+export interface RemoveAgentListItemsRequest {
+    /**
+     * Values to remove from the list.
+     */
+    items: string[];
+}
+/**
+ * Interface representing query parameters for listing Agent Account lists.
+ */
+export type ListAgentListsQueryParams = ListQueryParams;
+/**
+ * Interface representing query parameters for listing Agent Account list items.
+ */
+export type ListAgentListItemsQueryParams = ListQueryParams;

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

@@ -65,4 +65,85 @@ export interface FindAttachmentQueryParams {
  * Interface representing of the query parameters for downloading an attachment.
  */
 export type DownloadAttachmentQueryParams = FindAttachmentQueryParams;
+/**
+ * Status of a large-attachment upload session.
+ * @see https://developer.nylas.com/docs/v3/email/send-large-attachments/
+ */
+export type AttachmentUploadSessionStatusType = 'uploading' | 'ready' | 'failed' | 'expired';
+/**
+ * Request body for creating a large-attachment upload session.
+ * Sent to the API as snake_case (`content_type`, etc.).
+ */
+export interface CreateAttachmentUploadSessionRequest {
+    /**
+     * The name of the file as it will appear in the email.
+     */
+    filename: string;
+    /**
+     * MIME type of the file (for example, `application/pdf`).
+     */
+    contentType: string;
+    /**
+     * Expected file size in bytes. Recommended — Nylas validates the upload matches at completion.
+     * Maximum: 157286400 (150 MB).
+     */
+    size?: number;
+}
+/**
+ * Upload session returned when creating a large-attachment upload session.
+ * Corresponds to the `data` object in the create-session API response.
+ */
+export interface AttachmentUploadSession {
+    /**
+     * Unique identifier for the upload session. Use when completing the session and when referencing the attachment in send or draft.
+     */
+    attachmentId: string;
+    /**
+     * HTTP method to use when uploading to {@link AttachmentUploadSession.url}. Always `PUT`.
+     */
+    method: string;
+    /**
+     * Pre-signed URL to upload file bytes (no Nylas auth header on this request).
+     */
+    url: string;
+    /**
+     * Headers to include when uploading to {@link AttachmentUploadSession.url}.
+     */
+    headers: Record<string, string>;
+    /**
+     * When the upload session expires (RFC 3339).
+     */
+    expiresAt: string;
+    /**
+     * Maximum allowed file size in bytes.
+     */
+    maxSize: number;
+    /**
+     * Expected file size in bytes, echoing the request. `0` if `size` was omitted on creation.
+     */
+    size: number;
+    /**
+     * MIME type of the file.
+     */
+    contentType: string;
+    /**
+     * Name of the file.
+     */
+    filename: string;
+    /**
+     * The grant ID the upload session belongs to.
+     */
+    grantId: string;
+}
+/**
+ * Result of completing an upload session (`data` in the complete API response).
+ */
+export interface AttachmentUploadSessionComplete {
+    attachmentId: string;
+    grantId: string;
+    /**
+     * After successful completion, typically `ready`.
+     */
+    status: AttachmentUploadSessionStatusType;
+}
 export {};

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

@@ -5,7 +5,7 @@ type AccessType = 'online' | 'offline';
 /**
  * Type for the different OAuth providers Nylas supports.
  */
-export type Provider = 'google' | 'imap' | 'microsoft' | 'icloud' | 'virtual-calendar' | 'ews' | 'zoom';
+export type Provider = 'google' | 'imap' | 'microsoft' | 'icloud' | 'virtual-calendar' | 'ews' | 'zoom' | 'nylas';
 /**
  * Configuration for generating a URL for OAuth 2.0 authentication.
  */

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

@@ -64,11 +64,11 @@ export interface Grant {
 /**
  * Interface representing a request to create a grant.
  */
-export interface CreateGrantRequest {
+export interface CreateCustomAuthenticationGrantRequest {
     /**
      * OAuth provider
      */
-    provider: Provider;
+    provider: Exclude<Provider, 'nylas'>;
     /**
      * Settings required by provider.
      * Can include 'credentialId' to specify which credential to use for authentication.
@@ -90,6 +90,41 @@ export interface CreateGrantRequest {
      */
     scope?: string[];
 }
+/**
+ * Interface representing settings to create a Nylas Agent Account grant.
+ */
+export interface CreateAgentAccountSettings {
+    /**
+     * The Agent Account email address.
+     */
+    email: string;
+    /**
+     * A policy to apply to this grant.
+     */
+    policyId?: string;
+    /**
+     * Password for IMAP and SMTP-submission access.
+     */
+    appPassword?: string;
+}
+/**
+ * Interface representing a request to create a Nylas Agent Account grant.
+ */
+export interface CreateAgentAccountRequest {
+    /**
+     * The Nylas provider provisions an Agent Account.
+     */
+    provider: 'nylas';
+    /**
+     * Settings required to provision the Agent Account.
+     */
+    settings: CreateAgentAccountSettings;
+    /**
+     * Optional state value to return to developer's website after authentication flow is completed.
+     */
+    state?: string;
+}
+export type CreateGrantRequest = CreateCustomAuthenticationGrantRequest | CreateAgentAccountRequest;
 /**
  * Interface representing a request to update a grant.
  */

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

@@ -1,3 +1,4 @@
+export * from './agentLists.js';
 export * from './applicationDetails.js';
 export * from './attachments.js';
 export * from './auth.js';
@@ -15,8 +16,10 @@ export * from './grants.js';
 export * from './listQueryParams.js';
 export * from './messages.js';
 export * from './notetakers.js';
+export * from './policies.js';
 export * from './redirectUri.js';
 export * from './response.js';
+export * from './rules.js';
 export * from './scheduler.js';
 export * from './smartCompose.js';
 export * from './threads.js';

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

@@ -0,0 +1,167 @@
+import { ListQueryParams } from './listQueryParams.js';
+/**
+ * Interface representing operational limits for Nylas Agent Accounts.
+ */
+export interface PolicyLimits {
+    /**
+     * Maximum size, in bytes, for a single attachment.
+     */
+    limitAttachmentSizeLimit?: number;
+    /**
+     * Maximum number of attachments allowed on a single message.
+     */
+    limitAttachmentCountLimit?: number;
+    /**
+     * Allowed attachment MIME types.
+     */
+    limitAttachmentAllowedTypes?: string[];
+    /**
+     * Maximum total MIME size, in bytes, for a single message.
+     */
+    limitSizeTotalMime?: number;
+    /**
+     * Maximum total storage, in bytes, for each inbox using this policy.
+     */
+    limitStorageTotal?: number;
+    /**
+     * Maximum number of messages each grant can send per day.
+     */
+    limitCountDailyMessagePerGrant?: number;
+    /**
+     * How long, in days, to retain messages in the inbox.
+     */
+    limitInboxRetentionPeriod?: number;
+    /**
+     * How long, in days, to retain messages in the spam folder.
+     */
+    limitSpamRetentionPeriod?: number;
+}
+/**
+ * Interface representing spam detection settings for Nylas Agent Accounts.
+ */
+export interface PolicySpamDetection {
+    /**
+     * Whether to enable DNS-based block list checking on inbound messages.
+     */
+    useListDnsbl?: boolean;
+    /**
+     * Whether to enable header anomaly detection on inbound messages.
+     */
+    useHeaderAnomalyDetection?: boolean;
+    /**
+     * Spam detection sensitivity. Higher values mark more messages as spam.
+     */
+    spamSensitivity?: number;
+}
+/**
+ * Interface representing miscellaneous policy options.
+ */
+export interface PolicyOptions {
+    /**
+     * Extra folders to create for inboxes that use this policy.
+     */
+    additionalFolders?: string[];
+    /**
+     * Whether to enable CIDR-based email aliasing for inboxes that use this policy.
+     */
+    useCidrAliasing?: boolean;
+}
+/**
+ * Interface representing a Nylas Agent Account policy.
+ */
+export interface Policy {
+    /**
+     * Globally unique identifier for the policy.
+     */
+    id: string;
+    /**
+     * Human-readable name for the policy.
+     */
+    name: string;
+    /**
+     * The ID of the application that owns the policy.
+     */
+    applicationId?: string;
+    /**
+     * The ID of the Nylas organization that owns the policy.
+     */
+    organizationId?: string;
+    /**
+     * Miscellaneous options for inboxes that use this policy.
+     */
+    options?: PolicyOptions;
+    /**
+     * Operational limits enforced for inboxes that use this policy.
+     */
+    limits?: PolicyLimits;
+    /**
+     * Rule IDs linked to this policy for inbound processing.
+     */
+    rules?: string[];
+    /**
+     * Spam detection configuration for inboxes that use this policy.
+     */
+    spamDetection?: PolicySpamDetection;
+    /**
+     * Unix timestamp when the policy was created.
+     */
+    createdAt?: number;
+    /**
+     * Unix timestamp when the policy was last updated.
+     */
+    updatedAt?: number;
+}
+/**
+ * Interface representing a request to create a Nylas Agent Account policy.
+ */
+export interface CreatePolicyRequest {
+    /**
+     * Human-readable name for the policy.
+     */
+    name: string;
+    /**
+     * Miscellaneous options for inboxes that use this policy.
+     */
+    options?: PolicyOptions;
+    /**
+     * Operational limits enforced for inboxes that use this policy.
+     */
+    limits?: PolicyLimits;
+    /**
+     * Rule IDs to link to this policy for inbound processing.
+     */
+    rules?: string[];
+    /**
+     * Spam detection configuration for inboxes that use this policy.
+     */
+    spamDetection?: PolicySpamDetection;
+}
+/**
+ * Interface representing a request to update a Nylas Agent Account policy.
+ */
+export interface UpdatePolicyRequest {
+    /**
+     * Human-readable name for the policy.
+     */
+    name?: string;
+    /**
+     * Miscellaneous options for inboxes that use this policy.
+     */
+    options?: PolicyOptions;
+    /**
+     * Operational limits enforced for inboxes that use this policy.
+     */
+    limits?: PolicyLimits;
+    /**
+     * Rule IDs to link to this policy for inbound processing.
+     */
+    rules?: string[];
+    /**
+     * Spam detection configuration for inboxes that use this policy.
+     */
+    spamDetection?: PolicySpamDetection;
+}
+/**
+ * Interface representing query parameters for listing policies.
+ */
+export type ListPoliciesQueryParams = ListQueryParams;