nylas 8.0.5 → 8.1.0

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

@@ -0,0 +1,318 @@
+import { ListQueryParams } from './listQueryParams.js';
+/**
+ * Type for when a Nylas Agent Account rule is evaluated.
+ */
+export type RuleTrigger = 'inbound' | 'outbound';
+/**
+ * Type for how rule conditions are combined.
+ */
+export type RuleMatchOperator = 'all' | 'any';
+/**
+ * Type for fields a rule condition can match.
+ */
+export type RuleConditionField = 'from.address' | 'from.domain' | 'from.tld' | 'recipient.address' | 'recipient.domain' | 'recipient.tld' | 'outbound.type';
+/**
+ * Type for how a condition compares its field value.
+ */
+export type RuleConditionOperator = 'is' | 'is_not' | 'contains' | 'in_list';
+/**
+ * Type for the outbound send classification used in rule evaluation.
+ */
+export type RuleOutboundType = 'compose' | 'reply';
+/**
+ * Type for actions a rule can apply when matched.
+ */
+export type RuleActionType = 'block' | 'mark_as_spam' | 'assign_to_folder' | 'mark_as_read' | 'mark_as_starred' | 'archive' | 'trash';
+/**
+ * Type for where in the processing pipeline a rule evaluation happened.
+ */
+export type RuleEvaluationStage = 'smtp_rcpt' | 'inbox_processing' | 'outbound_send';
+/**
+ * Interface representing a Nylas Agent Account rule condition.
+ */
+export interface RuleCondition {
+    /**
+     * The field to match against.
+     */
+    field: RuleConditionField;
+    /**
+     * How to compare the field value.
+     */
+    operator: RuleConditionOperator;
+    /**
+     * The value to compare against. For in_list, pass one or more List IDs.
+     */
+    value: string | string[];
+}
+/**
+ * Interface representing the match clause for a rule.
+ */
+export interface RuleMatch {
+    /**
+     * How conditions are combined. Defaults to all when omitted.
+     */
+    operator?: RuleMatchOperator;
+    /**
+     * The list of conditions to evaluate.
+     */
+    conditions: RuleCondition[];
+}
+/**
+ * Interface representing a Nylas Agent Account rule action.
+ */
+export interface RuleAction {
+    /**
+     * The action to take when the rule matches.
+     */
+    type: RuleActionType;
+    /**
+     * Required when type is assign_to_folder.
+     */
+    value?: string;
+}
+/**
+ * Interface representing a Nylas Agent Account rule.
+ */
+export interface Rule {
+    /**
+     * Globally unique identifier for the rule.
+     */
+    id: string;
+    /**
+     * Human-readable name for the rule.
+     */
+    name: string;
+    /**
+     * Optional description of what the rule does.
+     */
+    description?: string;
+    /**
+     * Execution order for the rule. Lower numbers run first.
+     */
+    priority?: number;
+    /**
+     * Whether the rule is active.
+     */
+    enabled?: boolean;
+    /**
+     * When the rule is evaluated.
+     */
+    trigger?: RuleTrigger;
+    /**
+     * Conditions that must be met for the rule to apply.
+     */
+    match: RuleMatch;
+    /**
+     * Actions to perform when the rule matches.
+     */
+    actions: RuleAction[];
+    /**
+     * The ID of the application that owns the rule.
+     */
+    applicationId?: string;
+    /**
+     * The ID of the Nylas organization that owns the rule.
+     */
+    organizationId?: string;
+    /**
+     * Unix timestamp when the rule was created.
+     */
+    createdAt?: number;
+    /**
+     * Unix timestamp when the rule was last updated.
+     */
+    updatedAt?: number;
+}
+/**
+ * Interface representing a request to create a Nylas Agent Account rule.
+ */
+export interface CreateRuleRequest {
+    /**
+     * Human-readable name for the rule.
+     */
+    name: string;
+    /**
+     * Optional description of what the rule does.
+     */
+    description?: string;
+    /**
+     * Execution order for the rule. Lower numbers run first.
+     */
+    priority?: number;
+    /**
+     * Whether the rule is active.
+     */
+    enabled?: boolean;
+    /**
+     * When the rule is evaluated.
+     */
+    trigger?: RuleTrigger;
+    /**
+     * Conditions that must be met for the rule to apply.
+     */
+    match: RuleMatch;
+    /**
+     * Actions to perform when the rule matches.
+     */
+    actions: RuleAction[];
+}
+/**
+ * Interface representing a request to update a Nylas Agent Account rule.
+ */
+export interface UpdateRuleRequest {
+    /**
+     * Human-readable name for the rule.
+     */
+    name?: string;
+    /**
+     * Optional description of what the rule does.
+     */
+    description?: string;
+    /**
+     * Execution order for the rule. Lower numbers run first.
+     */
+    priority?: number;
+    /**
+     * Whether the rule is active.
+     */
+    enabled?: boolean;
+    /**
+     * When the rule is evaluated.
+     */
+    trigger?: RuleTrigger;
+    /**
+     * Conditions that must be met for the rule to apply.
+     */
+    match?: RuleMatch;
+    /**
+     * Actions to perform when the rule matches.
+     */
+    actions?: RuleAction[];
+}
+/**
+ * Interface representing the normalized data evaluated by the Rules engine.
+ */
+export interface RuleEvaluationInput {
+    /**
+     * The normalized sender email address.
+     */
+    fromAddress?: string;
+    /**
+     * The normalized sender domain.
+     */
+    fromDomain?: string;
+    /**
+     * The normalized sender top-level domain.
+     */
+    fromTld?: string;
+    /**
+     * Outbound recipient email addresses considered during rule evaluation.
+     */
+    recipientAddresses?: string[];
+    /**
+     * Outbound recipient domains considered during rule evaluation.
+     */
+    recipientDomains?: string[];
+    /**
+     * Outbound recipient top-level domains considered during rule evaluation.
+     */
+    recipientTlds?: string[];
+    /**
+     * Outbound send classification used during rule evaluation.
+     */
+    outboundType?: RuleOutboundType;
+}
+/**
+ * Interface representing actions applied during a rule evaluation.
+ */
+export interface RuleEvaluationAppliedActions {
+    /**
+     * Whether the inbound message or outbound send was blocked.
+     */
+    blocked?: boolean;
+    /**
+     * Whether the message or stored sent copy was moved to spam.
+     */
+    markedAsSpam?: boolean;
+    /**
+     * Whether the message or stored sent copy was marked as read.
+     */
+    markedAsRead?: boolean;
+    /**
+     * Whether the message or stored sent copy was starred.
+     */
+    markedStarred?: boolean;
+    /**
+     * Whether the message or stored sent copy was archived.
+     */
+    archived?: boolean;
+    /**
+     * Whether the message or stored sent copy was moved to trash.
+     */
+    trashed?: boolean;
+    /**
+     * IDs of folders assigned by matching rules.
+     */
+    folderIds?: string[];
+}
+/**
+ * Interface representing a Nylas Agent Account rule evaluation record.
+ */
+export interface RuleEvaluation {
+    /**
+     * Globally unique identifier for this evaluation record.
+     */
+    id: string;
+    /**
+     * The grant this evaluation belongs to.
+     */
+    grantId: string;
+    /**
+     * The inbound message or stored sent copy associated with this evaluation.
+     */
+    messageId?: string | null;
+    /**
+     * Unix timestamp when the evaluation occurred.
+     */
+    evaluatedAt?: number;
+    /**
+     * Where in the processing pipeline the evaluation happened.
+     */
+    evaluationStage?: RuleEvaluationStage;
+    /**
+     * The normalized data that rules were matched against.
+     */
+    evaluationInput?: RuleEvaluationInput;
+    /**
+     * The actions that were applied as a result of matching rules.
+     */
+    appliedActions?: RuleEvaluationAppliedActions;
+    /**
+     * IDs of the rules that matched during this evaluation.
+     */
+    matchedRuleIds?: string[];
+    /**
+     * The ID of the application this evaluation belongs to.
+     */
+    applicationId?: string;
+    /**
+     * The ID of the Nylas organization this evaluation belongs to.
+     */
+    organizationId?: string;
+    /**
+     * Unix timestamp when the evaluation record was created.
+     */
+    createdAt?: number;
+    /**
+     * Unix timestamp when the evaluation record was last updated.
+     */
+    updatedAt?: number;
+}
+/**
+ * Interface representing query parameters for listing rules.
+ */
+export type ListRulesQueryParams = ListQueryParams;
+/**
+ * Interface representing query parameters for listing rule evaluations.
+ */
+export type ListRuleEvaluationsQueryParams = ListQueryParams;

