Class Actions

Hierarchy

Constructors

constructor

Methods

create delete edit info list

Constructors

constructor

Methods

create

  • create(actionObj): Promise<{
        action: string;
    }>

  • Generates and retrieves a new action from the account

    Parameters

    Returns Promise<{
        action: string;
    }>

delete

  • delete(actionID): Promise<string>

  • Deletes an action from the account

    Parameters

    • actionID: string

      Action ID

    Returns Promise<string>

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>

info

list

  • list(queryObj?): Promise<ActionInfo[]>

  • Retrieves a list with all actions from the account

    Parameters

    Returns Promise<ActionInfo[]>

    Default

    queryObj: {
      page: 1,
      fields: ["id", "name"],
      filter: {},
      amount: 20,
      orderBy: "name,asc",
    }

Settings

Member Visibility

Theme

On This Page

constructorcreatedeleteeditinfolist