Class Actions

Index

Constructors

Methods

create delete edit info list

Constructors

constructor

new Actions(params: GenericModuleParams): Actions
Parameters
- params: GenericModuleParams
Returns Actions
Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in common/TagoIOModule.ts:75

Methods

create

create(actionObj: ActionCreateInfo): Promise<{ action: string }>
Creates a new action in your application.
Parameters
- actionObj: ActionCreateInfo
Returns Promise<{ action: string }>
See
https://help.tago.io/portal/en/kb/tagoio/actions Actions
Example
If receive an error "Authorization Denied", check policy Action / Create in Access Management.
```
const newAction = await Resources.actions.create({
  name: "My Action",
  type: "condition",
  action: {
    script: ["analysis-id"],
    type: "script"
  },
  tags: [{ key: "type", value: "notification" }]
});
console.log(newAction.action); // action-id-123
```
- Defined in modules/Resources/Actions.ts:63

delete

delete(actionID: string): Promise<string>
Deletes an action from your application.
Parameters
- actionID: string
Returns Promise<string>
See
https://help.tago.io/portal/en/kb/tagoio/actions Actions
Example
If receive an error "Authorization Denied", check policy Action / Delete in Access Management.
```
const result = await Resources.actions.delete("action-id-123");
console.log(result); // Successfully Removed
```
- Defined in modules/Resources/Actions.ts:110

edit

edit(actionID: string, actionObj: Partial<ActionCreateInfo>): Promise<string>
Modifies an existing action.
Parameters
- actionID: string
- actionObj: Partial<ActionCreateInfo>
Returns Promise<string>
See
https://help.tago.io/portal/en/kb/tagoio/actions Actions
Example
If receive an error "Authorization Denied", check policy Action / Edit in Access Management.
```
const result = await Resources.actions.edit("action-id-123", {
  name: "Updated Action",
  active: false
});
console.log(result); // Successfully Updated
```
- Defined in modules/Resources/Actions.ts:88

info

info(actionID: string): Promise<ActionInfo>
Retrieves detailed information about a specific action.
Parameters
- actionID: string
Returns Promise<ActionInfo>
See
https://help.tago.io/portal/en/kb/tagoio/actions Actions
Example
If receive an error "Authorization Denied", check policy Action / Access in Access Management.
```
const actionInfo = await Resources.actions.info("action-id-123");
console.log(actionInfo); // { id: 'action-id-123', name: 'My Action', ... }
```
- Defined in modules/Resources/Actions.ts:131

list

list(queryObj?: ActionQuery): Promise<ActionInfo[]>
Lists all actions from the application with pagination support. Use this to retrieve and manage actions in your application.
Parameters
- OptionalqueryObj: ActionQuery
Returns Promise<ActionInfo[]>
See
https://help.tago.io/portal/en/kb/tagoio/actions Actions
Example
If receive an error "Authorization Denied", check policy Action / Access in Access Management.
```
const list = await Resources.actions.list({
  page: 1,
  fields: ["id", "name"],
  amount: 10,
  orderBy: ["name", "asc"]
});
console.log(list); // [ { id: '66ab7c62e5f0db000998ce42', name: 'Action Test', ...} ]
```
- Defined in modules/Resources/Actions.ts:25