package/lib/types/nylas.d.ts

@@ -16,6 +16,9 @@ import { Contacts } from './resources/contacts.js';
 import { Attachments } from './resources/attachments.js';
 import { Scheduler } from './resources/scheduler.js';
 import { Notetakers } from './resources/notetakers.js';
+import { Policies } from './resources/policies.js';
+import { Rules } from './resources/rules.js';
+import { AgentLists } from './resources/agentLists.js';
 /**
  * The entry point to the Node SDK
  *
@@ -67,6 +70,18 @@ declare class Nylas {
      * Access the Notetakers API
      */
     notetakers: Notetakers;
+    /**
+     * Access the Agent Account Policies API
+     */
+    policies: Policies;
+    /**
+     * Access the Agent Account Rules API
+     */
+    rules: Rules;
+    /**
+     * Access the Agent Account Lists API
+     */
+    lists: AgentLists;
     /**
      * Access the Threads API
      */

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

@@ -0,0 +1,108 @@
+import { Overrides } from '../config.js';
+import { AddAgentListItemsRequest, AgentList, AgentListItem, CreateAgentListRequest, ListAgentListItemsQueryParams, ListAgentListsQueryParams, RemoveAgentListItemsRequest, UpdateAgentListRequest } from '../models/agentLists.js';
+import { NylasBaseResponse, NylasListResponse, NylasResponse } from '../models/response.js';
+import { AsyncListResponse, Resource } from './resource.js';
+/**
+ * @property queryParams The query parameters to include in the request.
+ */
+interface ListAgentListsParams {
+    queryParams?: ListAgentListsQueryParams;
+}
+/**
+ * @property listId The ID of the list to retrieve.
+ */
+interface FindAgentListParams {
+    listId: string;
+}
+/**
+ * @property requestBody The values to create the list with.
+ */
+interface CreateAgentListParams {
+    requestBody: CreateAgentListRequest;
+}
+/**
+ * @property listId The ID of the list to update.
+ * @property requestBody The values to update the list with.
+ */
+interface UpdateAgentListParams {
+    listId: string;
+    requestBody: UpdateAgentListRequest;
+}
+/**
+ * @property listId The ID of the list to delete.
+ */
+interface DestroyAgentListParams {
+    listId: string;
+}
+/**
+ * @property listId The ID of the list to list items from.
+ * @property queryParams The query parameters to include in the request.
+ */
+interface ListAgentListItemsParams {
+    listId: string;
+    queryParams?: ListAgentListItemsQueryParams;
+}
+/**
+ * @property listId The ID of the list to add items to.
+ * @property requestBody The values to add to the list.
+ */
+interface AddAgentListItemsParams {
+    listId: string;
+    requestBody: AddAgentListItemsRequest;
+}
+/**
+ * @property listId The ID of the list to remove items from.
+ * @property requestBody The values to remove from the list.
+ */
+interface RemoveAgentListItemsParams {
+    listId: string;
+    requestBody: RemoveAgentListItemsRequest;
+}
+/**
+ * Nylas Agent Account Lists API
+ *
+ * Lists manage values that rules can reference using the in_list operator.
+ */
+export declare class AgentLists extends Resource {
+    /**
+     * Return all lists.
+     * @return The list of Agent Account lists.
+     */
+    list({ queryParams, overrides, }?: ListAgentListsParams & Overrides): AsyncListResponse<NylasListResponse<AgentList>>;
+    /**
+     * Return a list.
+     * @return The Agent Account list.
+     */
+    find({ listId, overrides, }: FindAgentListParams & Overrides): Promise<NylasResponse<AgentList>>;
+    /**
+     * Create a list.
+     * @return The created Agent Account list.
+     */
+    create({ requestBody, overrides, }: CreateAgentListParams & Overrides): Promise<NylasResponse<AgentList>>;
+    /**
+     * Update a list.
+     * @return The updated Agent Account list.
+     */
+    update({ listId, requestBody, overrides, }: UpdateAgentListParams & Overrides): Promise<NylasResponse<AgentList>>;
+    /**
+     * Delete a list.
+     * @return The deletion response.
+     */
+    destroy({ listId, overrides, }: DestroyAgentListParams & Overrides): Promise<NylasBaseResponse>;
+    /**
+     * Return items in a list.
+     * @return The list items.
+     */
+    listItems({ listId, queryParams, overrides, }: ListAgentListItemsParams & Overrides): AsyncListResponse<NylasListResponse<AgentListItem>>;
+    /**
+     * Add items to a list.
+     * @return The updated Agent Account list.
+     */
+    addItems({ listId, requestBody, overrides, }: AddAgentListItemsParams & Overrides): Promise<NylasResponse<AgentList>>;
+    /**
+     * Remove items from a list.
+     * @return The updated Agent Account list.
+     */
+    removeItems({ listId, requestBody, overrides, }: RemoveAgentListItemsParams & Overrides): Promise<NylasResponse<AgentList>>;
+}
+export {};

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

