Class WorkModule

Work Module - Projects, Tasks, Workflows, Time Tracking

Constructors

constructor

Properties

client

Methods

createProject createTask deleteTask executeWorkflow getProject getTask listProjects listTasks listTimeEntries listWorkflows startTimer stopTimer updateTask

Constructors

constructor

Properties

Private client

client: ArqeraClient

Methods

createProject

  • createProject(data): Promise<unknown>

  • Create a new project

    Parameters

    • data: Record<string, unknown>

    Returns Promise<unknown>

createTask

  • createTask(data): Promise<unknown>

  • Create a new task

    Parameters

    • data: Record<string, unknown>

    Returns Promise<unknown>

deleteTask

  • deleteTask(taskId): Promise<unknown>

  • Delete a task (soft delete)

    Parameters

    • taskId: number

    Returns Promise<unknown>

executeWorkflow

  • executeWorkflow(workflowId, inputs): Promise<unknown>

  • Execute a workflow

    Parameters

    • workflowId: number
    • inputs: Record<string, unknown>

    Returns Promise<unknown>

getProject

  • getProject(projectId): Promise<unknown>

  • Get a single project by ID

    Parameters

    • projectId: number

    Returns Promise<unknown>

getTask

  • getTask(taskId): Promise<unknown>

  • Get a single task by ID

    Parameters

    • taskId: number

    Returns Promise<unknown>

listProjects

  • listProjects(options?): Promise<unknown>

  • List projects with optional filters

    Parameters

    • options: {
          limit?: number;
          offset?: number;
          status?: ProjectStatus;
      } = {}
      • Optional limit?: number
      • Optional offset?: number
      • Optional status?: ProjectStatus

    Returns Promise<unknown>

listTasks

  • listTasks(options?): Promise<unknown>

  • List tasks with optional filters

    Parameters

    • options: {
          assigneeId?: number;
          limit?: number;
          offset?: number;
          projectId?: number;
          status?: TaskStatus;
      } = {}
      • Optional assigneeId?: number
      • Optional limit?: number
      • Optional offset?: number
      • Optional projectId?: number
      • Optional status?: TaskStatus

    Returns Promise<unknown>

listTimeEntries

  • listTimeEntries(options?): Promise<unknown>

  • List time entries with optional filters

    Parameters

    • options: {
          endDate?: string;
          limit?: number;
          offset?: number;
          startDate?: string;
          taskId?: number;
          userId?: number;
      } = {}
      • Optional endDate?: string
      • Optional limit?: number
      • Optional offset?: number
      • Optional startDate?: string
      • Optional taskId?: number
      • Optional userId?: number

    Returns Promise<unknown>

listWorkflows

  • listWorkflows(options?): Promise<unknown>

  • List workflows with optional filters

    Parameters

    • options: {
          limit?: number;
          module?: string;
          offset?: number;
          status?: string;
      } = {}
      • Optional limit?: number
      • Optional module?: string
      • Optional offset?: number
      • Optional status?: string

    Returns Promise<unknown>

startTimer

  • startTimer(taskId): Promise<unknown>

  • Start a timer for a task

    Parameters

    • taskId: number

    Returns Promise<unknown>

stopTimer

  • stopTimer(timeEntryId): Promise<unknown>

  • Stop a running timer

    Parameters

    • timeEntryId: number

    Returns Promise<unknown>

updateTask

  • updateTask(taskId, data): Promise<unknown>

  • Update a task

    Parameters

    • taskId: number
    • data: Record<string, unknown>

    Returns Promise<unknown>

Settings

Member Visibility

Theme

On This Page

constructorclientcreateProjectcreateTaskdeleteTaskexecuteWorkflowgetProjectgetTasklistProjectslistTaskslistTimeEntrieslistWorkflowsstartTimerstopTimerupdateTask