nylas 8.1.2 → 8.3.0

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

@@ -1,4 +1,4 @@
-import { RedirectUri } from './redirectUri.js';
+import { RedirectUri, RedirectUriPlatform, RedirectUriSettings } from './redirectUri.js';
 /**
  * Interface for a Nylas application details object
  */
@@ -12,13 +12,17 @@ export interface ApplicationDetails {
      */
     organizationId: string;
     /**
-     * Region identifier
+     * Region identifier (e.g. `us`, `eu`). Free-form string, not a closed enum.
      */
-    region: 'us' | 'eu';
+    region: string;
     /**
-     * Environment identifier
+     * Environment identifier (e.g. `sandbox`). Free-form string, not a closed enum.
      */
-    environment: 'production' | 'staging';
+    environment: string;
+    /**
+     * White-label domain. Omitted when empty.
+     */
+    domain?: string;
     /**
      * Branding details for the application
      */
@@ -28,14 +32,33 @@ export interface ApplicationDetails {
      */
     hostedAuthentication?: HostedAuthentication;
     /**
-     * List of redirect URIs
+     * Identity provider (IdP) settings for the application
      */
-    redirectUris?: RedirectUri[];
+    idpSettings?: IdpSettings;
+    /**
+     * List of callback (redirect) URIs.
+     *
+     * Read-only on the application object; manage entries via the dedicated
+     * redirect-uris endpoints (`Nylas.applications.redirectUris`).
+     */
+    callbackUris?: RedirectUri[];
+    /**
+     * Unix timestamp (seconds) when the application was created. Omitted when empty.
+     */
+    createdAt?: number;
+    /**
+     * Unix timestamp (seconds) when the application was last updated. Omitted when empty.
+     */
+    updatedAt?: number;
+    /**
+     * Whether the application is blocked. Omitted when empty.
+     */
+    blocked?: boolean;
 }
 /**
  * Interface for branding details for the application
  */
-interface Branding {
+export interface Branding {
     /**
      * Name of the application
      */
@@ -49,14 +72,14 @@ interface Branding {
      */
     websiteUrl?: string;
     /**
-     * Description of the appli∏cati∏on
+     * Description of the application
      */
     description?: string;
 }
 /**
  * Interface for hosted authentication branding details
  */
-interface HostedAuthentication {
+export interface HostedAuthentication {
     /**
      * URL of the background image
      */
@@ -89,5 +112,120 @@ interface HostedAuthentication {
      * CSS spacing attribute in px
      */
     spacing?: number;
+    /**
+     * URL of the terms of service
+     */
+    termsOfServiceUrl?: string;
+    /**
+     * URL of the privacy policy
+     */
+    privacyPolicyUrl?: string;
+}
+/**
+ * Interface for identity provider (IdP) settings for the application
+ */
+export interface IdpSettings {
+    /**
+     * Comma-separated list of allowed origins. Each must be an absolute HTTPS URL
+     * (HTTP allowed for `localhost`/`127.0.0.1`) with no path, query, fragment, or userinfo.
+     */
+    origins?: string;
+    /**
+     * Comma-separated list of allowed issuers.
+     */
+    issuers?: string;
+}
+/**
+ * Interface for additional settings for the application.
+ *
+ * Write-only on update: these values can be set via `PATCH /v3/applications` but are
+ * stripped from every response, so they are not exposed on {@link ApplicationDetails}.
+ */
+export interface AdditionalSettings {
+    /**
+     * Login URL.
+     */
+    loginUrl?: string;
+    /**
+     * Logout URL.
+     */
+    logoutUrl?: string;
+    /**
+     * Absolute refresh-token expiration, in seconds.
+     */
+    refreshTokenExpirationAbsolute?: number;
+    /**
+     * Idle refresh-token expiration, in seconds.
+     */
+    refreshTokenExpirationIdle?: number;
+    /**
+     * Whether to rotate the refresh token on use.
+     */
+    rotateRefreshToken?: boolean;
+    /**
+     * Whether to allow query parameters in redirect URIs.
+     */
+    allowQueryParamInRedirectUri?: boolean;
+}
+/**
+ * Branding details accepted on the application update path.
+ *
+ * Unlike the response {@link Branding} type, `name` is optional here — the source does
+ * not require `branding.name` on `PATCH /v3/applications`.
+ */
+export type UpdateBranding = Partial<Branding>;
+/**
+ * Callback URI shape accepted by application updates.
+ */
+export interface UpdateApplicationRedirectUriRequest {
+    /**
+     * Existing callback URI ID. Include this when preserving or updating an existing URI.
+     */
+    id?: string;
+    /**
+     * Redirect URL.
+     */
+    url: string;
+    /**
+     * Platform identifier. One of `web`, `js`, `ios`, `android`, `desktop`.
+     * Defaults to `web` when omitted.
+     */
+    platform?: RedirectUriPlatform;
+    /**
+     * Optional settings for the redirect URI.
+     */
+    settings?: RedirectUriSettings;
+}
+/**
+ * Interface representing a request to update application details.
+ *
+ * All fields are optional; each supplied nested object is a full replace, not a deep merge.
+ */
+export interface UpdateApplicationRequest {
+    /**
+     * Branding details for the application.
+     */
+    branding?: UpdateBranding;
+    /**
+     * Hosted authentication branding details.
+     */
+    hostedAuthentication?: HostedAuthentication;
+    /**
+     * Identity provider (IdP) settings for the application.
+     */
+    idpSettings?: IdpSettings;
+    /**
+     * List of callback URIs for the application.
+     */
+    callbackUris?: UpdateApplicationRedirectUriRequest[];
+    /**
+     * White-label domain for the application.
+     */
+    domain?: string;
+    /**
+     * Additional settings for the application.
+     *
+     * Write-only: persisted on update but stripped from the response.
+     */
+    additionalSettings?: AdditionalSettings;
 }
-export {};

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

@@ -0,0 +1,177 @@
+import { ListQueryParams } from './listQueryParams.js';
+/**
+ * Type for the DNS verification types supported by the Manage Domains API.
+ */
+export type DomainVerificationType = 'ownership' | 'mx' | 'spf' | 'dkim' | 'feedback' | 'dmarc' | 'arc';
+/**
+ * Type for the DNS verification types accepted by Manage Domains info and
+ * verify request bodies.
+ */
+export type DomainVerificationRequestType = 'ownership' | 'mx' | 'spf' | 'dkim' | 'feedback';
+/**
+ * Type for the status of a domain DNS verification attempt.
+ */
+export type DomainVerificationStatus = 'pending' | 'done' | 'failed';
+/**
+ * Interface representing a registered email domain.
+ *
+ * Every field is optional: the API only emits fields it has populated.
+ */
+export interface Domain {
+    /**
+     * Server-generated domain ID.
+     */
+    id?: string;
+    /**
+     * Human-readable label.
+     */
+    name?: string;
+    /**
+     * The registered domain (for example, mail.example.com). Stored lowercased.
+     */
+    domainAddress?: string;
+    /**
+     * The ID of the organization that owns the domain. Derived from auth, never client-set.
+     */
+    organizationId?: string;
+    /**
+     * Whether the domain is a subdomain of a Nylas branded domain. Server-determined at create.
+     */
+    branded?: boolean;
+    /**
+     * Cluster region. Server-set from config at create.
+     */
+    region?: string;
+    /**
+     * Ownership (TXT) verification flag.
+     */
+    verifiedOwnership?: boolean;
+    /**
+     * MX verification flag.
+     */
+    verifiedMx?: boolean;
+    /**
+     * SPF verification flag.
+     */
+    verifiedSpf?: boolean;
+    /**
+     * Feedback MX verification flag.
+     */
+    verifiedFeedback?: boolean;
+    /**
+     * DKIM verification flag.
+     */
+    verifiedDkim?: boolean;
+    /**
+     * DMARC verification flag.
+     */
+    verifiedDmarc?: boolean;
+    /**
+     * ARC verification flag.
+     */
+    verifiedArc?: boolean;
+    /**
+     * Unix timestamp when the domain was created.
+     */
+    createdAt?: number;
+    /**
+     * Unix timestamp when the domain was last updated.
+     */
+    updatedAt?: number;
+}
+/**
+ * Interface representing a request to create a domain.
+ *
+ * Other Domain fields are not honored for create: the server sets region,
+ * branded, the verified flags, id, and timestamps.
+ */
+export interface CreateDomainRequest {
+    /**
+     * Human-readable label.
+     */
+    name: string;
+    /**
+     * The domain to register. Normalized to lowercase. Cannot duplicate an existing
+     * domain in the organization.
+     */
+    domainAddress: string;
+}
+/**
+ * Interface representing a request to update a domain.
+ *
+ * Only `name` is updatable. `domainAddress` cannot be changed after create;
+ * delete and recreate the domain to use a different address.
+ */
+export interface UpdateDomainRequest {
+    /**
+     * New human-readable label.
+     */
+    name?: string;
+}
+/**
+ * Interface representing a domain DNS verification attempt, used as the request
+ * body for both the Info and Verify endpoints.
+ */
+export interface DomainVerificationAttempt {
+    /**
+     * The DNS verification type to fetch info for or verify.
+     */
+    type: DomainVerificationRequestType;
+    /**
+     * Free-form options. For dkim, may carry a key-length hint. Most callers omit this.
+     */
+    options?: Record<string, any>;
+}
+/**
+ * Interface representing the DNS record details for a verification attempt
+ * returned in a verification result.
+ */
+export interface DomainVerificationAttemptResult {
+    /**
+     * The verification type that this attempt corresponds to.
+     */
+    type?: DomainVerificationType;
+    /**
+     * The DNS record values to configure (for example, host, type, and value).
+     */
+    options?: Record<string, any>;
+}
+/**
+ * Interface representing the result of a domain Info or Verify request.
+ *
+ * Info and Verify return the same shape. Every field is optional.
+ */
+export interface DomainVerificationResult {
+    /**
+     * The ID of the domain being verified.
+     */
+    domainId?: string;
+    /**
+     * The verification attempt, including the DNS record to configure.
+     */
+    attempt?: DomainVerificationAttemptResult;
+    /**
+     * The current status for this verification type.
+     */
+    status?: DomainVerificationStatus;
+    /**
+     * Unix timestamp when the attempt record was created.
+     */
+    createdAt?: number;
+    /**
+     * Unix timestamp when the temporary attempt expires.
+     */
+    expiresAt?: number;
+    /**
+     * Optional in-between state.
+     */
+    details?: Record<string, any>;
+    /**
+     * Human-readable instruction for configuring the DNS record.
+     */
+    message?: string;
+}
+/**
+ * Interface representing query parameters for listing domains.
+ */
+export type ListDomainsQueryParams = ListQueryParams;

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

@@ -314,6 +314,11 @@ export interface ListEventQueryParams extends ListQueryParams {
      * Master event id if recurring events.
      */
     masterEventId?: string;
+    /**
+     * Filter events by their iCalendar unique identifier.
+     * Useful for finding a specific event across calendaring systems.
+     */
+    icalUid?: string;
     /**
      * When set to false, treats tentative calendar events as busy:false.
      * Only applicable for Microsoft and EWS calendar providers. Defaults to true.

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

@@ -7,6 +7,7 @@ export * from './calendars.js';
 export * from './connectors.js';
 export * from './contacts.js';
 export * from './credentials.js';
+export * from './domains.js';
 export * from './drafts.js';
 export * from './error.js';
 export * from './events.js';
@@ -21,6 +22,8 @@ export * from './redirectUri.js';
 export * from './response.js';
 export * from './rules.js';
 export * from './scheduler.js';
+export * from './serviceAccount.js';
 export * from './smartCompose.js';
 export * from './threads.js';
 export * from './webhooks.js';
+export * from './workspaces.js';

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

@@ -342,6 +342,11 @@ export interface CleanMessagesRequest {
      * If true, removes phrases such as "Best" and "Regards" in the email message signature.
      */
     removeConclusionPhrases?: boolean;
+    /**
+     * If true, converts the cleaned HTML message body to Markdown.
+     * Note: This can't be true when imagesAsMarkdown is false.
+     */
+    htmlAsMarkdown?: boolean;
 }
 /**
  * Interface representing the response after cleaning a message.

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

@@ -24,9 +24,13 @@ export interface PolicyLimits {
      */
     limitStorageTotal?: number;
     /**
-     * Maximum number of messages each grant can send per day.
+     * Maximum number of messages each grant can receive per day. Use -1 for unlimited.
      */
-    limitCountDailyMessagePerGrant?: number;
+    limitCountDailyMessageReceived?: number;
+    /**
+     * Maximum number of emails each grant can send per day. Use -1 for unlimited.
+     */
+    limitCountDailyEmailSent?: number;
     /**
      * How long, in days, to retain messages in the inbox.
      */

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

@@ -1,3 +1,9 @@
+/**
+ * The platform of a Redirect URI.
+ *
+ * One of `web`, `js`, `ios`, `android`, or `desktop`. Defaults to `web` when omitted.
+ */
+export type RedirectUriPlatform = 'web' | 'js' | 'ios' | 'android' | 'desktop';
 /**
  * Interface representation of a Redirect URI object
  */
@@ -11,13 +17,17 @@ export type RedirectUri = {
      */
     url: string;
     /**
-     * Platform identifier
+     * Platform identifier. One of `web`, `js`, `ios`, `android`, `desktop`.
      */
-    platform: string;
+    platform: RedirectUriPlatform;
     /**
      * Configuration settings
      */
     settings?: RedirectUriSettings;
+    /**
+     * Unix timestamp (seconds) when the redirect URI was soft-deleted. Omitted when empty.
+     */
+    deletedAt?: number;
 };
 /**
  * Configuration settings for a Redirect URI object
@@ -57,9 +67,10 @@ export type CreateRedirectUriRequest = {
      */
     url: string;
     /**
-     * Platform identifier.
+     * Platform identifier. One of `web`, `js`, `ios`, `android`, `desktop`.
+     * Defaults to `web` when omitted.
      */
-    platform: string;
+    platform?: RedirectUriPlatform;
     /**
      * Optional settings for the redirect uri.
      */

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

@@ -230,6 +230,11 @@ export interface RuleEvaluationAppliedActions {
      * Whether the inbound message or outbound send was blocked.
      */
     blocked?: boolean;
+    /**
+     * Whether the message or send was blocked because an evaluation error
+     * triggered fail-closed handling, rather than a genuine rule match.
+     */
+    blockedByEvaluationError?: boolean;
     /**
      * Whether the message or stored sent copy was moved to spam.
      */
@@ -269,8 +274,9 @@ export interface RuleEvaluation {
     grantId: string;
     /**
      * The inbound message or stored sent copy associated with this evaluation.
+     * Omitted (absent) for smtp_rcpt evaluations and outbound sends with no stored copy.
      */
-    messageId?: string | null;
+    messageId?: string;
     /**
      * Unix timestamp when the evaluation occurred.
      */

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

@@ -0,0 +1,46 @@
+/**
+ * Configuration for Nylas Service Account request signing.
+ */
+export interface ServiceAccountSignerConfig {
+    /**
+     * RSA private key in PEM format. Base64-encoded PEM is also accepted.
+     */
+    privateKeyPem: string | Buffer;
+    /**
+     * The `private_key_id` from the Nylas Service Account credentials file.
+     */
+    privateKeyId: string;
+}
+/**
+ * Inputs for creating Nylas Service Account signing headers.
+ */
+export interface BuildServiceAccountHeadersParams {
+    method: string;
+    path: string;
+    body?: Record<string, unknown>;
+    timestamp?: number;
+    nonce?: string;
+}
+/**
+ * Nylas Service Account signing headers and the canonical JSON body, when the
+ * request method signs a payload.
+ */
+export interface ServiceAccountSignedRequest {
+    headers: Record<string, string>;
+    serializedBody?: string;
+}
+export declare function generateNonce(length?: number): string;
+/**
+ * Serialize JSON deterministically with sorted object keys and no extra
+ * whitespace, matching Nylas Service Account signing requirements.
+ */
+export declare function canonicalJson(data: Record<string, unknown>): string;
+/**
+ * Generates Nylas Service Account request signing headers.
+ */
+export declare class ServiceAccountSigner {
+    private readonly privateKey;
+    private readonly privateKeyId;
+    constructor({ privateKeyPem, privateKeyId }: ServiceAccountSignerConfig);
+    buildHeaders({ method, path, body, timestamp, nonce, }: BuildServiceAccountHeadersParams): ServiceAccountSignedRequest;
+}

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

@@ -151,3 +151,10 @@ export interface ListThreadsQueryParams extends ListQueryParams {
      */
     searchQueryNative?: string;
 }
+export interface FindThreadQueryParams {
+    /**
+     * Specify fields that you want Nylas to return
+     * as a comma-separated list (for example, select=id,updated_at).
+     */
+    select?: string;
+}