@espressif/rainmaker-neo-base-sdk 1.0.0

package/dist/types/methods/ESPRMNeoAutomation/RemoveCondition.d.ts

@@ -0,0 +1,17 @@
+import { ESPAPIResponse } from "../../types/output";
+/**
+ * Augments the ESPRMNeoAutomation class with the `removeCondition` method.
+ */
+declare module "../../ESPRMNeoAutomation" {
+    interface ESPRMNeoAutomation {
+        /**
+         * Removes a condition (trigger id) from this automation. The instance is
+         * updated only after the API call succeeds.
+         *
+         * @param triggerId - The trigger id to remove from conditions.
+         * @returns A promise that resolves with the API response.
+         * @throws {ESPAPICallValidationError} If triggerId is missing or empty.
+         */
+        removeCondition(triggerId: string): Promise<ESPAPIResponse>;
+    }
+}

package/dist/types/methods/ESPRMNeoAutomation/Update.d.ts

@@ -0,0 +1,19 @@
+import { CreateAutomationInput } from "../../types/automation";
+import { ESPAPIResponse } from "../../types/output";
+/**
+ * Augments the ESPRMNeoAutomation class with the `update` method.
+ */
+declare module "../../ESPRMNeoAutomation" {
+    interface ESPRMNeoAutomation {
+        /**
+         * Updates this automation with partial changes. `id` cannot be changed.
+         *
+         * Calls `PUT /v1/groups/{groupId}/service/automations/{automationId}`.
+         *
+         * @param updates - Partial automation fields to update.
+         * @returns A promise that resolves with the API response when the automation is successfully updated.
+         * @throws {Error} If updating the automation fails or the API request fails.
+         */
+        update(updates: Partial<CreateAutomationInput>): Promise<ESPAPIResponse>;
+    }
+}

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

@@ -0,0 +1,6 @@
+import "./Update";
+import "./Delete";
+import "./AddCondition";
+import "./RemoveCondition";
+import "./AddAction";
+import "./RemoveAction";

package/dist/types/methods/ESPRMNeoDevice/GetParams.d.ts

@@ -0,0 +1,41 @@
+import type { ESPRMNeoDeviceParam } from "../../ESPRMNeoDeviceParam";
+/**
+ * Options accepted by {@link ESPRMNeoDevice.getParams}.
+ */
+export interface GetDeviceParamsOptions {
+    /**
+     * Whether to use the local node-config cache for param values.
+     *
+     * - `true` (default): read this device's values from the cached node config
+     *   in local storage (when present) and apply them onto
+     *   {@link ESPRMNeoDevice.params}.
+     * - `false`: fetch live values via the best available transport (local
+     *   control first when reachable, otherwise MQTT) and update each
+     *   {@link ESPRMNeoDeviceParam}'s `value`.
+     *
+     * @defaultValue true
+     */
+    cache?: boolean;
+    /** Optional transport timeout in milliseconds (used when `cache` is `false`). */
+    timeout?: number;
+}
+/**
+ * Augments the ESPRMNeoDevice class with the `getParams` method.
+ */
+declare module "../../ESPRMNeoDevice" {
+    interface ESPRMNeoDevice {
+        /**
+         * Returns param values for this device.
+         *
+         * With `cache: true` (default), reads values from the local node-config
+         * cache when present and applies them onto {@link ESPRMNeoDevice.params}.
+         * With `cache: false`, fetches live values via the best available transport
+         * (local control first when reachable, otherwise MQTT) and updates each
+         * {@link ESPRMNeoDeviceParam}'s `value`. Returns the same instances as
+         * {@link ESPRMNeoDevice.params}.
+         *
+         * @param options - See {@link GetDeviceParamsOptions}. Defaults to `{ cache: true }`.
+         */
+        getParams(options?: GetDeviceParamsOptions): Promise<ESPRMNeoDeviceParam[]>;
+    }
+}

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

@@ -0,0 +1 @@
+import "./GetParams";

package/dist/types/methods/ESPRMNeoDeviceParam/GetLatestTSData.d.ts

