Skip to main content

Class: AutomationRestClient

Client for performing automation through to REST endpoints.

Extends​

  • BaseRestClient

Implements​

  • IAutomationComponent

Constructors​

Constructor​

new AutomationRestClient(config): AutomationRestClient

Create a new instance of AutomationRestClient.

Parameters​

config​

IBaseRestClientConfig

The configuration for the client.

Returns​

AutomationRestClient

Overrides​

BaseRestClient.constructor

Properties​

CLASS_NAME​

readonly static CLASS_NAME: string

Runtime name for the class.

Methods​

className()​

className(): string

Returns the class name of the component.

Returns​

string

The class name of the component.

Implementation of​

IAutomationComponent.className

actionCreate()​

actionCreate(actionType, trigger, config?): Promise<string>

Create an action with the trigger and configuration.

Parameters​

actionType​

string

The type of action to create.

trigger​

string

The trigger to create the action for.

config?​

unknown

Configuration to be passed to the actions.

Returns​

Promise<string>

The id of the created action.

Implementation of​

IAutomationComponent.actionCreate

actionRemove()​

actionRemove(actionId): Promise<void>

Remove an action by its id.

Parameters​

actionId​

string

The id of the action to remove.

Returns​

Promise<void>

A promise that resolves when the action has been removed.

Implementation of​

IAutomationComponent.actionRemove

actionGet()​

actionGet(actionId): Promise<IAutomationActionEntry>

Get an action by its id.

Parameters​

actionId​

string

The id of the action to get.

Returns​

Promise<IAutomationActionEntry>

The action with the given id.

Implementation of​

IAutomationComponent.actionGet

actionsQuery()​

actionsQuery(options?, cursor?, limit?): Promise<{ entries: IAutomationActionEntry[]; cursor?: string; }>

Query the actions with the given parameters.

Parameters​

options?​

The options to query the actions with.

trigger?​

string

The trigger to filter the actions by.

actionType?​

string

The type of action to filter by.

cursor?​

string

The cursor to continue the query from.

limit?​

number

The maximum number of actions to return.

Returns​

Promise<{ entries: IAutomationActionEntry[]; cursor?: string; }>

The actions matching the query and a cursor to continue the query if there are more results.

Implementation of​

IAutomationComponent.actionsQuery

trigger()​

trigger(trigger, data?): Promise<void>

Locate automation actions which match the given trigger and execute them.

Parameters​

trigger​

string

The trigger to find the actions for.

data?​

unknown

Optional data to be passed to the actions.

Returns​

Promise<void>

A promise that resolves when all matching actions have been dispatched.

Implementation of​

IAutomationComponent.trigger