@espressif/rainmaker-admin-sdk 1.1.1 → 1.3.0

package/dist/types-cjs/methods/ESPRMAdminNodeRegistration/RegisterNodeCertificates.d.cts

@@ -3,16 +3,16 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-import { RegisterNodeCertificatesRequest } from "../../types/node_registration.cjs";
-import { ESPAPISuccessResponse } from "../../types/api.cjs";
+import { RegisterNodeCertificatesRequest, RegisterNodeCertificatesResponse } from "../../types/node_registration.cjs";
 declare module "../../ESPRMAdminNodeRegistration.cjs" {
     interface ESPRMAdminNodeRegistration {
         /**
-         * Registers node certificates for device authentication.
+         * Triggers registration of the node certificates in a CSV that was
+         * uploaded to the URL from `getNodeCertificateUploadUrl`.
          *
-         * @param params - The certificate data to register.
-         * @returns A success response upon registration.
+         * @param params - The uploaded file details and registration options.
+         * @returns The ID of the registration request.
          */
-        registerNodeCertificates(params: RegisterNodeCertificatesRequest): Promise<ESPAPISuccessResponse>;
+        registerNodeCertificates(params: RegisterNodeCertificatesRequest): Promise<RegisterNodeCertificatesResponse>;
     }
 }

package/dist/types-cjs/methods/ESPRMAdminNodeRegistration/index.d.cts

@@ -8,5 +8,8 @@ import "./GetNodeIds.cjs";
 import "./GetNodeCertificates.cjs";
 import "./GetNodeCertificateRegistrationStatus.cjs";
 import "./RegisterNodeCertificates.cjs";
+import "./GetNodeCertificateUploadUrl.cjs";
 import "./GetMQTTHost.cjs";
 import "./GetCustomMQTTHost.cjs";
+import "./ListNodeRegistrationRequests.cjs";
+import "./GetNodeRegistrationRequest.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/command_response.d.cts

