Documentation

Class

TaskBundles

TaskBundles(client)

Class corresponding to Aworks TaskBundles Endpoints
Constructor

# new TaskBundles(client)

Endpoint constructor
Parameters:
Name Type Description
client Client
See:
  • [TaskBundles in Awork API Docs](https://openapi.awork.com/#/TaskBundles)

View Source endpoints/TaskBundles.js, line 13

Classes

TaskBundles

Methods

# async copy(taskBundleId) → {Promise.<TaskBundle>}

Creates the taskbundle, task templates, task list templates, task template to task list templates and copies the attachments.
Parameters:
Name Type Description
taskBundleId String The id of the task bundle to be copied.

View Source endpoints/TaskBundles.js, line 99

Promise.<TaskBundle>

# async create(taskbundle) → {Promise.<TaskBundle>}

Returns the task bundle with the specified id.
Parameters:
Name Type Description
taskbundle TaskBundleModel

View Source endpoints/TaskBundles.js, line 58

Promise.<TaskBundle>

# async createFromProject(projectId, taskBundle) → {Promise.<Task>}

Creates a new task bundle from the specified project.
Parameters:
Name Type Description
projectId String The id of the project of which the new task bundle will be created.
taskBundle TaskBundleCreateModel The model to create the task bundle.

View Source endpoints/TaskBundles.js, line 119

Promise.<Task>

# async createFromTaskList(taskListId, taskBundle) → {Promise.<Task>}

Creates a new task bundle from the specified task list.
Parameters:
Name Type Description
taskListId String The id of the task list of which the new task bundle will be created.
taskBundle TaskBundleCreateModel The model to create the task bundle.

View Source endpoints/TaskBundles.js, line 131

Promise.<Task>

# async delete(taskBundleId) → {Promise.<void>}

Deletes the task bundle with the specified id.
Parameters:
Name Type Description
taskBundleId String

View Source endpoints/TaskBundles.js, line 81

Promise.<void>

# async get(taskBundleId) → {Promise.<TaskBundle>}

Returns the task bundle with the specified id.
Parameters:
Name Type Description
taskBundleId String

View Source endpoints/TaskBundles.js, line 28

Promise.<TaskBundle>

# async icons() → {Promise.<Array.<String>>}

Returns all possible icons for a task bundle.

View Source endpoints/TaskBundles.js, line 89

Promise.<Array.<String>>

# async list(optionsopt) → {Promise.<Array.<TaskBundle>>}

Returns all global task bundles.
Parameters:
Name Type Attributes Description
options ListOptions <optional>
 Pagination and filtering options.

View Source endpoints/TaskBundles.js, line 39

Promise.<Array.<TaskBundle>>

# taskListTemplates(projectId) → {ProjectProjectStatus}

Returns the TaskBundleTaskListTemplates Endpoint with the specified task bundle Id.
Parameters:
Name Type Description
projectId String The id of the task bundle.

View Source endpoints/TaskBundles.js, line 142

ProjectProjectStatus

# taskTemplates(projectId) → {ProjectProjectStatus}

Returns the TaskBundleTaskTemplates Endpoint with the specified task bundle Id.
Parameters:
Name Type Description
projectId String The id of the task bundle.

View Source endpoints/TaskBundles.js, line 151

ProjectProjectStatus

# async update(taskBundleId, taskBundle) → {Promise.<TaskBundle>}

Updates the task bundle with the specified id.
Parameters:
Name Type Description
taskBundleId String
taskBundle TaskBundleModel

View Source endpoints/TaskBundles.js, line 70

Promise.<TaskBundle>