Class ESPAutomation

Class representing an automation in the ESP RainMaker system. This class implements the ESPAutomationInterface.

Implements

ESPAutomationInterface

Index

Constructors

Properties

actions automationId automationName enabled eventOperator events eventType location? metadata? nodeId? region? retrigger?

Methods

delete enable setRetrigger update updateActions updateEvents updateLocation updateName

Constructors

constructor

new ESPAutomation(automationConfig: ESPAutomationInterface): ESPAutomation
Creates a new instance of ESPAutomation.
Parameters
- automationConfig: ESPAutomationInterface
  The configuration object for the automation
Returns ESPAutomation
- Defined in src/ESPAutomation.ts:70

Properties

actions

actions: ESPAutomationAction[]

The list of actions to be performed when the automation is triggered.

automationId

automationId: string

The unique identifier of the automation.

automationName

automationName: string

The name of the automation.

enabled

enabled: boolean

Indicates whether the automation is currently enabled.

eventOperator

eventOperator: ESPAutomationEventOperator

The operator used to combine multiple events (AND/OR).

events

events: (
    | ESPAutomationEvent
    | ESPWeatherEvent
    | ESPWeatherCondition
    | ESPDaylightEvent
)[]

The list of events that trigger this automation.

eventType

eventType: ESPAutomationEventType

The type of events that trigger this automation.

`Optional`location

location?: ESPGeoCoordinates

The geographical coordinates for weather/daylight based automations.

`Optional`metadata

metadata?: any

Additional metadata associated with the automation.

`Optional`nodeId

nodeId?: string

The ID of the node associated with this automation.

`Optional`region

region?: string

The region for weather/daylight based automations.

`Optional`retrigger

retrigger?: boolean

Indicates whether the automation should be retriggered after completion.

Methods

delete

delete(): Promise<ESPAPIResponse>
Deletes the automation from the system.

Returns Promise<ESPAPIResponse>
A promise that resolves to the API response after successful deletion.

Throws
If the automation ID is missing or invalid.
- Defined in src/methods/ESPAutomation/Delete.ts:25

enable

enable(enabled: boolean): Promise<ESPAPIResponse>
Updates the enabled status of an existing automation.
Parameters
- enabled: boolean
  The new enabled status for the automation.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API response after successful update.
- Defined in src/methods/ESPAutomation/Enable.ts:21

setRetrigger

setRetrigger(retrigger: boolean): Promise<ESPAPIResponse>
Updates the retrigger option of an existing automation.
Parameters
- retrigger: boolean
  A boolean indicating whether the automation can be triggered more than once while the conditions are met.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API response after successful update.
- Defined in src/methods/ESPAutomation/SetRetrigger.ts:21

update

update(automationDetails: ESPAutomationUpdateDetails): Promise<ESPAPIResponse>
Updates an existing automation with new details.
Parameters
- automationDetails: ESPAutomationUpdateDetails
  The updated details for the automation.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API response after successful update.
- Defined in src/methods/ESPAutomation/Update.ts:31

updateActions

updateActions(actions: ESPAutomationAction[]): Promise<ESPAPIResponse>
Updates the actions of an existing automation.
Parameters
- actions: ESPAutomationAction[]
  An array of action objects defining the actions to be performed when the automation is triggered.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API response after successful update.
- Defined in src/methods/ESPAutomation/UpdateActions.ts:26

updateEvents

updateEvents(
    events: (
        | ESPAutomationEvent
        | ESPWeatherEvent
        | ESPWeatherCondition
        | ESPDaylightEvent
    )[],
): Promise<ESPAPIResponse>
Updates the events of an existing automation.
Parameters
- events: (ESPAutomationEvent | ESPWeatherEvent | ESPWeatherCondition | ESPDaylightEvent)[]
  An array of event objects defining the conditions that trigger the automation.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API response after successful update.
- Defined in src/methods/ESPAutomation/UpdateEvents.ts:29

updateLocation

updateLocation(location: ESPGeoCoordinates): Promise<ESPAPIResponse>
Updates the location of an existing automation.
Parameters
- location: ESPGeoCoordinates
  The new location coordinates for the automation.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API response after successful update.
- Defined in src/methods/ESPAutomation/UpdateLocation.ts:27

updateName

updateName(name: string): Promise<ESPAPIResponse>
Updates the name of an existing automation.
Parameters
- name: string
  The new name for the automation.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API response after successful update.
- Defined in src/methods/ESPAutomation/UpdateName.ts:24

Class ESPAutomation

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ESPAutomation

Properties

actions

automationId

automationName

enabled

eventOperator

events

eventType

Optionallocation

Optionalmetadata

OptionalnodeId

Optionalregion

Optionalretrigger

Methods

delete

Returns Promise<ESPAPIResponse>

Throws

enable

Parameters

Returns Promise<ESPAPIResponse>

setRetrigger

Parameters

Returns Promise<ESPAPIResponse>

update

Parameters

Returns Promise<ESPAPIResponse>

updateActions

Parameters

Returns Promise<ESPAPIResponse>

updateEvents

Parameters

Returns Promise<ESPAPIResponse>

updateLocation

Parameters

Returns Promise<ESPAPIResponse>

updateName

Parameters

Returns Promise<ESPAPIResponse>

Settings

On This Page

`Optional`location

`Optional`metadata

`Optional`nodeId

`Optional`region

`Optional`retrigger