@@ -1,5 +1,5 @@
 import { Overrides } from '../config.js';
-import { Attachment, FindAttachmentQueryParams, DownloadAttachmentQueryParams } from '../models/attachments.js';
+import { Attachment, AttachmentUploadSession, AttachmentUploadSessionComplete, CreateAttachmentUploadSessionRequest, FindAttachmentQueryParams, DownloadAttachmentQueryParams } from '../models/attachments.js';
 import { NylasResponse } from '../models/response.js';
 import { Resource } from './resource.js';
 /**
@@ -22,6 +22,22 @@ interface DownloadAttachmentParams {
     attachmentId: string;
     queryParams: DownloadAttachmentQueryParams;
 }
+/**
+ * @property identifier The ID of the grant to act upon.
+ * @property requestBody Session details (filename, content type, optional size).
+ */
+interface CreateAttachmentUploadSessionParams {
+    identifier: string;
+    requestBody: CreateAttachmentUploadSessionRequest;
+}
+/**
+ * @property identifier The ID of the grant to act upon.
+ * @property attachmentId The attachment upload session ID.
+ */
+interface CompleteAttachmentUploadSessionParams {
+    identifier: string;
+    attachmentId: string;
+}
 /**
  * Nylas Attachments API
  *
@@ -55,5 +71,19 @@ export declare class Attachments extends Resource {
      * @return The raw file data
      */
     downloadBytes({ identifier, attachmentId, queryParams, overrides, }: DownloadAttachmentParams & Overrides): Promise<Buffer>;
