Class

ProjectStatuses

ProjectStatuses(client)

Class corresponding to Aworks ProjectStatuses Endpoints
Constructor

# new ProjectStatuses(client)

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

View Source endpoints/ProjectStatuses.js, line 10

Classes

ProjectStatuses

Methods

# async archive(projectStatusId, archivedStatus)

Archives or unarchives the project status with the specified id.
Parameters:
Name Type Default Description
projectStatusId String
archivedStatus Boolean true

View Source endpoints/ProjectStatuses.js, line 81

# async create(projectTemplateId, projectStatus) → {Promise.<ProjectStatus>}

Creates a new project status. For this operation, a projectTemplateId is required.
Parameters:
Name Type Description
projectTemplateId String The id of the project template.
projectStatus ProjectStatus

View Source endpoints/ProjectStatuses.js, line 50

Promise.<ProjectStatus>

# async delete(projectStatusId)

Deletes the project status with the specified id.
Parameters:
Name Type Description
projectStatusId String

View Source endpoints/ProjectStatuses.js, line 72

# async get(projectStatusId) → {Array.<Promise.<ProjectStatus>>}

Returns the project status with the specified id.
Parameters:
Name Type Description
projectStatusId String The id of the project status.

View Source endpoints/ProjectStatuses.js, line 27

Array.<Promise.<ProjectStatus>>

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

Returns all project statuses.
Parameters:
Name Type Attributes Description
options ListOptions <optional>
Pagination and filtering options.

View Source endpoints/ProjectStatuses.js, line 38

Array.<Promise.<ProjectStatus>>

# async update(projectStatusId, projectStatus) → {Promise.<ProjectStatus>}

Updates the project status with the specified id.
Parameters:
Name Type Description
projectStatusId String
projectStatus ProjectStatus

View Source endpoints/ProjectStatuses.js, line 62

Promise.<ProjectStatus>