@@ -0,0 +1,17 @@
+import type { ESPRMNeoTSDataOptions, ESPRMNeoTSDataResult } from "../../types/tsData";
+/**
+ * Augments the ESPRMNeoDeviceParam class with the `getLatestTSData` method.
+ */
+declare module "../../ESPRMNeoDeviceParam" {
+    interface ESPRMNeoDeviceParam {
+        /**
+         * Gets the most recent time-series sample for this param from
+         * `GET /v1/groups/{groupId}/nodes/{nodeId}/timeseries/latest`.
+         *
+         * @param options - Query options (only `dataType` override is used).
+         * @returns Promise resolving to time-series data with at most one point
+         *   in `data` (empty when the param has no samples yet).
+         */
+        getLatestTSData(options?: ESPRMNeoTSDataOptions): Promise<ESPRMNeoTSDataResult>;
+    }
+}

package/dist/types/methods/ESPRMNeoDeviceParam/GetRawTSData.d.ts

@@ -0,0 +1,18 @@
+import type { ESPRMNeoTSDataOptions, ESPRMNeoTSDataResult } from "../../types/tsData";
+/**
+ * Augments the ESPRMNeoDeviceParam class with the `getRawTSData` method.
+ */
+declare module "../../ESPRMNeoDeviceParam" {
+    interface ESPRMNeoDeviceParam {
+        /**
+         * Gets raw time-series samples for this param (newest first) from
+         * `GET /v1/groups/{groupId}/nodes/{nodeId}/timeseries/raw`.
+         *
+         * @param options - Query options; `startTs` (Unix ms) is required,
+         *   `endTs` defaults to now. Paginate via `pageSize`/`startKey` or the
+         *   result's `fetchNext()`.
+         * @returns Promise resolving to raw time-series data.
+         */
+        getRawTSData(options?: ESPRMNeoTSDataOptions): Promise<ESPRMNeoTSDataResult>;
+    }
+}

package/dist/types/methods/ESPRMNeoDeviceParam/GetTSData.d.ts

@@ -0,0 +1,23 @@
+import type { ESPRMNeoTSDataOptions, ESPRMNeoTSDataResult } from "../../types/tsData";
+/**
+ * Augments the ESPRMNeoDeviceParam class with the `getTSData` method.
+ */
+declare module "../../ESPRMNeoDeviceParam" {
+    interface ESPRMNeoDeviceParam {
+        /**
+         * Gets aggregated time-series data for this param from
+         * `GET /v1/groups/{groupId}/nodes/{nodeId}/timeseries/aggregates`.
+         *
+         * Query modes (all require `options.window`):
+         * - no date options: current (live) window
+         * - `date`: one completed historical window
+         * - `startDate` + `endDate`: paginated range of completed windows
+         *
+         * @param options - Query options (`window` required; `date` or
+         *   `startDate`/`endDate` for historical windows; paginate via
+         *   `pageSize`/`startKey` or the result's `fetchNext()`).
+         * @returns Promise resolving to time-series data with `aggregates` populated.
+         */
+        getTSData(options?: ESPRMNeoTSDataOptions): Promise<ESPRMNeoTSDataResult>;
+    }
+}

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

@@ -0,0 +1,3 @@
+import "./GetTSData";
+import "./GetRawTSData";
+import "./GetLatestTSData";

package/dist/types/methods/ESPRMNeoGroup/AddNode.d.ts

@@ -0,0 +1,16 @@
+import { ESPAPIResponse } from "../../types/output";
+/**
+ * Augments the ESPRMNeoGroup class with the `addNode` method (nested groups only).
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Adds a node to this nested group (subgroup API).
+         *
+         * Calls `PUT /v1/groups/{groupId}/subgroups/{subGroupId}/nodes/{nodeId}`.
+         *
+         * @throws {ESPAPICallValidationError} If this is a root group or the node is already present.
+         */
+        addNode(nodeId: string): Promise<ESPAPIResponse>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/CreateAutomation.d.ts

