@espressif/rainmaker-admin-sdk 1.2.0 → 1.3.0

package/dist/types/types/input.d.ts

@@ -31,7 +31,7 @@ export type { UploadLicenseFileRequest, GetLicenseFileParams } from "./license.j
 export type { GenerateNodeIdsRequest, GetNodeIdsParams, GetNodeCertificatesParams, RegisterNodeCertificatesRequest, GetNodeCertificateRegistrationParams, } from "./node_registration.js";
 export type { ChangeSuperAdminRequest } from "./super_admin.js";
 export type { ChangeSenderEmailRequest } from "./sender_email.js";
-export type { SetCommonCustomDataRequest, GetCommonCustomDataParams, } from "./common_custom_data.js";
+export type { SetCommonCustomDataRequest, DeleteCommonCustomDataRequest, GetCommonCustomDataParams, } from "./common_custom_data.js";
 export type { GetDeploymentDetailsParams } from "./deployment_details.js";
 export type { UpdateDeploymentConfigRequest } from "./deployment_setting.js";
 export type { GetNotificationsParams, UpdateNotificationsRequest, } from "./configuration.js";
@@ -42,6 +42,7 @@ export type { CreateMobilePlatformRequest, UpdateMobilePlatformRequest, DeleteMo
 export type { PublishMessageQueryParams, PublishMessageRequest, } from "./publish_message.js";
 export type { CreatePassthroughConfigRequest, UpdatePassthroughConfigRequest, GetPassthroughConfigParams, } from "./passthrough.js";
 export type { UpdateNodeCACertificateRequest } from "./node_certificate_ca.js";
+export type { InitiateClaimRequest, VerifyClaimRequest, VerifyClaimOptions, } from "./claim.js";
 export type { CreateWebhookIntegrationRequest, UpdateWebhookIntegrationRequest, GetWebhookIntegrationsParams, DeleteWebhookIntegrationParams, UpdateWebhookEventMappingRequest, GetWebhookEventMappingParams, DeleteWebhookEventMappingParams, } from "./webhook.js";
 export type { GetStatsInfoParams } from "./statistical_service.js";
 export type { GetMailFailuresParams } from "./mail_failure.js";

package/dist/types/types/mainTypes.d.ts

@@ -52,5 +52,6 @@ import { ESPRMAdminAPIStatistics } from "../ESPRMAdminAPIStatistics.js";
 import { ESPRMAdminMQTTStatistics } from "../ESPRMAdminMQTTStatistics.js";
 import { ESPRMAdminMatter } from "../ESPRMAdminMatter.js";
 import { ESPRMAdminNodeParams } from "../ESPRMAdminNodeParams.js";
+import { ESPRMClaim } from "../ESPRMClaim.js";
 import "../methods/export.js";
-export { ESPRMAuth, ESPRMUser, ESPRMAdminUser, ESPRMAdminNode, ESPRMAdminOTAImage, ESPRMAdminOTAJob, ESPRMAdminGroup, ESPRMAdminTag, ESPRMAdminEventFilter, ESPRMAdminCustomData, ESPRMAdminRole, ESPRMAdminPolicy, ESPRMAdminUserRole, ESPRMAdminKey, ESPRMAdminSecureSign, ESPRMAdminFile, ESPRMAdminAPIInfo, ESPRMAdminDeploymentDetails, ESPRMAdminCognitoAppClient, ESPRMAdminCognitoDomain, ESPRMAdminIdentityProvider, ESPRMAdminMessageTemplate, ESPRMAdminDashboard, ESPRMAdminLicense, ESPRMAdminNodeRegistration, ESPRMAdminSuperAdmin, ESPRMAdminSenderEmail, ESPRMAdminCommonCustomData, ESPRMAdminDeploymentSetting, ESPRMAdminConfiguration, ESPRMAdminIoTDeviceRateLimit, ESPRMAdminAPIRateLimit, ESPRMAdminCustomMessageTemplate, ESPRMAdminMobilePlatform, ESPRMAdminPublishMessage, ESPRMAdminPassthrough, ESPRMAdminNodeCertificateCA, ESPRMAdminWebhook, ESPRMAdminStatisticalService, ESPRMAdminMailFailure, ESPRMAdminAPIGateway, ESPRMAdminTermsPolicy, ESPRMAdminCloudwatchLog, ESPRMAdminLogConfig, ESPRMAdminDeploymentCapability, ESPRMAdminAPIStatistics, ESPRMAdminMQTTStatistics, ESPRMAdminMatter, ESPRMAdminNodeParams, };
+export { ESPRMAuth, ESPRMUser, ESPRMAdminUser, ESPRMAdminNode, ESPRMAdminOTAImage, ESPRMAdminOTAJob, ESPRMAdminGroup, ESPRMAdminTag, ESPRMAdminEventFilter, ESPRMAdminCustomData, ESPRMAdminRole, ESPRMAdminPolicy, ESPRMAdminUserRole, ESPRMAdminKey, ESPRMAdminSecureSign, ESPRMAdminFile, ESPRMAdminAPIInfo, ESPRMAdminDeploymentDetails, ESPRMAdminCognitoAppClient, ESPRMAdminCognitoDomain, ESPRMAdminIdentityProvider, ESPRMAdminMessageTemplate, ESPRMAdminDashboard, ESPRMAdminLicense, ESPRMAdminNodeRegistration, ESPRMAdminSuperAdmin, ESPRMAdminSenderEmail, ESPRMAdminCommonCustomData, ESPRMAdminDeploymentSetting, ESPRMAdminConfiguration, ESPRMAdminIoTDeviceRateLimit, ESPRMAdminAPIRateLimit, ESPRMAdminCustomMessageTemplate, ESPRMAdminMobilePlatform, ESPRMAdminPublishMessage, ESPRMAdminPassthrough, ESPRMAdminNodeCertificateCA, ESPRMAdminWebhook, ESPRMAdminStatisticalService, ESPRMAdminMailFailure, ESPRMAdminAPIGateway, ESPRMAdminTermsPolicy, ESPRMAdminCloudwatchLog, ESPRMAdminLogConfig, ESPRMAdminDeploymentCapability, ESPRMAdminAPIStatistics, ESPRMAdminMQTTStatistics, ESPRMAdminMatter, ESPRMAdminNodeParams, ESPRMClaim, };

package/dist/types/types/node.d.ts

@@ -3,6 +3,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+import type { ESPAPISuccessResponse } from "./api.js";
 /** Parameters for listing admin nodes. */
 export interface GetAdminNodesParams {
     /** Maximum number of records to return. */
@@ -34,11 +35,40 @@ export interface GetAdminNodesParams {
 }
 /** Parameters for activating or deactivating nodes. */
 export interface ActivateDeactivateNodesParams {
-    /** ID of the node to activate or deactivate. */
-    node_id: string;
-    /** Whether to activate (true) or deactivate (false) the node. */
+    /**
+     * IDs of the nodes to activate or deactivate. At most
+     * `MAX_NODE_ACTIVATION_BATCH_SIZE` (25) per request.
+     */
+    node_ids: string[];
+    /** Whether to activate (true) or deactivate (false) the nodes. */
     activate: boolean;
 }
+/** Per-node success entry in a 207 activation response. */
+export interface NodeActivationSuccessResult {
+    node_id: string;
+    status: "success";
+    description: string;
+}
+/** Per-node failure entry in a 207 activation response. */
+export interface NodeActivationFailureResult {
+    node_id: string;
+    status: "failure";
+    error_code: number;
+    description: string;
+}
+/**
+ * 207 Multi-Status response from `PUT admin/nodes`, returned when the
+ * per-node outcomes differ.
+ */
+export interface NodeActivationMultiStatusResponse {
+    responses: Array<NodeActivationSuccessResult | NodeActivationFailureResult>;
+}
+/**
+ * Response from `activateDeactivateNodes`. When every node has the same
+ * outcome the backend returns a single 200 success; otherwise 207 with
+ * per-node results. A uniform failure rejects with `ESPAPIError`.
+ */
+export type ActivateDeactivateNodesResponse = ESPAPISuccessResponse | NodeActivationMultiStatusResponse;
 /** Parameters for listing node tags or tag values. */
 export interface GetNodeTagsParams {
     /** Filter by tag name to retrieve its associated tag values. */

package/dist/types/types/output.d.ts

@@ -29,7 +29,7 @@ export type { GetDashboardUpdateStatusResponse, GetDashboardVersionMappingRespon
 export type { LicenseFileInfo, GetLicenseFileResponse, GetLicenseQuotaResponse, } from "./license.js";
 export type { GenerateNodeIdsResponse, GetNodeIdsResponse, NodeCertificateInfo, GetNodeCertificatesResponse, NodeCertificateRegistrationStatusResponse, GetMQTTHostResponse, } from "./node_registration.js";
 export type { GetDeploymentDetailsResponse } from "./deployment_details.js";
-export type { GetCommonCustomDataResponse } from "./common_custom_data.js";
+export type { CommonCustomDataItem, GetCommonCustomDataResponse, } from "./common_custom_data.js";
 export type { GetDeploymentSettingsResponse, GetRbacDeploymentSettingResponse, RbacConfigurationValue, } from "./deployment_setting.js";
 export type { GetNotificationsResponse } from "./configuration.js";
 export type { GetIoTDeviceRateRuleResponse } from "./iot_device_rate_limit.js";
@@ -38,6 +38,7 @@ export type { CustomMessageTemplateInfo, GetCustomMessageTemplatesResponse, } fr
 export type { MobilePlatformInfo, CreateMobilePlatformResponse, GetMobilePlatformsResponse, } from "./mobile_platform.js";
 export type { PassthroughConfigInfo, CreatePassthroughConfigResponse, GetPassthroughConfigResponse, } from "./passthrough.js";
 export type { GetNodeCACertificateResponse } from "./node_certificate_ca.js";
+export type { InitiateClaimResponse, VerifyClaimResponse } from "./claim.js";
 export type { WebhookIntegrationInfo, GetWebhookIntegrationsResponse, WebhookEventMappingInfo, GetWebhookEventMappingResponse, } from "./webhook.js";
 export type { StatsCount, StatsObject, GetStatsInfoResponse, } from "./statistical_service.js";
 export type { MailFailureInfo, GetMailFailuresResponse } from "./mail_failure.js";

package/dist/types/types/webhook.d.ts

@@ -63,8 +63,11 @@ export interface WebhookIntegrationInfo {
 }
 /** Response containing a list of webhook integrations. */
 export interface GetWebhookIntegrationsResponse {
-    /** Array of webhook integration details. */
-    webhooks_endpoints?: WebhookIntegrationInfo[];
+    /**
+     * Array of webhook integration details.
+     * The backend returns `null` when no integrations are configured.
+     */
+    integration_info_list?: WebhookIntegrationInfo[] | null;
 }
 /** Details of a webhook event mapping. */
 export interface WebhookEventMappingInfo {

package/dist/types/utils/constants.d.ts

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

package/dist/types/utils/error/errorMessages.d.ts

@@ -7,6 +7,8 @@ declare const configErrorMessages: {
     SDK_NOT_CONFIGURED: string;
     INVALID_CONFIG_OBJECT: string;
     INVALID_BASE_URL: string;
+    INVALID_CLAIMING_BASE_URL: string;
+    CLAIMING_NOT_CONFIGURED: string;
 };
 declare const validationErrorMessages: {
     MISSING_LOGIN_PASSWORD: string;
@@ -18,6 +20,8 @@ declare const storageAdapterErrorMessages: {
 };
 declare const apiCallValidationErrorMessages: {
     MISSING_NODE_ID: string;
+    MISSING_NODE_IDS: string;
+    TOO_MANY_NODE_IDS: string;
     MISSING_OTA_IMAGE_ID: string;
     MISSING_ARCHIVE_FLAG: string;
     MISSING_OTA_JOB_ID: string;
@@ -54,6 +58,11 @@ declare const apiCallValidationErrorMessages: {
     MISSING_BATCH_ID: string;
     MISSING_CANCEL_COMMAND_SCOPE: string;
     CMD_ID_REQUIRES_NODE_ID: string;
+    MISSING_COMMON_CUSTOM_DATA_NAME: string;
+    MISSING_COMMON_CUSTOM_DATA_VALUE: string;
+    MISSING_MAC_ADDRESS: string;
+    MISSING_CLAIM_PLATFORM: string;
+    MISSING_CSR: string;
 };
 declare const tokenErrorMessages: {
     MISSING_ACCESS_TOKEN: string;

package/dist/types/utils/validator/ConfigValidator.d.ts

@@ -7,5 +7,6 @@ import { ESPRMBaseConfig } from "../../types/config.js";
 export declare class ConfigValidator {
     static validateConfig(config: ESPRMBaseConfig): void;
     private static validateConfigObject;
+    private static validateClaimingBaseUrl;
     private static validateBaseUrl;
 }

package/dist/types-cjs/ESPRMClaim.d.cts

@@ -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-cjs/entries/ESPRMClaim.d.cts

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

package/dist/types-cjs/methods/ESPRMAdminCommonCustomData/DeleteCommonCustomData.d.cts

@@ -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.cjs";
+import { ESPAPISuccessResponse } from "../../types/api.cjs";
+declare module "../../ESPRMAdminCommonCustomData.cjs" {
+    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-cjs/methods/ESPRMAdminCommonCustomData/SetCommonCustomData.d.cts

@@ -8,10 +8,15 @@ import { ESPAPISuccessResponse } from "../../types/api.cjs";
 declare module "../../ESPRMAdminCommonCustomData.cjs" {
     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-cjs/methods/ESPRMAdminCommonCustomData/index.d.cts

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

package/dist/types-cjs/methods/ESPRMAdminEventFilter/UpdateEventFilter.d.cts

@@ -10,6 +10,11 @@ declare module "../../ESPRMAdminEventFilter.cjs" {
         /**
          * 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-cjs/methods/ESPRMAdminNode/ActivateDeactivateNodes.d.cts

@@ -3,16 +3,19 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-import { ActivateDeactivateNodesParams } from "../../types/node.cjs";
-import { ESPAPISuccessResponse } from "../../types/api.cjs";
+import { ActivateDeactivateNodesParams, ActivateDeactivateNodesResponse } from "../../types/node.cjs";
 declare module "../../ESPRMAdminNode.cjs" {
     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-cjs/methods/ESPRMAdminNode/DeleteNode.d.cts

@@ -0,0 +1,19 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ESPAPISuccessResponse } from "../../types/api.cjs";
+declare module "../../ESPRMAdminNode.cjs" {
+    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-cjs/methods/ESPRMAdminNode/index.d.cts

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

package/dist/types-cjs/methods/ESPRMAdminWebhook/GetWebhookIntegrations.d.cts

@@ -11,7 +11,8 @@ declare module "../../ESPRMAdminWebhook.cjs" {
          * 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-cjs/methods/ESPRMClaim/InitiateClaim.d.cts

@@ -0,0 +1,21 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { InitiateClaimRequest, InitiateClaimResponse } from "../../types/claim.cjs";
+declare module "../../ESPRMClaim.cjs" {
+    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-cjs/methods/ESPRMClaim/VerifyClaim.d.cts

@@ -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.cjs";
+declare module "../../ESPRMClaim.cjs" {
+    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-cjs/methods/ESPRMClaim/index.d.cts

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

package/dist/types-cjs/methods/export.d.cts

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

package/dist/types-cjs/services/ESPRMAPIManager.d.cts

@@ -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-cjs/types/claim.d.cts

@@ -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-cjs/types/common_custom_data.d.cts

@@ -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-cjs/types/config.d.cts

@@ -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-cjs/types/event_filter.d.cts

@@ -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-cjs/types/index.d.cts

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

package/dist/types-cjs/types/input.d.cts

@@ -31,7 +31,7 @@ export type { UploadLicenseFileRequest, GetLicenseFileParams } from "./license.c
 export type { GenerateNodeIdsRequest, GetNodeIdsParams, GetNodeCertificatesParams, RegisterNodeCertificatesRequest, GetNodeCertificateRegistrationParams, } from "./node_registration.cjs";
 export type { ChangeSuperAdminRequest } from "./super_admin.cjs";
 export type { ChangeSenderEmailRequest } from "./sender_email.cjs";
-export type { SetCommonCustomDataRequest, GetCommonCustomDataParams, } from "./common_custom_data.cjs";
+export type { SetCommonCustomDataRequest, DeleteCommonCustomDataRequest, GetCommonCustomDataParams, } from "./common_custom_data.cjs";
 export type { GetDeploymentDetailsParams } from "./deployment_details.cjs";
 export type { UpdateDeploymentConfigRequest } from "./deployment_setting.cjs";
 export type { GetNotificationsParams, UpdateNotificationsRequest, } from "./configuration.cjs";
@@ -42,6 +42,7 @@ export type { CreateMobilePlatformRequest, UpdateMobilePlatformRequest, DeleteMo
 export type { PublishMessageQueryParams, PublishMessageRequest, } from "./publish_message.cjs";
 export type { CreatePassthroughConfigRequest, UpdatePassthroughConfigRequest, GetPassthroughConfigParams, } from "./passthrough.cjs";
 export type { UpdateNodeCACertificateRequest } from "./node_certificate_ca.cjs";
+export type { InitiateClaimRequest, VerifyClaimRequest, VerifyClaimOptions, } from "./claim.cjs";
 export type { CreateWebhookIntegrationRequest, UpdateWebhookIntegrationRequest, GetWebhookIntegrationsParams, DeleteWebhookIntegrationParams, UpdateWebhookEventMappingRequest, GetWebhookEventMappingParams, DeleteWebhookEventMappingParams, } from "./webhook.cjs";
 export type { GetStatsInfoParams } from "./statistical_service.cjs";
 export type { GetMailFailuresParams } from "./mail_failure.cjs";

package/dist/types-cjs/types/mainTypes.d.cts

@@ -52,5 +52,6 @@ import { ESPRMAdminAPIStatistics } from "../ESPRMAdminAPIStatistics.cjs";
 import { ESPRMAdminMQTTStatistics } from "../ESPRMAdminMQTTStatistics.cjs";
 import { ESPRMAdminMatter } from "../ESPRMAdminMatter.cjs";
 import { ESPRMAdminNodeParams } from "../ESPRMAdminNodeParams.cjs";
+import { ESPRMClaim } from "../ESPRMClaim.cjs";
 import "../methods/export.cjs";
-export { ESPRMAuth, ESPRMUser, ESPRMAdminUser, ESPRMAdminNode, ESPRMAdminOTAImage, ESPRMAdminOTAJob, ESPRMAdminGroup, ESPRMAdminTag, ESPRMAdminEventFilter, ESPRMAdminCustomData, ESPRMAdminRole, ESPRMAdminPolicy, ESPRMAdminUserRole, ESPRMAdminKey, ESPRMAdminSecureSign, ESPRMAdminFile, ESPRMAdminAPIInfo, ESPRMAdminDeploymentDetails, ESPRMAdminCognitoAppClient, ESPRMAdminCognitoDomain, ESPRMAdminIdentityProvider, ESPRMAdminMessageTemplate, ESPRMAdminDashboard, ESPRMAdminLicense, ESPRMAdminNodeRegistration, ESPRMAdminSuperAdmin, ESPRMAdminSenderEmail, ESPRMAdminCommonCustomData, ESPRMAdminDeploymentSetting, ESPRMAdminConfiguration, ESPRMAdminIoTDeviceRateLimit, ESPRMAdminAPIRateLimit, ESPRMAdminCustomMessageTemplate, ESPRMAdminMobilePlatform, ESPRMAdminPublishMessage, ESPRMAdminPassthrough, ESPRMAdminNodeCertificateCA, ESPRMAdminWebhook, ESPRMAdminStatisticalService, ESPRMAdminMailFailure, ESPRMAdminAPIGateway, ESPRMAdminTermsPolicy, ESPRMAdminCloudwatchLog, ESPRMAdminLogConfig, ESPRMAdminDeploymentCapability, ESPRMAdminAPIStatistics, ESPRMAdminMQTTStatistics, ESPRMAdminMatter, ESPRMAdminNodeParams, };
+export { ESPRMAuth, ESPRMUser, ESPRMAdminUser, ESPRMAdminNode, ESPRMAdminOTAImage, ESPRMAdminOTAJob, ESPRMAdminGroup, ESPRMAdminTag, ESPRMAdminEventFilter, ESPRMAdminCustomData, ESPRMAdminRole, ESPRMAdminPolicy, ESPRMAdminUserRole, ESPRMAdminKey, ESPRMAdminSecureSign, ESPRMAdminFile, ESPRMAdminAPIInfo, ESPRMAdminDeploymentDetails, ESPRMAdminCognitoAppClient, ESPRMAdminCognitoDomain, ESPRMAdminIdentityProvider, ESPRMAdminMessageTemplate, ESPRMAdminDashboard, ESPRMAdminLicense, ESPRMAdminNodeRegistration, ESPRMAdminSuperAdmin, ESPRMAdminSenderEmail, ESPRMAdminCommonCustomData, ESPRMAdminDeploymentSetting, ESPRMAdminConfiguration, ESPRMAdminIoTDeviceRateLimit, ESPRMAdminAPIRateLimit, ESPRMAdminCustomMessageTemplate, ESPRMAdminMobilePlatform, ESPRMAdminPublishMessage, ESPRMAdminPassthrough, ESPRMAdminNodeCertificateCA, ESPRMAdminWebhook, ESPRMAdminStatisticalService, ESPRMAdminMailFailure, ESPRMAdminAPIGateway, ESPRMAdminTermsPolicy, ESPRMAdminCloudwatchLog, ESPRMAdminLogConfig, ESPRMAdminDeploymentCapability, ESPRMAdminAPIStatistics, ESPRMAdminMQTTStatistics, ESPRMAdminMatter, ESPRMAdminNodeParams, ESPRMClaim, };