@espressif/rainmaker-admin-sdk 1.2.0 → 1.3.0

package/dist/esm/methods/ESPRMAdminCommonCustomData/SetCommonCustomData.js

@@ -5,9 +5,16 @@
  */
 import { ESPRMAdminCommonCustomData } from '../../ESPRMAdminCommonCustomData.js';
 import { ESPRMAPIManager } from '../../services/ESPRMAPIManager.js';
-import { HTTPMethods, APIEndpoints } from '../../utils/constants.js';
+import { APICallValidationErrorCodes, HTTPMethods, APIEndpoints } from '../../utils/constants.js';
+import { ESPAPICallValidationError } from '../../utils/error/ESPAPICallValidationError.js';
 
 ESPRMAdminCommonCustomData.prototype.setCommonCustomData = async function (params) {
+    if (!params.name) {
+        throw new ESPAPICallValidationError(APICallValidationErrorCodes.MISSING_COMMON_CUSTOM_DATA_NAME);
+    }
+    if (params.value === null || params.value === undefined) {
+        throw new ESPAPICallValidationError(APICallValidationErrorCodes.MISSING_COMMON_CUSTOM_DATA_VALUE);
+    }
     const requestConfig = {
         url: APIEndpoints.ADMIN_COMMON_CUSTOM_DATA,
         method: HTTPMethods.PUT,

package/dist/esm/methods/ESPRMAdminNode/ActivateDeactivateNodes.js

@@ -5,13 +5,23 @@
  */
 import { ESPRMAdminNode } from '../../ESPRMAdminNode.js';
 import { ESPRMAPIManager } from '../../services/ESPRMAPIManager.js';
-import { HTTPMethods, APIEndpoints } from '../../utils/constants.js';
+import { APICallValidationErrorCodes, MAX_NODE_ACTIVATION_BATCH_SIZE, HTTPMethods, APIEndpoints } from '../../utils/constants.js';
+import { ESPAPICallValidationError } from '../../utils/error/ESPAPICallValidationError.js';
 
 ESPRMAdminNode.prototype.activateDeactivateNodes = async function (params) {
+    const nodeIds = params.node_ids?.filter(Boolean) ?? [];
+    if (nodeIds.length === 0) {
+        throw new ESPAPICallValidationError(APICallValidationErrorCodes.MISSING_NODE_IDS);
+    }
+    if (nodeIds.length > MAX_NODE_ACTIVATION_BATCH_SIZE) {
+        throw new ESPAPICallValidationError(APICallValidationErrorCodes.TOO_MANY_NODE_IDS);
+    }
+    // The backend reads both values from the query string only; a JSON body
+    // on this endpoint is parsed as node tags.
     const requestConfig = {
         url: APIEndpoints.ADMIN_NODES,
         method: HTTPMethods.PUT,
-        data: params,
+        params: { node_id: nodeIds.join(","), activate: params.activate },
     };
     const response = await ESPRMAPIManager.authorizeRequest(requestConfig);
     return response;

package/dist/esm/methods/ESPRMAdminNode/DeleteNode.js

@@ -0,0 +1,22 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ESPRMAdminNode } from '../../ESPRMAdminNode.js';
+import { ESPRMAPIManager } from '../../services/ESPRMAPIManager.js';
+import { APICallValidationErrorCodes, HTTPMethods, APIEndpoints } from '../../utils/constants.js';
+import { ESPAPICallValidationError } from '../../utils/error/ESPAPICallValidationError.js';
+
+ESPRMAdminNode.prototype.deleteNode = async function (nodeId) {
+    if (!nodeId) {
+        throw new ESPAPICallValidationError(APICallValidationErrorCodes.MISSING_NODE_ID);
+    }
+    const requestConfig = {
+        url: APIEndpoints.ADMIN_NODES,
+        method: HTTPMethods.DELETE,
+        params: { node_id: nodeId, delete_node: true },
+    };
+    const response = await ESPRMAPIManager.authorizeRequest(requestConfig);
+    return response;
+};

package/dist/esm/methods/ESPRMClaim/InitiateClaim.js

@@ -0,0 +1,26 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ESPRMClaim } from '../../ESPRMClaim.js';
+import { ESPRMAPIManager } from '../../services/ESPRMAPIManager.js';
+import { APICallValidationErrorCodes, HTTPMethods, APIEndpoints } from '../../utils/constants.js';
+import { ESPAPICallValidationError } from '../../utils/error/ESPAPICallValidationError.js';
+
+ESPRMClaim.prototype.initiateClaim = async function (params) {
+    if (!params.mac_addr) {
+        throw new ESPAPICallValidationError(APICallValidationErrorCodes.MISSING_MAC_ADDRESS);
+    }
+    if (!params.platform) {
+        throw new ESPAPICallValidationError(APICallValidationErrorCodes.MISSING_CLAIM_PLATFORM);
+    }
+    const requestConfig = {
+        baseURL: ESPRMAPIManager.getClaimingBaseUrl(),
+        url: APIEndpoints.CLAIM_INITIATE,
+        method: HTTPMethods.POST,
+        data: params,
+    };
+    const response = await ESPRMAPIManager.authorizeRequest(requestConfig);
+    return response;
+};

package/dist/esm/methods/ESPRMClaim/VerifyClaim.js

@@ -0,0 +1,26 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ESPRMClaim } from '../../ESPRMClaim.js';
+import { ESPRMAPIManager } from '../../services/ESPRMAPIManager.js';
+import { APICallValidationErrorCodes, HTTPMethods, APIEndpoints } from '../../utils/constants.js';
+import { ESPAPICallValidationError } from '../../utils/error/ESPAPICallValidationError.js';
+
+ESPRMClaim.prototype.verifyClaim = async function (params, options = {}) {
+    if (!params.csr) {
+        throw new ESPAPICallValidationError(APICallValidationErrorCodes.MISSING_CSR);
+    }
+    const matter = options.matter ?? false;
+    const requestConfig = {
+        baseURL: ESPRMAPIManager.getClaimingBaseUrl(),
+        url: APIEndpoints.CLAIM_VERIFY,
+        method: HTTPMethods.POST,
+        data: params,
+        // The service ignores `test` unless `matter` is true.
+        params: matter ? { matter, test: options.test ?? false } : { matter },
+    };
+    const response = await ESPRMAPIManager.authorizeRequest(requestConfig);
+    return response;
+};

