nylas 8.1.2 → 8.3.0

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

@@ -0,0 +1,191 @@
+/**
+ * Interface representing a Nylas workspace.
+ *
+ * A workspace groups grants in a Nylas application by email domain. Grants can be
+ * auto-grouped (by matching email domain) or manually assigned and removed.
+ */
+export interface Workspace {
+    /**
+     * Globally unique identifier for the workspace.
+     */
+    workspaceId: string;
+    /**
+     * The ID of the application that owns the workspace.
+     * Set server-side from the API key, never from the request body.
+     */
+    applicationId: string;
+    /**
+     * Descriptive name for the workspace.
+     */
+    name: string;
+    /**
+     * Top-level email domain for the workspace.
+     * May be an empty string when created with autoGroup false and no domain.
+     */
+    domain: string;
+    /**
+     * When true, new grants whose email domain matches domain are auto-assigned.
+     */
+    autoGroup: boolean;
+    /**
+     * When true, this is the application's default workspace.
+     */
+    default?: boolean;
+    /**
+     * The ID of the inbox policy attached to the workspace.
+     */
+    policyId?: string;
+    /**
+     * The IDs of the inbox rules attached to the workspace.
+     */
+    ruleIds?: string[];
+    /**
+     * Unix timestamp (seconds) when the workspace was created.
+     */
+    createdAt: number;
+    /**
+     * Unix timestamp (seconds) when the workspace was last updated.
+     */
+    updatedAt: number;
+}
+/**
+ * Interface representing a request to create a workspace.
+ */
+export interface CreateWorkspaceRequest {
+    /**
+     * Descriptive name for the workspace.
+     */
+    name: string;
+    /**
+     * Top-level email domain for the workspace.
+     * Optional: when omitted along with autoGroup, an empty-domain workspace is created.
+     */
+    domain?: string;
+    /**
+     * When true, new grants whose email domain matches domain are auto-assigned.
+     * Defaults server-side to true when a domain is provided, false otherwise.
+     */
+    autoGroup?: boolean;
+    /**
+     * The ID of the inbox policy to attach to the workspace.
+     */
+    policyId?: string;
+    /**
+     * The IDs of the inbox rules to attach to the workspace.
+     */
+    ruleIds?: string[];
+}
+/**
+ * Interface representing a request to update a workspace.
+ *
+ * Updates are issued as PATCH and address the workspace by its UUID only.
+ * At least one field must be provided.
+ */
+export interface UpdateWorkspaceRequest {
+    /**
+     * Descriptive name for the workspace. Omitted fields are preserved.
+     */
+    name?: string;
+    /**
+     * Top-level email domain. Changing the domain is rejected by the server;
+     * the domain is effectively immutable after creation.
+     */
+    domain?: string;
+    /**
+     * When true, new grants whose email domain matches domain are auto-assigned.
+     * Cannot be set to true on a workspace with an empty domain.
+     */
+    autoGroup?: boolean;
+    /**
+     * The ID of the inbox policy attached to the workspace.
+     * A UUID sets the policy, null clears it, and omitting preserves the current value.
+     */
+    policyId?: string | null;
+    /**
+     * The IDs of the inbox rules attached to the workspace.
+     * An array (including an empty array) overwrites; null or omitting preserves.
+     */
+    ruleIds?: string[] | null;
+}
+/**
+ * Interface representing query parameters for listing workspaces.
+ *
+ * The list endpoint is not paginated and accepts no query parameters.
+ */
+export type ListWorkspacesQueryParams = Record<string, never>;
+/**
+ * Interface representing a request to auto-group grants into workspaces.
+ *
+ * All fields are optional. Auto-grouping runs as a background job.
+ */
+export interface AutoGroupWorkspacesRequest {
+    /**
+     * Only group grants created at or after this Unix timestamp (seconds).
+     */
+    afterCreatedAt?: number;
+    /**
+     * When true, includes invalid grants in the grouping pass. Defaults to false.
+     */
+    invalidAlso?: boolean;
+    /**
+     * Only group grants whose email domain matches this domain.
+     */
+    specificDomain?: string;
+}
+/**
+ * Interface representing the response from starting an auto-group job.
+ */
+export interface AutoGroupWorkspacesResponse {
+    /**
+     * The ID of the background auto-group job.
+     */
+    jobId: string;
+    /**
+     * A human-readable message describing the started job.
+     */
+    message: string;
+}
+/**
+ * Interface representing a request to manually assign or remove grants
+ * for a workspace.
+ *
+ * At least one of assignGrants or removeGrants must contain a grant ID.
+ * Each list may contain at most 500 entries.
+ */
+export interface ManualAssignWorkspaceRequest {
+    /**
+     * Grant IDs to assign to the workspace. Maximum 500 entries.
+     */
+    assignGrants?: string[];
+    /**
+     * Grant IDs to remove from the workspace. Maximum 500 entries.
+     */
+    removeGrants?: string[];
+}
+/**
+ * Interface representing the response from manually assigning or removing grants.
+ */
+export interface ManualAssignWorkspaceResponse {
+    /**
+     * The ID of the application that owns the workspace.
+     */
+    applicationId: string;
+    /**
+     * The ID of the workspace that was updated.
+     */
+    workspaceId: string;
+    /**
+     * The domain of the workspace (empty string if none).
+     */
+    domain: string;
+    /**
+     * The grant IDs that were actually assigned.
+     * Serializes as null (not an empty array) when no assigned grant matched.
+     */
+    grantsAssigned: string[] | null;
+    /**
+     * The grant IDs that were actually removed.
+     * Serializes as null (not an empty array) when no removed grant matched.
+     */
+    grantsRemoved: string[] | null;
+}

