Class ESPRMNeoAutomation

constructor

• new ESPRMNeoAutomation(
      data: AutomationItem,
      group: ESPRMNeoGroup,
  ): ESPRMNeoAutomation

  Parameters

  • data: AutomationItem
  • group: ESPRMNeoGroup

  Returns ESPRMNeoAutomation

actions

conditions

groupId

id

name

Optionalretrigger

Optionalstatus

addAction

• addAction(target: ActionTarget): Promise<ESPAPIResponse>

  Adds an action target to this automation. The instance is updated only after the API call succeeds.

  Parameters

  • target: ActionTarget

    The action target to add.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response.

  Throws

  If target is missing or missing required fields.

addCondition

• addCondition(triggerId: string): Promise<ESPAPIResponse>

  Adds a condition (trigger id) to this automation. The instance is updated only after the API call succeeds.

  Parameters

  • triggerId: string

    The trigger id to add to conditions.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response.

  Throws

  If triggerId is missing or empty.

delete

• delete(): Promise<ESPAPIResponse>

  Deletes this automation. After a successful delete, the instance is stale — callers should discard it.

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

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response when the automation is successfully deleted.

  Throws

  If the API request fails.

removeAction

• removeAction(index: number): Promise<ESPAPIResponse>

  Removes an action from this automation by index. The instance is updated only after the API call succeeds.

  Parameters

  • index: number

    The index of the action to remove.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response.

  Throws

  If the index is out of range.

removeCondition

• removeCondition(triggerId: string): Promise<ESPAPIResponse>

  Removes a condition (trigger id) from this automation. The instance is updated only after the API call succeeds.

  Parameters

  • triggerId: string

    The trigger id to remove from conditions.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response.

  Throws

  If triggerId is missing or empty.

update

• update(updates: Partial<CreateAutomationInput>): Promise<ESPAPIResponse>

  Updates this automation with partial changes. id cannot be changed.

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

  Parameters

  • updates: Partial<CreateAutomationInput>

    Partial automation fields to update.

  Returns Promise<ESPAPIResponse>

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

  Throws

  If updating the automation fails or the API request fails.