package/dist/esm/services/ESPRMAPIManager.js

@@ -19,10 +19,12 @@ class ESPRMAPIManager {
     static #instance;
     #baseUrl;
     #timeoutMs;
+    #claimingBaseUrl;
     constructor(config) {
-        const { baseUrl, version, timeoutMs } = config;
+        const { baseUrl, version, timeoutMs, claimingBaseUrl } = config;
         this.#baseUrl = `${baseUrl}/${version}`;
         this.#timeoutMs = timeoutMs ?? DEFAULT_REQUEST_TIMEOUT_MS;
+        this.#claimingBaseUrl = claimingBaseUrl?.replace(/\/+$/, "");
     }
     static initialize(config) {
         ESPRMAPIManager.#instance = new ESPRMAPIManager(config);
@@ -33,6 +35,18 @@ class ESPRMAPIManager {
         }
         return ESPRMAPIManager.#instance;
     }
+    /**
+     * Base URL of the claiming service set through `claimingBaseUrl`.
+     *
+     * @throws ESPConfigError `CLAIMING_NOT_CONFIGURED` when it was not configured.
+     */
+    static getClaimingBaseUrl() {
+        const claimingBaseUrl = ESPRMAPIManager.#getInstance().#claimingBaseUrl;
+        if (!claimingBaseUrl) {
+            throw new ESPConfigError(ConfigErrorCodes.CLAIMING_NOT_CONFIGURED);
+        }
+        return claimingBaseUrl;
+    }
     /**
      * Send a request with the current user's access token in the
      * `Authorization` header, refreshing the token first if it has expired.

package/dist/esm/utils/constants.js

@@ -94,6 +94,8 @@ const APIEndpoints = {
     ADMIN_MATTER_BATCH: "admin/matter/batch",
     ADMIN_MATTER_BATCH_NODES: "admin/matter/batch/nodes",
     ADMIN_MAIL_FAILURES: "admin/mail_failures",
+    CLAIM_INITIATE: "claim/initiate",
+    CLAIM_VERIFY: "claim/verify",
 };
 const StorageKeys = {
     ACCESSTOKEN: "com.esprmbase.accessToken",
@@ -104,6 +106,8 @@ const ConfigErrorCodes = {
     SDK_NOT_CONFIGURED: "SDK_NOT_CONFIGURED",
     INVALID_CONFIG_OBJECT: "INVALID_CONFIG_OBJECT",
     INVALID_BASE_URL: "INVALID_BASE_URL",
+    INVALID_CLAIMING_BASE_URL: "INVALID_CLAIMING_BASE_URL",
+    CLAIMING_NOT_CONFIGURED: "CLAIMING_NOT_CONFIGURED",
 };
 const ValidationErrorCodes = {
     MISSING_LOGIN_PASSWORD: "MISSING_LOGIN_PASSWORD",
@@ -151,6 +155,13 @@ const APICallValidationErrorCodes = {
     MISSING_BATCH_ID: "MISSING_BATCH_ID",
     MISSING_CANCEL_COMMAND_SCOPE: "MISSING_CANCEL_COMMAND_SCOPE",
     CMD_ID_REQUIRES_NODE_ID: "CMD_ID_REQUIRES_NODE_ID",
+    MISSING_COMMON_CUSTOM_DATA_NAME: "MISSING_COMMON_CUSTOM_DATA_NAME",
+    MISSING_COMMON_CUSTOM_DATA_VALUE: "MISSING_COMMON_CUSTOM_DATA_VALUE",
+    MISSING_MAC_ADDRESS: "MISSING_MAC_ADDRESS",
+    MISSING_CLAIM_PLATFORM: "MISSING_CLAIM_PLATFORM",
+    MISSING_CSR: "MISSING_CSR",
+    MISSING_NODE_IDS: "MISSING_NODE_IDS",
+    TOO_MANY_NODE_IDS: "TOO_MANY_NODE_IDS",
 };
 const TokenErrorCodes = {
     MISSING_ACCESS_TOKEN: "MISSING_ACCESS_TOKEN",
@@ -176,10 +187,12 @@ const DEFAULT_REST_API_VERSION = "v1";
 const DEFAULT_REQUEST_TIMEOUT_MS = 30000;
 /** Tokens expiring within this many seconds are refreshed proactively. */
 const TOKEN_EXPIRY_MARGIN_SECONDS = 30;
+/** Backend limit on node IDs per `PUT admin/nodes` activation request. */
+const MAX_NODE_ACTIVATION_BATCH_SIZE = 25;
 /** errorCode values the SDK itself sets on ESPAPIError for non-HTTP failures. */
 const APIErrorCodes = {
     REQUEST_TIMEOUT: "REQUEST_TIMEOUT",
     NETWORK_ERROR: "NETWORK_ERROR",
 };
 
-export { APICallValidationErrorCodes, APIEndpoints, APIErrorCodes, AdditionalInfo, ConfigErrorCodes, DEFAULT_REQUEST_TIMEOUT_MS, DEFAULT_REST_API_VERSION, ErrorLabels, HTTPMethods, HTTPStatusCodes, StorageAdapterErrorCodes, StorageKeys, TOKEN_EXPIRY_MARGIN_SECONDS, TokenErrorCodes, ValidationErrorCodes };
+export { APICallValidationErrorCodes, APIEndpoints, APIErrorCodes, AdditionalInfo, ConfigErrorCodes, DEFAULT_REQUEST_TIMEOUT_MS, DEFAULT_REST_API_VERSION, ErrorLabels, HTTPMethods, HTTPStatusCodes, MAX_NODE_ACTIVATION_BATCH_SIZE, StorageAdapterErrorCodes, StorageKeys, TOKEN_EXPIRY_MARGIN_SECONDS, TokenErrorCodes, ValidationErrorCodes };

package/dist/esm/utils/error/errorMessages.js

@@ -7,6 +7,8 @@ const configErrorMessages = {
     SDK_NOT_CONFIGURED: "ESPRMBase is not configured yet",
     INVALID_CONFIG_OBJECT: "Configuration Error: Config must be a non-null object.",
     INVALID_BASE_URL: "Configuration Error: BaseUrl must be a non-empty valid URL string.",
+    INVALID_CLAIMING_BASE_URL: "Configuration Error: claimingBaseUrl must be a non-empty valid URL string.",
+    CLAIMING_NOT_CONFIGURED: "Configuration Error: claimingBaseUrl is not configured. Pass it to ESPRMBase.configure to use ESPRMClaim.",
 };
 const validationErrorMessages = {
     MISSING_LOGIN_PASSWORD: "Validation Error: Password is required.",
@@ -18,6 +20,8 @@ const storageAdapterErrorMessages = {
 };
 const apiCallValidationErrorMessages = {
     MISSING_NODE_ID: "ESPAPICallValidationError: Node ID is required.",
+    MISSING_NODE_IDS: "ESPAPICallValidationError: At least one node ID is required.",
+    TOO_MANY_NODE_IDS: "ESPAPICallValidationError: Too many node IDs; at most 25 are allowed per request.",
     MISSING_OTA_IMAGE_ID: "ESPAPICallValidationError: OTA image ID is required.",
     MISSING_ARCHIVE_FLAG: "ESPAPICallValidationError: Archive flag is required and must be a boolean.",
     MISSING_OTA_JOB_ID: "ESPAPICallValidationError: OTA job ID is required.",
@@ -54,6 +58,11 @@ const apiCallValidationErrorMessages = {
     MISSING_BATCH_ID: "ESPAPICallValidationError: Batch ID is required.",
     MISSING_CANCEL_COMMAND_SCOPE: "ESPAPICallValidationError: Request ID or node ID is required.",
     CMD_ID_REQUIRES_NODE_ID: "ESPAPICallValidationError: Command ID can only be used together with a node ID.",
+    MISSING_COMMON_CUSTOM_DATA_NAME: "ESPAPICallValidationError: Common custom data name is required.",
+    MISSING_COMMON_CUSTOM_DATA_VALUE: "ESPAPICallValidationError: Common custom data value is required. Use deleteCommonCustomData to delete an entry.",
+    MISSING_MAC_ADDRESS: "ESPAPICallValidationError: MAC address is required (12 uppercase hex characters, no separators).",
+    MISSING_CLAIM_PLATFORM: "ESPAPICallValidationError: Claim platform is required.",
+    MISSING_CSR: "ESPAPICallValidationError: Certificate signing request (CSR) is required.",
 };
 const tokenErrorMessages = {
     MISSING_ACCESS_TOKEN: "ESPTokenError: Access token is missing. User needs to authenticate.",

package/dist/esm/utils/validator/ConfigValidator.js

@@ -11,12 +11,21 @@ class ConfigValidator {
     static validateConfig(config) {
         ConfigValidator.validateConfigObject(config);
         ConfigValidator.validateBaseUrl(config.baseUrl);
+        ConfigValidator.validateClaimingBaseUrl(config.claimingBaseUrl);
     }
     static validateConfigObject(config) {
         if (!isValidObject(config)) {
             throw new ESPConfigError(ConfigErrorCodes.INVALID_CONFIG_OBJECT);
         }
     }
+    static validateClaimingBaseUrl(claimingBaseUrl) {
+        if (claimingBaseUrl === undefined) {
+            return;
+        }
+        if (!isNonEmptyString(claimingBaseUrl) || !isValidUrl(claimingBaseUrl)) {
+            throw new ESPConfigError(ConfigErrorCodes.INVALID_CLAIMING_BASE_URL);
+        }
+    }
     static validateBaseUrl(baseUrl) {
         if (!isNonEmptyString(baseUrl) || !isValidUrl(baseUrl)) {
             throw new ESPConfigError(ConfigErrorCodes.INVALID_BASE_URL);

package/dist/types/ESPRMClaim.d.ts

@@ -0,0 +1,12 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Shell class for the standalone ESP RainMaker claiming service.
+ * Requires `claimingBaseUrl` in {@link ESPRMBase.configure}.
+ * Methods are added via prototype augmentation in methods/ESPRMClaim/*.
+ */
+export declare class ESPRMClaim {
+}

package/dist/types/entries/ESPRMClaim.d.ts

@@ -0,0 +1,7 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import "../methods/ESPRMClaim/index.js";
+export { ESPRMClaim } from "../ESPRMClaim.js";

package/dist/types/methods/ESPRMAdminCommonCustomData/DeleteCommonCustomData.d.ts

@@ -0,0 +1,22 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { DeleteCommonCustomDataRequest } from "../../types/common_custom_data.js";
+import { ESPAPISuccessResponse } from "../../types/api.js";
+declare module "../../ESPRMAdminCommonCustomData.js" {
+    interface ESPRMAdminCommonCustomData {
+        /**
+         * Deletes a common custom data entry.
+         *
+         * The backend has no DELETE method for this resource; an entry is deleted
+         * by sending `PUT admin/common_custom_data` with `value: null`.
+         *
+         * @param params - The name of the entry to delete.
+         * @returns A success response confirming the entry was deleted.
+         * @throws ESPAPICallValidationError when `name` is empty.
+         */
+        deleteCommonCustomData(params: DeleteCommonCustomDataRequest): Promise<ESPAPISuccessResponse>;
+    }
+}

package/dist/types/methods/ESPRMAdminCommonCustomData/SetCommonCustomData.d.ts

@@ -8,10 +8,15 @@ import { ESPAPISuccessResponse } from "../../types/api.js";
 declare module "../../ESPRMAdminCommonCustomData.js" {
     interface ESPRMAdminCommonCustomData {
         /**
-         * Sets or updates common custom data shared across users.
+         * Adds or updates a common custom data entry shared across users.
+         *
+         * JSON object values are deep merged into the stored object; other value
+         * types replace it. See {@link SetCommonCustomDataRequest}.
          *
          * @param params - The common custom data payload to set.
          * @returns A success response confirming the data was set.
+         * @throws ESPAPICallValidationError when `name` is empty, or when `value`
+         *   is `null` or `undefined` (the backend would delete the entry).
          */
         setCommonCustomData(params: SetCommonCustomDataRequest): Promise<ESPAPISuccessResponse>;
     }

package/dist/types/methods/ESPRMAdminCommonCustomData/index.d.ts

@@ -5,3 +5,4 @@
  */
 import "./SetCommonCustomData.js";
 import "./GetCommonCustomData.js";
+import "./DeleteCommonCustomData.js";

package/dist/types/methods/ESPRMAdminEventFilter/UpdateEventFilter.d.ts

@@ -10,6 +10,11 @@ declare module "../../ESPRMAdminEventFilter.js" {
         /**
          * Updates an existing event filter configuration.
          *
+         * `enabled_for_integrations` adds or removes integrations instead of
+         * replacing the stored list; see {@link UpdateEventFilterRequest}. Omit it
+         * to change only `enabled`. Fails with error code `113109` when the
+         * mapping does not exist (this call never creates one).
+         *
          * @param params - The updated event filter properties.
          * @returns A success response confirming the event filter was updated.
          */

package/dist/types/methods/ESPRMAdminNode/ActivateDeactivateNodes.d.ts

@@ -3,16 +3,19 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-import { ActivateDeactivateNodesParams } from "../../types/node.js";
-import { ESPAPISuccessResponse } from "../../types/api.js";
+import { ActivateDeactivateNodesParams, ActivateDeactivateNodesResponse } from "../../types/node.js";
 declare module "../../ESPRMAdminNode.js" {
     interface ESPRMAdminNode {
         /**
-         * Activates or deactivates nodes based on the provided parameters.
+         * Activates or deactivates up to 25 nodes in one request. Supported only
+         * on private (customer) deployments.
          *
-         * @param params - Parameters specifying which nodes to activate or deactivate.
-         * @returns A success response confirming the operation.
+         * The backend returns a single success when every node has the same
+         * outcome, and a 207 response with per-node results when they differ.
+         *
+         * @param params - Node IDs and whether to activate or deactivate them.
+         * @returns A success response, or per-node results on mixed outcomes.
          */
-        activateDeactivateNodes(params: ActivateDeactivateNodesParams): Promise<ESPAPISuccessResponse>;
+        activateDeactivateNodes(params: ActivateDeactivateNodesParams): Promise<ActivateDeactivateNodesResponse>;
     }
 }

package/dist/types/methods/ESPRMAdminNode/DeleteNode.d.ts

@@ -0,0 +1,19 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ESPAPISuccessResponse } from "../../types/api.js";
+declare module "../../ESPRMAdminNode.js" {
+    interface ESPRMAdminNode {
+        /**
+         * Permanently deletes a node: its IoT certificates and thing, its data,
+         * and its user and group mappings. Cannot be undone. Supported only on
+         * public deployments; the backend accepts one node per request.
+         *
+         * @param nodeId - The ID of the node to delete.
+         * @returns A success response confirming the node was deleted.
+         */
+        deleteNode(nodeId: string): Promise<ESPAPISuccessResponse>;
+    }
+}

package/dist/types/methods/ESPRMAdminNode/index.d.ts

@@ -7,6 +7,7 @@ import "./GetNodes.js";
 import "./ActivateDeactivateNodes.js";
 import "./AttachNodeTags.js";
 import "./RemoveNodeTags.js";
+import "./DeleteNode.js";
 import "./GetNodeTags.js";
 import "./GetCommandRequests.js";
 import "./AddCommandRequest.js";

package/dist/types/methods/ESPRMAdminWebhook/GetWebhookIntegrations.d.ts

@@ -11,7 +11,8 @@ declare module "../../ESPRMAdminWebhook.js" {
          * Retrieves the list of configured webhook integrations.
          *
          * @param params - Optional filtering parameters for the webhook integrations query.
-         * @returns The response containing webhook integration details.
+         * @returns The response containing webhook integration details in
+         * `integration_info_list`, which is `null` when none are configured.
          */
         getWebhookIntegrations(params?: GetWebhookIntegrationsParams): Promise<GetWebhookIntegrationsResponse>;
     }

package/dist/types/methods/ESPRMClaim/InitiateClaim.d.ts

@@ -0,0 +1,21 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { InitiateClaimRequest, InitiateClaimResponse } from "../../types/claim.js";
+declare module "../../ESPRMClaim.js" {
+    interface ESPRMClaim {
+        /**
+         * Starts authenticated claiming of a node for the signed in user.
+         * The claim expires a few minutes after it is created, so call
+         * {@link ESPRMClaim.verifyClaim} promptly.
+         *
+         * @param params - MAC address and platform of the node.
+         * @returns The node ID assigned to the node.
+         * @throws ESPConfigError `CLAIMING_NOT_CONFIGURED` without `claimingBaseUrl`.
+         * @throws ESPAPICallValidationError when `mac_addr` or `platform` is empty.
+         */
+        initiateClaim(params: InitiateClaimRequest): Promise<InitiateClaimResponse>;
+    }
+}

package/dist/types/methods/ESPRMClaim/VerifyClaim.d.ts

@@ -0,0 +1,21 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { VerifyClaimOptions, VerifyClaimRequest, VerifyClaimResponse } from "../../types/claim.js";
+declare module "../../ESPRMClaim.js" {
+    interface ESPRMClaim {
+        /**
+         * Completes a claim started with {@link ESPRMClaim.initiateClaim} by
+         * submitting the node's CSR, and returns the signed node certificate.
+         *
+         * @param params - CSR plus optional node policies and MQTT host request.
+         * @param options - Matter and Matter test CA flags.
+         * @returns The node certificate, and MQTT hosts when requested.
+         * @throws ESPConfigError `CLAIMING_NOT_CONFIGURED` without `claimingBaseUrl`.
+         * @throws ESPAPICallValidationError when `csr` is empty.
+         */
+        verifyClaim(params: VerifyClaimRequest, options?: VerifyClaimOptions): Promise<VerifyClaimResponse>;
+    }
+}

package/dist/types/methods/ESPRMClaim/index.d.ts

@@ -0,0 +1,7 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import "./InitiateClaim.js";
+import "./VerifyClaim.js";

package/dist/types/methods/export.d.ts

@@ -40,6 +40,7 @@ import "./ESPRMAdminMobilePlatform/index.js";
 import "./ESPRMAdminPublishMessage/index.js";
 import "./ESPRMAdminPassthrough/index.js";
 import "./ESPRMAdminNodeCertificateCA/index.js";
+import "./ESPRMClaim/index.js";
 import "./ESPRMAdminWebhook/index.js";
 import "./ESPRMAdminStatisticalService/index.js";
 import "./ESPRMAdminMailFailure/index.js";

package/dist/types/services/ESPRMAPIManager.d.ts

@@ -13,6 +13,12 @@ export declare class ESPRMAPIManager {
     #private;
     private constructor();
     static initialize(config: ESPRMAPIManagerConfig): void;
+    /**
+     * Base URL of the claiming service set through `claimingBaseUrl`.
+     *
+     * @throws ESPConfigError `CLAIMING_NOT_CONFIGURED` when it was not configured.
+     */
+    static getClaimingBaseUrl(): string;
     /**
      * Send a request with the current user's access token in the
      * `Authorization` header, refreshing the token first if it has expired.

package/dist/types/types/claim.d.ts

@@ -0,0 +1,45 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Request body for `POST claim/initiate` (authenticated claiming). */
+export interface InitiateClaimRequest {
+    /** Node MAC address: 12 uppercase hex characters, no separators, e.g. `7CDFA100033B`. */
+    mac_addr: string;
+    /** Platform the node is claimed for, e.g. `ESP32` or `ESP32S3`. */
+    platform: string;
+}
+/** Response of `POST claim/initiate` for authenticated claiming. */
+export interface InitiateClaimResponse {
+    /** Node ID assigned to the claimed node. */
+    node_id: string;
+}
+/** Request body for `POST claim/verify` (authenticated claiming). */
+export interface VerifyClaimRequest {
+    /** PEM encoded certificate signing request for the node key, with `CN=<node_id>`. */
+    csr: string;
+    /** When true, the response also carries `mqtt_host` and `mqtt_cred_host`. */
+    send_mqtt_host?: boolean;
+    /**
+     * Comma separated node policies to attach, e.g. `videostream`. The
+     * `mqtt` policy is always attached by the backend.
+     */
+    node_policies?: string;
+}
+/** Query options for `POST claim/verify`. */
+export interface VerifyClaimOptions {
+    /** Issue a Matter compliant node certificate. Defaults to false. */
+    matter?: boolean;
+    /** Use the Matter test CA. Only sent when `matter` is true. */
+    test?: boolean;
+}
+/** Response of `POST claim/verify`. */
+export interface VerifyClaimResponse {
+    /** PEM encoded node certificate chain. */
+    certificate: string;
+    /** MQTT endpoint, present when `send_mqtt_host` was true. */
+    mqtt_host?: string;
+    /** MQTT credentials endpoint, present when `send_mqtt_host` was true. */
+    mqtt_cred_host?: string;
+}

package/dist/types/types/common_custom_data.d.ts

@@ -3,19 +3,46 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-/** Request body for setting a common custom data entry. */
+/**
+ * Request body for adding or updating a common custom data entry.
+ *
+ * `PUT admin/common_custom_data` is an upsert with merge semantics:
+ * - When the stored value and `value` are both JSON objects, they are deep
+ *   merged. Keys omitted from `value` are kept, and a nested `null` deletes
+ *   that key.
+ * - Arrays, strings, numbers and booleans replace the stored value.
+ * - A `null` or missing `value` deletes the whole entry, so `value` must be
+ *   defined here. Use `deleteCommonCustomData` to delete.
+ */
 export interface SetCommonCustomDataRequest {
     /** Name of the custom data entry. */
     name: string;
-    /** Value to assign to the custom data entry. */
+    /** Value to assign to the custom data entry. Must not be `null` or `undefined`. */
     value: unknown;
 }
+/** Request for deleting a common custom data entry. */
+export interface DeleteCommonCustomDataRequest {
+    /** Name of the custom data entry to delete. */
+    name: string;
+}
 /** Parameters for retrieving common custom data. */
 export interface GetCommonCustomDataParams {
     /** Name of the custom data entry to retrieve. */
     name?: string;
 }
-/** Response containing common custom data as dynamic key-value pairs. */
-export interface GetCommonCustomDataResponse {
-    [key: string]: unknown;
+/** A single common custom data entry. */
+export interface CommonCustomDataItem {
+    /** Name of the custom data entry. */
+    name: string;
+    /** Stored value: a JSON object, array, string, number or boolean. */
+    value: unknown;
+    /** RBAC permissions attached to the entry, when any were set. */
+    perms?: unknown[];
 }
+/**
+ * Response of `GET admin/common_custom_data`.
+ *
+ * Always an array: every entry when `name` is omitted, or a single-element
+ * array when `name` is given.
+ */
+export type GetCommonCustomDataResponse = CommonCustomDataItem[];

package/dist/types/types/config.d.ts

@@ -21,12 +21,21 @@ export interface ESPRMBaseConfig {
      * `errorCode` is `REQUEST_TIMEOUT`. Defaults to 30000. Set to `0` to disable.
      */
     timeoutMs?: number;
+    /**
+     * Base URL of the standalone ESP RainMaker claiming service, e.g.
+     * `https://esp-claiming.rainmaker.espressif.com`. Required only for
+     * `ESPRMClaim`; the service is available on public deployments only.
+     * The user's access token is sent to this host, so only set it to a
+     * trusted Espressif claiming endpoint.
+     */
+    claimingBaseUrl?: string;
 }
 /** Configuration for the ESPRMAPIManager. */
 export interface ESPRMAPIManagerConfig {
     baseUrl: string;
     version: string;
     timeoutMs?: number;
+    claimingBaseUrl?: string;
 }
 /** Configuration for an API request made through ESPRMAPIManager. */
 export interface ESPRMRequestConfig {

package/dist/types/types/event_filter.d.ts

@@ -24,10 +24,24 @@ export interface UpdateEventFilterRequest {
     entity_id: string;
     /** Type of entity. */
     entity_type: string;
-    /** Whether this filter is enabled. */
+    /**
+     * Whether this filter is enabled. When `enabled_for_integrations` is
+     * omitted or empty, this value is stored as sent. When it is non-empty,
+     * the backend derives `enabled` itself (see `enabled_for_integrations`).
+     */
     enabled: boolean;
-    /** Integration types this filter is enabled for. */
-    enabled_for_integrations: string[];
+    /**
+     * Integrations to add or remove. This is **not** a replacement list:
+     * - omitted or `[]`: the stored list is kept unchanged.
+     * - with `enabled: true`: the listed integrations are added to the stored list.
+     * - with `enabled: false`: the listed integrations are removed from the stored list.
+     *
+     * When a non-empty list is sent, the backend overrides `enabled`: it becomes
+     * `false` if the resulting list is empty, otherwise `true`, except that a
+     * filter already stored as disabled (with a non-empty list) stays disabled.
+     * To set `enabled` explicitly, send a separate update without this field.
+     */
+    enabled_for_integrations?: string[];
 }
 /** Parameters for listing event filters. */
 export interface GetEventFiltersParams {

package/dist/types/types/index.d.ts

@@ -44,6 +44,7 @@ export * from "./mobile_platform.js";
 export * from "./publish_message.js";
 export * from "./passthrough.js";
 export * from "./node_certificate_ca.js";
+export * from "./claim.js";
 export * from "./webhook.js";
 export * from "./statistical_service.js";
 export * from "./mail_failure.js";