package/lib/types/nylas.d.ts

@@ -16,8 +16,10 @@ 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 { Domains } from './resources/domains.js';
 import { Policies } from './resources/policies.js';
 import { Rules } from './resources/rules.js';
+import { Workspaces } from './resources/workspaces.js';
 import { AgentLists } from './resources/agentLists.js';
 /**
  * The entry point to the Node SDK
@@ -70,6 +72,10 @@ declare class Nylas {
      * Access the Notetakers API
      */
     notetakers: Notetakers;
+    /**
+     * Access the Manage Domains API
+     */
+    domains: Domains;
     /**
      * Access the Agent Account Policies API
      */
@@ -78,6 +84,10 @@ declare class Nylas {
      * Access the Agent Account Rules API
      */
     rules: Rules;
+    /**
+     * Access the Workspaces API
+     */
+    workspaces: Workspaces;
     /**
      * Access the Agent Account Lists API
      */

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

@@ -1,9 +1,15 @@
 import { Resource } from './resource.js';
 import { RedirectUris } from './redirectUris.js';
 import APIClient from '../apiClient.js';
-import { ApplicationDetails } from '../models/applicationDetails.js';
+import { ApplicationDetails, UpdateApplicationRequest } from '../models/applicationDetails.js';
 import { NylasResponse } from '../models/response.js';
 import { Overrides } from '../config.js';
+/**
+ * @property requestBody The values to update the application with.
+ */
+export interface UpdateApplicationParams {
+    requestBody: UpdateApplicationRequest;
+}
 /**
  * Nylas Applications API
  *
@@ -23,4 +29,11 @@ export declare class Applications extends Resource {
      * @returns The application details
      */
     getDetails({ overrides }?: Overrides): Promise<NylasResponse<ApplicationDetails>>;
+    /**
+     * Update application details.
+     *
+     * Each supplied nested object is a full replace, not a deep merge.
+     * @returns The updated application details
+     */
+    update({ requestBody, overrides, }: UpdateApplicationParams & Overrides): Promise<NylasResponse<ApplicationDetails>>;
 }

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

