@espressif/rainmaker-admin-sdk 1.1.1 → 1.2.0

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

@@ -34,13 +34,73 @@ export interface GetNodeCertificatesParams {
     /** The maximum number of records to return. */
     num_records?: number;
 }
-/** Request body for registering node certificates. */
+/** Parameters for fetching a pre-signed URL to upload a node certificates CSV. */
+export interface GetNodeCertificateUploadUrlParams {
+    /** Name of the CSV file to upload. */
+    file_name: string;
+}
+/** Response containing the pre-signed upload URL for a node certificates CSV. */
+export interface NodeCertificateUploadUrlResponse {
+    /** The API call status. */
+    status: string;
+    /** Pre-signed S3 PUT URL (valid for 1 hour). Upload without an `Authorization` header. */
+    url: string;
+    /** ID of the registration request; pass it to `registerNodeCertificates`. */
+    request_id: string;
+}
+/**
+ * Request body for registering node certificates from an uploaded CSV.
+ *
+ * Upload the CSV to the URL from `getNodeCertificateUploadUrl` first, then
+ * trigger the registration with the same `request_id`.
+ */
 export interface RegisterNodeCertificatesRequest {
-    /** List of node IDs to register certificates for. */
-    node_ids: string[];
-    /** List of certificates corresponding to the node IDs. */
-    certs: string[];
-    [key: string]: unknown;
+    /** Name of the uploaded CSV file. */
+    file_name: string;
+    /** Hex MD5 digest of the uploaded CSV file. */
+    file_md5: string;
+    /** Request ID returned by `getNodeCertificateUploadUrl`. */
+    request_id: string;
+    /**
+     * The caller's refresh token. The backend requires it and uses it to add
+     * the registered nodes to their group.
+     */
+    refresh_token: string;
+    /** The node type. */
+    type?: string;
+    /** The node model. */
+    model?: string;
+    /** The node subtype. */
+    subtype?: string;
+    /**
+     * Group to add the nodes to. When omitted, the backend creates a group named
+     * after the type/model and the current date.
+     */
+    group_name?: string;
+    /** ID of the parent group when `group_name` is a subgroup. Takes precedence over `parent_group_name`. */
+    parent_group_id?: string;
+    /** Name of the parent group when `group_name` is a subgroup. */
+    parent_group_name?: string;
+    /**
+     * Comma-separated tags. Static tags are `key:value`; CSV-column tags are
+     * `key:@column` and take each node's value from that CSV column.
+     */
+    tags?: string;
+    /** Ignore duplicate node registrations and update existing certificates. */
+    force?: boolean;
+    /** Only update type, model, subtype and tags of existing nodes. Cannot be combined with `node_policies`. */
+    update_nodes?: boolean;
+    /** Comma-separated IoT policies to attach: `mqtt`, `videostream`. */
+    node_policies?: string;
+    /** The tenant ID, required when multi-tenancy is enabled. */
+    tenant_id?: string;
+}
+/** Response returned after triggering a node certificate registration. */
+export interface RegisterNodeCertificatesResponse {
+    /** The API call status. */
+    status: string;
+    /** ID of the registration request. */
+    request_id: string;
 }
 /** Parameters for checking node certificate registration status. */
 export interface GetNodeCertificateRegistrationParams {
@@ -85,17 +145,109 @@ export interface GetNodeCertificatesResponse {
     /** The total number of certificates. */
     total?: number;
 }
-/** Response containing node certificate registration status. */
+/**
+ * Response containing node certificate registration status.
+ *
+ * Unlike `getNodeRegistrationRequest`, this call checks the batch job and
+ * reports `failure` when it has died while the request was still `requested`.
+ */
 export interface NodeCertificateRegistrationStatusResponse {
-    /** The registration request ID. */
-    request_id?: string;
     /** The registration status. */
-    status?: string;
-    [key: string]: unknown;
+    status: NodeRegistrationRequestStatus;
+    /** Number of nodes registered so far. */
+    completed_count?: number;
+    /** Total number of nodes in the request. */
+    total_count?: number;
+    /** Failure reason, when the request failed. */
+    description?: string;
+    /** Nodes that failed to register, as reported by the backend. */
+    failed_registration?: string;
+    /** Name of the group the nodes are added to. */
+    group_name?: string;
+    /** ID of the group the nodes are added to. */
+    group_id?: string;
 }
-/** Response containing the MQTT host endpoint. */
+/** Response containing the deployment's node endpoints. */
 export interface GetMQTTHostResponse {
     /** The MQTT broker host address. */
     mqtt_host?: string;
+    /** The AWS IoT credential provider endpoint (written to node NVS as `mqtt_cred_host`). */
+    mqtt_cred_host?: string;
+    /** The HTTPS node endpoint, when the deployment has one configured. */
+    https_host?: string;
     [key: string]: unknown;
 }
+/**
+ * Status of a node certificate registration request.
+ *
+ * `failed` and `failure` both mean the request failed: the backend writes
+ * `failed` when submitting the batch job fails and `failure` when the batch
+ * job itself fails.
+ */
+export type NodeRegistrationRequestStatus = "requested" | "in_progress" | "success" | "failed" | "failure";
+/** Parameters for listing node certificate registration requests. */
+export interface ListNodeRegistrationRequestsParams {
+    /** Filter results by request status. */
+    status?: NodeRegistrationRequestStatus;
+    /** The maximum number of records to return (the backend caps this at 25). */
+    num_records?: number;
+    /** The `next_id` from the previous response, to fetch the next page. */
+    start_id?: string;
+}
+/** A node certificate registration request, as returned in the list. */
+export interface NodeRegistrationRequest {
+    /** The registration request ID. */
+    request_id: string;
+    /** The request status. */
+    status: NodeRegistrationRequestStatus;
+    /** Name of the uploaded certificates CSV file. */
+    file_name?: string;
+    /** Time the request was created, in epoch seconds. */
+    request_timestamp?: number;
+    /** Number of nodes registered so far. */
+    completed_count?: number;
+    /** Total number of nodes in the request. */
+    total_count?: number;
+}
+/** Response containing a page of node certificate registration requests. */
+export interface ListNodeRegistrationRequestsResponse {
+    /** The API call status. */
+    status: string;
+    /** Registration requests, newest first. */
+    requests?: NodeRegistrationRequest[];
+    /** Pagination cursor for the next page; absent on the last page. */
+    next_id?: string;
+}
+/** Full detail of a single node certificate registration request. */
+export interface NodeRegistrationRequestDetail extends NodeRegistrationRequest {
+    /** Pre-signed download URL of the original CSV (valid for 1 hour). */
+    url?: string;
+    /** Additional context from the backend, e.g. a batch job failure reason. */
+    additional_comments?: string;
+    /** Number of nodes that failed to register (omitted when 0). */
+    failed_registration_count?: number;
+    /** Name of the group the nodes were added to. */
+    group_name?: string;
+    /** ID of the group the nodes were added to. */
+    group_id?: string;
+    /** The node type. */
+    type?: string;
+    /** The node model. */
+    model?: string;
+    /** The node subtype. */
+    subtype?: string;
+    /** ID of the parent group. */
+    parent_group_id?: string;
+    /** Name of the parent group. */
+    parent_group_name?: string;
+    /** Comma-separated `key:value` tags applied to the nodes. */
+    tags?: string;
+    /** Whether existing registrations were overwritten. */
+    force?: boolean;
+    /** Whether existing nodes were updated. */
+    update_nodes?: boolean;
+    /** The tenant ID. */
+    tenant_id?: string;
+    /** Policies attached to the nodes. */
+    node_policies?: string;
+}

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

@@ -10,7 +10,7 @@ export type { AdminNodeInfo, AdminNodeListResponse, GetNodeTagsResponse, NodeSta
 export type { OTAImageInfo, OTAImageRelatedFile, OTAImageCreateResponse, GetOTAImagesResponse, OTAImageUploadUrlResponse, ConfirmOTAImageUploadResponse, OTAPackageUploadUrlResponse, ConfirmOTAPackageUploadResponse, OTAJobInfo, OTAJobCreateResponse, OTAJobUpdateResponse, OTAJobRetriggerResponse, GetOTAJobsResponse, NodeOTAJobStatusEntry, OTAJobStatusResponse, OTAJobStatusSummaryResponse, } from "./ota.cjs";
 export type { AdminGroupInfo, CreateAdminGroupResponse, GetAdminGroupsResponse, } from "./group.cjs";
 export type { TagResourceInfo, GetAdminTagsResponse, GetTagNamesResponse, } from "./tag.cjs";
-export type { CommandRequestInfo, GetCommandRequestsResponse, AddCommandRequestResponse, } from "./command_response.cjs";
+export type { CommandRequestInfo, GetCommandRequestsResponse, AddCommandRequestResponse, CancelCommandRequestsResponse, CommandRequestDataError, } from "./command_response.cjs";
 export type { EventFilterInfo, GetEventFiltersResponse } from "./event_filter.cjs";
 export type { TimeSeriesParamData, TimeSeriesNodeData, GetTimeSeriesDataResponse, GetSimpleTimeSeriesDataResponse, } from "./time_series.cjs";
 export type { CustomDataResponse } from "./custom_data.cjs";

package/dist/types-cjs/utils/constants.d.cts

@@ -68,6 +68,7 @@ declare const APIEndpoints: {
     readonly ADMIN_NODE_IDS: "admin/node_ids";
     readonly ADMIN_NODE_CERTIFICATES: "admin/node_certificates";
     readonly ADMIN_NODE_CERTIFICATES_REGISTER: "admin/node_certificates/register";
+    readonly ADMIN_NODE_REGISTRATION_REQUESTS: "admin/node_registrations/requests";
     readonly ADMIN_API_STATS: "admin/api_stats";
     readonly ADMIN_MQTT_STATS: "admin/mqtt_stats";
     readonly ADMIN_CHANGE_SUPER_ADMIN: "admin/change_super_admin";
@@ -148,6 +149,8 @@ declare const APICallValidationErrorCodes: {
     readonly MISSING_PLATFORM_NAME: "MISSING_PLATFORM_NAME";
     readonly MISSING_PLATFORM_APPLICATION_ARN: "MISSING_PLATFORM_APPLICATION_ARN";
     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";
 };
 declare const TokenErrorCodes: {
     readonly MISSING_ACCESS_TOKEN: "MISSING_ACCESS_TOKEN";

package/dist/types-cjs/utils/error/errorMessages.d.cts

@@ -52,6 +52,8 @@ declare const apiCallValidationErrorMessages: {
     MISSING_PLATFORM_NAME: string;
     MISSING_PLATFORM_APPLICATION_ARN: string;
     MISSING_BATCH_ID: string;
+    MISSING_CANCEL_COMMAND_SCOPE: string;
+    CMD_ID_REQUIRES_NODE_ID: string;
 };
 declare const tokenErrorMessages: {
     MISSING_ACCESS_TOKEN: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@espressif/rainmaker-admin-sdk",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Espressif's Rainmaker Admin SDK enables seamless integration of admin applications with the ESP Rainmaker ecosystem.",
   "license": "Apache-2.0",
   "author": "Espressif Systems (Shanghai) CO LTD",