@@ -0,0 +1,20 @@
+import { ESPRMNeoAutomation } from "../../ESPRMNeoAutomation";
+import { CreateAutomationInput } from "../../types/automation";
+/**
+ * Augments the ESPRMNeoGroup class with the `createAutomation` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Creates a new automation for this group. The server mints the id.
+         *
+         * Calls `POST /v1/groups/{groupId}/service/automations`.
+         *
+         * @param input - The automation fields (name, conditions, actions, …).
+         * @returns A promise that resolves to the created ESPRMNeoAutomation instance.
+         * @throws {ESPAPICallValidationError} If name, conditions, or actions are missing.
+         * @throws {Error} If automation creation fails or the API request fails.
+         */
+        createAutomation(input: CreateAutomationInput): Promise<ESPRMNeoAutomation>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/CreateSchedule.d.ts

@@ -0,0 +1,23 @@
+import { ESPRMNeoSchedule } from "../../ESPRMNeoSchedule";
+import { ScheduleItem } from "../../types/schedule";
+/**
+ * Augments the ESPRMNeoGroup class with the `createSchedule` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Creates schedules for multiple nodes in this group.
+         *
+         * For each node, calls `PUT /v1/groups/{groupId}/nodes/{nodeId}/schedules`.
+         *
+         * @param nodeSchedules - Array of objects, each containing a nodeId and its schedules.
+         * @returns A promise that resolves to the created schedules across all nodes.
+         * @throws {ESPAPICallValidationError} If nodeSchedules or schedule data is invalid, or any node is not found.
+         * @throws {Error} If creating schedules fails on one or more nodes.
+         */
+        createSchedule(nodeSchedules: Array<{
+            nodeId: string;
+            schedules: ScheduleItem[];
+        }>): Promise<ESPRMNeoSchedule[]>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/CreateSubGroup.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Augments the ESPRMNeoGroup class with the `createSubGroup` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Creates a new nested group (subgroup) under this group.
+         *
+         * Calls `POST /v1/groups/{groupId}/subgroups`.
+         *
+         * @param name - The name for the new nested group.
+         * @returns A promise that resolves to the created child {@link ESPRMNeoGroup} (`parentId` set).
+         * @throws {Error} If the API request fails.
+         */
+        createSubGroup(name: string): Promise<ESPRMNeoGroup>;
+    }
+}
+export {};

package/dist/types/methods/ESPRMNeoGroup/Delete.d.ts

@@ -0,0 +1,23 @@
+import { ESPAPIResponse } from "../../types/output";
+/**
+ * Augments the ESPRMNeoGroup class with the `delete` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Deletes this group from the cloud.
+         *
+         * Calls:
+         * - Root group: `DELETE /v1/groups/{groupId}`
+         * - Nested subgroup: `DELETE /v1/groups/{groupId}/subgroups/{subGroupId}`
+         *
+         * After a successful delete this instance is stale. Callers should discard
+         * it and drop it from any local caches (for a subgroup, remove it from its
+         * parent's `subgroups` array — the SDK cannot reach the parent from here).
+         *
+         * @returns A promise that resolves with the API response when the group has been deleted.
+         * @throws {Error} If the deletion fails or the API request fails.
+         */
+        delete(): Promise<ESPAPIResponse>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/DeleteAllSchedules.d.ts

@@ -0,0 +1,16 @@
+import { ESPAPIResponse } from "../../types/output";
+/**
+ * Augments the ESPRMNeoGroup class with the `deleteAllSchedules` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Deletes all schedules for all nodes in this group.
+         *
+         * For each node, calls `DELETE /v1/groups/{groupId}/nodes/{nodeId}/schedules`.
+         *
+         * @returns A promise that resolves with the API response when all schedules are deleted.
+         */
+        deleteAllSchedules(): Promise<ESPAPIResponse>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/GetAutomation.d.ts

@@ -0,0 +1,18 @@
+import { ESPRMNeoAutomation } from "../../ESPRMNeoAutomation";
+/**
+ * Augments the ESPRMNeoGroup class with the `getAutomation` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Retrieves a specific automation by its ID.
+         *
+         * Calls `GET /v1/groups/{groupId}/service/automations/{automationId}`.
+         *
+         * @param automationId - The ID of the automation to retrieve.
+         * @returns A promise that resolves to an ESPRMNeoAutomation instance.
+         * @throws {Error} If the automation is not found or the API request fails.
+         */
+        getAutomation(automationId: string): Promise<ESPRMNeoAutomation>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/GetAutomations.d.ts