+    /**
+     * Create a resumable upload session for a large attachment (up to 150 MB).
+     * Upload bytes to the returned `url`, then call {@link Attachments.completeUploadSession}.
+     *
+     * @see https://developer.nylas.com/docs/v3/email/send-large-attachments/
+     * @return Session details including `attachmentId` and pre-signed `url`
+     */
+    createUploadSession({ identifier, requestBody, overrides, }: CreateAttachmentUploadSessionParams & Overrides): Promise<NylasResponse<AttachmentUploadSession>>;
+    /**
+     * Complete an upload session after the file has been uploaded to the pre-signed URL.
+     *
+     * @see https://developer.nylas.com/docs/v3/email/send-large-attachments/
+     */
+    completeUploadSession({ identifier, attachmentId, overrides, }: CompleteAttachmentUploadSessionParams & Overrides): Promise<NylasResponse<AttachmentUploadSessionComplete>>;
 }
 export {};

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

@@ -0,0 +1,69 @@
+import { Overrides } from '../config.js';
+import { CreatePolicyRequest, ListPoliciesQueryParams, Policy, UpdatePolicyRequest } from '../models/policies.js';
+import { NylasBaseResponse, NylasListResponse, NylasResponse } from '../models/response.js';
+import { AsyncListResponse, Resource } from './resource.js';
+/**
+ * @property queryParams The query parameters to include in the request.
+ */
+interface ListPoliciesParams {
+    queryParams?: ListPoliciesQueryParams;
+}
+/**
+ * @property policyId The ID of the policy to retrieve.
+ */
+interface FindPolicyParams {
+    policyId: string;
+}
+/**
+ * @property requestBody The values to create the policy with.
+ */
+interface CreatePolicyParams {
+    requestBody: CreatePolicyRequest;
+}
+/**
+ * @property policyId The ID of the policy to update.
+ * @property requestBody The values to update the policy with.
+ */
+interface UpdatePolicyParams {
+    policyId: string;
+    requestBody: UpdatePolicyRequest;
+}
+/**
+ * @property policyId The ID of the policy to delete.
+ */
+interface DestroyPolicyParams {
+    policyId: string;
+}
+/**
+ * Nylas Agent Account Policies API
+ *
+ * Policies define limits, spam settings, options, and linked rules for Agent Accounts.
+ */
+export declare class Policies extends Resource {
+    /**
+     * Return all policies.
+     * @return The list of policies.
+     */
+    list({ queryParams, overrides, }?: ListPoliciesParams & Overrides): AsyncListResponse<NylasListResponse<Policy>>;
+    /**
+     * Return a policy.
+     * @return The policy.
+     */
+    find({ policyId, overrides, }: FindPolicyParams & Overrides): Promise<NylasResponse<Policy>>;
+    /**
+     * Create a policy.
+     * @return The created policy.
+     */
+    create({ requestBody, overrides, }: CreatePolicyParams & Overrides): Promise<NylasResponse<Policy>>;
+    /**
+     * Update a policy.
+     * @return The updated policy.
+     */
+    update({ policyId, requestBody, overrides, }: UpdatePolicyParams & Overrides): Promise<NylasResponse<Policy>>;
+    /**
+     * Delete a policy.
+     * @return The deletion response.
+     */
+    destroy({ policyId, overrides, }: DestroyPolicyParams & Overrides): Promise<NylasBaseResponse>;
+}
+export {};

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