@@ -0,0 +1,137 @@
+import { Overrides } from '../config.js';
+import { CreateDomainRequest, Domain, DomainVerificationAttempt, DomainVerificationResult, ListDomainsQueryParams, UpdateDomainRequest } from '../models/domains.js';
+import { NylasBaseResponse, NylasListResponse, NylasResponse } from '../models/response.js';
+import { ServiceAccountSigner } from '../models/serviceAccount.js';
+import { AsyncListResponse, Resource } from './resource.js';
+/**
+ * @property queryParams The query parameters to include in the request.
+ */
+interface ListDomainsParams {
+    queryParams?: ListDomainsQueryParams;
+    signer?: ServiceAccountSigner;
+}
+/**
+ * @property domainId The ID of the domain to retrieve. Accepts either a domain
+ * UUID or a domain address (FQDN/email format).
+ */
+interface FindDomainParams {
+    domainId: string;
+    signer?: ServiceAccountSigner;
+}
+/**
+ * @property requestBody The values to create the domain with.
+ */
+interface CreateDomainParams {
+    requestBody: CreateDomainRequest;
+    signer?: ServiceAccountSigner;
+}
+/**
+ * @property domainId The ID of the domain to update. Accepts either a domain
+ * UUID or a domain address (FQDN/email format).
+ * @property requestBody The values to update the domain with.
+ */
+interface UpdateDomainParams {
+    domainId: string;
+    requestBody: UpdateDomainRequest;
+    signer?: ServiceAccountSigner;
+}
+/**
+ * @property domainId The ID of the domain to delete. Accepts either a domain
+ * UUID or a domain address (FQDN/email format).
+ */
+interface DestroyDomainParams {
+    domainId: string;
+    signer?: ServiceAccountSigner;
+}
+/**
+ * @property domainId The ID of the domain to fetch verification info for.
+ * Accepts either a domain UUID or a domain address (FQDN/email format).
+ * @property requestBody The verification attempt describing which DNS type to fetch info for.
+ */
+interface InfoDomainParams {
+    domainId: string;
+    requestBody: DomainVerificationAttempt;
+    signer?: ServiceAccountSigner;
+}
+/**
+ * @property domainId The ID of the domain to verify. Accepts either a domain
+ * UUID or a domain address (FQDN/email format).
+ * @property requestBody The verification attempt describing which DNS type to verify.
+ */
+interface VerifyDomainParams {
+    domainId: string;
+    requestBody: DomainVerificationAttempt;
+    signer?: ServiceAccountSigner;
+}
+/**
+ * Nylas Manage Domains API
+ *
+ * Register email domains and run their DNS verification flow
+ * (ownership / MX / SPF / DKIM / feedback) for Transactional Send and Nylas Inbound.
+ */
+export declare class Domains extends Resource {
+    private static readonly REQUIRED_SERVICE_ACCOUNT_HEADERS;
+    private assertServiceAccountSigningHeaders;
+    private buildSignedRequest;
+    /**
+     * Return all domains for the caller's organization.
+     *
+     * Requires Nylas Service Account request signing headers:
+     * X-Nylas-Kid, X-Nylas-Timestamp, X-Nylas-Nonce, and X-Nylas-Signature.
+     * @return The list of domains.
+     */
+    list({ queryParams, signer, overrides, }?: ListDomainsParams & Overrides): AsyncListResponse<NylasListResponse<Domain>>;
+    /**
+     * Return a domain.
+     *
+     * Requires Nylas Service Account request signing headers:
+     * X-Nylas-Kid, X-Nylas-Timestamp, X-Nylas-Nonce, and X-Nylas-Signature.
+     * @return The domain.
+     */
+    find({ domainId, signer, overrides, }: FindDomainParams & Overrides): Promise<NylasResponse<Domain>>;
+    /**
+     * Create a domain.
+     *
+     * Requires Nylas Service Account request signing headers:
+     * X-Nylas-Kid, X-Nylas-Timestamp, X-Nylas-Nonce, and X-Nylas-Signature.
+     * @return The created domain.
+     */
+    create({ requestBody, signer, overrides, }: CreateDomainParams & Overrides): Promise<NylasResponse<Domain>>;
+    /**
+     * Update a domain.
+     *
+     * Note: the response echoes the sparse cleared input (typically just `name`
+     * and `updatedAt`), not a full domain. Re-fetch the domain with `find` if you
+     * need the complete record.
+     *
+     * Requires Nylas Service Account request signing headers:
+     * X-Nylas-Kid, X-Nylas-Timestamp, X-Nylas-Nonce, and X-Nylas-Signature.
+     * @return The updated domain fields.
+     */
+    update({ domainId, requestBody, signer, overrides, }: UpdateDomainParams & Overrides): Promise<NylasResponse<Domain>>;
+    /**
+     * Delete a domain.
+     *
+     * Requires Nylas Service Account request signing headers:
+     * X-Nylas-Kid, X-Nylas-Timestamp, X-Nylas-Nonce, and X-Nylas-Signature.
+     * @return The deletion response.
+     */
+    destroy({ domainId, signer, overrides, }: DestroyDomainParams & Overrides): Promise<NylasBaseResponse>;
+    /**
+     * Get the DNS record a customer must configure for a given verification type.
+     *
+     * Requires Nylas Service Account request signing headers:
+     * X-Nylas-Kid, X-Nylas-Timestamp, X-Nylas-Nonce, and X-Nylas-Signature.
+     * @return The verification result, including the DNS record to configure.
+     */
+    info({ domainId, requestBody, signer, overrides, }: InfoDomainParams & Overrides): Promise<NylasResponse<DomainVerificationResult>>;
+    /**
+     * Trigger a DNS verification check for a given verification type.
+     *
+     * Requires Nylas Service Account request signing headers:
+     * X-Nylas-Kid, X-Nylas-Timestamp, X-Nylas-Nonce, and X-Nylas-Signature.
+     * @return The verification result, including the current status.
+     */
+    verify({ domainId, requestBody, signer, overrides, }: VerifyDomainParams & Overrides): Promise<NylasResponse<DomainVerificationResult>>;
+}
+export {};

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