@@ -0,0 +1,17 @@
+import { ESPRMNeoAutomation } from "../../ESPRMNeoAutomation";
+/**
+ * Augments the ESPRMNeoGroup class with the `getAutomations` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Retrieves all automations for this group.
+         *
+         * Calls `GET /v1/groups/{groupId}/service/automations`.
+         *
+         * @returns A promise that resolves to an array of ESPRMNeoAutomation instances.
+         * @throws {Error} If retrieving automations fails or the API request fails.
+         */
+        getAutomations(): Promise<ESPRMNeoAutomation[]>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/GetNode.d.ts

@@ -0,0 +1,45 @@
+import { ESPRMNeoNode } from "../../ESPRMNeoNode";
+/**
+ * Options accepted by {@link ESPRMNeoGroup.getNode} and
+ * {@link ESPRMNeoGroup.getNodes}.
+ */
+export interface GetNodeOptions {
+    /**
+     * Whether to use the local node-config cache.
+     *
+     * - `true` (default): read from local storage when a cached config exists.
+     * - `false`: always fetch from the cloud and refresh local storage.
+     *
+     * Cache key: {@link StorageKeys.NODE_CONFIG_PREFIX} + `nodeId`.
+     *
+     * @defaultValue true
+     */
+    cache?: boolean;
+}
+/**
+ * Augments the ESPRMNeoGroup class with the `getNode` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Retrieves a specific node from this group by node ID.
+         *
+         * Cloud paths:
+         * - Root: `GET /v1/groups/{groupId}/nodes/{nodeId}/config`
+         * - Nested: `GET /v1/groups/{groupId}/subgroups/{subGroupId}/nodes/{nodeId}/config`
+         *
+         * With `cache: true` (default), uses local storage when present; otherwise
+         * fetches from the cloud. With `cache: false`, always fetches from the cloud.
+         *
+         * **Multi-subgroup nodes:** call `getNode` on the **root group** so all
+         * subgroup memberships are discovered for the correct MQTT shadow name.
+         *
+         * @param nodeId - The ID of the node to retrieve.
+         * @param options - See {@link GetNodeOptions}. Defaults to `{ cache: true }`.
+         * @returns A promise that resolves to an ESPRMNeoNode instance.
+         * @throws {ESPAPICallValidationError} If the node config could not be resolved.
+         * @throws {Error} If the API request fails.
+         */
+        getNode(nodeId: string, options?: GetNodeOptions): Promise<ESPRMNeoNode>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/GetNodes.d.ts

@@ -0,0 +1,28 @@
+import { ESPRMNeoNode } from "../../ESPRMNeoNode";
+import { GetNodeOptions } from "./GetNode";
+/**
+ * Options accepted by {@link ESPRMNeoGroup.getNodes}.
+ * Same shape as {@link GetNodeOptions} — forwarded to each `getNode` call.
+ */
+export interface GetNodesOptions extends GetNodeOptions {
+}
+/**
+ * Augments the ESPRMNeoGroup class with the `getNodes` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Retrieves all nodes in this group.
+         *
+         * Forwards {@link GetNodesOptions} to each {@link ESPRMNeoGroup.getNode}
+         * call. With `cache: true` (default), each node config is read from local
+         * storage (`{@link StorageKeys.NODE_CONFIG_PREFIX}` + `nodeId`) when
+         * present; with `cache: false`, configs are fetched from the cloud and
+         * written back to local storage.
+         *
+         * @param options - See {@link GetNodesOptions}. Defaults to `{ cache: true }`.
+         * @returns A promise that resolves to an array of ESPRMNeoNode instances.
+         */
+        getNodes(options?: GetNodesOptions): Promise<ESPRMNeoNode[]>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/GetSchedules.d.ts

@@ -0,0 +1,16 @@
+import { ESPRMNeoSchedule } from "../../ESPRMNeoSchedule";
+/**
+ * Augments the ESPRMNeoGroup class with the `getSchedules` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Retrieves all schedules for all nodes in this group.
+         * Aggregates schedules from all nodes in the group via
+         * `GET /v1/groups/{groupId}/nodes/{nodeId}/schedules` per node.
+         *
+         * @returns A promise that resolves to an array of ESPRMNeoSchedule instances.
+         */
+        getSchedules(): Promise<ESPRMNeoSchedule[]>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/GetSharingInfo.d.ts

