Class Projects

The Projects API provides access for getting and manipulating projects. It can be accessed through Time.Projects, for example:

const project = await Time.Projects.createProject({ name: "My Project" })

Hierarchy

Projects

Index

Methods

createProject updateProject projects deleteProject projectsWithTotalMinutes

Methods

createProject

createProject(project: IProjectCreateParams): Promise<IProject>
Creates a new project

Returns
The created project
Parameters
- project: IProjectCreateParams
  
  The project to create
Returns Promise<IProject>

updateProject

updateProject(projectId: string, changes: IProjectChanges): Promise<IProjectChanges>
Updates a project

Returns
The updated project
Parameters
- projectId: string
  
  The ID of the project to update
- changes: IProjectChanges
  
  The changes to make to the project
Returns Promise<IProjectChanges>

projects

projects(): Promise<IProject[]>
Fetches all projects for the current organisation from the database and returns them.

Returns
The projects for the current organisation

Throws
This request may fail with the following error codes:
- ErrorCode.Unauthorised
- ErrorCode.DifferentOrganisation
Returns Promise<IProject[]>

deleteProject

deleteProject(projectId: string): Promise<Deleted<IProject>>
Deletes the project with the given ID. If the project is not found in the database, the method will return the message "Project already deleted":
```
{
   "message": "Project already deleted"
}
If you get this message, you may have to refresh the projects list in your store.
```
Returns
The deleted project or the message "Project already deleted"
Parameters
- projectId: string
  
  The ID of the project to delete
Returns Promise<Deleted<IProject>>

projectsWithTotalMinutes

projectsWithTotalMinutes(): Promise<IProjectWithTotalMinutes[]>
Fetches all projects for the current organisation from the database and returns them with total hours.

Returns
The projects for the current organisation with total hours

Returns Promise<IProjectWithTotalMinutes[]>