Class ESPRMNeoGroup

constructor

• new ESPRMNeoGroup(data: ESPRMNeoGroup): ESPRMNeoGroup

  Parameters

  • data: ESPRMNeoGroup

  Returns ESPRMNeoGroup

OptionalaccessType

groupId

groupName

nodeDetails

nodeIds

OptionalparentId

subgroups

addNode

• addNode(nodeId: string): Promise<ESPAPIResponse>

  Adds a node to this nested group (subgroup API).

  Calls PUT /v1/groups/{groupId}/subgroups/{subGroupId}/nodes/{nodeId}.

  Parameters

  • nodeId: string

  Returns Promise<ESPAPIResponse>

  Throws

  If this is a root group or the node is already present.

createAutomation

• createAutomation(input: CreateAutomationInput): Promise<ESPRMNeoAutomation>

  Creates a new automation for this group. The server mints the id.

  Calls POST /v1/groups/{groupId}/service/automations.

  Parameters

  • input: CreateAutomationInput

    The automation fields (name, conditions, actions, …).

  Returns Promise<ESPRMNeoAutomation>

  A promise that resolves to the created ESPRMNeoAutomation instance.

  Throws

  If name, conditions, or actions are missing.

  Throws

  If automation creation fails or the API request fails.

createSchedule

• createSchedule(
      nodeSchedules: { nodeId: string; schedules: ScheduleItem[] }[],
  ): Promise<ESPRMNeoSchedule[]>

  Creates schedules for multiple nodes in this group.

  For each node, calls PUT /v1/groups/{groupId}/nodes/{nodeId}/schedules.

  Parameters

  • nodeSchedules: { nodeId: string; schedules: ScheduleItem[] }[]

    Array of objects, each containing a nodeId and its schedules.

  Returns Promise<ESPRMNeoSchedule[]>

  A promise that resolves to the created schedules across all nodes.

  Throws

  If nodeSchedules or schedule data is invalid, or any node is not found.

  Throws

  If creating schedules fails on one or more nodes.

createSubGroup

• createSubGroup(name: string): Promise<ESPRMNeoGroup>

  Creates a new nested group (subgroup) under this group.

  Calls POST /v1/groups/{groupId}/subgroups.

  Parameters

  • name: string

    The name for the new nested group.

  Returns Promise<ESPRMNeoGroup>

  A promise that resolves to the created child ESPRMNeoGroup (parentId set).

  Throws

  If the API request fails.

delete

• delete(): Promise<ESPAPIResponse>

  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 Promise<ESPAPIResponse>

  A promise that resolves with the API response when the group has been deleted.

  Throws

  If the deletion fails or the API request fails.

deleteAllSchedules

• deleteAllSchedules(): Promise<ESPAPIResponse>

  Deletes all schedules for all nodes in this group.

  For each node, calls DELETE /v1/groups/{groupId}/nodes/{nodeId}/schedules.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response when all schedules are deleted.

getAutomation

• getAutomation(automationId: string): Promise<ESPRMNeoAutomation>

  Retrieves a specific automation by its ID.

  Calls GET /v1/groups/{groupId}/service/automations/{automationId}.

  Parameters

  • automationId: string

    The ID of the automation to retrieve.

  Returns Promise<ESPRMNeoAutomation>

  A promise that resolves to an ESPRMNeoAutomation instance.

  Throws

  If the automation is not found or the API request fails.

getAutomations

• getAutomations(): Promise<ESPRMNeoAutomation[]>

  Retrieves all automations for this group.

  Calls GET /v1/groups/{groupId}/service/automations.

  Returns Promise<ESPRMNeoAutomation[]>

  A promise that resolves to an array of ESPRMNeoAutomation instances.

  Throws

  If retrieving automations fails or the API request fails.

getNode

• getNode(nodeId: string, options?: GetNodeOptions): Promise<ESPRMNeoNode>

  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.

  Parameters

  • nodeId: string

    The ID of the node to retrieve.
  • Optionaloptions: GetNodeOptions

    See GetNodeOptions. Defaults to { cache: true }.

  Returns Promise<ESPRMNeoNode>

  A promise that resolves to an ESPRMNeoNode instance.

  Throws

  If the node config could not be resolved.

  Throws

  If the API request fails.

getNodes

• getNodes(options?: GetNodesOptions): Promise<ESPRMNeoNode[]>

  Retrieves all nodes in this group.

  Forwards GetNodesOptions to each 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.

  Parameters

  • Optionaloptions: GetNodesOptions

    See GetNodesOptions. Defaults to { cache: true }.

  Returns Promise<ESPRMNeoNode[]>

  A promise that resolves to an array of ESPRMNeoNode instances.

getSchedules

• getSchedules(): Promise<ESPRMNeoSchedule[]>

  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 Promise<ESPRMNeoSchedule[]>

  A promise that resolves to an array of ESPRMNeoSchedule instances.

getSharingInfo

• getSharingInfo(): Promise<GroupSharingInfo>

  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 Promise<GroupSharingInfo>

  A promise that resolves to a GroupSharingInfo.

  Throws

  If the API request fails.

leave

• leave(): Promise<ESPAPIResponse>

  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 Promise<ESPAPIResponse>

  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.

removeMember

• removeMember(userId: string): Promise<ESPAPIResponse>

  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 ESPRMNeoGroup.leave instead.

  Parameters

  • userId: string

    The ID of the user to remove. Must not be the caller.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response.

  Throws

  If userId is empty or refers to the caller (use leave()).

removeNode

• removeNode(nodeId: string): Promise<ESPAPIResponse>

  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).

  Parameters

  • nodeId: string

  Returns Promise<ESPAPIResponse>

setParams

• setParams(
      params: Record<string, any>,
      options?: ESPRMNeoGroupSetParamsOptions,
  ): Promise<ESPAPIResponse>

  Sends a parameter payload to all devices in this group (or one subgroup) via the group control MQTT topic. Same JSON shape as 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.

  Parameters

  • params: Record<string, any>
  • Optionaloptions: ESPRMNeoGroupSetParamsOptions

  Returns Promise<ESPAPIResponse>

share

• share(options: ShareOptions): Promise<ESPAPIResponse>

  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

  Parameters

  • options: ShareOptions

    Sharing options.

    Options for sharing a group or subgroup.

    • accessType: "primary" | "secondary"

    • username: string

  Returns Promise<ESPAPIResponse>

  A promise that resolves to the API response.

  Throws

  If username is missing.

  Throws

  If the API request fails.

updateName

• updateName(newName: string): Promise<ESPAPIResponse>

  Updates the name of this group.

  Calls:

  • Root group: PATCH /v1/groups/{groupId}
  • Nested subgroup: PATCH /v1/groups/{groupId}/subgroups/{subGroupId}

  Parameters

  • newName: string

    The new name for the group.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response when the name is successfully updated.

  Throws

  If updating the name fails or the API request fails.