@@ -3,6 +3,19 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+/**
+ * Lifecycle status of a command request.
+ *
+ * - `requested`: created, not yet delivered to the node
+ * - `in_progress`: delivered to the node, awaiting its response
+ * - `success` / `failure`: the node reported the result
+ * - `timed_out`: the timeout elapsed before the command completed
+ * - `overridden`: replaced by a later request sent with `override: true`
+ * - `cancelled`: cancelled through the cancel API
+ */
+export type CommandRequestStatus = "requested" | "in_progress" | "success" | "failure" | "timed_out" | "overridden" | "cancelled";
+/** Error marker set when stored request or response data cannot be decoded. */
+export type CommandRequestDataError = "ERROR_DESERIALIZE_JSON";
 /** Parameters for listing command requests. */
 export interface GetCommandRequestsParams {
     /** Filter by specific request ID. */
@@ -10,10 +23,13 @@ export interface GetCommandRequestsParams {
     /** Filter by node ID. */
     node_id?: string;
     /** Filter by request status. */
-    status?: string;
-    /** Filter requests created after this timestamp. */
+    status?: CommandRequestStatus;
+    /**
+     * Start of the request time range, in epoch seconds. Must be sent with
+     * `end_time`, and requires the `cmd_resp_history` deployment setting.
+     */
     start_time?: number;
-    /** Filter requests created before this timestamp. */
+    /** End of the request time range, in epoch seconds. Must be sent with `start_time`. */
     end_time?: number;
     /** Filter by command ID. */
     cmd_id?: number;
@@ -44,25 +60,37 @@ export interface CommandRequestInfo {
     /** Unique identifier of the command request. */
     request_id: string;
     /** Current status of the request. */
-    status: string;
+    status: CommandRequestStatus;
     /** Device-reported status code. */
     device_status?: number;
     /** Human-readable description of the status. */
     status_description?: string;
     /** Data sent in the request. */
     request_data?: unknown;
+    /** Set instead of `request_data` when the stored request data cannot be decoded. */
+    request_data_error?: CommandRequestDataError;
     /** Data received in the response. */
     response_data?: unknown;
+    /** Set instead of `response_data` when the stored response data cannot be decoded. */
+    response_data_error?: CommandRequestDataError;
+    /** Whether the data is a base64-encoded string rather than JSON. */
+    is_base64?: boolean;
     /** Node ID the command was sent to. */
     node_id: string;
-    /** Timestamp when the request was created. */
+    /** Timestamp when the request was created, in epoch seconds. */
     request_timestamp?: number;
-    /** Timestamp when the response was received. */
+    /** Timestamp when the response was received, in epoch seconds. */
     response_timestamp?: number;
-    /** Timestamp when the request expires. */
+    /** Timestamp when the request expires, in epoch seconds. */
     expiration_timestamp?: number;
+    /** Whether the request never expires (sent with a timeout of -1). */
+    indefinite_timeout?: boolean;
     /** Command identifier. */
     cmd?: number;
+    /** Name of the user who created the request. */
+    user_name?: string;
+    /** Whether the request was created through the user API rather than by a device. */
+    for_user?: boolean;
 }
 /** Paginated response containing a list of command requests. */
 export interface GetCommandRequestsResponse {
@@ -80,3 +108,24 @@ export interface AddCommandRequestResponse {
     /** Status of the command submission. */
     status: string;
 }
+/**
+ * Parameters for cancelling pending command requests.
+ *
+ * Provide `request_id` to cancel one request, or `node_id` to cancel every
+ * pending request for a node (optionally narrowed by `cmd_id`).
+ */
+export interface CancelCommandRequestsParams {
+    /** Cancel this specific request. */
+    request_id?: string;
+    /** Cancel all pending requests for this node. */
+    node_id?: string;
+    /** Cancel only requests with this command ID. Requires `node_id`. */
+    cmd_id?: number;
+}
+/** Response returned after cancelling command requests. */
+export interface CancelCommandRequestsResponse {
+    /** Status of the cancel operation. */
+    status: string;
+    /** Number of requests that were cancelled. */
+    total_cancelled: number;
+}

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

@@ -11,7 +11,7 @@ export type { GetAdminNodesParams, ActivateDeactivateNodesParams, GetNodeTagsPar
 export type { CreateOTAImageRequest, GetOTAImagesParams, ArchiveOTAImageParams, DeleteOTAImageParams, GetOTAImageUploadUrlParams, ConfirmOTAImageUploadRequest, GetOTAPackageUploadUrlParams, ConfirmOTAPackageUploadRequest, CreateOTAJobRequest, CreateOTAJobQueryOptions, OtaJobDownloadWindow, OtaJobValidity, OtaJobMetadata, OtaSecureBoot, OtaNetworkSerialisation, GetOTAJobParams, UpdateOTAJobParams, CancelOTAJobRequest, ArchiveOTAJobRequest, GetOTAJobStatusParams, GetOTAJobStatusSummaryParams, RetriggerOTAJobRequest, } from "./ota.cjs";
 export type { CreateAdminGroupRequest, UpdateAdminGroupRequest, GetAdminGroupsParams, } from "./group.cjs";
 export type { GetAdminTagsParams, AttachDetachTagsParams, GetTagNamesParams, } from "./tag.cjs";
-export type { GetCommandRequestsParams, AddCommandRequestBody, } from "./command_response.cjs";
+export type { GetCommandRequestsParams, AddCommandRequestBody, CancelCommandRequestsParams, CommandRequestStatus, } from "./command_response.cjs";
 export type { CreateEventFilterRequest, UpdateEventFilterRequest, GetEventFiltersParams, DeleteEventFilterRequest, } from "./event_filter.cjs";
 export type { GetTimeSeriesDataParams, GetSimpleTimeSeriesDataParams, } from "./time_series.cjs";
 export type { GetAdminCustomDataParams, SetAdminCustomDataParams, } from "./custom_data.cjs";
@@ -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, };

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

@@ -3,6 +3,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+import type { ESPAPISuccessResponse } from "./api.cjs";
 /** 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. */