@@ -56,7 +56,7 @@ export declare class RedirectUris extends Resource {
     update({ redirectUriId, requestBody, overrides, }: UpdateRedirectUrisParams & Overrides): Promise<NylasResponse<RedirectUri>>;
     /**
      * Delete a Redirect URI
-     * @return The deleted Redirect URI
+     * @return The deletion response
      */
-    destroy({ redirectUriId, overrides, }: DestroyRedirectUrisParams & Overrides): Promise<NylasResponse<NylasBaseResponse>>;
+    destroy({ redirectUriId, overrides, }: DestroyRedirectUrisParams & Overrides): Promise<NylasBaseResponse>;
 }

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

@@ -6,6 +6,7 @@ interface ListParams<T> {
     queryParams?: ListQueryParams;
     path: string;
     overrides?: OverridableNylasConfig;
+    getOverrides?: () => OverridableNylasConfig | undefined;
     useGenerator?: boolean;
 }
 interface FindParams<T> {
@@ -17,6 +18,7 @@ interface PayloadParams<T> {
     path: string;
     queryParams?: Record<string, any>;
     requestBody: Record<string, any>;
+    serializedBody?: string | Buffer;
     overrides?: OverridableNylasConfig;
 }
 interface DestroyParams {

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

@@ -1,4 +1,4 @@
-import { ListThreadsQueryParams, Thread, UpdateThreadRequest } from '../models/threads.js';
+import { FindThreadQueryParams, ListThreadsQueryParams, Thread, UpdateThreadRequest } from '../models/threads.js';
 import { AsyncListResponse, Resource } from './resource.js';
 import { Overrides } from '../config.js';
 import { NylasBaseResponse, NylasListResponse, NylasResponse } from '../models/response.js';
@@ -20,6 +20,7 @@ export interface ListThreadsParams {
 export interface FindThreadParams {
     identifier: string;
     threadId: string;
+    queryParams?: FindThreadQueryParams;
 }
 /**
  * The parameters for the {@link Threads.update} method
@@ -56,7 +57,7 @@ export declare class Threads extends Resource {
      * Return a Thread
      * @return The thread
      */
-    find({ identifier, threadId, overrides, }: FindThreadParams & Overrides): Promise<NylasResponse<Thread>>;
+    find({ identifier, threadId, overrides, queryParams, }: FindThreadParams & Overrides): Promise<NylasResponse<Thread>>;
     /**
      * Update a Thread
      * @return The updated thread

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

@@ -0,0 +1,98 @@
+import { Overrides } from '../config.js';
+import { AutoGroupWorkspacesRequest, AutoGroupWorkspacesResponse, CreateWorkspaceRequest, ListWorkspacesQueryParams, ManualAssignWorkspaceRequest, ManualAssignWorkspaceResponse, UpdateWorkspaceRequest, Workspace } from '../models/workspaces.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 ListWorkspacesParams {
+    queryParams?: ListWorkspacesQueryParams;
+}
+/**
+ * @property workspaceId The ID of the workspace to retrieve. Accepts a UUID or a domain.
+ */
+interface FindWorkspaceParams {
+    workspaceId: string;
+}
+/**
+ * @property requestBody The values to create the workspace with.
+ */
+interface CreateWorkspaceParams {
+    requestBody: CreateWorkspaceRequest;
+}
+/**
+ * @property workspaceId The UUID of the workspace to update. A domain is not accepted here.
+ * @property requestBody The values to update the workspace with.
+ */
+interface UpdateWorkspaceParams {
+    workspaceId: string;
+    requestBody: UpdateWorkspaceRequest;
+}
+/**
+ * @property workspaceId The ID of the workspace to delete. Accepts a UUID or a domain.
+ */
+interface DestroyWorkspaceParams {
+    workspaceId: string;
+}
+/**
+ * @property requestBody The auto-group filters to apply.
+ */
+interface AutoGroupWorkspacesParams {
+    requestBody?: AutoGroupWorkspacesRequest;
+}
+/**
+ * @property workspaceId The ID of the workspace to update. Accepts a UUID or a domain.
+ * @property requestBody The grants to assign and/or remove.
+ */
+interface ManualAssignWorkspaceParams {
+    workspaceId: string;
+    requestBody: ManualAssignWorkspaceRequest;
+}
+/**
+ * Nylas Workspaces API
+ *
+ * Workspaces group grants in a Nylas application by email domain. Grants can be
+ * auto-grouped by matching email domain or manually assigned and removed.
+ */
+export declare class Workspaces extends Resource {
+    /**
+     * Return all workspaces for the application.
+     *
+     * The list endpoint is not paginated and returns every workspace as a flat array.
+     * @return The list of workspaces.
+     */
+    list({ queryParams, overrides, }?: ListWorkspacesParams & Overrides): AsyncListResponse<NylasListResponse<Workspace>>;
+    /**
+     * Return a workspace.
+     * @return The workspace.
+     */
+    find({ workspaceId, overrides, }: FindWorkspaceParams & Overrides): Promise<NylasResponse<Workspace>>;
+    /**
+     * Create a workspace.
+     * @return The created workspace.
+     */
+    create({ requestBody, overrides, }: CreateWorkspaceParams & Overrides): Promise<NylasResponse<Workspace>>;
+    /**
+     * Update a workspace.
+     *
+     * Issued as PATCH; the workspace must be addressed by its UUID.
+     * @return The updated workspace.
+     */
+    update({ workspaceId, requestBody, overrides, }: UpdateWorkspaceParams & Overrides): Promise<NylasResponse<Workspace>>;
+    /**
+     * Delete a workspace.
+     * @return The deletion response.
+     */
+    destroy({ workspaceId, overrides, }: DestroyWorkspaceParams & Overrides): Promise<NylasBaseResponse>;
+    /**
+     * Start a background job that auto-groups grants into workspaces by email domain.
+     * @return The auto-group job response.
+     */
+    autoGroup({ requestBody, overrides, }?: AutoGroupWorkspacesParams & Overrides): Promise<NylasResponse<AutoGroupWorkspacesResponse>>;
+    /**
+     * Manually assign grants to and/or remove grants from a workspace.
+     * @return The assignment response.
+     */
+    manualAssign({ workspaceId, requestBody, overrides, }: ManualAssignWorkspaceParams & Overrides): Promise<NylasResponse<ManualAssignWorkspaceResponse>>;
+}
+export {};

package/lib/types/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "8.1.2";
+export declare const SDK_VERSION = "8.3.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nylas",
-  "version": "8.1.2",
+  "version": "8.3.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",