@@ -0,0 +1,82 @@
+import { Overrides } from '../config.js';
+import { CreateRuleRequest, ListRuleEvaluationsQueryParams, ListRulesQueryParams, Rule, RuleEvaluation, UpdateRuleRequest } from '../models/rules.js';
+import { NylasBaseResponse, NylasListResponse, NylasResponse } from '../models/response.js';
+import { AsyncListResponse, Resource } from './resource.js';
+/**
+ * @property queryParams The query parameters to include in the request.
+ */
+interface ListRulesParams {
+    queryParams?: ListRulesQueryParams;
+}
+/**
+ * @property ruleId The ID of the rule to retrieve.
+ */
+interface FindRuleParams {
+    ruleId: string;
+}
+/**
+ * @property requestBody The values to create the rule with.
+ */
+interface CreateRuleParams {
+    requestBody: CreateRuleRequest;
+}
+/**
+ * @property ruleId The ID of the rule to update.
+ * @property requestBody The values to update the rule with.
+ */
+interface UpdateRuleParams {
+    ruleId: string;
+    requestBody: UpdateRuleRequest;
+}
+/**
+ * @property ruleId The ID of the rule to delete.
+ */
+interface DestroyRuleParams {
+    ruleId: string;
+}
+/**
+ * @property identifier The identifier of the grant to list rule evaluations for.
+ * @property queryParams The query parameters to include in the request.
+ */
+interface ListRuleEvaluationsParams {
+    identifier: string;
+    queryParams?: ListRuleEvaluationsQueryParams;
+}
+/**
+ * Nylas Agent Account Rules API
+ *
+ * Rules define inbound and outbound filtering logic for Agent Accounts.
+ */
+export declare class Rules extends Resource {
+    /**
+     * Return all rules.
+     * @return The list of rules.
+     */
+    list({ queryParams, overrides, }?: ListRulesParams & Overrides): AsyncListResponse<NylasListResponse<Rule>>;
+    /**
+     * Return a rule.
+     * @return The rule.
+     */
+    find({ ruleId, overrides, }: FindRuleParams & Overrides): Promise<NylasResponse<Rule>>;
+    /**
+     * Create a rule.
+     * @return The created rule.
+     */
+    create({ requestBody, overrides, }: CreateRuleParams & Overrides): Promise<NylasResponse<Rule>>;
+    /**
+     * Update a rule.
+     * @return The updated rule.
+     */
+    update({ ruleId, requestBody, overrides, }: UpdateRuleParams & Overrides): Promise<NylasResponse<Rule>>;
+    /**
+     * Delete a rule.
+     * @return The deletion response.
+     */
+    destroy({ ruleId, overrides, }: DestroyRuleParams & Overrides): Promise<NylasBaseResponse>;
+    /**
+     * Return rule evaluation records for a grant.
+     * @return The list of rule evaluation records.
+     */
+    listEvaluations({ identifier, queryParams, overrides, }: ListRuleEvaluationsParams & Overrides): AsyncListResponse<NylasListResponse<RuleEvaluation>>;
+}
+export {};

package/lib/types/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "8.0.5";
+export declare const SDK_VERSION = "8.1.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nylas",
-  "version": "8.0.5",
+  "version": "8.1.0",
   "description": "A NodeJS wrapper for the Nylas REST API for email, contacts, and calendar.",
   "main": "lib/cjs/nylas.js",
   "types": "lib/types/nylas.d.ts",