@@ -0,0 +1,23 @@
+import { GroupSharingInfo } from "../../types/output";
+/**
+ * Augments the ESPRMNeoGroup class with the `getSharingInfo` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Returns users with access to this group (email, phone number, access type, user id).
+         *
+         * Calls:
+         * - Root group: `GET /v1/groups/{groupId}/users`
+         * - Nested subgroup: `GET /v1/groups/{groupId}/subgroups/{subGroupId}/users`
+         *
+         * The listing scope is decided by the backend from the caller's access
+         * level: primary callers see all members; secondary and subgroup-only
+         * callers see only the group's primary owners.
+         *
+         * @returns A promise that resolves to a {@link GroupSharingInfo}.
+         * @throws If the API request fails.
+         */
+        getSharingInfo(): Promise<GroupSharingInfo>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/Leave.d.ts

@@ -0,0 +1,24 @@
+import { ESPAPIResponse } from "../../types/output";
+/**
+ * Augments the ESPRMNeoGroup class with the `leave` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Leaves this group (or subgroup) by removing the current (calling) user.
+         *
+         * Calls the remove-member API with the `'me'` path alias so the server
+         * resolves the authenticated caller:
+         * - Root group: `DELETE /v1/groups/{groupId}/users/{userId}` with `userId=me`.
+         * - Nested subgroup: `DELETE /v1/groups/{groupId}/subgroups/{subGroupId}/users/{userId}` with `userId=me`.
+         *
+         * The last remaining Primary user cannot leave; the group must always
+         * have at least one Primary.
+         *
+         * @returns A promise that resolves with the API response when the user has left.
+         * @throws If the request fails, the caller is not a member, or the caller
+         *   is the last remaining Primary user.
+         */
+        leave(): Promise<ESPAPIResponse>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/RemoveMember.d.ts

@@ -0,0 +1,21 @@
+import { ESPAPIResponse } from "../../types/output";
+/**
+ * Augments the ESPRMNeoGroup class with the `removeMember` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Removes another member from this group (or subgroup).
+         *
+         * - Root group: `DELETE /v1/groups/{groupId}/users/{userId}`.
+         * - Nested subgroup: `DELETE /v1/groups/{groupId}/subgroups/{subGroupId}/users/{userId}`.
+         *
+         * To remove the current (calling) user, use {@link ESPRMNeoGroup.leave} instead.
+         *
+         * @param userId - The ID of the user to remove. Must not be the caller.
+         * @returns A promise that resolves with the API response.
+         * @throws {ESPAPICallValidationError} If `userId` is empty or refers to the caller (use `leave()`).
+         */
+        removeMember(userId: string): Promise<ESPAPIResponse>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/RemoveNode.d.ts

@@ -0,0 +1,15 @@
+import { ESPAPIResponse } from "../../types/output";
+/**
+ * Augments the ESPRMNeoGroup class with the `removeNode` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Removes a node association from this group.
+         *
+         * - Root group: `DELETE /v1/groups/{groupId}/nodes/{nodeId}` (full disassociation from the group).
+         * - Nested subgroup: `DELETE /v1/groups/{groupId}/subgroups/{subGroupId}/nodes/{nodeId}` (removes from the subgroup only).
+         */
+        removeNode(nodeId: string): Promise<ESPAPIResponse>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/SetParams.d.ts

@@ -0,0 +1,19 @@
+import { ESPRMNeoGroupSetParamsOptions } from "../../types/group";
+import { ESPAPIResponse } from "../../types/output";
+/**
+ * Augments the ESPRMNeoGroup class with the `setParams` method (group control).
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Sends a parameter payload to all devices in this group (or one subgroup) via the
+         * group control MQTT topic. Same JSON shape as {@link ESPRMNeoNode.setParams}.
+         *
+         * - Root group: omit `subgroupId` for a group-wide broadcast, or pass `subgroupId`
+         *   to address one subgroup.
+         * - Nested subgroup instance: always targets that subgroup using the parent group's
+         *   MQTT namespace.
+         */
+        setParams(params: Record<string, any>, options?: ESPRMNeoGroupSetParamsOptions): Promise<ESPAPIResponse>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/Share.d.ts

