Class Actions

Hierarchy

TagoIOModule<GenericModuleParams>
- Actions

Index

Constructors

Methods

create delete edit info list

Constructors

constructor

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

Methods

create

create(actionObj): Promise<{
action: string;
}>
Generates and retrieves a new action from the account
Parameters
- actionObj: ActionCreateInfo
  
  Object data to create new TagoIO Action
Returns Promise<{
action: string;
}>
- Defined in modules/Resources/Actions.ts:43

delete

delete(actionID): Promise<string>
Deletes an action from the account
Parameters
- actionID: string
  
  Action ID
Returns Promise<string>
- Defined in modules/Resources/Actions.ts:72

edit

edit(actionID, actionObj): Promise<string>
Modify any property of the action.
Parameters
- actionID: string
  
  Action ID
- actionObj: Partial<ActionCreateInfo>
  
  Action Object with data to be replaced
Returns Promise<string>
- Defined in modules/Resources/Actions.ts:58

info

info(actionID): Promise<ActionInfo>
Gets information about the action
Parameters
- actionID: string
  
  Action ID
Returns Promise<ActionInfo>
- Defined in modules/Resources/Actions.ts:85

list

list(queryObj?): Promise<ActionInfo[]>
Retrieves a list with all actions from the account
Parameters
- Optional queryObj: ActionQuery
  
  Search query params
Returns Promise<ActionInfo[]>
Default
```
queryObj: {
  page: 1,
  fields: ["id", "name"],
  filter: {},
  amount: 20,
  orderBy: "name,asc",
}
```
- Defined in modules/Resources/Actions.ts:21