@espressif/rainmaker-admin-sdk 1.0.0 → 1.1.1

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

@@ -26,16 +26,31 @@ export interface GetOTAImagesParams {
     type?: string;
     /** Filter by node model. */
     model?: string;
-    /** Filter by firmware version. */
+    /**
+     * Filter by firmware version.
+     *
+     * @deprecated Ignored by the backend, which has no `fw_version` filter on this endpoint.
+     */
     fw_version?: string;
     /** Maximum number of records to return. */
     num_records?: string;
     /** Image ID to start pagination from. */
     start_id?: string;
-    /** Substring filter for image name. */
+    /**
+     * Substring filter for image name, as the string `"true"`. Applies to `image_name`
+     * only; without it the name lookup is an exact match.
+     */
     contains?: string;
-    /** Filter by archived status. */
+    /**
+     * Return only archived images. Honoured by the unfiltered listing only — the
+     * `ota_image_id`, `image_name`, `type` and `model` lookups span both states.
+     */
     archived?: boolean;
+    /**
+     * Return archived and unarchived images alike. Same listing-only caveat as
+     * `archived`, and takes precedence over it.
+     */
+    all?: boolean;
 }
 /** Parameters for archiving or unarchiving an OTA image. */
 export interface ArchiveOTAImageParams {
@@ -44,6 +59,16 @@ export interface ArchiveOTAImageParams {
     /** Whether to archive (true) or unarchive (false). */
     archive: boolean;
 }
+/** Parameters for deleting an OTA image or the package it came from. */
+export interface DeleteOTAImageParams {
+    /** ID of the OTA image to delete. */
+    ota_image_id: string;
+    /**
+     * Delete an image that is still referenced by OTA jobs. Never overrides a
+     * reference from an *active* job, which is rejected regardless of this flag.
+     */
+    force_delete?: boolean;
+}
 /** Time window (minutes past midnight) during which the node may apply the OTA. */
 export interface OtaJobDownloadWindow {
     /** Window start, in minutes past midnight (0-1439). */
@@ -150,6 +175,21 @@ export interface UpdateOTAJobParams {
     /** Additional update fields. */
     [key: string]: unknown;
 }
+/** Request body for cancelling an in-flight OTA job. */
+export interface CancelOTAJobRequest {
+    /** ID of the OTA job to cancel. */
+    ota_job_id: string;
+}
+/**
+ * Request body for archiving an OTA job.
+ *
+ * The `archive` flag is supplied by `archiveJob` itself and is deliberately not
+ * part of this type: archiving is one-way, so there is no `archive: false`.
+ */
+export interface ArchiveOTAJobRequest {
+    /** ID of the OTA job to archive. */
+    ota_job_id: string;
+}
 /** Parameters for fetching OTA job status. */
 export interface GetOTAJobStatusParams {
     /** ID of the OTA job to check status for. */
@@ -180,12 +220,13 @@ export interface OTAJobStatusSummaryResponse {
     failed?: number;
     total?: number;
 }
-/** Request body for retriggering a failed OTA job. */
+/**
+ * Request body for retriggering an OTA job, pushing it to every node that is
+ * still pending. The backend accepts no other fields.
+ */
 export interface RetriggerOTAJobRequest {
     /** ID of the OTA job to retrigger. */
     ota_job_id: string;
-    /** List of node IDs to retrigger the job for. */
-    node_ids?: string[];
 }
 /** Related artifact bundled with an OTA image (e.g. bootloader). */
 export interface OTAImageRelatedFile {
@@ -212,12 +253,28 @@ export interface OTAImageInfo {
     fw_version: string;
     /** Size of the image file in bytes. */
     file_size?: number;
-    /** Current status of the image. */
+    /**
+     * Current status of the image.
+     *
+     * @deprecated Never returned for OTA images; carried over from the OTA job type.
+     */
     status?: string;
-    /** Timestamp when the image was created. */
+    /**
+     * Timestamp when the image was created.
+     *
+     * @deprecated Never returned for OTA images; use `upload_timestamp`.
+     */
     timestamp?: number;
-    /** Whether the image is archived. */
+    /**
+     * Whether the image is archived. Omitted entirely rather than set to `false` for
+     * images that have never been archived.
+     */
     archived?: boolean;
+    /**
+     * Name of the package archive this image was extracted from, when it was uploaded
+     * as a package. Such images can only be removed via `deletePackage`.
+     */
+    package?: string;
     /** Presigned or public URL for the main firmware binary (detail responses). */
     image_url?: string;
     /** MD5 checksum of the main image file (detail responses). */
@@ -248,7 +305,11 @@ export interface GetOTAImagesResponse {
     ota_images?: OTAImageInfo[];
     /** ID to use for fetching the next page. */
     next_id?: string;
-    /** Total number of images matching the query. */
+    /**
+     * Total number of images matching the query.
+     *
+     * @deprecated Never sent by the backend for OTA images.
+     */
     total?: number;
 }
 /** OTA job response. */
@@ -269,9 +330,21 @@ export interface OTAJobInfo {
     additional_info?: string;
     /** Whether the job is continuous / recurring when returned by the API. */
     continuous?: boolean;
+    /**
+     * Present and `true` once the job has been archived. Archiving is one-way,
+     * so the attribute is absent rather than `false` on unarchived jobs.
+     */
+    archived?: boolean;
     /** Additional job properties. */
     [key: string]: unknown;
 }
+/**
+ * Response returned by the cancel and archive operations.
+ *
+ * The backend re-reads the job after applying the update and returns its full
+ * record, so this is the updated job itself rather than a bare acknowledgement.
+ */
+export type OTAJobUpdateResponse = OTAJobInfo;
 /** Response returned after creating an OTA job. */
 export interface OTAJobCreateResponse {
     /** ID assigned to the newly created job. */
@@ -281,6 +354,18 @@ export interface OTAJobCreateResponse {
     /** Human-readable description of the result. */
     description: string;
 }
+/**
+ * Response returned after retriggering an OTA job.
+ *
+ * Delivery is dispatched asynchronously, so a success here means the retrigger
+ * was accepted — not that any node has received the update yet.
+ */
+export interface OTAJobRetriggerResponse {
+    /** ID of the job that was retriggered. */
+    ota_job_id: string;
+    /** Status of the retrigger operation. */
+    status: string;
+}
 /** Paginated response containing a list of OTA jobs. */
 export interface GetOTAJobsResponse {
     /** List of OTA job objects. */

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

@@ -7,7 +7,7 @@ export type { ESPAPIError, ESPAPISuccessResponse } from "./api.cjs";
 export type { LoginWithPasswordResponse, ExtendSessionResponse, LoginWithoutPasswordResponse, GetUserInfoResponse, } from "./auth.cjs";
 export type { AdminUserInfo, GetAdminUsersResponse } from "./admin_user.cjs";
 export type { AdminNodeInfo, AdminNodeListResponse, GetNodeTagsResponse, NodeStatusSummaryResponse, } from "./node.cjs";
-export type { OTAImageInfo, OTAImageRelatedFile, OTAImageCreateResponse, GetOTAImagesResponse, OTAImageUploadUrlResponse, ConfirmOTAImageUploadResponse, OTAPackageUploadUrlResponse, ConfirmOTAPackageUploadResponse, OTAJobInfo, OTAJobCreateResponse, GetOTAJobsResponse, NodeOTAJobStatusEntry, OTAJobStatusResponse, OTAJobStatusSummaryResponse, } from "./ota.cjs";
+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";

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

@@ -42,10 +42,16 @@ export interface GetSimpleTimeSeriesDataParams {
     node_id: string;
     /** Parameter name to query. */
     param_name: string;
-    /** Start of the time range (epoch seconds). */
-    start_time: number;
-    /** End of the time range (epoch seconds). */
-    end_time: number;
+    /**
+     * Start of the time range (epoch seconds). Omit to start from the oldest
+     * stored record. The backend rejects a range whose start is after its end.
+     */
+    start_time?: number;
+    /**
+     * End of the time range (epoch seconds). Omit to include records up to
+     * the current time.
+     */
+    end_time?: number;
     /**
      * Expected data type of the parameter values (GET query param `type`,
      * e.g. `int`, `float`).
@@ -53,7 +59,7 @@ export interface GetSimpleTimeSeriesDataParams {
     type: string;
     /** ID to start pagination from. */
     start_id?: string;
-    /** Maximum number of records to return. */
+    /** Maximum number of records to return. The backend caps this at 200. */
     num_records?: number;
 }
 /** Time series data for a single parameter. */

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

@@ -27,7 +27,7 @@ declare const APIEndpoints: {
     readonly ADMIN_OTA_JOB: "admin/otajob";
     readonly ADMIN_OTA_JOB_STATUS: "admin/otajob/status";
     readonly ADMIN_OTA_JOB_STATUS_SUMMARY: "admin/otajob/status/summary";
-    readonly ADMIN_OTA_JOB_ACTION: "admin/otajob";
+    readonly ADMIN_OTA_JOB_RETRIGGER: "admin/otajob/retrigger";
     readonly ADMIN_NODE_GROUP: "admin/node_group";
     readonly ADMIN_TAGS: "admin/tags";
     readonly ADMIN_TAG_NAMES: "admin/tags/names";
@@ -115,6 +115,7 @@ declare const StorageAdapterErrorCodes: {
 declare const APICallValidationErrorCodes: {
     readonly MISSING_NODE_ID: "MISSING_NODE_ID";
     readonly MISSING_OTA_IMAGE_ID: "MISSING_OTA_IMAGE_ID";
+    readonly MISSING_ARCHIVE_FLAG: "MISSING_ARCHIVE_FLAG";
     readonly MISSING_OTA_JOB_ID: "MISSING_OTA_JOB_ID";
     readonly MISSING_GROUP_ID: "MISSING_GROUP_ID";
     readonly MISSING_GROUP_NAME: "MISSING_GROUP_NAME";

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

@@ -19,6 +19,7 @@ declare const storageAdapterErrorMessages: {
 declare const apiCallValidationErrorMessages: {
     MISSING_NODE_ID: string;
     MISSING_OTA_IMAGE_ID: string;
+    MISSING_ARCHIVE_FLAG: string;
     MISSING_OTA_JOB_ID: string;
     MISSING_GROUP_ID: string;
     MISSING_GROUP_NAME: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@espressif/rainmaker-admin-sdk",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "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",

package/dist/types/methods/ESPRMAdminOTAJob/DeleteJob.d.ts

@@ -1,17 +0,0 @@
-/*
- * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-import { ESPAPISuccessResponse } from "../../types/api.js";
-declare module "../../ESPRMAdminOTAJob.js" {
-    interface ESPRMAdminOTAJob {
-        /**
-         * Deletes an OTA job by its job ID.
-         *
-         * @param otaJobId - The ID of the OTA job to delete.
-         * @returns A success response confirming the job was deleted.
-         */
-        deleteJob(otaJobId: string): Promise<ESPAPISuccessResponse>;
-    }
-}

package/dist/types-cjs/methods/ESPRMAdminOTAJob/DeleteJob.d.cts

@@ -1,17 +0,0 @@
-/*
- * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-import { ESPAPISuccessResponse } from "../../types/api.cjs";
-declare module "../../ESPRMAdminOTAJob.cjs" {
-    interface ESPRMAdminOTAJob {
-        /**
-         * Deletes an OTA job by its job ID.
-         *
-         * @param otaJobId - The ID of the OTA job to delete.
-         * @returns A success response confirming the job was deleted.
-         */
-        deleteJob(otaJobId: string): Promise<ESPAPISuccessResponse>;
-    }
-}