@@ -0,0 +1,25 @@
+import { ESPAPIResponse, ShareOptions } from "../../types/output";
+/**
+ * Augments the ESPRMNeoGroup class with the `share` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Shares this group with another user.
+         *
+         * Calls:
+         * - Root group: `POST /v1/groups/{groupId}/sharing-requests`
+         * - Nested subgroup: `POST /v1/groups/{groupId}/subgroups/{subGroupId}/sharing-requests`
+         *
+         * @param options - Sharing options.
+         * @param options.username - Recipient's email address or E.164 phone number
+         *   (e.g. `"user@example.com"` or `"+919876543210"`). Unregistered addresses
+         *   answer HTTP 404 without revealing whether an account exists.
+         * @param options.accessType - `"primary"` (transfer ownership) or `"secondary"` (invite as member).
+         * @returns A promise that resolves to the API response.
+         * @throws {ESPAPICallValidationError} If `username` is missing.
+         * @throws {Error} If the API request fails.
+         */
+        share(options: ShareOptions): Promise<ESPAPIResponse>;
+    }
+}

package/dist/types/methods/ESPRMNeoGroup/UpdateName.d.ts

@@ -0,0 +1,20 @@
+import { ESPAPIResponse } from "../../types/output";
+/**
+ * Augments the ESPRMNeoGroup class with the `updateName` method.
+ */
+declare module "../../ESPRMNeoGroup" {
+    interface ESPRMNeoGroup {
+        /**
+         * Updates the name of this group.
+         *
+         * Calls:
+         * - Root group: `PATCH /v1/groups/{groupId}`
+         * - Nested subgroup: `PATCH /v1/groups/{groupId}/subgroups/{subGroupId}`
+         *
+         * @param newName - The new name for the group.
+         * @returns A promise that resolves with the API response when the name is successfully updated.
+         * @throws {Error} If updating the name fails or the API request fails.
+         */
+        updateName(newName: string): Promise<ESPAPIResponse>;
+    }
+}

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

@@ -0,0 +1,18 @@
+import "./CreateSubGroup";
+import "./SetParams";
+import "./Delete";
+import "./UpdateName";
+import "./Share";
+import "./GetSharingInfo";
+import "./RemoveMember";
+import "./Leave";
+import "./AddNode";
+import "./RemoveNode";
+import "./GetNode";
+import "./GetNodes";
+import "./GetSchedules";
+import "./CreateSchedule";
+import "./DeleteAllSchedules";
+import "./GetAutomations";
+import "./GetAutomation";
+import "./CreateAutomation";

package/dist/types/methods/ESPRMNeoNode/CreateSchedule.d.ts

@@ -0,0 +1,31 @@
+import { ESPRMNeoSchedule } from "../../ESPRMNeoSchedule";
+import { ScheduleItem } from "../../types/schedule";
+/**
+ * Augments the ESPRMNeoNode class with the `createSchedule` method.
+ */
+declare module "../../ESPRMNeoNode" {
+    interface ESPRMNeoNode {
+        /**
+         * Creates schedules on this node.
+         *
+         * - Pass a single {@link ScheduleItem} to append it while preserving existing
+         *   schedules (GET current list, then PUT the merged list).
+         * - Pass an array to replace all schedules in one PUT. Pass `[]` to clear.
+         *
+         * Calls `PUT /v1/groups/{groupId}/nodes/{nodeId}/schedules`.
+         *
+         * Single-item append is not safe under concurrent calls to the same node —
+         * two simultaneous creates can read the same existing list and the later
+         * PUT wins. Callers appending many schedules should build the array locally
+         * and pass it once.
+         *
+         * @param schedules - One schedule to append, or the full list to set.
+         * @returns The created schedule, or the full list after a replace-all PUT.
+         * @throws {ESPAPICallValidationError} If the argument is invalid, or a single
+         *   schedule's id is missing / already exists.
+         * @throws {Error} If the API request fails.
+         */
+        createSchedule(schedule: ScheduleItem): Promise<ESPRMNeoSchedule>;
+        createSchedule(schedules: ScheduleItem[]): Promise<ESPRMNeoSchedule[]>;
+    }
+}